A type description for a structured which is also a simple union. More...

Inherits UnifiedAutomation.UaBase.GenericStructureDataType.

Public Member Functions
	GenericOptionalFieldListDataType ()
	Initializes a new instance of the GenericOptionalFieldListDataType class. More...

void	AddOptional (GenericStructureDataTypeField value)
	Adds the field for the specified field name. More...

bool	IsFieldOptional (string fieldName)
	Checks if the field is optional. More...

bool	IsFieldEncoded (string fieldName, long encodingMask)
	Checks if the field is encoded given a value for the encoding mask. More...

void	SetEncodingMask (string fieldName, string encodingMaskFieldName)
	Sets the encoding mask field name for the specified field. More...

void	SetEncodingMask (string fieldName, byte bitPosition)
	Sets the bit position of the encoding mask for the specified field. More...

int	GetEncodingMask (string fieldName)
	Gets the bit position of the encoding mask for the specified field. More...

string	GetEncodingMaskField (string fieldName)
	Gets the encoding mask field name for the specified field. More...

override string	ToString (string format, IFormatProvider formatProvider)
	Returns a System.String that represents this instance. More...

override DataTypeDefinitionSettings	DataTypeDefinition (NamespaceTable namespaceUris)
	Returns the DataTypeDefinitionSettings for the structure. More...

Public Member Functions inherited from UnifiedAutomation.UaBase.GenericStructureDataType
	GenericStructureDataType ()
	Initializes a new instance of the GenericStructureDataType class. More...

bool	TryGetValue (string name, out GenericStructureDataTypeField value)
	Checks whether the specified field exists and returns it if it does. More...

virtual void	Add (GenericStructureDataTypeField value)
	Adds the field for the specified field name. More...

bool	Remove (string name)
	Removes the field with the specified name. More...

void	RemoveAt (int ii)
	Removes the field at the specified index. More...

IEnumerator< KeyValuePair < string, GenericStructureDataTypeField > >	GetEnumerator ()
	Returns an enumerator that iterates through the collection. More...

Public Member Functions inherited from UnifiedAutomation.UaBase.GenericDataType
override string	ToString ()
	Returns a System.String that represents this instance. More...

Properties
string	EncodingMaskField `[get]`
	The name of the encoding mask field More...

override GenericDataTypeClass	TypeClass `[get]`
	Gets the type class for the object. More...

IList< string >	EncodingMaskFields `[get, set]`
	The an ordered list of the names of the fields in the encoding mask. More...

IList< int >	EncodingMaskLengths `[get, set]`
	The an ordered list of the lengths of each field in the encoding mask. More...

IDictionary< string, int >	EncodingMaskIndex `[get]`
	Gets a table with the mapping between a field and the index of the encoding mask used to select it. More...

Properties inherited from UnifiedAutomation.UaBase.GenericStructureDataType
ExpandedNodeId	XmlEncodingNodeId `[get, set]`
	The NodeId for the DefaultXML encoding node. More...

ExpandedNodeId	BinaryEncodingNodeId `[get, set]`
	The NodeId for the DefaultBinary encoding node. More...

override GenericDataTypeClass	TypeClass `[get]`
	Gets the type class for the object. More...

int	Count `[get]`
	Gets the number of fields in the structure. More...

IList< string >	Fields `[get]`
	Gets list of field names. More...

GenericStructureDataTypeField	this[string key] `[get, set]`
	Gets or sets the field with the specified field name. More...

GenericStructureDataTypeField	this[int index] `[get, set]`
	Gets or sets the field at the specified index. More...

Properties inherited from UnifiedAutomation.UaBase.GenericDataType
XmlQualifiedName	Name `[get, set]`
	Gets or sets the qualified name for the type. More...

abstract GenericDataTypeClass	TypeClass `[get]`
	Gets the type class for the object. More...

virtual ExpandedNodeId	DataTypeId `[get, set]`
	Gets or sets the DataTypeId More...

Additional Inherited Members
Protected Member Functions inherited from UnifiedAutomation.UaBase.GenericStructureDataType
void	Rename (string oldName, string newName)
	Renames the specified field. More...

Detailed Description

A type description for a structured which is also a simple union.

Constructor & Destructor Documentation

UnifiedAutomation.UaBase.GenericOptionalFieldListDataType.GenericOptionalFieldListDataType ( )

