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

A type description for a enumerated data type. More...

Inherits UnifiedAutomation.UaBase.GenericDataType, and IEnumerable< GenericEnumeratedValue >.

Inherited by UnifiedAutomation.UaBase.GenericOptionSetDataType.

Public Member Functions

override DataTypeDefinitionSettings DataTypeDefinition (NamespaceTable namespaceUris)
 
 GenericEnumeratedDataType ()
 Initializes a new instance of the GenericEnumeratedDataType class. More...
 
bool TryGetValue (string name, out int value)
 Tries to the get value for the name. More...
 
bool TryGetValue (int value, out string name)
 Tries to the get name for the value. More...
 
void Add (string name, int value)
 Adds the field for the specified field name. More...
 
bool Remove (string name)
 Removes the field with the specified name. More...
 
IEnumerator
< GenericEnumeratedValue
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

override GenericDataTypeClass TypeClass [get]
 Gets the type class for the object. More...
 
int Count [get]
 Gets the number of values in the enumeration. More...
 
int this[string name] [get]
 Gets the value for the name. More...
 
string this[int value] [get]
 Gets the name for the value. 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 enumerated data type.

Constructor & Destructor Documentation

UnifiedAutomation.UaBase.GenericEnumeratedDataType.GenericEnumeratedDataType ( )
inline

Initializes a new instance of the GenericEnumeratedDataType class.

Member Function Documentation

void UnifiedAutomation.UaBase.GenericEnumeratedDataType.Add ( string  name,
int  value 
)
inline

Adds the field for the specified field name.

Parameters
nameThe name of the field.
valueThe field.
override DataTypeDefinitionSettings UnifiedAutomation.UaBase.GenericEnumeratedDataType.DataTypeDefinition ( NamespaceTable  namespaceUris)
inlinevirtual

Returns

Reimplemented from UnifiedAutomation.UaBase.GenericDataType.

IEnumerator<GenericEnumeratedValue> UnifiedAutomation.UaBase.GenericEnumeratedDataType.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.GenericEnumeratedDataType.Remove ( string  name)
inline

Removes the field with the specified name.

Parameters
nameThe name of the field.
Returns
The true if the field exists. False otherwise.
Exceptions
System.ArgumentNullExceptionname
override string UnifiedAutomation.UaBase.GenericEnumeratedDataType.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.

bool UnifiedAutomation.UaBase.GenericEnumeratedDataType.TryGetValue ( string  name,
out int  value 
)
inline

Tries to the get value for the name.

Parameters
nameThe name.
valueThe value.
Returns
TRUE if the name was found; FALSE otherwise.
bool UnifiedAutomation.UaBase.GenericEnumeratedDataType.TryGetValue ( int  value,
out string  name 
)
inline

Tries to the get name for the value.

Parameters
valueThe value.
nameThe name.
Returns
TRUE if the value was found; FALSE otherwise.

Property Documentation

int UnifiedAutomation.UaBase.GenericEnumeratedDataType.Count
get

Gets the number of values in the enumeration.

The number of fields in the enumeration.

string UnifiedAutomation.UaBase.GenericEnumeratedDataType.this[int value]
get

Gets the name for the value.

Parameters
valueThe value.
Returns
The name if found.
int UnifiedAutomation.UaBase.GenericEnumeratedDataType.this[string name]
get

Gets the value for the name.

Parameters
nameThe name.
Returns
The value if found.
override GenericDataTypeClass UnifiedAutomation.UaBase.GenericEnumeratedDataType.TypeClass
get

Gets the type class for the object.

The type class.


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