C++ Based OPC UA Client/Server/PubSub SDK  1.7.4.520
UaOptionSetDefinition Class Reference

Manages the description for an OptionSet DataType. More...

#include <uaoptionsetdefinition.h>

Inherits UaAbstractDefinition.

Public Member Functions

 UaOptionSetDefinition ()
 Creates an instance.
 
 UaOptionSetDefinition (const UaOptionSetDefinition &other)
 Copies an UaOptionSetDefinition including all OptionSetValues.
 
UaOptionSetDefinitionoperator= (const UaOptionSetDefinition &other)
 Assignment operator.
 
bool operator== (const UaOptionSetDefinition &other) const
 Checks whether two UaOptionSetDefinitions are equal. More...
 
bool operator!= (const UaOptionSetDefinition &other) const
 Checks whether two UaOptionSetDefinitions are not equal. More...
 
virtual int childrenCount () const
 Returns the number of OptionSet values.
 
virtual bool isNull () const
 Checks if the OptionSetDefinition is null. More...
 
BaseType baseType () const
 Returns the base type id of the UaOptionSetDefinition. More...
 
void setBaseType (BaseType baseType)
 Sets the base type of the UaOptionSetDefinition. More...
 
UaLocalizedText child (int i) const
 Returns the OptionSet value for bit i. More...
 
void addChild (const UaLocalizedText &newChild)
 Adds an OptionSetValue. More...
 
UaLocalizedTextArray children () const
 Returns the OptionSet values. More...
 
void setChildren (const UaLocalizedTextArray &children)
 Sets all OptionSet values. 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...
 
UaEnumDefinitionDataType getEnumDefinitionDataType () const
 Returns the definition of the enumeration DataType as EnumDefinitionDataType. More...
 
- Public Member Functions inherited from UaAbstractDefinition
void setDataTypeId (const UaNodeId &nodeId)
 Sets the DataTypeId of the UaAbstractDefinition.
 
UaNodeId dataTypeId () const
 Returns the DataTypeId of the UaAbstractDefinition. More...
 
void setName (const UaString &sName)
 Sets the Name of the UaAbstractDefinition.
 
UaString name () const
 Returns the name of the UaAbstractDefinition. More...
 
void setDocumentation (const UaLocalizedText &documentation)
 Sets the Documentation of the UaAbstractDefinition.
 
UaLocalizedText documentation () const
 Returns the documentation of the UaAbstractDefinition. More...
 
void setNamespace (const UaString &sNamespace)
 Sets the Namespace of the UaAbstractDefinition.
 
UaString getNamespace () const
 Returns the NamespaceUri of the UaAbstractDefinition. More...
 

Additional Inherited Members

- Protected Member Functions inherited from UaAbstractDefinition
 UaAbstractDefinition (UaAbstractDefinitionPrivate *pBody)
 Creates an instance. More...
 

Detailed Description

Manages the description for an OptionSet DataType.

OptionSet DataTypes represent bit masks of different length in OPC UA. Simple bit masks of a length from four bytes up to 8 bytes are defines as subtypes of the OPC UA built-in DataTypes Byte, UInt16, UInt32 and UInt64. Bit mask with more than eight bytes length are represented as sub-types of the OptionSet structure DataType.

OptionSet DataTypes that are not known at compile time can be described using this class. This class can be used to add an option set DataType on server side as well as as result of reading the DataType Dictionary of a server on client side.

Member Function Documentation

void UaOptionSetDefinition::addChild ( const UaLocalizedText newChild)

Adds an OptionSetValue.

UaOptionSetDefinition::BaseType UaOptionSetDefinition::baseType ( ) const

Returns the base type id of the UaOptionSetDefinition.

UaNodeId UaOptionSetDefinition::binaryEncodingId ( ) const

Returns the Binary encoding id.

UaLocalizedText UaOptionSetDefinition::child ( int  i) const

Returns the OptionSet value for bit i.

UaLocalizedTextArray UaOptionSetDefinition::children ( ) const

Returns the OptionSet values.

UaEnumDefinitionDataType UaOptionSetDefinition::getEnumDefinitionDataType ( ) const

Returns the definition of the enumeration DataType as EnumDefinitionDataType.

bool UaOptionSetDefinition::isNull ( ) const
virtual

Checks if the OptionSetDefinition is null.

Reimplemented from UaAbstractDefinition.

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

Checks whether two UaOptionSetDefinitions are not equal.

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

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

Checks whether two UaOptionSetDefinitions are equal.

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

void UaOptionSetDefinition::setBaseType ( UaOptionSetDefinition::BaseType  baseType)

Sets the base type of the UaOptionSetDefinition.

void UaOptionSetDefinition::setBinaryEncodingId ( const UaNodeId nodeId)

Sets the Binary encoding id.

void UaOptionSetDefinition::setChildren ( const UaLocalizedTextArray children)

Sets all OptionSet values.

OptionSet values that are existing already, are discarded.

void UaOptionSetDefinition::setXmlEncodingId ( const UaNodeId nodeId)

Sets the XML encoding id.

UaNodeId UaOptionSetDefinition::xmlEncodingId ( ) const

Returns the XML encoding id.


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