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.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...
void	Add (string name, 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...
Public Member Functions inherited from UnifiedAutomation.UaBase.GenericDataType
override string	ToString ()
	Returns a System.String that represents this instance. More...

Properties
int	Count [get]
	Gets the number of fields in the structure. 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...
object	SchemaInfo [get, set]
	Gets or sets the OPCBinary or XML schema object which defines the type. 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

void UnifiedAutomation.UaBase.GenericStructureDataType.Add ( string  name, GenericStructureDataTypeField  value  )

inline

Adds the field for the specified field name.

Parameters

name	The name of the field.
value	The field.

Exceptions

System.ArgumentNullException

name

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

name	The name of the field.

Returns

The true if the field exists. False otherwise.

Exceptions

System.ArgumentNullException

name

void UnifiedAutomation.UaBase.GenericStructureDataType.RemoveAt ( int  ii )

inline

Removes the field at the specified index.

Parameters

ii

The ii.

override string UnifiedAutomation.UaBase.GenericStructureDataType.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.GenericDataType.

Reimplemented in 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

name	The field name.
value	The value.

Returns

True if the field exists; False otherwise.

Property Documentation

int UnifiedAutomation.UaBase.GenericStructureDataType.Count

get

Gets the number of fields in the structure.

The number of fields in the structure..

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

getset

Gets or sets the field at the specified index.

The field at the specified index.

Parameters

index

The 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

key

The name.

Returns

The field with the specified field name.

---

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

• C:/work/uasdknet/src/UaBase/Schema/GenericDataType.cs