UaVariable Class Reference
[Core Module Address Model Classes]
Class definition of the UaVariable. Derived from UaNode Get all information about UaVariables and their references.
More...
#include <uabasenodes.h>
Public Member Functions | |
| UaVariable () | |
| virtual UaDataValue | value (Session *pSession)=0 |
| virtual UaStatus | setValue (Session *pSession, UaDataValue &dataValue, OpcUa_Boolean checkAccessLevel=OpcUa_True)=0 |
| virtual UaNodeId | dataType () const =0 |
| virtual OpcUa_Int32 | valueRank () const =0 |
| virtual OpcUa_Boolean | isArrayDimensionsSupported () const =0 |
| virtual void | arrayDimensions (UaUInt32Array &arrayDimensions) const =0 |
| virtual OpcUa_Byte | accessLevel () const =0 |
| virtual OpcUa_Byte | userAccessLevel (Session *pSession) const =0 |
| virtual OpcUa_Boolean | isMinimumSamplingIntervalSupported () const =0 |
| virtual OpcUa_Double | minimumSamplingInterval () const =0 |
| virtual OpcUa_Boolean | historizing () const =0 |
| virtual OpcUa_UInt32 | valueHandling () const |
| virtual VariableHandle * | pVariableHandle () |
| OpcUa_NodeClass | nodeClass () const |
Protected Member Functions | |
| virtual | ~UaVariable () |
Detailed Description
Class definition of the UaVariable. Derived from UaNode Get all information about UaVariables and their references.Constructor & Destructor Documentation
| virtual UaVariable::~UaVariable | ( | ) | [inline, protected, virtual] |
destruction
| UaVariable::UaVariable | ( | ) | [inline] |
construction
Member Function Documentation
| virtual UaDataValue UaVariable::value | ( | Session * | pSession | ) | [pure virtual] |
Sets the current value for the DataVariable.
- Parameters:
-
pSession Interface to the Session context for the method call
- Returns:
- the current value for the DataVariable.
Implemented in UaDataVariableCache, UaPropertyMethodArgument, UaDataVariableCacheEx, UaGenericVariable, and UaDataVariableDevice.
| virtual UaStatus UaVariable::setValue | ( | Session * | pSession, | |
| UaDataValue & | dataValue, | |||
| OpcUa_Boolean | checkAccessLevel = OpcUa_True | |||
| ) | [pure virtual] |
Sets the current value for the DataVariable.
- Parameters:
-
pSession Interface to the Session context for the method call dataValue Cached value of the DataVariable. checkAccessLevel checks the Access Level of the current Session.
- Returns:
- Error code
Implemented in UaDataVariableCache, UaPropertyMethodArgument, UaDataVariableCacheEx, UaGenericVariable, and UaDataVariableDevice.
| virtual UaNodeId UaVariable::dataType | ( | ) | const [pure virtual] |
Get the DataType for the DataVariable.
- Returns:
- the DataType for the DataVariable.
Implemented in UaDataVariableCache, UaPropertyMethodArgument, UaDataVariableCacheEx, UaGenericVariable, and UaDataVariableDevice.
| virtual OpcUa_Int32 UaVariable::valueRank | ( | ) | const [pure virtual] |
Get the ValueRank for the DataVariable.
- Returns:
- the ValueRank for the DataVariable.
Implemented in UaDataVariableCache, UaPropertyMethodArgument, UaDataVariableCacheEx, UaGenericVariable, and UaDataVariableDevice.
| virtual OpcUa_Boolean UaVariable::isArrayDimensionsSupported | ( | ) | const [pure virtual] |
Check if the Node is ArrayDimensionsSupported.
- Returns:
- FALSE if not supported.
Implemented in UaDataVariableCache, UaPropertyMethodArgument, UaDataVariableCacheEx, UaGenericVariable, and UaDataVariableDevice.
| virtual void UaVariable::arrayDimensions | ( | UaUInt32Array & | arrayDimensions | ) | const [pure virtual] |
Get the arrayDimensions value for the passed UaNode.
- Parameters:
-
arrayDimensions the arrayDimensions value for the passed UaNode.
Implemented in UaDataVariableCache, UaPropertyMethodArgument, UaDataVariableCacheEx, UaGenericVariable, and UaDataVariableDevice.
| virtual OpcUa_Byte UaVariable::accessLevel | ( | ) | const [pure virtual] |
Get the AccessLevel for the DataVariable.
- Returns:
- the AccessLevel for the DataVariable.
Implemented in UaDataVariableCache, UaPropertyMethodArgument, UaDataVariableCacheEx, UaGenericVariable, and UaDataVariableDevice.
| virtual OpcUa_Byte UaVariable::userAccessLevel | ( | Session * | pSession | ) | const [pure virtual] |
Get the UserAccessLevel for the DataVariable.
- Parameters:
-
pSession Interface to the Session context for the method call
- Returns:
- the UserAccessLevel for the DataVariable.
Implemented in UaDataVariableCache, UaPropertyMethodArgument, UaDataVariableCacheEx, UaGenericVariable, and UaDataVariableDevice.
| virtual OpcUa_Boolean UaVariable::isMinimumSamplingIntervalSupported | ( | ) | const [pure virtual] |
Check wether a minimum sampling interval is supported.
- Returns:
- TRUE if supported FALSE if not.
Implemented in UaDataVariableCache, UaPropertyMethodArgument, UaDataVariableCacheEx, UaGenericVariable, and UaDataVariableDevice.
| virtual OpcUa_Double UaVariable::minimumSamplingInterval | ( | ) | const [pure virtual] |
Get the minimum sampling interval of the Node.
- Returns:
- the minimum sampling interval.
Implemented in UaDataVariableCache, UaPropertyMethodArgument, UaDataVariableCacheEx, UaGenericVariable, and UaDataVariableDevice.
| virtual OpcUa_Boolean UaVariable::historizing | ( | ) | const [pure virtual] |
Indicates if historizing is available or not.
- Returns:
- TRUE if historizing is available FALSE if not.
Implemented in UaDataVariableCache, UaPropertyMethodArgument, UaDataVariableCacheEx, UaGenericVariable, and UaDataVariableDevice.
| virtual OpcUa_UInt32 UaVariable::valueHandling | ( | ) | const [inline, virtual] |
Get the handling of a Value (UaVariable_Value_Cache or UaVariable_Value_CacheIsSource).
- Returns:
- the handling of a Value.
Reimplemented in UaDataVariableDevice.
| virtual VariableHandle* UaVariable::pVariableHandle | ( | ) | [inline, virtual] |
Return the VariableHandle for the Value Attribute of the UaVariable. Needs to be implemented by the derived class if the creation of the VariableHandle should be optiomize by keeping a created variable handle in memory.
- Returns:
- the VariableHandle for the Value Attribute of the UaVariable.
Reimplemented in UaVariableCache.
| OpcUa_NodeClass UaVariable::nodeClass | ( | ) | const [inline, virtual] |
Get the Nodeclass of the current Node.
- Returns:
- the Nodeclass of the current Node.
Implements UaNode.
Reimplemented in UaGenericVariable.
The documentation for this class was generated from the following file:
- src/uaserver/uaservercpp/coremodule/uabasenodes.h
