UA Server SDK C++ Bundle  1.4.0.258
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
ServerConfigXml Class Reference

ServerConfigXml Derived from ServerConfig. More...

#include <serverconfigxml.h>

Inherits ServerConfigData.

Inherited by ServerConfigBasicXml.

Public Member Functions

 ServerConfigXml (const UaString &sXmlFileName, const UaString &sApplicationPath, const UaString &sConfigPath, const UaString &sTracePath)
 Creates an instance of the ServerConfigXml class reading the configuration settings from a XML file. More...
 
virtual ~ServerConfigXml ()
 destruction More...
 
UaStatus loadConfiguration ()
 Load the configuration from the config file and generate node managers. More...
 
UaStatus addConfiguredNamespace (OpcUa_UInt16 namespaceIndex, const UaString &namespaceUri, OpcUa_Boolean allowRenameUri, const UaString &uniqueId)
 Adds a namespaces configuration entry for preconfigured namespaces. More...
 
UaStatus removeConfiguredNamespace (OpcUa_UInt16 namespaceIndex)
 Removes a namespaces configuration entry for preconfigured namespaces. More...
 
UaStatus setTagFileConfiguration (const UaString &defaultTagFileName, const UaString &tagFileLocation, const UaString &tagFileEnding, const UaString &defaultFileUpdatePolicy)
 Set information about tagfile name, path und file ending used in the NodeManagerTagFile. More...
 
UaStatus addComDaPropertyMapping (const UaString &propertyName, const UaString &propertyNameSpaceUri, OpcUa_UInt32 propertyId)
 Adds an entry to the mapping list of OPC UA property names to COM Data Access property Ids. More...
 
UaStatus addComAeEventCategoryMapping (ComAeEventType eventType, const UaUInt32Array &categoryIDs, const UaStringArray &categoryNames, const UaNodeIdArray &eventTypeIds, const UaStringArray &namespaceUris)
 Adds a mapping list of OPC UA event type NodeIds to COM Alarms and Events category IDs. More...
 
UaStatus addComAeAttributeMapping (OpcUa_UInt32 attributeID, const UaString &attributeName, OpcUa_BuiltInType dataType, OpcUa_Boolean isArray, const UaStringArray &eventFieldPathNames, const UaStringArray &eventFieldPathNamespaceUris)
 Adds an entry to the mapping list of OPC UA event fields to COM Alarms and Events attribute IDs. More...
 
UaStatus saveConfiguration ()
 Save the configuration to the config file. More...
 
UaString sXmlFileName () const
 
- Public Member Functions inherited from ServerConfigData
 ServerConfigData (const UaString &sApplicationPath, const UaString &sConfigPath, const UaString &sTracePath)
 Creates an instance of the ServerConfigData class reading the configuration settings from a INI file. More...
 
virtual ~ServerConfigData ()
 destruction More...
 
void clear ()
 Clears all members and intializes them with default values.
 
virtual UaStatus afterLoadConfiguration ()=0
 
virtual UaStatus getEndpointConfiguration (UaString &sRejectedCertificateDirectory, OpcUa_UInt32 &nRejectedCertificatesCount, UaEndpointArray &uaEndpointArray)
 Get Endpoint Configuration. More...
 
virtual void endpointOpened (OpcUa_UInt32 index)
 Set state of successfully opened endpoint.
 
virtual UaStatus getUserIdentityTokenConfig (OpcUa_Boolean &bEnableAnonymous, OpcUa_Boolean &bEnableUserPw, OpcUa_Boolean &bEnableCertificate, OpcUa_Boolean &bEnableKerberosTicket)
 Get the enabled settings for the different user identity tokens supported by the server. More...
 
virtual UaStatus getDiscoveryRegistrationConfig (OpcUa_UInt32 &nRegistrationInterval, UaStringArray &discoveryUrlArray)
 Get settings for registration with discovery service. More...
 
