OpcUa::NamespaceMetadataType Class Reference

Generated base class for a NamespaceMetadataType. More...

#include <opcua_namespacemetadatatype.h>

Inherits OpcUa::BaseObjectType.

Public Member Functions
	NamespaceMetadataType (const UaNodeId &nodeId, UaObject *pInstanceDeclarationObject, NodeManagerConfig *pNodeConfig, UaMutexRefCounted *pSharedMutex=NULL)
	Constructs an NamespaceMetadataType object using an instance declaration node as base.
	NamespaceMetadataType (const UaNodeId &nodeId, const UaString &name, OpcUa_UInt16 browseNameNameSpaceIndex, NodeManagerConfig *pNodeConfig, UaMutexRefCounted *pSharedMutex=NULL)
	Constructs an NamespaceMetadataType object.
	NamespaceMetadataType (UaBase::Object *pBaseNode, XmlUaNodeFactoryManager *pFactory, NodeManagerConfig *pNodeConfig, UaMutexRefCounted *pSharedMutex=NULL)
	Constructs an instance of the class NamespaceMetadataType with all components. More...
virtual UaNodeId	typeDefinitionId () const
	Returns the type definition NodeId for the NamespaceMetadataType.
virtual UaStatus	beginCall (MethodManagerCallback *pCallback, const ServiceContext &serviceContext, OpcUa_UInt32 callbackHandle, MethodHandle *pMethodHandle, const UaVariantArray &inputArguments)
	Call method of an UA object. More...
virtual UaStatus	call (const ServiceContext &serviceContext, MethodHandle *pMethodHandle, const UaVariantArray &inputArguments, UaVariantArray &outputArguments, UaStatusCodeArray &inputArgumentResults, UaDiagnosticInfos &inputArgumentDiag)
	Synchronous version of the MethodManager method call executed in a worker thread.
virtual void	setDefaultAccessRestrictions (OpcUa_UInt16 DefaultAccessRestrictions)
	Sets the DefaultAccessRestrictions value. More...
virtual OpcUa_UInt16	getDefaultAccessRestrictions () const
	Returns the value of DefaultAccessRestrictions. More...
virtual void	setDefaultRolePermissions (const UaRolePermissionTypes &DefaultRolePermissions)
	Sets the DefaultRolePermissions.
virtual void	getDefaultRolePermissions (UaRolePermissionTypes &DefaultRolePermissions) const
	Gets the DefaultRolePermissions.
virtual void	setDefaultUserRolePermissions (const UaRolePermissionTypes &DefaultUserRolePermissions)
	Sets the DefaultUserRolePermissions.
virtual void	getDefaultUserRolePermissions (UaRolePermissionTypes &DefaultUserRolePermissions) const
	Gets the DefaultUserRolePermissions.
virtual void	setIsNamespaceSubset (OpcUa_Boolean IsNamespaceSubset)
	Sets the IsNamespaceSubset value. More...
virtual OpcUa_Boolean	getIsNamespaceSubset () const
	Returns the value of IsNamespaceSubset. More...
virtual void	setNamespacePublicationDate (const UaDateTime &NamespacePublicationDate)
	Sets the NamespacePublicationDate value. More...
virtual UaDateTime	getNamespacePublicationDate () const
	Returns the value of NamespacePublicationDate. More...
virtual void	setNamespaceUri (const UaString &NamespaceUri)
	Sets the NamespaceUri value. More...
virtual UaString	getNamespaceUri () const
	Returns the value of NamespaceUri. More...
virtual void	setNamespaceVersion (const UaString &NamespaceVersion)
	Sets the NamespaceVersion value. More...
virtual UaString	getNamespaceVersion () const
	Returns the value of NamespaceVersion. More...
virtual void	setStaticNodeIdTypes (const UaInt32Array &StaticNodeIdTypes)
	Sets the StaticNodeIdTypes. More...
virtual void	getStaticNodeIdTypes (UaInt32Array &StaticNodeIdTypes) const
	Gets the StaticNodeIdTypes. More...
virtual void	setStaticNumericNodeIdRange (const UaStringArray &StaticNumericNodeIdRange)
	Sets the StaticNumericNodeIdRange. More...
virtual void	getStaticNumericNodeIdRange (UaStringArray &StaticNumericNodeIdRange) const
	Gets the StaticNumericNodeIdRange. More...
virtual void	setStaticStringNodeIdPattern (const UaString &StaticStringNodeIdPattern)
	Sets the StaticStringNodeIdPattern value. More...
