.NET Based OPC UA Client/Server SDK  3.0.10.493
UnifiedAutomation.UaBase.GenericStructureDataType Class Reference

A type description for a structured value. More...

Inherits UnifiedAutomation.UaBase.GenericDataType, and IEnumerable< KeyValuePair< string, GenericStructureDataTypeField >>.

Inherited by UnifiedAutomation.UaBase.GenericOptionalFieldListDataType, and UnifiedAutomation.UaBase.GenericUnionDataType.

Public Member Functions

 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...
 
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.GenericDataType
override string ToString ()
 Returns a System.String that represents this instance. More...
 

Protected Member Functions

void Rename (string oldName, string newName)
 Renames the specified field. More...
 

Properties

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...
 

Detailed Description

A type description for a structured value.

Constructor & Destructor Documentation

UnifiedAutomation.UaBase.GenericStructureDataType.GenericStructureDataType ( )
inline

Initializes a new instance of the GenericStructureDataType class.

Member Function Documentation

virtual void UnifiedAutomation.UaBase.GenericStructureDataType.Add ( GenericStructureDataTypeField  value)
inlinevirtual

Adds the field for the specified field name.

Parameters
valueA description for the field.

Reimplemented in UnifiedAutomation.UaBase.GenericUnionDataType.

override DataTypeDefinitionSettings UnifiedAutomation.UaBase.GenericStructureDataType.DataTypeDefinition ( NamespaceTable  namespaceUris)
inlinevirtual

Returns the DataTypeDefinitionSettings for the structure.

Parameters
namespaceUrisThe NamespaceTable to resolve the DataTypeIds of the fields.
Returns
The StructureDefinitionSettings of the DataType.

Reimplemented from UnifiedAutomation.UaBase.GenericDataType.

Reimplemented in UnifiedAutomation.UaBase.GenericOptionalFieldListDataType, and UnifiedAutomation.UaBase.GenericUnionDataType.

IEnumerator<KeyValuePair<string, GenericStructureDataTypeField> > UnifiedAutomation.UaBase.GenericStructureDataType.GetEnumerator ( )
inline

Returns an enumerator that iterates through the collection.

Returns
A T:System.Collections.Generic.IEnumerator`1 that can be used to iterate through the collection.
bool UnifiedAutomation.UaBase.GenericStructureDataType.Remove ( string  name)
inline

Removes the field with the specified name.

Parameters
nameThe name of the field.
Returns
TRUE if the field exists; FALSE otherwise.
void UnifiedAutomation.UaBase.GenericStructureDataType.RemoveAt ( int  ii)
inline

Removes the field at the specified index.

Parameters
iiThe ii.
void UnifiedAutomation.UaBase.GenericStructureDataType.Rename ( string  oldName,
string  newName 
)
inlineprotected

Renames the specified field.

Parameters
oldNameThe old name.
newNameThe new name.
override string UnifiedAutomation.UaBase.GenericStructureDataType.ToString ( string  format,
IFormatProvider  formatProvider 
)
inlinevirtual

Returns a System.String that represents this instance.

Parameters
formatThe format.
formatProviderThe format provider.
Returns
A System.String that represents this instance.

Reimplemented from UnifiedAutomation.UaBase.GenericDataType.

Reimplemented in UnifiedAutomation.UaBase.GenericOptionalFieldListDataType, and UnifiedAutomation.UaBase.GenericUnionDataType.

bool UnifiedAutomation.UaBase.GenericStructureDataType.TryGetValue ( string  name,
out GenericStructureDataTypeField  value 
)
inline

Checks whether the specified field exists and returns it if it does.

Parameters
nameThe field name.
valueThe value.
Returns
True if the field exists; False otherwise.

Property Documentation

ExpandedNodeId UnifiedAutomation.UaBase.GenericStructureDataType.BinaryEncodingNodeId
getset

The NodeId for the DefaultBinary encoding node.

int UnifiedAutomation.UaBase.GenericStructureDataType.Count
get

Gets the number of fields in the structure.

The number of fields in the structure.

IList<string> UnifiedAutomation.UaBase.GenericStructureDataType.Fields
get

Gets list of field names.

The list of fields.

GenericStructureDataTypeField UnifiedAutomation.UaBase.GenericStructureDataType.this[int index]
getset

Gets or sets the field at the specified index.

The field at the specified index.

Parameters
indexThe zero based index.
Returns
The field at the index.
GenericStructureDataTypeField UnifiedAutomation.UaBase.GenericStructureDataType.this[string key]
getset

Gets or sets the field with the specified field name.

The field with the specified field name.

Parameters
keyThe name.
Returns
The field with the specified field name.
override GenericDataTypeClass UnifiedAutomation.UaBase.GenericStructureDataType.TypeClass
get

Gets the type class for the object.

The type class.

ExpandedNodeId UnifiedAutomation.UaBase.GenericStructureDataType.XmlEncodingNodeId
getset

The NodeId for the DefaultXML encoding node.


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