UA Server SDK C++ Bundle  1.4.0.258
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
UaStructureField Class Reference

#include <uastructurefield.h>

Public Types

enum  ArrayType { ArrayType_Scalar = OpcUa_VariantArrayType_Scalar, ArrayType_Array = OpcUa_VariantArrayType_Array }
 

Public Member Functions

 UaStructureField ()
 Constructor.
 
 UaStructureField (const UaStructureField &other)
 Copy constructor.
 
UaStructureFieldoperator= (const UaStructureField &other)
 
bool isNull ()
 
void setName (const UaString &sName)
 
UaString name () const
 
void setDocumentation (const UaLocalizedText &sDocumentation)
 
UaLocalizedText documentation () const
 
void setDataTypeId (const UaNodeId &dataTypeId)
 Sets the DataTypeId. More...
 
UaNodeId typeId () const
 Returns the DataTypeId.
 
void setValueType (OpcUa_BuiltInType type)
 Sets the ValueType. More...
 
OpcUa_BuiltInType valueType () const
 
void setEnumDefinition (const UaEnumDefinition &newEnumDefinition)
 Sets the EnumDefinition, the DataTypeId, and the ValueType.
 
UaEnumDefinition enumDefinition () const
 
void setStructureDefinition (const UaStructureDefinition &newStructureDefinition)
 Sets the StructureDefinition, the DataTypeId and the ValueType.
 
UaStructureDefinition structureDefinition () const
 
void setArrayType (ArrayType arrayType)
 
ArrayType arrayType () const
 
void setSourceType (const UaStructureDefinition &parent)
 This method should only be called by UaStructureDefinition::createSubtype. More...
 
UaStructureDefinition sourceType () const
 
void setSwitchField (const UaStructureField &newSwitchField)
 Sets the SwitchField for unions. More...
 
UaStructureField switchField () const
 This method is used for declaring unions. More...
 
void setSwitchValue (int iSwitchValue)
 This method is used for declaring unions. More...
 
int switchValue () const
 This method is used for declaring unions. More...
 

Static Public Member Functions

static OpcUa_BuiltInType builtInTypeFromDataTypeId (const UaNodeId &dataTypeId, UaDataTypeDictionary *pDataTypeDictionary=NULL)
 Returns the ValueType that is specified by a DataType. More...
 

Detailed Description

Member Function Documentation

OpcUa_BuiltInType UaStructureField::builtInTypeFromDataTypeId ( const UaNodeId dataTypeId,
UaDataTypeDictionary pDataTypeDictionary = NULL 
)
static

Returns the ValueType that is specified by a DataType.

Returns valid values for DataTypes with NamespaceIndex = 0 and Indentifier < 26, and for Enumerations or Structures that are defined in the pDataTypeDictionary.

Parameters
dataTypeIdNodeId of the requested data type
pDataTypeDictionaryIf NULL, only DataTypes with NamespaceIndex = 0 and Indetifier < 26 will return a valid ValueType.
void UaStructureField::setDataTypeId ( const UaNodeId dataTypeId)

Sets the DataTypeId.

For DataTypeIds with NamespaceIndex = 0 and Identifier < 26 the ValueType is set, too.

void UaStructureField::setSourceType ( const UaStructureDefinition parent)

This method should only be called by UaStructureDefinition::createSubtype.

It links to the base type which declares the field.

void UaStructureField::setSwitchField ( const UaStructureField newSwitchField)

Sets the SwitchField for unions.

This method should not be called, since unions are not specified finally.

void UaStructureField::setSwitchValue ( int  iSwitchValue)

This method is used for declaring unions.

This method should not be called, since unions are not specified finally.

void UaStructureField::setValueType ( OpcUa_BuiltInType  type)

Sets the ValueType.

If the DataTypeId is not set yet, the DataType is set, too.

UaStructureField UaStructureField::switchField ( ) const

This method is used for declaring unions.

This method should not be called, since unions are not specified finally.

int UaStructureField::switchValue ( ) const

This method is used for declaring unions.

This method should not be called, since unions are not specified finally.


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