virtual UaString	getStaticStringNodeIdPattern () const
	Returns the value of StaticStringNodeIdPattern. More...
virtual OpcUa::PropertyType *	getDefaultAccessRestrictionsNode ()
	Returns the DefaultAccessRestrictions node. More...
virtual const OpcUa::PropertyType *	getDefaultAccessRestrictionsNode () const
	Returns the DefaultAccessRestrictions node. More...
virtual OpcUa::PropertyType *	getDefaultRolePermissionsNode ()
	Returns the DefaultRolePermissions node. More...
virtual const OpcUa::PropertyType *	getDefaultRolePermissionsNode () const
	Returns the DefaultRolePermissions node. More...
virtual OpcUa::PropertyType *	getDefaultUserRolePermissionsNode ()
	Returns the DefaultUserRolePermissions node. More...
virtual const OpcUa::PropertyType *	getDefaultUserRolePermissionsNode () const
	Returns the DefaultUserRolePermissions node. More...
virtual OpcUa::PropertyType *	getIsNamespaceSubsetNode ()
	Returns the IsNamespaceSubset node. More...
virtual const OpcUa::PropertyType *	getIsNamespaceSubsetNode () const
	Returns the IsNamespaceSubset node. More...
virtual OpcUa::AddressSpaceFileType *	getNamespaceFile ()
	Returns the NamespaceFile node. More...
virtual const OpcUa::AddressSpaceFileType *	getNamespaceFile () const
	Returns the NamespaceFile node. More...
virtual OpcUa::PropertyType *	getNamespacePublicationDateNode ()
	Returns the NamespacePublicationDate node. More...
virtual const OpcUa::PropertyType *	getNamespacePublicationDateNode () const
	Returns the NamespacePublicationDate node. More...
virtual OpcUa::PropertyType *	getNamespaceUriNode ()
	Returns the NamespaceUri node. More...
virtual const OpcUa::PropertyType *	getNamespaceUriNode () const
	Returns the NamespaceUri node. More...
virtual OpcUa::PropertyType *	getNamespaceVersionNode ()
	Returns the NamespaceVersion node. More...
virtual const OpcUa::PropertyType *	getNamespaceVersionNode () const
	Returns the NamespaceVersion node. More...
virtual OpcUa::PropertyType *	getStaticNodeIdTypesNode ()
	Returns the StaticNodeIdTypes node. More...
virtual const OpcUa::PropertyType *	getStaticNodeIdTypesNode () const
	Returns the StaticNodeIdTypes node. More...
virtual OpcUa::PropertyType *	getStaticNumericNodeIdRangeNode ()
	Returns the StaticNumericNodeIdRange node. More...
virtual const OpcUa::PropertyType *	getStaticNumericNodeIdRangeNode () const
	Returns the StaticNumericNodeIdRange node. More...
virtual OpcUa::PropertyType *	getStaticStringNodeIdPatternNode ()
	Returns the StaticStringNodeIdPattern node. More...
virtual const OpcUa::PropertyType *	getStaticStringNodeIdPatternNode () const
	Returns the StaticStringNodeIdPattern node. More...
virtual void	useAccessInfoFromType ()
	Applies the NodeAccessInfo set at the NamespaceMetadataType and its children. More...
void	useAccessInfoFromInstance (NamespaceMetadataType *pInstance)
	Uses the NodeAccessInfo of pOther and its children. More...
Public Member Functions inherited from OpcUa::BaseObjectType
	BaseObjectType (const UaNodeId &nodeId, UaObject *pInstanceDeclarationObject, NodeManagerConfig *pNodeConfig, UaMutexRefCounted *pSharedMutex=NULL)
	Construction of the class BaseObjectType. More...
	BaseObjectType (const UaNodeId &nodeId, const UaString &name, OpcUa_UInt16 browseNameNameSpaceIndex, NodeManagerConfig *pNodeConfig, UaMutexRefCounted *pSharedMutex=NULL)
	Construction of the class BaseObjectType. More...
UaReferenceLists *	getUaReferenceLists () const
	Get the UaReferenceLists interface for the node. More...
virtual UaStatus	browse (const ServiceContext &serviceContext, BrowseContext &browseContext, UaReferenceDescriptions &References)
	Discover the references of a specified node of a view. More...
UaNodeId	nodeId () const
	Get the NodeId of the current Node. More...