virtual UaStatus getWindowsDiscoveryRegistrationSecuritySetup (OpcUa_Boolean &bAutomaticCertificateExchange, UaString &sDiscoveryServerTrustListLocation, UaString &sDiscoveryServerStoreName, UaString &sDiscoveryServerCertificateName)
 Get settings for exchanging certificates with local discovery server on a windows computer for registration with local windows discovery server. More...
 
virtual UaStatus getSerializerConfiguration (OpcUa_Int32 &iMaxAlloc, OpcUa_Int32 &iMaxStringLength, OpcUa_Int32 &iMaxByteStringLength, OpcUa_Int32 &iMaxArrayLength, OpcUa_Int32 &iMaxMessageSize) const
 Get Serializer Configuration. More...
 
virtual UaStatus getStackThreadPoolSettings (OpcUa_Boolean &bEnabled, OpcUa_Int32 &iMinThreads, OpcUa_Int32 &iMaxThreads, OpcUa_Int32 &iMaxJobs, OpcUa_Boolean &bBlockOnAdd, OpcUa_UInt32 &nTimeout) const
 Returns the settings for the thread pool used in the OPC UA Stack. More...
 
virtual UaStatus getStackTraceSettings (OpcUa_Boolean &bTraceEnabled, OpcUa_UInt32 &uTraceLevel) const
 Get UA Stack trace settings. More...
 
virtual UaStatus getServerTraceSettings (OpcUa_Boolean &bTraceEnabled, OpcUa_UInt32 &uTraceLevel, OpcUa_UInt32 &uMaxTraceEntries, OpcUa_UInt32 &uMaxBackupFiles, UaString &sTraceFile) const
 Get UA Server SDK trace settings. More...
 
virtual OpcUa_Int32 getMaxRequestAge () const
 Returns the maximum age of a request the server allows. More...
 
virtual UaStatus getSessionSettings (OpcUa_Int32 &iMaxSessionCount, OpcUa_Int32 &iMaxSessionsPerClient, OpcUa_Int32 &iMinSessionTimeout, OpcUa_Int32 &iMaxSessionTimeout) const
 Get the setting parameters for session creation. More...
 
virtual UaStatus getServerSettings (OpcUa_Double &minSupportedSampleRate, UaStringArray &localeIdArray, UaStringArray &serverProfileArray, UaByteStringArray &softwareCertificateArray) const
 Get the general setting parameters for the server. More...
 
virtual OpcUa_Int32 getMaxBrowseContinuationPoints () const
 Returns the maximum number of Browse Continuation Points managed by the server. More...
 
virtual OpcUa_Int32 getMaxBrowseResults () const
 Returns the maximum number of Browse results for one browse operation. More...
 
virtual OpcUa_Int32 getMaxHistoryContinuationPoints () const
 Returns the maximum number of History Continuation Points managed by the server. More...
 
virtual UaStatus getSubscriptionSettings (OpcUa_UInt32 &iMinPublishingInterval, OpcUa_UInt32 &iMaxPublishingInterval, OpcUa_UInt32 &iMinKeepAliveInterval, OpcUa_UInt32 &iMinSubscriptionLifetime, OpcUa_UInt32 &iMaxSubscriptionLifetime, OpcUa_UInt32 &iMaxRetransmissionQueueSize, OpcUa_UInt32 &iMaxNotificationsPerPublish) const
 Get the setting parameters for a subscription. More...
 
virtual UaStatus getMonitoredItemSettings (OpcUa_UInt32 &iMaxDataQueueSize, OpcUa_UInt32 &iMaxEventQueueSize) const
 Get the setting parameters for a MonitoreItem. More...
 
virtual UaStatus getSubscriptionMaxCountSettings (OpcUa_UInt32 &iMaxSubscriptionCount, OpcUa_UInt32 &iMaxSubscriptionsPerSession, OpcUa_UInt32 &iMaxMonitoredItemCount, OpcUa_UInt32 &iMaxMonitoredItemPerSubscriptionCount, OpcUa_UInt32 &iMaxMonitoredItemPerSessionCount) const
 Get the max object count parameters for Subscriptions. More...
 
