C++ Based OPC UA Client/Server SDK  1.5.5.355
UserDataVariableGetValue Class Referenceabstract

Specialized UserData class for UaVariable where the UserData class provides a capability to get the current value. More...

#include <userdatabase.h>

Inherits UserDataBase.

Inherited by ServerDiagnosticsSummaryUserDataGetCounter, SubscriptionDiagnosticsArrayUserDataGetValue, SubscriptionDiagnosticsUserDataGetValue, UaVariableNs1UserDataGetCounter, UserDataGetCounterBoolean, UserDataGetCounterByte, UserDataGetCounterDouble, UserDataGetCounterNodeId, UserDataGetCounterUInt32, and UserDataServerStatus.

Public Member Functions

 UserDataVariableGetValue ()
 Creates an object of the type UserDataVariableGetValue. More...
 
virtual ~UserDataVariableGetValue ()
 Destroys the UserDataVariableGetValue object. More...
 
UserDataType getUserDataType () const
 Returns UserDataType_GetValue as UserDataType for the class UserDataVariableGetValue.
 
virtual void getDataValue (UaDataValue &dataValue) const
 Default implementation for getting the value as DataValue. More...
 
virtual OpcUa_StatusCode setDataValue (const UaDataValue &dataValue)
 Default implementation for setting the value. More...
 
- Public Member Functions inherited from UserDataBase
 UserDataBase ()
 Creates an object of the type UserDataBase. More...
 
virtual ~UserDataBase ()
 Destroys the UserDataBase object. More...
 
virtual void setInvalid ()
 This method is called by the SDK when the owning object of the user data was invalidated. More...
 

Additional Inherited Members

- Public Types inherited from UserDataBase
enum  UserDataType { UserDataType_Custom, UserDataType_GetValue }
 Enumeration used to detect the type of user data for further processing. More...
 

Detailed Description

Specialized UserData class for UaVariable where the UserData class provides a capability to get the current value.

This class and the derived classes are used for instances of the UaVariable where polling access through NodeManagerUaNode::readValues is used for variables. This is usefull where the data of the underlying system is available in memory but data changes are not reported through events. In this case the functionality of UaDataVariableCache can not be used but the current value can be provided for generic polling through this user data class.

Constructor & Destructor Documentation

UserDataVariableGetValue::UserDataVariableGetValue ( )

Creates an object of the type UserDataVariableGetValue.

UserDataVariableGetValue::~UserDataVariableGetValue ( )
virtual

Destroys the UserDataVariableGetValue object.

Member Function Documentation

void UserDataVariableGetValue::getDataValue ( UaDataValue dataValue) const
virtual

Default implementation for getting the value as DataValue.

The default implementation is using getValue(). An implementation class can overwrite this method and return the DataValue directly

Reimplemented in UserDataGetCounterNodeId, UserDataGetCounterBoolean, UserDataGetCounterDouble, UserDataGetCounterByte, UserDataGetCounterUInt32, and UaVariableNs1UserDataGetCounter.

OpcUa_StatusCode UserDataVariableGetValue::setDataValue ( const UaDataValue dataValue)
virtual

Default implementation for setting the value.

The default implementation return BadNotWritable


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