virtual UaQualifiedName	browseName () const
	Get the browseName of the current Node. More...
virtual UaLocalizedText	displayName (Session *pSession) const
	Get the displayName as LocalizedText of the current Node. More...
virtual OpcUa_Boolean	isDescriptionSupported () const
	Check if Node is DescriptionSupported. More...
virtual UaLocalizedText	description (Session *pSession) const
	Get the description as LocalizedText of the current Node. More...
virtual OpcUa_Boolean	isWriteMaskSupported () const
	Check if Node is WriteMaskSupported. More...
virtual OpcUa_UInt32	writeMask () const
	Get the writeMask of the current Node. More...
virtual OpcUa_Boolean	isUserWriteMaskSupported () const
	Check if Node is UserWriteMaskSupported. More...
virtual OpcUa_UInt32	userWriteMask (Session *pSession) const
	Check if Node has a userWriteMask. More...
UaNode *	getUaNode () const
	Get the UaNode interface pointer of this node. More...
virtual OpcUa_Byte	eventNotifier () const
	Returns the EventNotifier for the BaseObjectType. More...
virtual MethodManager *	getMethodManager (UaMethod *pMethod) const
	Returns the method manager interface for the BaseObjectType instance. More...
virtual void	setUserData (UserDataBase *pUserData)
	Method to set user data stored in this class. More...
virtual UserDataBase *	getUserData () const
	Method to get the user data stored in this class. More...
virtual void	setBrowseName (const UaQualifiedName &browseName)
	Sets the browse name attribute value. More...
virtual void	setDisplayName (const UaLocalizedText &displayName)
	Sets the display name attribute value. More...
virtual void	setDescription (const UaLocalizedText &description)
	Sets the description attribute value. More...
virtual void	setWriteMask (OpcUa_UInt32 writeMask)
	Sets the write mask attribute value. More...
virtual void	setEventNotifier (OpcUa_Byte eventNotifier)
	Sets the eventNotifier attribute value. More...
virtual void	setModellingRuleId (const UaNodeId &modellingRuleId)
	Set NodeId of the modeling rule for this node. More...
virtual UaNodeId	modellingRuleId () const
	Get NodeId of the modeling rule for this node. More...
void	setMethodManager (MethodManager *pMethodManager)
	Allows a class aggregating the object to implement the MethodManager for this object. More...
virtual UaStatus	setAttributeValue (Session *pSession, OpcUa_Int32 attributeId, const UaDataValue &dataValue, NodeAccessInfo *pDefaultPermissions, OpcUa_Boolean checkWriteMask)
	Sets the value of an attribute of the Node. More...
Public Member Functions inherited from MethodManager
	MethodManager ()
	construction
virtual	~MethodManager ()
	destruction
Public Member Functions inherited from UaObject
	UaObject (UaMutexRefCounted *pSharedMutex=NULL)
	Construction of the UaObject. More...
OpcUa_NodeClass	nodeClass () const
	Get the node class of the Node. More...
virtual void	getAttributeValue (Session *pSession, OpcUa_Int32 attributeId, NodeAccessInfo *pDefaultPermissions, UaDataValue &uaDataValue)
	Gets the value of an attribute of the Node. More...
Public Member Functions inherited from UaNode
	UaNode (UaMutexRefCounted *pSharedMutex=NULL)
	Construction of the UaNode. More...
virtual UaNodeId	getKey () const
	Get the key of the node used for the hash table. More...
virtual NodeAccessInfo *	getAccessInfo () const
	Returns the access info for this node. More...
virtual bool	hasAccessInfo () const
	Check if this UaNode has a NodeAccessInfo assigned. More...
virtual void	useAccessInfoFrom (const UaNode *pOther)
	Set the NodeAccessInfo from another node to this node. More...
virtual void	setAccessInfo (NodeAccessInfo *pAccessInfo)
	Set the NodeAccessInfo for this node. More...
virtual void	attachAccessInfo (NodeAccessInfo *pAccessInfo)
	Set the NodeAccessInfo for this node. More...
Public Member Functions inherited from ChainEntry
	ChainEntry ()
	construction
ChainEntry *	find (const UaNodeId &key, ChainEntry **ppPrevious)
	finds the right entry in the chain. More...
void	add (ChainEntry *pNewEntry)
	adds a new entry to the list. More...
void	prepend (ChainEntry *pNewEntry)
	prepends a new entry to the list. More...