virtual UaStatus getAvailableSamplingRates (UaUInt32Array &availableSamplingRates) const
 Returns the sampling rates provided by the OPC server. More...
 
virtual OpcUa_StatusCode getBuildInfo (UaString &ProductUri, UaString &ManufacturerName, UaString &ProductName, UaString &sSoftwareVersion, UaString &sBuildNumber, OpcUa_DateTime &BuildDate) const
 Returns the BuildInfo for the server. More...
 
virtual OpcUa_StatusCode getServerInstanceInfo (UaString &ServerUri, UaLocalizedTextArray &ServerName) const
 Returns the server instance information for the OPC server. More...
 
virtual UaString getServerId () const
 Returns the ServerId used for audit events. More...
 
virtual UaStatus getThreadPoolSettings (OpcUa_UInt32 &minSizeTransactionManager, OpcUa_UInt32 &maxSizeTransactionManager, OpcUa_UInt32 &minSizeSubscriptionManager, OpcUa_UInt32 &maxSizeSubscriptionManager) const
 Returns the settings for the thread pools used in the OPC server. More...
 
virtual OpcUa_Boolean isAuditActivated ()
 Flag indicating if audit events are activated. More...
 
virtual UaStatus getRedundancySettings (OpcUa_RedundancySupport &redundancySupport, UaStringArray &serverUriArray)
 Provides the redundancy settings for the server. More...
 
virtual UaStatus getAdditionalServerEntries (UaApplicationDescriptions &serverDescriptions)
 Provides capability to configure additional servers to be returned in FindServers. More...
 
virtual UaStatus getConfiguredNamespaces (UaUInt16Array &namespaceIndexArray, UaStringArray &namespaceUriArray, UaBoolArray &allowRenameUriArray, UaStringArray &uniqueIdArray)
 Provides configuration option for namespaces other than index 0 and 1 (OPC UA and local server). More...
 
virtual UaStatus getTagFileConfiguration (UaString &defaultTagFileName, UaString &tagFileLocation, UaString &tagFileEnding, UaString &defaultFileUpdatePolicy)
 Provides information about tagfile name, path und file ending used in the NodeManagerTagFile. More...
 
virtual UaStatus getComDaPropertyMapping (UaStringArray &propertyNames, UaStringArray &propertyNameSpaces, UaUInt32Array &propertyIds)
 Provides a mapping list of OPC UA property names to COM Data Access property Ids. More...
 
virtual UaStatus getComDaNamespaceInformation (UaString &defaultNamespace)
 Provides additional namespace related information for COM DA Server module. More...
 
virtual ComDaTimestampSource getComDaTimestampSource ()
 Provides the source of timestamp used for COM DA items. More...
 
virtual UaStatus getComAeNamespaceInformation (UaString &defaultNamespace)
 Provides additional namespace related information for COM A&E Server module. More...
 
virtual UaStatus getComAeEventCategoryMapping (ComAeEventType eventType, UaUInt32Array &categoryIDs, UaStringArray &categoryNames, UaNodeIdArray &eventTypeIds, UaStringArray &, UaBoolArray &)
 Provides a mapping list of OPC UA event type NodeIds to COM Alarms and Events category IDs. More...
 
virtual UaStatus getComAeAttributeMapping (ComAeAttributeMappingArray &comAeAttributeMappingArray)
 Get the mapping list of OPC UA event fields to COM Alarms and Events attribute IDs. More...
 
void lockConfigFile ()
 Lock snchronization object for configuratin changes.
 
void unlockConfigFile ()
 Unlock snchronization object for configuratin changes.
 
UaString sApplicationPath () const
 
UaString sConfigPath () const
 
UaString sTracePath () const
 
void setProductUri (const UaString &sProductUri)
 
void setManufacturerName (const UaString &sManufacturerName)
 
void setProductName (const UaString &sProductName)
 
void setSoftwareVersion (const UaString &sSoftwareVersion)
 
void setBuildNumber (const UaString &sBuildNumber)
 
- Public Member Functions inherited from ServerConfig
 ServerConfig ()
 construction. More...
 
