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

#include <uastructurefield.h>

Public Member Functions

 UaStructureField ()
 Constructor.
 
 UaStructureField (const UaStructureField &other)
 Copy constructor.
 
virtual ~UaStructureField ()
 Destruction. More...
 
UaStructureFieldoperator= (const UaStructureField &other)
 Assignment. More...
 
bool isNull ()
 Returns true if the name is empty. More...
 
void setName (const UaString &sName)
 Sets the name. More...
 
UaString name () const
 Returns the name. More...
 
void setDocumentation (const UaLocalizedText &sDocumentation)
 Sets the documentation. More...
 
UaLocalizedText documentation () const
 Returns the documentation. More...
 
void setDataTypeId (const UaNodeId &dataTypeId)
 Sets the DataTypeId. More...
 
UaNodeId typeId () const
 Returns the DataTypeId. More...
 
void setValueType (OpcUa_BuiltInType type)
 Sets the ValueType. More...
 
OpcUa_BuiltInType valueType () const
 Returns the ValueType. More...
 
void setEnumDefinition (const UaEnumDefinition &newEnumDefinition)
 Sets the EnumDefinition, the DataTypeId, and the ValueType. More...
 
UaEnumDefinition enumDefinition () const
 Returns the UaEnumDefinition of the field. More...
 
void setStructureDefinition (const UaStructureDefinition &newStructureDefinition)
 Sets the StructureDefinition, the DataTypeId and the ValueType. More...
 
UaStructureDefinition structureDefinition () const
 Returns the UaStructureDefinition of the field. More...
 
void setArrayType (ArrayType arrayType)
 Sets the array type. More...
 
ArrayType arrayType () const
 Returns the array type. More...
 
void setSourceType (const UaStructureDefinition &parent)
 
UaStructureDefinition sourceType () const
 Returns the source type. More...
 
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

Constructor & Destructor Documentation

UaStructureField::~UaStructureField ( )
virtual

Destruction.

Member Function Documentation

UaStructureField::ArrayType UaStructureField::arrayType ( ) const

Returns the array type.

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.
UaLocalizedText UaStructureField::documentation ( ) const

Returns the documentation.

UaEnumDefinition UaStructureField::enumDefinition ( ) const

Returns the UaEnumDefinition of the field.

If the enum definintion has not been set, an empty UaEnumDefinition is returned.

bool UaStructureField::isNull ( )

Returns true if the name is empty.

UaString UaStructureField::name ( ) const

Returns the name.

UaStructureField & UaStructureField::operator= ( const UaStructureField other)

Assignment.

void UaStructureField::setArrayType ( UaStructureField::ArrayType  arrayType)

Sets the array type.

void UaStructureField::setDataTypeId ( const UaNodeId dataTypeId)

Sets the DataTypeId.

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

void UaStructureField::setDocumentation ( const UaLocalizedText documentation)

Sets the documentation.

void UaStructureField::setEnumDefinition ( const UaEnumDefinition newEnumDefinition)

Sets the EnumDefinition, the DataTypeId, and the ValueType.

void UaStructureField::setName ( const UaString sName)

Sets the name.

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::setStructureDefinition ( const UaStructureDefinition newStructureDefinition)

Sets the StructureDefinition, the DataTypeId and the ValueType.

void UaStructureField::setSwitchField ( const UaStructureField newSwitchField)

Sets the SwitchField for unions.

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

void UaStructureField::setSwitchValue ( int  iSwitchValue)

This method is used for declaring unions.

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

void UaStructureField::setValueType ( OpcUa_BuiltInType  type)

Sets the ValueType.

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

UaStructureDefinition UaStructureField::sourceType ( ) const

Returns the source type.

The source type is the supertype of the UaStructureDefinition which originally declared the field.

UaStructureDefinition UaStructureField::structureDefinition ( ) const

Returns the UaStructureDefinition of the field.

If the structure definintion has not been set, an empty UaStructureDefinition is returned.

UaStructureField UaStructureField::switchField ( ) const

This method is used for declaring unions.

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

int UaStructureField::switchValue ( ) const

This method is used for declaring unions.

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

UaNodeId UaStructureField::typeId ( ) const

Returns the DataTypeId.

OpcUa_BuiltInType UaStructureField::valueType ( ) const

Returns the ValueType.


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