ChainEntry *	remove (const UaNodeId &key, ChainEntry **ppNext)
	removes an entry from the list. More...
ChainEntry *	getNext () const
	Check if there is a chain. More...
virtual void	setInvalid ()
	Set the entry to invalid. More...
void	clearChain ()
	Clear the chain when the hashtable is cleared.
Public Member Functions inherited from ReferenceCounter
	ReferenceCounter ()
	construction
virtual	~ReferenceCounter ()
	destruction
Public Member Functions inherited from UaReferenceLists
	UaReferenceLists ()
	Constructs the reference lists object.
virtual	~UaReferenceLists ()
	Destroys the reference lists object.
virtual UaStatus	browseReferences (const ServiceContext &serviceContext, BrowseContext &browseContext, UaReferenceDescriptions &References)
	Discover the references of a specified node of a view. More...
virtual UaStatus	translateBrowsePathToNodeId (const ServiceContext &serviceContext, const UaNodeId &startingNode, UaRelativePath &relativePath, UaBrowsePathTargets &browsePathTargets)
	Find a node based on an element of an relative path. More...
virtual const UaReference *	pTargetNodes () const
	Returns the list of references to target nodes. More...
virtual const UaReference *	pSourceNodes () const
	Returns the list of references to source nodes. More...
virtual UaNode *	getTargetNodeByBrowseName (const UaQualifiedName &browseName) const
	Searches a target node with the passed browse name and returns the UaNode interface if found. More...
virtual void	addTargetNode (UaReference *pReference)
	Add a reference to a target node where this node is the source node. More...
virtual void	addSourceNode (UaReference *pReference)
	Adds a reference to a source node where this node is the target node. More...
virtual UaStatus	removeSourceNode (UaReference *pReferenceToRemove)
	Remove a reference to a source node where this node is the target node. More...
virtual bool	removeSourceReference (UaReference *pReferenceToRemove)
	Remove the passed reference to a source node. More...
virtual UaStatus	removeTargetNode (UaNode *pTargetNode, const UaNodeId &referenceTypeId, OpcUa_Boolean deleteBidirectional)
	Remove a reference to a target node where this node is the source node. More...
virtual UaStatus	removeTargetNode (const UaNodeId &targetNodeId, const UaNodeId &referenceTypeId, OpcUa_Boolean deleteBidirectional)
	Remove a reference to a target node where this node is the source node. More...
virtual bool	removeTargetReference (UaReference *pReferenceToRemove)
	Remove the passed reference to a target node. More...
virtual UaStatus	removeCrossNodeManagerRef (NodeManager *pNodeManager)
	Remove references to another NodeManager. More...
virtual UaStatus	invalidateSourceReferences (OpcUa_Boolean deleteSourceReferences)
	Set all references from SourceNodes to this Node invalid. More...
virtual UaStatus	invalidateTargetReferences (OpcUa_Boolean deleteTargetReferences)
	Set all references to TargetNode of this node invalid. More...
virtual UaStatus	deleteAllChildren (NodeManagerConfig *pNodeManagerConfig)
	Deletes all child nodes. More...

Static Public Member Functions
static void	createTypes ()
	Create the related type nodes.
static void	clearStaticMembers ()
	Clear the static members of the class.
Static Public Member Functions inherited from OpcUa::BaseObjectType
static void	clearStaticMembers ()
	Clear the static members of the class.

Protected Member Functions
virtual	~NamespaceMetadataType ()
	Destruction.
Protected Member Functions inherited from OpcUa::BaseObjectType
virtual	~BaseObjectType ()
	Destruction of the BaseObjectType. More...
Protected Member Functions inherited from UaObject
virtual	~UaObject ()
	Destruction of the UaObject. More...
Protected Member Functions inherited from UaNode
virtual	~UaNode ()
	Destruction of the UaNode. More...
Protected Member Functions inherited from ChainEntry
virtual	~ChainEntry ()
	destruction
Protected Member Functions inherited from UaReferenceLists
virtual UaStatus	collectAllChildrenRecursive (NodeManagerConfig *pNodeManagerConfig, NodesToDeleteCollection &nodesToDeleteCollection, int recursionCounter=0)
	Collect a list of all child nodes. More...

Additional Inherited Members
Protected Attributes inherited from UaReferenceLists
UaReference *	m_pTargetNodes
	List of references to target nodes where this node is the source node. More...
UaReference *	m_pLastTargetNode
	Last references in the list of references to the target nodes. More...