virtual ~ServerConfig ()
 destruction
 
virtual UaStatus startUp (ServerManager *pServerManager)=0
 Start up OPC ServerConfig. More...
 
virtual UaStatus shutDown ()=0
 Shut down OPC ServerConfig. More...
 
virtual SessioncreateSession (OpcUa_Int32 sessionID, const UaNodeId &authenticationToken)=0
 Creates a session object for the OPC server. More...
 
virtual UaStatus logonSessionUser (Session *pSession, UaUserIdentityToken *pUserIdentityToken)=0
 Validates the user identity token and sets the user for a session. More...
 

Additional Inherited Members

- Public Types inherited from ServerConfig
enum  ComDaTimestampSource { INTERNAL, SOURCE_TIMESTAMP, SERVER_TIMESTAMP }
 ComDaTimestampSource enumeration. More...
 
enum  ComAeEventType { SIMPLE_EVENT, TRACKING_EVENT, CONDITION_EVENT }
 ComAeEventType enumeration. More...
 
- Static Public Member Functions inherited from ServerConfigData
static void replaceString (UaString &sString, const UaString &sSearch, const UaString &sReplace)
 Replaces all occurrences of the search string sSearch in sString with sReplace. More...
 
static void replaceNodeName (UaString &sString, const UaString &sNodeName)
 Replace placeholder [NodeName] with real node name. More...
 
static void replaceServerName (UaString &sString, const UaString &sServerName)
 Replace placeholder [ServerName] with real node name. More...
 
static void replaceApplicationPath (UaString &sString, const UaString &sApplicationPath)
 Replace placeholder [ApplicationPath] with real application path. More...
 
static void replaceConfigPath (UaString &sString, const UaString &sConfigPath)
 Replace placeholder [ConfigPath] with real configuration files path. More...
 
static void replaceTracePath (UaString &sString, const UaString &sTracePath)
 Replace placeholder [TracePath] with real trace file path. More...
 
- Protected Member Functions inherited from ServerConfigData
virtual OpcUa_DateTime getBuildDate () const
 Get the build date from the static compiled in string. More...
 
- Protected Attributes inherited from ServerConfigData
UaMutex m_mutex
 
OpcUa_Int32 m_maxRequestAge
 Maximum age of a request the server allows.
 
OpcUa_Int32 m_maxSessionCount
 Maximum number of sessions the server allows to create.
 
OpcUa_Int32 m_maxSessionsPerClient
 Maximum number of sessions the server allows per Client, 0 is no limitation.
 
OpcUa_Int32 m_minSessionTimeout
 Minimum timeout in ms for a sessions the server allows to set.
 
OpcUa_Int32 m_maxSessionTimeout
 Maximum timeout in ms for a sessions the server allows to set.
 
OpcUa_Int32 m_maxBrowseContinuationPoints
 Maximum number of Browse Continuation Points managed by the server.
 
OpcUa_Int32 m_maxBrowseResults
 Maximum number of Browse results for one browse operation.
 
OpcUa_Int32 m_maxHistoryContinuationPoints
 Maximum number of History Continuation Points managed by the server.
 
OpcUa_UInt32 m_minPublishingInterval
 Minimum publishing interval in milliseconds the server allows.
 
OpcUa_UInt32 m_maxPublishingInterval
 Maximum publishing interval in milliseconds the server allows.
 
OpcUa_UInt32 m_minKeepAliveInterval
 Minimum KeepAlive interval in milliseconds the server allows.
 
OpcUa_UInt32 m_minSubscriptionLifetime
 Minimum Subscription lifetime in milliseconds the server allows.
 
OpcUa_UInt32 m_maxSubscriptionLifetime
 Maximum Subscription lifetime in milliseconds the server allows.
 
OpcUa_UInt32 m_maxRetransmissionQueueSize
 Maximum number of messages in the republish queue the server allows per Subscription.
 
OpcUa_UInt32 m_maxNotificationsPerPublish
 Maximum number of notifications per Publish the server allows.
 
OpcUa_UInt32 m_maxSubscriptionCount
 
