///
/// | Parameter |
/// Description |
///
///
/// | ALL |
/// Activates all valid parameters for log. |
///
///
/// | AKEY |
/// Access Key used by the map layer. |
///
///
/// | CLIENT |
/// The client and version that generated the request. |
///
///
/// | CLIENTID |
/// A unique identifier for the client computer that generated the request. |
///
///
/// | DATASRC |
/// Data source name. |
///
///
/// | ITEM |
/// The type of request |
///
///
/// | LYRTYPE |
/// Layer Type. |
///
///
/// | MLNAME |
/// Map layer name. |
///
///
/// | MWIN |
/// A composite item that generates entries for MWFURL, XMIN, YMIN, XMAX, and YMAX. |
///
///
/// | MWFURL |
/// The URL of the map that generated the request. |
///
///
/// | NLAYER |
/// The number of layers in the request. |
///
///
/// | NSCALOG |
/// A composite item that generates several entries that conform to the NCSA/CERN log file standard. |
///
///
/// | PASSWORD |
/// Password used by the map layer. |
///
///
/// | PREC |
/// A number that indicates map data precision. |
///
///
/// | REQID |
/// The request identification number. |
///
///
/// | REQTIME |
/// Time taken to process the request in seconds. |
///
///
/// | SCALE |
/// The current scale. |
///
///
/// | TABLE |
/// Feature table name used by the map layer. |
///
///
/// | TRACKID |
/// Customer tracking ID. |
///
///
/// | USER |
/// User ID used by this map layer. |
///
///
/// | XMAX |
/// The maximum X value of the area covered by the request. |
///
///
/// | YMAX |
/// The maximum Y value of the area covered by the request. |
///
///
/// | XMIN |
/// The minimum X value of the area covered by the request. |
///
///
/// | YMIN |
/// The minimum Y value of the area covered by the request. |
///
///
/// \n
/// The valid Access log customization parameters are:
/// CLIENT, CLIENTID, ITEM, NSCALOG, REQID, PREC, REQTIME, MWIN, MWFURL,
/// XMAX, YMAX, XMIN, YMIN, NLAYER, SCALE, TRACKID.
/// \n
/// The valid Map Layer Access log customization parameters are:
/// AKEY, CLIENT, CLIENTID, DATASRC, LYRTYPE, MLNAME, MWIN, MWFURL,
/// NSCALOG, PASSWORD, PREC, REQID, REQTIME, SCALE, TABLE, TRACKID,
/// USER, XMAX, YMAX, XMIN, YMIN.
///
/// TODO:
/// - Determine the valid log parameters for the various logs.
///
/// ACCESS LOG PROPERTIES SECTION ------------------------------------------------------------------------------------
/// Access Log properties. This log records all requests to the MapGuide server.
/// A record is created for each request after it has been completed.
const AccessLogPropertiesSection = "AccessLogProperties";
/// Enables/disables the Access log
const AccessLogPropertyEnabled = "Enabled";
const DefaultAccessLogPropertyEnabled = true;
/// The Access log's file name. NOTE: A log's filename may include the following special
/// characters: %d,%m,%y, standing for date, month, year. If one or all of these are used,
/// the special char will be replaced by the actual calendar value when the log file is
/// created. A new log file will be created when the shortest time period has elapsed.
/// That is, if the filename includes %d, a new log file will be created everyday. If the
/// filename contains both %m and %y, a new log file is created every month.
const AccessLogPropertyFilename = "Filename";
const DefaultAccessLogPropertyFilename = "Access.log";
/// The Access log's parameters
const AccessLogPropertyParameters = "Parameters";
const DefaultAccessLogPropertyParameters = "";
/// ADMIN LOG PROPERTIES SECTION -------------------------------------------------------------------------------------
/// Admin Log properties. This log records all administrative operations (server status
/// changes, configuration changes, etc.).
const AdminLogPropertiesSection = "AdminLogProperties";
/// Enables/disables the Admin log
const AdminLogPropertyEnabled = "Enabled";
const DefaultAdminLogPropertyEnabled = true;
/// The Admin log's file name. NOTE: As with the Access Log, the special characters: %d,
/// %m, %y may be used in the filename.
const AdminLogPropertyFilename = "Filename";
const DefaultAdminLogPropertyFilename = "Admin.log";
/// The Admin log's parameters
const AdminLogPropertyParameters = "Parameters";
const DefaultAdminLogPropertyParameters = "";
/// AUTHENTICATION LOG PROPERTIES SECTION ----------------------------------------------------------------------------
/// Authentication Log properties. This log records the success or failure of all
/// authentication operations.
const AuthenticationLogPropertiesSection = "AuthenticationLogProperties";
/// Enables/disables the Authentication log
const AuthenticationLogPropertyEnabled = "Enabled";
const DefaultAuthenticationLogPropertyEnabled = true;
/// The Authentication log's file name. NOTE: As with the Access Log, the special
/// characters: %d, %m, %y may be used in the filename.
const AuthenticationLogPropertyFilename = "Filename";
const DefaultAuthenticationLogPropertyFilename = "Authentication.log";
/// The Authentication log's parameters
const AuthenticationLogPropertyParameters = "Parameters";
const DefaultAuthenticationLogPropertyParameters = "";
/// ERROR LOG PROPERTIES SECTION -------------------------------------------------------------------------------------
/// Error Log properties. This log records all errors that occur during the MapGuide
/// server's operation.
const ErrorLogPropertiesSection = "ErrorLogProperties";
/// Enables/disables the Error log
const ErrorLogPropertyEnabled = "Enabled";
const DefaultErrorLogPropertyEnabled = true;
/// The Error log's file name. NOTE: As with the Access Log, the special characters:
/// %d, %m, %y may be used in the file name.
const ErrorLogPropertyFilename = "Filename";
const DefaultErrorLogPropertyFilename = "Error.log";
/// The Error log's parameters
const ErrorLogPropertyParameters = "Parameters";
const DefaultErrorLogPropertyParameters = "";
/// SESSION LOG PROPERTIES SECTION -----------------------------------------------------------------------------------
/// Session Log properties. This log records state information for each connection
/// to the MapGuide server, such as connection ID, connection, duration,
/// user name, operations received, and operations processed.
const SessionLogPropertiesSection = "SessionLogProperties";
/// Enables/disables the Session log
const SessionLogPropertyEnabled = "Enabled";
const DefaultSessionLogPropertyEnabled = true;
/// The Session log's file name. NOTE: As with the Access Log, the special
/// characters: %d, %m, %y may be used in the filename.
const SessionLogPropertyFilename = "Filename";
const DefaultSessionLogPropertyFilename = "Session.log";
/// The Session log's parameters
const SessionLogPropertyParameters = "Parameters";
const DefaultSessionLogPropertyParameters = "";
/// TRACE LOG PROPERTIES SECTION -------------------------------------------------------------------------------------
/// Trace Log properties. This log records the details for each request (logged
/// in the access log). For example, each request can include data from several
/// maps or feature sets, and a detailed record would be created for each one.
const TraceLogPropertiesSection = "TraceLogProperties";
/// Enables/disables the Trace log
const TraceLogPropertyEnabled = "Enabled";
const DefaultTraceLogPropertyEnabled = true;
/// The Trace log's file name. NOTE: As with the Access Log, the special
/// characters: %d, %m, %y may be used in the filename.
const TraceLogPropertyFilename = "Filename";
const DefaultTraceLogPropertyFilename = "Trace.log";
/// The Trace log's parameters
const TraceLogPropertyParameters = "Parameters";
const DefaultTraceLogPropertyParameters = "";
///////////////////////////////////////////////////////////////////////////
/// Web Configuration Validation Information Maps
///
/// AGENT PROPERTIES SECTION -----------------------------------------------------------------------------------------
/// Agent properties
const AgentPropertiesSection = "AgentProperties";
/// Number of seconds to wait before processing each request value
const AgentDebugPause = "DebugPause";
const DefaultAgentDebugPause = 0;
/// Disables Http operations used for Authoring
const AgentDisableAuthoring = "DisableAuthoring";
/// Disables Http operations used for OGC Wfs
const AgentDisableWfs = "DisableWfs";
/// Disables Http operations used for OGC Wms
const AgentDisableWms = "DisableWms";
/// OGC PROPERTIES SECTION -------------------------------------------------------------------------------------------
/// Ogc properties
const OgcPropertiesSection = "OgcProperties";
/// Password for Wfs requests
const WfsPassword = "WfsPassword";
/// Password for Wms requests
const WmsPassword = "WmsPassword";
}
/// \cond INTERNAL
//////////////////////////////////////////////////////////////////
/// \brief
/// Types of log files
class MgLogFileType
{
/// Logs all requests to the MapGuide server. A record is created
/// for each request after it has been completed.
const Access = "AccessLog";
/// Logs all administrative operations (server status changes, configuration changes, etc.).
const Admin = "AdminLog";
/// Logs the success or failure of all authentication operations.
const Authentication = "AuthenticationLog";
/// Logs all errors that occur during the MapGuide server's operation.
const Error = "ErrorLog";
/// Logs state information for each connection to the MapGuide server,
/// such as connection ID, connection, duration, user name, operations received,
/// and operations processed.
const Session = "SessionLog";
/// Logs the details for each request (logged in the access log). For example,
/// each request can include data from several maps or feature sets, and a detailed
/// record would be created for each one.
const Trace = "TraceLog";
}
//////////////////////////////////////////////////////////////////
/// \brief
/// ServerAdmin properties. Note that this is not a complete list of the properties which may be set
/// for a server. Values stored in the server's config file are also properties of the server. These
/// properties are defined in MgConfigProperties.h.
class MgServerInformationProperties
{
/// INFO PROPERTIES SECTION ----------------------------------------------------------------------------------------
/// The server's version
const ServerVersion = "ServerVersion";
/// STATISTIC PROPERTIES SECTION -----------------------------------------------------------------------------------
/// Gets the # of operations in the administrative queue
const AdminOperationsQueueCount = "AdminOperationsQueueCount";
/// Gets the # of operations in the client queue
const ClientOperationsQueueCount = "ClientOperationsQueueCount";
/// Gets the # of operations in the site queue
const SiteOperationsQueueCount = "SiteOperationsQueueCount";
/// Gets the average time to process an operation
const AverageOperationTime = "AverageOperationTime";
/// Gets the total amount of time used by the Server to process operations
const TotalOperationTime = "TotalOperationTime";
/// Gets the current CPU utilization in percent
const CpuUtilization = "CpuUtilization";
/// Gets the total physical memory in bytes
const TotalPhysicalMemory = "TotalPhysicalMemory";
/// Gets the available physical memory in bytes
const AvailablePhysicalMemory = "AvailablePhysicalMemory";
/// Gets the total virtual memory in bytes
const TotalVirtualMemory = "TotalVirtualMemory";
/// Gets the available virtual memory in bytes
const AvailableVirtualMemory = "AvailableVirtualMemory";
/// Gets the server uptime
const Uptime = "Uptime";
/// Gets the server online/offline status
const Status = "Status";
/// Gets the server display name
const DisplayName = "DisplayName";
/// Gets the total operations received
const TotalReceivedOperations = "TotalReceivedOperations";
/// Gets the total operations processed
const TotalProcessedOperations = "TotalProcessedOperations";
/// Gets the total # of connections created on the server
const TotalConnections = "TotalConnections";
/// Gets the total # of active connections on the server
const TotalActiveConnections = "TotalActiveConnections";
/// Gets the operating system version
const OperatingSystemVersion = "OperatingSystemVersion";
}
/// \defgroup MgCoordinateSystemType MgCoordinateSystemType
/// \ingroup Coordinate_System_classes
/// \{
///////////////////////////////////////////////////////////////
/// \brief
/// Defines constants used to indicate the type of a coordinate
/// system.
///
class MgCoordinateSystemType
{
///////////////////////////////////////////////////////////////
/// \brief
/// Specifies that the coordinate system is arbitrary. That is,
/// it is not spatially bound to the earth, and the initial
/// keyword in the WKT definition of the coordinate system is
/// LOCAL_CS.
///
///
const Arbitrary = 1 ;
////////////////////////////////////////////////////////////////
/// \brief
/// Specifies that the coordinate system is geographic. That is,
/// the initial keyword in the WKT definition of the coordinate
/// system is GEOGCS.
///
///
const Geographic = 2 ;
//////////////////////////////////////////////////////////////
/// \brief
/// Specifies that the coordinate system is projected. In most
/// cases, the initial keyword in the WKT definition of the
/// coordinate system is PROJCS. In some cases, the initial
/// keyword is GEOGCS.
///
///
const Projected = 3 ;
}
/// \defgroup MgMapPlotInstruction MgMapPlotInstruction
/// \ingroup Mapping_Service_Module
/// \{
///////////////////////////////////////////////////////////////////////////////
/// \brief
/// MgMapPlotInstruction defines enumerated values used to indicate whether the plot
/// should be based on the center and scale of the map,
/// an overridden center and scale, or an overridden extent.
class MgMapPlotInstruction
{
///////////////////////////////////////////////////////////////////////////
/// \brief
/// Specifies the plot should use the center and scale of the map
///
const UseMapCenterAndScale = 0 ;
///////////////////////////////////////////////////////////////////////////
/// \brief
/// Specifies the plot should use the overridden center and scale of the map
///
const UseOverriddenCenterAndScale = 1 ;
///////////////////////////////////////////////////////////////////////////
/// \brief
/// Specifies the plot should use the overridden extent
///
const UseOverriddenExtent = 2 ;
}
///////////////////////////////////////////////////////////////////////////////
/// \brief
/// MgUnitType defines enumerated values used to determine the type
/// of units for plot decorations (scale bar).
class MgUnitType
{
/// \if INTERNAL
/// The "value(xxx)" comments are used by SWIG to build constants.php. Do not alter them.
/// \endif
/// US English.
const USEnglish = "US-English"; /// \if INTERNAL \endif
/// Metric.
const Metric = "Metric"; /// \if INTERNAL \endif
}
////////////////////////////////////////////////////////////////////////////////
///