UaReference *	m_pSourceNodes
	List of references to source nodes where this node is the target node. More...

Detailed Description

Generated base class for a NamespaceMetadataType.

This class contains the generated base code for the object type NamespaceMetadataType representing an OPC UA ObjectType. This class is used to create the object type and to create and represent instances of the object type in the server address space.

Object members of the NamespaceMetadataType:

Browse Name	TypeDefinition	Modelling Rule	See Also
NamespaceFile	AddressSpaceFileType	Optional	getNamespaceFile

Variable members of the NamespaceMetadataType:

Browse Name	DataType	TypeDefinition	Modelling Rule	See Also
DefaultAccessRestrictions	UInt16	PropertyType	Optional	getDefaultAccessRestrictions, setDefaultAccessRestrictions
DefaultRolePermissions	RolePermissionType	PropertyType	Optional	getDefaultRolePermissions, setDefaultRolePermissions
DefaultUserRolePermissions	RolePermissionType	PropertyType	Optional	getDefaultUserRolePermissions, setDefaultUserRolePermissions
IsNamespaceSubset	Boolean	PropertyType	Mandatory	getIsNamespaceSubset, setIsNamespaceSubset
NamespacePublicationDate	DateTime	PropertyType	Mandatory	getNamespacePublicationDate, setNamespacePublicationDate
NamespaceUri	String	PropertyType	Mandatory	getNamespaceUri, setNamespaceUri
NamespaceVersion	String	PropertyType	Mandatory	getNamespaceVersion, setNamespaceVersion
StaticNodeIdTypes	IdType	PropertyType	Mandatory	getStaticNodeIdTypes, setStaticNodeIdTypes
StaticNumericNodeIdRange	NumericRange	PropertyType	Mandatory	getStaticNumericNodeIdRange, setStaticNumericNodeIdRange
StaticStringNodeIdPattern	String	PropertyType	Mandatory	getStaticStringNodeIdPattern, setStaticStringNodeIdPattern

This object type defines the metadata for a namespace provided by the Server.

Instances of this object allow Servers to provide more information like version information in addition to the namespace URI. Important information for aggregating Servers is provided by the StaticNodeIdTypes, StaticNumericNodeIdRange and StaticStringNodeIdPattern properties.

The browse name of instances of this type shall be derived from the represented namespace. This can, for example, be done by using the index of the namespace in the namespace array as namespaceIndex of the QualifiedName and the namespace URI as name of the QualifiedName.

See also NamespaceMetadataType for a documentation of the complete Information Model.

Constructor & Destructor Documentation

OpcUa::NamespaceMetadataType::NamespaceMetadataType	(	UaBase::Object *	pBaseNode,
		XmlUaNodeFactoryManager *	pFactory,
		NodeManagerConfig *	pNodeConfig,
		UaMutexRefCounted *	pSharedMutex = NULL
	)

Constructs an instance of the class NamespaceMetadataType with all components.

Parameters

[in]	pBaseNode	The "tree" of nodes that specifies the attributes of the instance and its children
[in]	pFactory	The factory to create the children
[in]	pNodeConfig	Interface pointer to the NodeManagerConfig interface used to add and delete node and references in the address space
[in]	pSharedMutex	Shared mutex object used to synchronize access to the variable. Can be NULL if no shared mutex is provided

Member Function Documentation

UaStatus OpcUa::NamespaceMetadataType::beginCall ( MethodManagerCallback *  pCallback, const ServiceContext &  serviceContext, OpcUa_UInt32  callbackHandle, MethodHandle *  pMethodHandle, const UaVariantArray &  inputArguments  )

virtual

Call method of an UA object.

Implementation of the MethodManager interface method beginCall.

Reimplemented from OpcUa::BaseObjectType.

OpcUa_UInt16 OpcUa::NamespaceMetadataType::getDefaultAccessRestrictions ( ) const

virtual

Returns the value of DefaultAccessRestrictions.

If the optional DefaultAccessRestrictions node has not been created, the value of the InstanceDeclaration node of the ObjectType is returned.

OpcUa::PropertyType * OpcUa::NamespaceMetadataType::getDefaultAccessRestrictionsNode ( )

virtual

Returns the DefaultAccessRestrictions node.

If the Variable has not been created yet, this method returns NULL.

const OpcUa::PropertyType * OpcUa::NamespaceMetadataType::getDefaultAccessRestrictionsNode ( ) const

virtual

Returns the DefaultAccessRestrictions node.

