UnifiedAutomation.UaBase.GenericStructuredValue Class Reference

The value of a field which contains a structured value. More...

Inherits UnifiedAutomation.UaBase.GenericValue, and IEnumerable< KeyValuePair< string, GenericValue >>.

Public Member Functions
	GenericStructuredValue ()
	Initializes a new instance of the GenericStructuredValue class. More...
	GenericStructuredValue (IList< string > names, IList< GenericValue > values)
	Initializes a new instance of the GenericStructuredValue class. More...
IEnumerator< KeyValuePair < string, GenericValue > >	GetEnumerator ()
	Returns an enumerator that iterates through the collection. More...
bool	ContainsKey (string name)
	Determines whether the specified field exists. More...
bool	TryGetValue (string name, out GenericValue value)
	Checks whether the specified field exists and returns it if it does. More...
void	Add (string name, GenericValue value)
	Adds the value for the specified field name. More...
bool	Remove (string name)
	Removes the field with the specified name. More...
void	RemoveAt (int ii)
	Removes the value at the specified index. More...
override string	ToString (string format, IFormatProvider formatProvider)
	Returns a System.String that represents this instance. More...
Public Member Functions inherited from UnifiedAutomation.UaBase.GenericValue
override string	ToString ()
	Returns a System.String that represents this instance. More...

Properties
new GenericStructureDataType	DataType [get, set]
	Gets or sets the type description for the structure. More...
int	Count [get]
	Gets the number of values in the structure. More...
GenericValue	this[string key] [get, set]
	Gets or sets the value with the specified field name. More...
GenericValue	this[int index] [get, set]
	Gets or sets the value at the specified index. More...
Properties inherited from UnifiedAutomation.UaBase.GenericValue
GenericDataType	DataType [get, set]
	Gets or sets the type description for the simple value. More...

Detailed Description

The value of a field which contains a structured value.

Constructor & Destructor Documentation

UnifiedAutomation.UaBase.GenericStructuredValue.GenericStructuredValue ( )

inline

Initializes a new instance of the GenericStructuredValue class.

UnifiedAutomation.UaBase.GenericStructuredValue.GenericStructuredValue ( IList< string >  names, IList< GenericValue >  values  )

inline

Initializes a new instance of the GenericStructuredValue class.

Parameters

names	The list of field names.
values	The matching list of field values.

Member Function Documentation

void UnifiedAutomation.UaBase.GenericStructuredValue.Add ( string  name, GenericValue  value  )

inline

Adds the value for the specified field name.

Parameters

name	The name of the field.
value	The value.

Exceptions

System.ArgumentNullException

key

bool UnifiedAutomation.UaBase.GenericStructuredValue.ContainsKey ( string  name )

inline

Determines whether the specified field exists.

Parameters

name	The field name.

Returns

True if the field exists; False otherwise.

IEnumerator<KeyValuePair<string, GenericValue> > UnifiedAutomation.UaBase.GenericStructuredValue.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.GenericStructuredValue.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.GenericStructuredValue.RemoveAt ( int  ii )

inline

Removes the value at the specified index.

Parameters

ii

The ii.

override string UnifiedAutomation.UaBase.GenericStructuredValue.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.GenericValue.

bool UnifiedAutomation.UaBase.GenericStructuredValue.TryGetValue ( string  name, out GenericValue  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.GenericStructuredValue.Count

get

Gets the number of values in the structure.

The number of values in the structure.

new GenericStructureDataType UnifiedAutomation.UaBase.GenericStructuredValue.DataType

getset

Gets or sets the type description for the structure.

The type type description for the structure.

GenericValue UnifiedAutomation.UaBase.GenericStructuredValue.this[int index]

getset

Gets or sets the value at the specified index.

The value at the specified index.

Parameters

index

The zero based index.

Returns

The value at the index.

GenericValue UnifiedAutomation.UaBase.GenericStructuredValue.this[string key]

getset

Gets or sets the value with the specified field name.

The value with the specified field name.

Parameters

key

The name.

Returns

The value with the specified field name.

---

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

• C:/work/uasdknet/src/UaBase/Encoders/GenericValue.cs