OpcUa_UInt32 m_maxSubscriptionsPerSession
 
OpcUa_UInt32 m_maxMonitoredItemCount
 
OpcUa_UInt32 m_maxMonitoredItemPerSubscriptionCount
 
OpcUa_UInt32 m_maxMonitoredItemPerSessionCount
 
OpcUa_Double m_minSupportedSampleRate
 
UaStringArray m_localeIdArray
 
UaStringArray m_serverProfileArray
 
UaByteStringArray m_softwareCertificateArray
 
OpcUa_UInt32 m_iMaxDataQueueSize
 
OpcUa_UInt32 m_iMaxEventQueueSize
 
UaUInt32Array m_availableSamplingRates
 Array of sampling rates provided by the OPC server.
 
UaString m_sProductUri
 BuildInfo structure.
 
UaString m_sManufacturerName
 
UaString m_sProductName
 
UaString m_sSoftwareVersion
 
UaString m_sBuildNumber
 
UaString m_sServerUri
 Server Description.
 
UaString m_sServerName
 
OpcUa_Boolean m_bStackThreadPoolEnabled
 UA Stack Thread pool settings.
 
OpcUa_Int32 m_iMinStackThreads
 
OpcUa_Int32 m_iMaxStackThreads
 
OpcUa_Int32 m_iMaxStackThreadJobs
 
OpcUa_Boolean m_bStackThreadBlockOnAdd
 
OpcUa_UInt32 m_nStackThreadTimeout
 
OpcUa_UInt32 m_minSizeTransactionManager
 SDK Thread pool settings.
 
OpcUa_UInt32 m_maxSizeTransactionManager
 
OpcUa_UInt32 m_minSizeSubscriptionManager
 
OpcUa_UInt32 m_maxSizeSubscriptionManager
 
UaString m_sRejectedCertificatesDirectory
 Directory to store rejected certificates in.
 
OpcUa_UInt32 m_nRejectedCertificatesCount
 
UaEndpointArray m_uaEndpointArray
 Array of UA endpoint descriptions.
 
OpcUa_Boolean m_bEnableAnonymous
 
OpcUa_Boolean m_bEnableUserPw
 
OpcUa_Boolean m_bEnableCertificate
 
OpcUa_Boolean m_bEnableKerberosTicket
 
OpcUa_UInt32 m_nRegistrationInterval
 Discovery server registration settings. More...
 
UaStringArray m_discoveryUrlArray
 
OpcUa_Boolean m_bAutomaticCertificateExchange
 
UaString m_sDiscoveryServerTrustListLocation
 
UaString m_sDiscoveryServerStoreName
 
UaString m_sDiscoveryServerCertificateName
 
OpcUa_Int32 m_iMaxAlloc
 These are the Security constraints for the serializer. More...
 
OpcUa_Int32 m_iMaxStringLength
 
OpcUa_Int32 m_iMaxByteStringLength
 
OpcUa_Int32 m_iMaxArrayLength
 
OpcUa_Int32 m_iMaxMessageSize
 
OpcUa_Boolean m_bTraceEnabled
 UA Stack trace settings. More...
 
OpcUa_UInt32 m_uTraceLevel
 
OpcUa_Boolean m_bSdkTraceEnabled
 UA Server SDK trace settings. More...
 
OpcUa_UInt32 m_uSdkTraceLevel
 
OpcUa_UInt32 m_uMaxTraceEntries
 
OpcUa_UInt32 m_uMaxBackupFiles
 
UaString m_sTraceFile
 
OpcUa_Boolean m_isAuditActivated
 
OpcUa_RedundancySupport m_redundancySupport
 
UaStringArray m_serverUriArray
 
UaApplicationDescriptions m_serverDescriptions
 
UaUInt16Array m_namespaceIndexArray
 
UaStringArray m_namespaceUriArray
 
UaBoolArray m_allowRenameUriArray
 
UaStringArray m_uniqueIdArray
 
UaString m_sDefaultTagFileName
 
UaString m_sTagFileLocation
 
