UA Server SDK C++ Bundle  1.4.3.291
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Modules Pages
UaAbstractGenericValue Class Referenceabstract

Base class for handling values of structured DataTypes that are not known at compile time. More...

#include <uaabstractgenericvalue.h>

Inherited by UaGenericUnion, and UaGenericValue.

Public Types

enum  Encoding
 The possible encodings for a UaAbstractGenericValue. More...
 

Public Member Functions

virtual void clear ()=0
 Clears the value. More...
 
void toVariant (UaVariant &variant, Encoding valueEncoding=Encoding_Binary) const
 Serializes the UaGenericValue to the variant. More...
 
void toVariant (OpcUa_Variant &variant, Encoding valueEncoding=Encoding_Binary) const
 Serializes the UaGenericValue to the variant. More...
 
void toDataValue (UaDataValue &dataValue, OpcUa_Boolean updateTimeStamps, Encoding valueEncoding=Encoding_Binary) const
 Serializes the UaGenericValue to the dataValue. More...
 
void toDataValue (OpcUa_DataValue &dataValue, OpcUa_Boolean updateTimeStamps, Encoding valueEncoding=Encoding_Binary) const
 Serializes the UaGenericValue to the dataValue. More...
 
void toExtensionObject (UaExtensionObject &extensionObject, Encoding valueEncoding=Encoding_Binary) const
 Serializes the UaGenericValue to the extensionObject. More...
 
void toExtensionObject (OpcUa_ExtensionObject &extensionObject, Encoding valueEncoding=Encoding_Binary) const
 Serializes the UaGenericValue to the extensionObject. More...
 
virtual UaStructureDefinition definition () const =0
 Returns the UaStructureDefinition of the instance. More...
 
virtual void decode (UaAbstractDecoder *pDecoder)=0
 Deserializes the instance. More...
 
virtual void encode (UaAbstractEncoder *pEncoder) const =0
 Serializes the instance. More...
 

Protected Member Functions

UaVariant readField (UaAbstractDecoder *pDecoder, const UaStructureField &field) const
 Deserializes a field. More...
 
void writeField (UaAbstractEncoder *pEncoder, const UaStructureField &field, const UaVariant &value) const
 Serializes a field. More...
 
bool checkValue (const UaStructureField &field, const UaVariant &value) const
 Checks whether value matches the DataType and ValueRank definition of field. More...
 
UaVariant defaultValue (const UaStructureField &field) const
 Returns a value based on the DataType and the ValueRank of the field. More...
 

Detailed Description

Base class for handling values of structured DataTypes that are not known at compile time.

Member Enumeration Documentation

The possible encodings for a UaAbstractGenericValue.

Member Function Documentation

bool UaAbstractGenericValue::checkValue ( const UaStructureField field,
const UaVariant value 
) const
protected

Checks whether value matches the DataType and ValueRank definition of field.

virtual void UaAbstractGenericValue::clear ( )
pure virtual

Clears the value.

Implemented in UaGenericValue.

virtual void UaAbstractGenericValue::decode ( UaAbstractDecoder pDecoder)
pure virtual

Deserializes the instance.

Implemented in UaGenericValue.

UaVariant UaAbstractGenericValue::defaultValue ( const UaStructureField field) const
protected

Returns a value based on the DataType and the ValueRank of the field.

virtual UaStructureDefinition UaAbstractGenericValue::definition ( ) const
pure virtual

Returns the UaStructureDefinition of the instance.

Implemented in UaGenericValue.

virtual void UaAbstractGenericValue::encode ( UaAbstractEncoder pEncoder) const
pure virtual

Serializes the instance.

Implemented in UaGenericValue.

UaVariant UaAbstractGenericValue::readField ( UaAbstractDecoder pDecoder,
const UaStructureField field 
) const
protected

Deserializes a field.

void UaAbstractGenericValue::toDataValue ( UaDataValue dataValue,
OpcUa_Boolean  updateTimeStamps,
Encoding  valueEncoding = Encoding_Binary 
) const

Serializes the UaGenericValue to the dataValue.

void UaAbstractGenericValue::toDataValue ( OpcUa_DataValue &  dataValue,
OpcUa_Boolean  updateTimeStamps,
Encoding  valueEncoding = Encoding_Binary 
) const

Serializes the UaGenericValue to the dataValue.

void UaAbstractGenericValue::toExtensionObject ( UaExtensionObject extensionObject,
Encoding  valueEncoding = Encoding_Binary 
) const

Serializes the UaGenericValue to the extensionObject.

void UaAbstractGenericValue::toExtensionObject ( OpcUa_ExtensionObject &  extensionObject,
Encoding  valueEncoding = Encoding_Binary 
) const

Serializes the UaGenericValue to the extensionObject.

void UaAbstractGenericValue::toVariant ( UaVariant variant,
Encoding  valueEncoding = Encoding_Binary 
) const

Serializes the UaGenericValue to the variant.

void UaAbstractGenericValue::toVariant ( OpcUa_Variant &  variant,
Encoding  valueEncoding = Encoding_Binary 
) const

Serializes the UaGenericValue to the variant.

void UaAbstractGenericValue::writeField ( UaAbstractEncoder pEncoder,
const UaStructureField field,
const UaVariant value 
) const
protected

Serializes a field.


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