A type description for a structured which is also a simple union.
More...
Inherits UnifiedAutomation.UaBase.GenericStructureDataType.
|
void | Rename (string oldName, string newName) |
| Renames the specified field. More...
|
|
A type description for a structured which is also a simple union.
UnifiedAutomation.UaBase.GenericOptionalFieldListDataType.GenericOptionalFieldListDataType |
( |
| ) |
|
|
inline |
Adds the field for the specified field name.
- Parameters
-
value | A description for the field. |
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 |
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.
Gets the type class for the object.
The type class.
The documentation for this class was generated from the following file:
- D:/work/uasdknet/src/UaBase/Encoders/GenericDataType.cs