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

The class describes a structured data type. More...

#include <uastructuredefinition.h>

Public Member Functions

 UaStructureDefinition ()
 Creates an empty UaStructureDefinition. More...
 
 UaStructureDefinition (const UaStructureDefinition &other)
 Copy constructor.
 
virtual ~UaStructureDefinition ()
 Destruction.
 
bool operator== (const UaStructureDefinition &other) const
 Checks whether two UaStructureDefinitions are equal. More...
 
bool operator!= (const UaStructureDefinition &other) const
 Checks wheter two UaStructureDefinitions are not equal. More...
 
void clear ()
 Clears the UaStructureDefinition. More...
 
bool isNull () const
 Returns true if the DataType of the Structure is null. More...
 
void setDataTypeId (const UaNodeId &nodeId)
 Sets the DataType. More...
 
UaNodeId dataTypeId () const
 Returns the DataType. More...
 
void setName (const UaString &sName)
 Sets the name. More...
 
UaString name () const
 Returns the name. More...
 
void setDocumentation (const UaLocalizedText &documentation)
 Sets the documentation. More...
 
UaLocalizedText documentation () const
 Returns the documentation. More...
 
void setNamespace (const UaString &sNamespace)
 Sets the NamespaceUri. More...
 
UaString getNamespace () const
 Returns the NamespaceUri. More...
 
void setBaseType (const UaStructureDefinition &newBaseType)
 
UaNodeId baseTypeId () const
 Returns the BaseType of the the UaStructureDefinition. More...
 
UaStructureDefinition createSubtype () const
 Creates a subtype. More...
 
int childrenCount () const
 Returns the number of fields. More...
 
UaStructureField child (int i) const
 Returns the field at position i. More...
 
void addChild (const UaStructureField &newChild)
 Adds a field. More...
 
void setBinaryEncodingId (const UaNodeId &nodeId)
 Sets the Binary encoding id. More...
 
UaNodeId binaryEncodingId () const
 Returns the Binary encoding id. More...
 
void setXmlEncodingId (const UaNodeId &nodeId)
 Sets the XML encoding id. More...
 
UaNodeId xmlEncodingId () const
 Returns the XML encoding id. More...
 
void remove (const UaString &sFieldName)
 Removes the field with the name sFieldName if the field exists. More...
 
bool isUnion () const
 Returns true if UaStructureDefinition describes a Union. More...
 

Detailed Description

The class describes a structured data type.

Constructor & Destructor Documentation

UaStructureDefinition::UaStructureDefinition ( )

Creates an empty UaStructureDefinition.

Member Function Documentation

void UaStructureDefinition::addChild ( const UaStructureField newChild)

Adds a field.

UaNodeId UaStructureDefinition::baseTypeId ( ) const

Returns the BaseType of the the UaStructureDefinition.

UaNodeId UaStructureDefinition::binaryEncodingId ( ) const

Returns the Binary encoding id.

UaStructureField UaStructureDefinition::child ( int  i) const

Returns the field at position i.

int UaStructureDefinition::childrenCount ( ) const

Returns the number of fields.

void UaStructureDefinition::clear ( )

Clears the UaStructureDefinition.

UaStructureDefinition UaStructureDefinition::createSubtype ( ) const

Creates a subtype.

Adds copies for the fields.

UaNodeId UaStructureDefinition::dataTypeId ( ) const

Returns the DataType.

UaLocalizedText UaStructureDefinition::documentation ( ) const

Returns the documentation.

UaString UaStructureDefinition::getNamespace ( ) const

Returns the NamespaceUri.

bool UaStructureDefinition::isNull ( ) const

Returns true if the DataType of the Structure is null.

bool UaStructureDefinition::isUnion ( ) const

Returns true if UaStructureDefinition describes a Union.

UaString UaStructureDefinition::name ( ) const

Returns the name.

bool UaStructureDefinition::operator!= ( const UaStructureDefinition other) const

Checks wheter two UaStructureDefinitions are not equal.

If the definitions are created separately but have the same content, this method returns true.

bool UaStructureDefinition::operator== ( const UaStructureDefinition other) const

Checks whether two UaStructureDefinitions are equal.

If the definitions are created separately but have the same content, this method returns false.

void UaStructureDefinition::remove ( const UaString sFieldName)

Removes the field with the name sFieldName if the field exists.

void UaStructureDefinition::setBaseType ( const UaStructureDefinition newBaseType)

Call this method if a structure is the base type of another one. This method does not craete fields for the current UaStructureDefinition. The fields of the base type must match the first fields of the current UaStructureDefinition.

This method should be used for reading bsd files.

void UaStructureDefinition::setBinaryEncodingId ( const UaNodeId nodeId)

Sets the Binary encoding id.

void UaStructureDefinition::setDataTypeId ( const UaNodeId nodeId)

Sets the DataType.

void UaStructureDefinition::setDocumentation ( const UaLocalizedText documentation)

Sets the documentation.

void UaStructureDefinition::setName ( const UaString sName)

Sets the name.

void UaStructureDefinition::setNamespace ( const UaString sNamespace)

Sets the NamespaceUri.

void UaStructureDefinition::setXmlEncodingId ( const UaNodeId nodeId)

Sets the XML encoding id.

UaNodeId UaStructureDefinition::xmlEncodingId ( ) const

Returns the XML encoding id.


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