inline

Initializes a new instance of the GenericOptionalFieldListDataType class.

Member Function Documentation

void UnifiedAutomation.UaBase.GenericOptionalFieldListDataType.AddOptional ( GenericStructureDataTypeField value )

inline

Adds the field for the specified field name.

Parameters

value A description for the field.

override DataTypeDefinitionSettings UnifiedAutomation.UaBase.GenericOptionalFieldListDataType.DataTypeDefinition ( NamespaceTable namespaceUris )

inlinevirtual

Returns the DataTypeDefinitionSettings for the structure.

Parameters

namespaceUris The NamespaceTable to resolve the DataTypeIds of the fields.

Returns: The StructureDefinitionSettings of the DataType.

Reimplemented from UnifiedAutomation.UaBase.GenericStructureDataType.

int UnifiedAutomation.UaBase.GenericOptionalFieldListDataType.GetEncodingMask ( string fieldName )

inline

Gets the bit position of the encoding mask for the specified field.

Parameters

fieldName Name of the field.

Returns: The bit position of the encoding mask for the specified field; -1 if no mapping exists.

string UnifiedAutomation.UaBase.GenericOptionalFieldListDataType.GetEncodingMaskField ( string fieldName )

inline

Gets the encoding mask field name for the specified field.

Parameters

fieldName Name of the field.

Returns: The encoding mask field name for the specified field; NULL if no mapping exists.

bool UnifiedAutomation.UaBase.GenericOptionalFieldListDataType.IsFieldEncoded	(	string	fieldName,
		long	encodingMask
	)

inline

Checks if the field is encoded given a value for the encoding mask.

Parameters

fieldName	Name of the field.
encodingMask	The encoding mask.

Returns: TRUE if the field is encoded; FALSE otherwise.

bool UnifiedAutomation.UaBase.GenericOptionalFieldListDataType.IsFieldOptional ( string fieldName )

inline

Checks if the field is optional.

Parameters

fieldName Name of the field.

Returns: TRUE if the field is optional; FALSE otherwise.

void UnifiedAutomation.UaBase.GenericOptionalFieldListDataType.SetEncodingMask	(	string	fieldName,
		string	encodingMaskFieldName
	)

inline

Sets the encoding mask field name for the specified field.

Parameters

fieldName	Name of the field.
encodingMaskFieldName	Name of the encoding mask field.

The encoding mask field name is added to the end of the list if it does not exist.

void UnifiedAutomation.UaBase.GenericOptionalFieldListDataType.SetEncodingMask	(	string	fieldName,
		byte	bitPosition
	)

inline

Sets the bit position of the encoding mask for the specified field.

Parameters

fieldName	Name of the field.
bitPosition	The zero based bit position.

New encoding mask fields are allocated to allow the value to be set. Each automatically added field has a name "Bit#" and a width of 1.

override string UnifiedAutomation.UaBase.GenericOptionalFieldListDataType.ToString	(	string	format,
		IFormatProvider	formatProvider
	)

inlinevirtual

Returns a System.String that represents this instance.

Parameters

format	The format.
formatProvider	The format provider.

Returns: A System.String that represents this instance.

Reimplemented from UnifiedAutomation.UaBase.GenericStructureDataType.

Property Documentation

string UnifiedAutomation.UaBase.GenericOptionalFieldListDataType.EncodingMaskField

get

The name of the encoding mask field

IList<string> UnifiedAutomation.UaBase.GenericOptionalFieldListDataType.EncodingMaskFields

getset

The an ordered list of the names of the fields in the encoding mask.

IDictionary<string, int> UnifiedAutomation.UaBase.GenericOptionalFieldListDataType.EncodingMaskIndex

get

Gets a table with the mapping between a field and the index of the encoding mask used to select it.

A table with the mapping between a field and the index of the encoding mask used to select it.

IList<int> UnifiedAutomation.UaBase.GenericOptionalFieldListDataType.EncodingMaskLengths

getset

The an ordered list of the lengths of each field in the encoding mask.

override GenericDataTypeClass UnifiedAutomation.UaBase.GenericOptionalFieldListDataType.TypeClass

get

Gets the type class for the object.

The type class.

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

C:/work/uasdknet/src/UaBase/Encoders/GenericDataType.cs

Public Member Functions

Properties

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Property Documentation