UaString m_sTagFileEnding
 
UaString m_sDefaultFileUpdatePolicy
 
UaStringArray m_propertyNames
 
UaStringArray m_propertyNameSpaces
 
UaUInt32Array m_propertyIds
 
UaString m_defaultNamespace
 
ServerConfig::ComDaTimestampSource m_comDaTimestampType
 
UaString m_defaultAeNamespace
 
UaUInt32Array m_simpleCategoryIDs
 
UaStringArray m_simpleCategoryNames
 
UaNodeIdArray m_simpleEventTypeIds
 
UaStringArray m_simpleNamespaceUris
 
UaBoolArray m_simpleVisbilityFlags
 
UaUInt32Array m_trackingCategoryIDs
 
UaStringArray m_trackingCategoryNames
 
UaNodeIdArray m_trackingEventTypeIds
 
UaStringArray m_trackingNamespaceUris
 
UaBoolArray m_trackingVisbilityFlags
 
UaUInt32Array m_conditionCategoryIDs
 
UaStringArray m_conditionCategoryNames
 
UaNodeIdArray m_conditionEventTypeIds
 
UaStringArray m_conditionNamespaceUris
 
UaBoolArray m_conditionVisbilityFlags
 
ComAeAttributeMappingArray m_comAeAttributeMappingArray
 
UaString m_sApplicationPath
 
UaString m_sConfigPath
 
UaString m_sTracePath
 
OpcUa_Boolean m_isConfigLoaded
 

Detailed Description

ServerConfigXml Derived from ServerConfig.

It is not possible to make plane copies of this class.

Constructor & Destructor Documentation

ServerConfigXml::ServerConfigXml ( const UaString sXmlFileName,
const UaString sApplicationPath,
const UaString sConfigPath,
const UaString sTracePath 
)

Creates an instance of the ServerConfigXml class reading the configuration settings from a XML file.

Parameters
sXmlFileNamethe file name of the XML file.
sApplicationPaththe path to the application.
sConfigPaththe path to the configuration file directory.
sTracePaththe path to the log files directory.
ServerConfigXml::~ServerConfigXml ( )
virtual

destruction

Destroys the ServerConfigXml object.

Member Function Documentation

UaStatus ServerConfigXml::addComAeAttributeMapping ( OpcUa_UInt32  attributeID,
const UaString attributeName,
OpcUa_BuiltInType  dataType,
OpcUa_Boolean  isArray,
const UaStringArray &  eventFieldPathNames,
const UaStringArray &  eventFieldPathNamespaceUris 
)
virtual

Adds an entry to the mapping list of OPC UA event fields to COM Alarms and Events attribute IDs.

The event type hirarchy and its event fields are managed by the SDK or custom NodeManager implementations is created based on the OPC UA model. In OPC UA, event fields are identified by a path of QualifiedNames starting from the EventType. These QualifiedNames are defined by standardization bodies like the OPC Foundation for the standard OPC UA event types or by vendors or users. for the standard OPC UA event types or by vendors or users. In classic OPC Alarms & Events, attribute IDs are DWORDS. This method adds an entrie to the mapping table of OPC UA event fields to classic OPC Alarms & Events attribute IDs. This mapping table is only needed for servers providing a classic OPC Alarms & Events interface in addition to the OPC UA interface.

Returns
Error code
Parameters
[in]attributeIDAttribute ID
[in]attributeNameAttribute Name
[in]dataTypeData type of the attribute
[in]isArrayArray flag for the data type of the attribute
[in]eventFieldPathNamesList of event field path names
[in]eventFieldPathNamespaceUrisList of event field path namespace URIs

Reimplemented from ServerConfigData.

UaStatus ServerConfigXml::addComAeEventCategoryMapping ( ComAeEventType  eventType,
const UaUInt32Array &  categoryIDs,
const UaStringArray &  categoryNames,
const UaNodeIdArray &  eventTypeIds,
const UaStringArray &  namespaceUris 
)
virtual

Adds a mapping list of OPC UA event type NodeIds to COM Alarms and Events category IDs.

