.NET Based OPC UA Client/Server SDK  3.3.0.530
UnifiedAutomation.UaServer.NamespaceMetadataModel Class Reference

Defines application specific behavior for the Server object. More...

Inherits UnifiedAutomation.UaServer.BaseObjectModel.

Public Member Functions

 NamespaceMetadataModel (ServerManager server)
 Initializes a new instance of the ServerModel class. More...
 
override ModelHandle GetModelHandle (StringTable namespaceUris, object instance)
 Gets the metadata handle. More...
 
 NamespaceMetadataModel ()
 Initializes a new instance of the NamespaceMetadataModel class. More...
 
 NamespaceMetadataModel (NamespaceMetadataModel template, DummyArgument dummy=null)
 Initializes a new instance of the NamespaceMetadataModel class. More...
 
- Public Member Functions inherited from UnifiedAutomation.UaServer.BaseObjectModel
 BaseObjectModel ()
 Initializes a new instance of the BaseObjectModel class. More...
 
 BaseObjectModel (BaseObjectModel template, DummyArgument dummy=null)
 Initializes a new instance of the BaseObjectModel class. More...
 
- Public Member Functions inherited from UnifiedAutomation.UaServer.ModelControllerBase
virtual DataValue GetValue (IMapperContext context, ModelMapping mapping)
 Gets the value associated with the mapping. More...
 
virtual bool SetValue (IMapperContext context, ModelMapping mapping, DataValue value)
 Sets the value associated with the mapping. More...
 
StatusCode GetStatusCode (string propertyName)
 Retrieve the status code for the given property. If no status code was explicitly set, StatusCodes.Good will be returned.
Parameters
propertyNameThe property name.
Returns
The status code of the property.

 
void SetStatusCode (string propertyName, StatusCode statusCode)
 Sets the status code of the given property. More...
 

Properties

uint ConfigurationVersion [get, set]
 Gets or sets the ConfigurationVersion More...
 
AccessRestrictionType DefaultAccessRestrictions [get, set]
 Gets or sets the DefaultAccessRestrictions More...
 
RolePermissionType[] DefaultRolePermissions [get, set]
 Gets or sets the DefaultRolePermissions More...
 
RolePermissionType[] DefaultUserRolePermissions [get, set]
 Gets or sets the DefaultUserRolePermissions More...
 
bool IsNamespaceSubset [get, set]
 Defines whether all nodes of the namespace are accessible in the Server or only a subset. More...
 
AddressSpaceFileModel NamespaceFile [get, set]
 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. More...
 
DateTime NamespacePublicationDate [get, set]
 Provides the publication date of the namespace version. More...
 
string NamespaceUri [get, set]
 Contains the namespace represented by an instance of the MetaDataType. More...
 
string NamespaceVersion [get, set]
 Provides version information for the namespace. More...
 
IdType[] StaticNodeIdTypes [get, set]
 Provides a list of IdTypes used for static nodes. More...
 
string[] StaticNumericNodeIdRange [get, set]
 Provides a list of NumericRanges used for numeric NodeIds of static nodes. More...
 
string StaticStringNodeIdPattern [get, set]
 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. More...
 
- Properties inherited from UnifiedAutomation.UaServer.ModelControllerBase
ModelHandle ModelHandle [get, set]
 Gets or sets the metadata handle. More...
 
object UserData [get, set]
 Gets or sets the user data. More...
 
- Properties inherited from UnifiedAutomation.UaServer.INotifyStatusCodeInfo
bool HasStatusCodes [get]
 true if no property has an explicit set status code. Hence when all status codes are implicit StatusCodes.Good. More...
 

Additional Inherited Members

- Public Attributes inherited from UnifiedAutomation.UaServer.ModelControllerBase
bool HasStatusCodes => m_statusCodes != null && m_statusCodes.Count > 0
 
- Protected Member Functions inherited from UnifiedAutomation.UaServer.ModelControllerBase
void RaisePropertyChangedEvent ([CallerMemberName] string propertyName=null)
 Raises an property change event. More...
 
void RaisePropertyChangeRequestedEvent< T > (T value, [CallerMemberName] string propertyName=null)
 Called when the value of a property is supposed to be changed. More...
 
bool SetField< T > (ref T field, T value, [CallerMemberName] string propertyName=null)
 Sets the backing field to the new value, and triggers a property change event, if the value has changed. More...
 
- Events inherited from UnifiedAutomation.UaServer.ModelControllerBase
PropertyChangedEventHandler PropertyChanged
 Occurs when a property value changes. More...
 
EventHandler
< PropertyChangeRequestedEventArgs
PropertyChangeRequested
 The event is emitted just before the value will be changed, and gives the observer the opportunity to reject or adjust (e.g. clamp) the property change by setting the PropertyChangeRequestedEventArgs.StatusCode and PropertyChangeRequestedEventArgs.Value properties. More...
 
EventHandler
< StatusCodeChangedEventArgs
StatusCodeChanged
 
- Events inherited from UnifiedAutomation.UaServer.INotifyPropertyChangeRequested
EventHandler
< PropertyChangeRequestedEventArgs
PropertyChangeRequested
 The property change request event. More...
 
- Events inherited from UnifiedAutomation.UaServer.INotifyStatusCodeInfo
EventHandler
< StatusCodeChangedEventArgs
StatusCodeChanged
 Occurs if the status code of a property was changed. More...
 

Detailed Description

Defines application specific behavior for the Server object.

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 UnifiedAutomation.UaBase.QualifiedName and the namespace URI as name of the UnifiedAutomation.UaBase.QualifiedName.

Constructor & Destructor Documentation

UnifiedAutomation.UaServer.NamespaceMetadataModel.NamespaceMetadataModel ( ServerManager  server)

Initializes a new instance of the ServerModel class.

Parameters
serverThe server.
UnifiedAutomation.UaServer.NamespaceMetadataModel.NamespaceMetadataModel ( )

Initializes a new instance of the NamespaceMetadataModel class.

UnifiedAutomation.UaServer.NamespaceMetadataModel.NamespaceMetadataModel ( NamespaceMetadataModel  template,
DummyArgument  dummy = null 
)

Initializes a new instance of the NamespaceMetadataModel class.

Parameters
templateThe template.
dummyDummy argument to enable writing own constructors that are called by the generated code.

Member Function Documentation

override ModelHandle UnifiedAutomation.UaServer.NamespaceMetadataModel.GetModelHandle ( StringTable  namespaceUris,
object  instance 
)
virtual

Gets the metadata handle.

Parameters
namespaceUrisThe namespace uris.
instanceThe instance.
Returns

Reimplemented from UnifiedAutomation.UaServer.ModelControllerBase.

Property Documentation

uint UnifiedAutomation.UaServer.NamespaceMetadataModel.ConfigurationVersion
getset

Gets or sets the ConfigurationVersion

AccessRestrictionType UnifiedAutomation.UaServer.NamespaceMetadataModel.DefaultAccessRestrictions
getset

Gets or sets the DefaultAccessRestrictions

RolePermissionType [] UnifiedAutomation.UaServer.NamespaceMetadataModel.DefaultRolePermissions
getset

Gets or sets the DefaultRolePermissions

RolePermissionType [] UnifiedAutomation.UaServer.NamespaceMetadataModel.DefaultUserRolePermissions
getset

Gets or sets the DefaultUserRolePermissions

bool UnifiedAutomation.UaServer.NamespaceMetadataModel.IsNamespaceSubset
getset

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.

AddressSpaceFileModel UnifiedAutomation.UaServer.NamespaceMetadataModel.NamespaceFile
getset

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.

DateTime UnifiedAutomation.UaServer.NamespaceMetadataModel.NamespacePublicationDate
getset

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.

string UnifiedAutomation.UaServer.NamespaceMetadataModel.NamespaceUri
getset

Contains the namespace represented by an instance of the MetaDataType.

string UnifiedAutomation.UaServer.NamespaceMetadataModel.NamespaceVersion
getset

Provides version information for the namespace.

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

IdType [] UnifiedAutomation.UaServer.NamespaceMetadataModel.StaticNodeIdTypes
getset

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.

string [] UnifiedAutomation.UaServer.NamespaceMetadataModel.StaticNumericNodeIdRange
getset

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.

string UnifiedAutomation.UaServer.NamespaceMetadataModel.StaticStringNodeIdPattern
getset

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.


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