9.1.9 Subscribed DataSet model

9.1.9.1 SubscribedDataSetType

This ObjectType defines the metadata for the subscribed DataSet and the information for the processing of DataSetMessages. See 5.4.2.2 for an introduction to the processing options for received DataSetMessages.

The SubscribedDataSetType is formally defined in Table 296.

9.1.9.2 Target Variables

9.1.9.2.1 TargetVariablesType

This ObjectType defines the metadata for the subscribed DataSet and the information for the processing of DataSetMessages. The TargetVariablesType is formally defined in Table 297.

The TargetVariables is defined in 6.2.10.2.

9.1.9.2.2 AddTargetVariables Method

This Method is used to add target Variables to an existing list of target Variables of a TargetVariablesType Object.

The Client shall be authorized to modify the configuration for the PubSub functionality when invoking this Method on the Server.

Signature

	AddTargetVariables (
		[in]	ConfigurationVersionDataType		ConfigurationVersion,
		[in]	FieldTargetDataType[]			TargetVariablesToAdd,
		[out]	StatusCode[]				AddResults
		);
	

Method Result Codes

Operation Result Codes

Table 298 specifies the AddressSpace representation for the AddTargetVariables Method.

9.1.9.2.3 RemoveTargetVariables Method

This Method is used to remove entries from the list of target Variables of a TargetVariablesType Object.

The Client shall be authorized to modify the configuration for the PubSub functionality when invoking this Method on the Server.

Signature

	RemoveTargetVariables (
		[in]	ConfigurationVersionDataType		ConfigurationVersion,
		[in]	UInt32[]					TargetsToRemove,
		[out]	StatusCode[]				RemoveResults
		);
	

Method Result Codes

Operation Result Codes

Table 299 specifies the AddressSpace representation for the RemoveTargetVariables Method.

9.1.9.3 SubscribedDataSetMirrorType

This ObjectType defines the information for the processing of DataSetMessages as mirror Variables. For each field of the DataSet a mirror Variable is created in the Subscriber AddressSpace. The SubscribedDataSetMirrorType is formally defined in Table 300.

An Object of this type shall reference a mirror Object with HasComponent where the name of the Object is based on the ParentNodeName. The Method CreateDataSetMirror can be used to set the SubscribedDataSet into the mirror mode.

The mirror Object shall reference Variables for each DataSet field in the DataSetMetaData with HasComponent. The name, DataType, ValueRank and ArrayDimensions of the Variables shall match the settings for the corresponding DataSet field in the DataSetMetaData.

A Variable representing a field of the DataSet shall be created with the following rules

TypeDefinition is BaseDataVariableType or a subtype.

The Reference from the parent Node to the Variable is of type HasComponent.

The initial AccessLevel of the Variables is CurrentRead.

The RolePermissions is derived from the parent Node.

The other Attribute values are taken from the FieldMetaData.

The properties in the FieldMetaData are created as Properties of the Variable.

The DataTypes are created in the Subscriber from the DataSetMetaData if they do not exist. The NamespaceUri of the created DataTypes shall match the namespace contained in the DataSetMetaData.

9.1.9.4 Subscribed DataSet Folder

9.1.9.4.1 SubscribedDataSetFolderType

The SubscribedDataSetFolderType is formally defined in Table 301.

The SubscribedDataSetFolderType ObjectType is a concrete type and can be used directly.

Instances of the SubscribedDataSetFolderType can contain StandaloneSubscribedDataSets or other instances of the SubscribedDataSetFolderType. This can be used to build a tree of Folder Objects used to group the configured StandaloneSubscribedDataSets.

The StandaloneSubscribedDataSetType Objects are added as components to the instance of the SubscribedDataSetFolderType. An instance of a StandaloneSubscribedDataSetType is referenced only from one SubscribedDataSetFolder. If the SubscribedDataSetFolder is deleted, all referenced StandaloneSubscribedDataSetType Objects are deleted with the folder.

StandaloneSubscribedDataSetType Objects may be configured with product-specific configuration tools or added and removed through the Methods AddSubscribedDataSet and RemoveSubscribedDataSet.

9.1.9.4.2 AddSubscribedDataSet Method

This Method is used to add a new standalone subscribed DataSet Object to an instance of the DataSet Folder.

The Client shall be authorized to modify the configuration for the PubSub functionality when invoking this Method on the Server.

Signature

	AddSubscribedDataSet (
		[in]	StandaloneSubscribedDataSetDataType SubscribedDataSet,
		[out]	NodeId				SubscribedDataSetNodeId
		);
	

Method Result Codes

Table 302 specifies the AddressSpace representation for the AddSubscribedDataSet Method.

9.1.9.4.3 RemoveSubscribedDataSet Method

This Method is used to remove a standalone subscribed DataSet Object from a subscribed DataSet Folder. If a DataSetReader is connected, the DataSetReader is removed too.

The Client shall be authorized to modify the configuration for the PubSub functionality when invoking this Method on the Server.

Signature

	RemoveSubscribedDataSet (
		[in]	NodeId	SubscribedDataSetNodeId
		);
	

Method Result Codes

Table 303 specifies the AddressSpace representation for the RemoveSubscribedDataSet Method.

9.1.9.4.4 AddDataSetFolder Method

This Method is used to add a SubscribedDataSetFolderType Object to a SubscribedDataSetFolderType Object.

The Client shall be authorized to modify the configuration for the PubSub functionality when invoking this Method on the Server.

Signature

	AddDataSetFolder (
		[in]	String	Name,
		[out]	NodeId	DataSetFolderNodeId
		);
	

Method Result Codes

Table 304 specifies the AddressSpace representation for the AddDataSetFolder Method.

9.1.9.4.5 RemoveDataSetFolder Method

This Method is used to remove a SubscribedDataSetFolderType Object from the parent SubscribedDataSetFolderType Object.

A successful removal of the SubscribedDataSetFolderType Object removes all associated StandaloneSubscribedDataSetType Objects and their associated DataSetReader Objects. Before the Objects are removed, their state is changed to Disabled.

The Client shall be authorized to modify the configuration for the PubSub functionality when invoking this Method on the Server.

Signature

	RemoveDataSetFolder (
		[in]	NodeId	DataSetFolderNodeId
		);
	

Method Result Codes

Table 305 specifies the AddressSpace representation for the RemoveDataSetFolder Method.

9.1.9.5 StandaloneSubscribedDataSetType

This ObjectType represents a Subscriber defined standalone DataSet. A standalone subscribed DataSet can exist without DataSetReader and is used to define a DataSet from the Subscriber side. A DataSetReader can be configured and connected to the standalone DataSet if a Publisher provides the DataSetMessages defined by the DataSetMetaData in the standalone DataSet. The StandaloneSubscribedDataSetType is formally defined in Table 306.

The SubscribedDataSetType defined in 9.1.9.1 describes the processing of the received DataSet in a Subscriber.

The DataSetMetaData is defined in 6.2.9.4. A Publisher must be configured to send DataSetMessages that comply with the DataSetMetaData in the standalone subscribed DataSet.

The IsConnected Property with DataType Boolean indicates if the standalone subscribed DataSet is connected to a DataSetReader. A standalone subscribed DataSet can only be connected to one DataSetReader. If a DataSetReader is connected, the DataSetReader Object shall share the Nodes SubscribedDataSet and DataSetMetaData with the StandaloneSubscribedDataSet Object. The relation between standalone SubscribedDataSet and the connected DataSetReader is provided in both directions through the inverse References from the SubscribedDataSet Object.