If the Variable has not been created yet, this method returns NULL.

OpcUa::PropertyType * OpcUa::NamespaceMetadataType::getDefaultRolePermissionsNode ( )

virtual

Returns the DefaultRolePermissions node.

If the Variable has not been created yet, this method returns NULL.

const OpcUa::PropertyType * OpcUa::NamespaceMetadataType::getDefaultRolePermissionsNode ( ) const

virtual

Returns the DefaultRolePermissions node.

If the Variable has not been created yet, this method returns NULL.

OpcUa::PropertyType * OpcUa::NamespaceMetadataType::getDefaultUserRolePermissionsNode ( )

virtual

Returns the DefaultUserRolePermissions node.

If the Variable has not been created yet, this method returns NULL.

const OpcUa::PropertyType * OpcUa::NamespaceMetadataType::getDefaultUserRolePermissionsNode ( ) const

virtual

Returns the DefaultUserRolePermissions node.

If the Variable has not been created yet, this method returns NULL.

OpcUa_Boolean OpcUa::NamespaceMetadataType::getIsNamespaceSubset ( ) const

virtual

Returns the value of IsNamespaceSubset.

Defines whether all nodes of the namespace are accessible in the Server or only a subset.

It is set to FALSE if the full namespace is provided and TRUE if not.

Static nodes are identical for all attributes in all Servers, including the Value attribute. For type definition nodes, also the instance declarations shall be identical. That means that for static nodes the semantic is always the same. Namespaces with static nodes are for example namespaces defined by standard bodies like the OPC Foundation. This is important information for aggregating Servers. If the namespace is dynamic and used in several Servers the aggregating Server needs to distinguish the namespace for each aggregated Server. The static nodes of a namespace only need to be handled once, even if it they are used by several aggregated Servers.

OpcUa::PropertyType * OpcUa::NamespaceMetadataType::getIsNamespaceSubsetNode ( )

virtual

Returns the IsNamespaceSubset node.

Defines whether all nodes of the namespace are accessible in the Server or only a subset.

It is set to FALSE if the full namespace is provided and TRUE if not.

Static nodes are identical for all attributes in all Servers, including the Value attribute. For type definition nodes, also the instance declarations shall be identical. That means that for static nodes the semantic is always the same. Namespaces with static nodes are for example namespaces defined by standard bodies like the OPC Foundation. This is important information for aggregating Servers. If the namespace is dynamic and used in several Servers the aggregating Server needs to distinguish the namespace for each aggregated Server. The static nodes of a namespace only need to be handled once, even if it they are used by several aggregated Servers.

const OpcUa::PropertyType * OpcUa::NamespaceMetadataType::getIsNamespaceSubsetNode ( ) const

virtual

Returns the IsNamespaceSubset node.

Defines whether all nodes of the namespace are accessible in the Server or only a subset.

It is set to FALSE if the full namespace is provided and TRUE if not.

Static nodes are identical for all attributes in all Servers, including the Value attribute. For type definition nodes, also the instance declarations shall be identical. That means that for static nodes the semantic is always the same. Namespaces with static nodes are for example namespaces defined by standard bodies like the OPC Foundation. This is important information for aggregating Servers. If the namespace is dynamic and used in several Servers the aggregating Server needs to distinguish the namespace for each aggregated Server. The static nodes of a namespace only need to be handled once, even if it they are used by several aggregated Servers.

OpcUa::AddressSpaceFileType * OpcUa::NamespaceMetadataType::getNamespaceFile ( )

virtual

Returns the NamespaceFile node.

If the Object has not been created yet, this method creates the node and returns it.

Contains all nodes and references of the namespace in an XML file where the information model XML schema is defined in Part 6 of OPC UA Specification.

The XML file is provided through an AddressSpaceFileType object.

const OpcUa::AddressSpaceFileType * OpcUa::NamespaceMetadataType::getNamespaceFile ( ) const

virtual

Returns the NamespaceFile node.

If the Object has not been created yet, this method return NULL.

Contains all nodes and references of the namespace in an XML file where the information model XML schema is defined in Part 6 of OPC UA Specification.

The XML file is provided through an AddressSpaceFileType object.

UaDateTime OpcUa::NamespaceMetadataType::getNamespacePublicationDate ( ) const

virtual

Returns the value of NamespacePublicationDate.

Provides the publication date of the namespace version.

This property value can be used by Clients to determine the latest version if different versions are provided by different Servers.

OpcUa::PropertyType * OpcUa::NamespaceMetadataType::getNamespacePublicationDateNode ( )

virtual

Returns the NamespacePublicationDate node.

Provides the publication date of the namespace version.

This property value can be used by Clients to determine the latest version if different versions are provided by different Servers.

const OpcUa::PropertyType * OpcUa::NamespaceMetadataType::getNamespacePublicationDateNode ( ) const

virtual

Returns the NamespacePublicationDate node.

Provides the publication date of the namespace version.

This property value can be used by Clients to determine the latest version if different versions are provided by different Servers.

UaString OpcUa::NamespaceMetadataType::getNamespaceUri ( ) const

virtual

Returns the value of NamespaceUri.

Contains the namespace represented by an instance of the MetaDataType.

OpcUa::PropertyType * OpcUa::NamespaceMetadataType::getNamespaceUriNode ( )

virtual

Returns the NamespaceUri node.

Contains the namespace represented by an instance of the MetaDataType.

const OpcUa::PropertyType * OpcUa::NamespaceMetadataType::getNamespaceUriNode ( ) const

virtual

Returns the NamespaceUri node.

Contains the namespace represented by an instance of the MetaDataType.

UaString OpcUa::NamespaceMetadataType::getNamespaceVersion ( ) const

virtual

Returns the value of NamespaceVersion.

Provides version information for the namespace.

It is intended for display purposes and shall not be used to programmatically identify the latest version.

OpcUa::PropertyType * OpcUa::NamespaceMetadataType::getNamespaceVersionNode ( )

virtual

Returns the NamespaceVersion node.

Provides version information for the namespace.

It is intended for display purposes and shall not be used to programmatically identify the latest version.

const OpcUa::PropertyType * OpcUa::NamespaceMetadataType::getNamespaceVersionNode ( ) const

virtual

Returns the NamespaceVersion node.

Provides version information for the namespace.

It is intended for display purposes and shall not be used to programmatically identify the latest version.

void OpcUa::NamespaceMetadataType::getStaticNodeIdTypes ( UaInt32Array &  StaticNodeIdTypes ) const

virtual

Gets the StaticNodeIdTypes.

Provides a list of IdTypes used for static nodes.

All nodes in the address space of the namespace using one of the IdTypes in the array shall be static nodes.

OpcUa::PropertyType * OpcUa::NamespaceMetadataType::getStaticNodeIdTypesNode ( )

virtual

Returns the StaticNodeIdTypes node.

Provides a list of IdTypes used for static nodes.

All nodes in the address space of the namespace using one of the IdTypes in the array shall be static nodes.

const OpcUa::PropertyType * OpcUa::NamespaceMetadataType::getStaticNodeIdTypesNode ( ) const

virtual

Returns the StaticNodeIdTypes node.

Provides a list of IdTypes used for static nodes.

All nodes in the address space of the namespace using one of the IdTypes in the array shall be static nodes.

void OpcUa::NamespaceMetadataType::getStaticNumericNodeIdRange ( UaStringArray &  StaticNumericNodeIdRange ) const

virtual

Gets the StaticNumericNodeIdRange.

Provides a list of NumericRanges used for numeric NodeIds of static nodes.

If the StaticNodeIdTypes property contains an entry for numeric NodeIds then this property is ignored.

OpcUa::PropertyType * OpcUa::NamespaceMetadataType::getStaticNumericNodeIdRangeNode ( )

virtual

Returns the StaticNumericNodeIdRange node.

Provides a list of NumericRanges used for numeric NodeIds of static nodes.

If the StaticNodeIdTypes property contains an entry for numeric NodeIds then this property is ignored.

const OpcUa::PropertyType * OpcUa::NamespaceMetadataType::getStaticNumericNodeIdRangeNode ( ) const

virtual

Returns the StaticNumericNodeIdRange node.

Provides a list of NumericRanges used for numeric NodeIds of static nodes.

If the StaticNodeIdTypes property contains an entry for numeric NodeIds then this property is ignored.

UaString OpcUa::NamespaceMetadataType::getStaticStringNodeIdPattern ( ) const

virtual

Returns the value of StaticStringNodeIdPattern.

Provides a regular expression as defined for the Like operator defined in Part 4 of the OPC UA Specification to filter for string NodeIds of static nodes.

If the StaticNodeIdTypes property contains an entry for string NodeIds, this property is ignored.

OpcUa::PropertyType * OpcUa::NamespaceMetadataType::getStaticStringNodeIdPatternNode ( )

virtual

Returns the StaticStringNodeIdPattern node.

Provides a regular expression as defined for the Like operator defined in Part 4 of the OPC UA Specification to filter for string NodeIds of static nodes.

If the StaticNodeIdTypes property contains an entry for string NodeIds, this property is ignored.

const OpcUa::PropertyType * OpcUa::NamespaceMetadataType::getStaticStringNodeIdPatternNode ( ) const

virtual

Returns the StaticStringNodeIdPattern node.

Provides a regular expression as defined for the Like operator defined in Part 4 of the OPC UA Specification to filter for string NodeIds of static nodes.

If the StaticNodeIdTypes property contains an entry for string NodeIds, this property is ignored.

void OpcUa::NamespaceMetadataType::setDefaultAccessRestrictions ( OpcUa_UInt16  DefaultAccessRestrictions )

virtual

Sets the DefaultAccessRestrictions value.

If the optional DefaultAccessRestrictions node has not been created, this method adds it to the address space.

void OpcUa::NamespaceMetadataType::setIsNamespaceSubset ( OpcUa_Boolean  IsNamespaceSubset )

virtual

Sets the IsNamespaceSubset value.

Defines whether all nodes of the namespace are accessible in the Server or only a subset.

It is set to FALSE if the full namespace is provided and TRUE if not.

Static nodes are identical for all attributes in all Servers, including the Value attribute. For type definition nodes, also the instance declarations shall be identical. That means that for static nodes the semantic is always the same. Namespaces with static nodes are for example namespaces defined by standard bodies like the OPC Foundation. This is important information for aggregating Servers. If the namespace is dynamic and used in several Servers the aggregating Server needs to distinguish the namespace for each aggregated Server. The static nodes of a namespace only need to be handled once, even if it they are used by several aggregated Servers.

void OpcUa::NamespaceMetadataType::setNamespacePublicationDate ( const UaDateTime &  NamespacePublicationDate )

virtual

Sets the NamespacePublicationDate value.

Provides the publication date of the namespace version.

This property value can be used by Clients to determine the latest version if different versions are provided by different Servers.

void OpcUa::NamespaceMetadataType::setNamespaceUri ( const UaString &  NamespaceUri )

virtual

Sets the NamespaceUri value.

Contains the namespace represented by an instance of the MetaDataType.

void OpcUa::NamespaceMetadataType::setNamespaceVersion ( const UaString &  NamespaceVersion )

virtual

Sets the NamespaceVersion value.

Provides version information for the namespace.

It is intended for display purposes and shall not be used to programmatically identify the latest version.

void OpcUa::NamespaceMetadataType::setStaticNodeIdTypes ( const UaInt32Array &  StaticNodeIdTypes )

virtual

Sets the StaticNodeIdTypes.

Provides a list of IdTypes used for static nodes.

All nodes in the address space of the namespace using one of the IdTypes in the array shall be static nodes.

void OpcUa::NamespaceMetadataType::setStaticNumericNodeIdRange ( const UaStringArray &  StaticNumericNodeIdRange )

virtual

Sets the StaticNumericNodeIdRange.

Provides a list of NumericRanges used for numeric NodeIds of static nodes.

If the StaticNodeIdTypes property contains an entry for numeric NodeIds then this property is ignored.

void OpcUa::NamespaceMetadataType::setStaticStringNodeIdPattern ( const UaString &  StaticStringNodeIdPattern )

virtual

Sets the StaticStringNodeIdPattern value.

Provides a regular expression as defined for the Like operator defined in Part 4 of the OPC UA Specification to filter for string NodeIds of static nodes.

If the StaticNodeIdTypes property contains an entry for string NodeIds, this property is ignored.

void OpcUa::NamespaceMetadataType::useAccessInfoFromInstance

(

NamespaceMetadataType *

pOther

)

Uses the NodeAccessInfo of pOther and its children.

void OpcUa::NamespaceMetadataType::useAccessInfoFromType ( )

virtual

Applies the NodeAccessInfo set at the NamespaceMetadataType and its children.

Reimplemented from OpcUa::BaseObjectType.

---

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

• C:/work/uasdkcpp/src/uaserver/uaservercpp/coremodule/opcua_namespacemetadatatype.h
• C:/work/uasdkcpp/src/uaserver/uaservercpp/coremodule/opcua_namespacemetadatatype.cpp