The event type hirarchy managed by the SDK or custom NodeManager implementations is created based on the OPC UA model. In OPC UA, event types are identified by NodeIds. These NodeIds are defined by standardization bodies like the OPC Foundation for the standard OPC UA event types or by vendors or users. In classic OPC Alarms & Events, event category IDs are DWORDS. This method provides the mapping table of OPC UA event type NodeIds to classic OPC Alarms & Events category IDs. This mapping table is only needed for servers providing a classic OPC Alarms & Events interface in addition to the OPC UA interface. The default implementation does not store the list

Returns
Error code
Parameters
[in]eventTypeEvent type for the categories to add
[in]categoryIDsList of OPC A&E category names
[in]categoryNamesList of OPC A&E category names
[in]eventTypeIdsList of OPC UA event type NodeIds
[in]namespaceUrisList of namespace URIs for the event type id. The string is empty for namespace 0

Reimplemented from ServerConfigData.

UaStatus ServerConfigXml::addComDaPropertyMapping ( const UaString propertyName,
const UaString propertyNameSpaceUri,
OpcUa_UInt32  propertyId 
)
virtual

Adds an entry to the mapping list of OPC UA property names to COM Data Access property Ids.

The address space managed by the SDK or custom NodeManager implementations is created based on the OPC UA model. In OPC UA, properties are identified by qualified names. These names are defined by standardization bodies like the OPC Foundation for the standard OPC UA properties or by vendors or users. In classig OPC Data Access, properties are defined by integer IDs defined by the OPC Foundation or by vendors. This method adds an entry to the mapping table of OPC UA porperty names to classic OPC Data Access property IDs. This mapping table is only needed for servers providing a classic OPC Data Access interface in addition to the OPC UA interface. The entry is stored in the XML file and added to the internal list.

Returns
Error code
Parameters
[in]propertyNameOPC UA Property name
[in]propertyNameSpaceUriOPC UA Property name space URI
[in]propertyIdClassic OPC Data Access Property Id

Reimplemented from ServerConfigData.

UaStatus ServerConfigXml::addConfiguredNamespace ( OpcUa_UInt16  namespaceIndex,
const UaString namespaceUri,
OpcUa_Boolean  allowRenameUri,
const UaString uniqueId 
)
virtual

Adds a namespaces configuration entry for preconfigured namespaces.

The entry is stored in the XML file and added to the internal list.

Returns
Error code
Parameters
[in]namespaceIndexIndex for the namespace in the namespace table
[in]namespaceUriNamespace URI in the namespace table
[in]allowRenameUriFlag indicating if module responsible for the namespace supports a change of the namespace URI in the configuration
[in]uniqueIdUnique ID required to identify the namespace if the module allows to change the namespace URI in the configuration

Reimplemented from ServerConfigData.

UaStatus ServerConfigXml::loadConfiguration ( )
virtual

Load the configuration from the config file and generate node managers.

First method called after creation of ServerConfig. Must create all NodeManagers before method startUp is called.

Returns
Error code.

Implements ServerConfig.

UaStatus ServerConfigXml::removeConfiguredNamespace ( OpcUa_UInt16  namespaceIndex)
virtual

Removes a namespaces configuration entry for preconfigured namespaces.

See Also
getConfiguredNamespaces. The entry is removed from the XML file and from the internal list.
Returns
Error code
Parameters
[in]namespaceIndexIndex for the namespace in the namespace table

Reimplemented from ServerConfigData.

UaStatus ServerConfigXml::saveConfiguration ( )
virtual

Save the configuration to the config file.

Returns
Error code.

Implements ServerConfig.

UaStatus ServerConfigXml::setTagFileConfiguration ( const UaString defaultTagFileName,
const UaString tagFileLocation,
const UaString tagFileEnding,
const UaString defaultFileUpdatePolicy 
)
virtual

Set information about tagfile name, path und file ending used in the NodeManagerTagFile.

Returns
Error code

Reimplemented from ServerConfigData.


The documentation for this class was generated from the following files: