OpenZWave Library  1.6.1914
Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | Friends | List of all members
OpenZWave::Internal::VC::Value Class Reference
ValueID Support

Base class for values associated with a node. More...

#include <Value.h>

+ Inheritance diagram for OpenZWave::Internal::VC::Value:
+ Collaboration diagram for OpenZWave::Internal::VC::Value:

Public Member Functions

 Value (uint32 const _homeId, uint8 const _nodeId, ValueID::ValueGenre const _genre, uint8 const _commandClassId, uint8 const _instance, uint16 const _index, ValueID::ValueType const _type, string const &_label, string const &_units, bool const _readOnly, bool const _writeOnly, bool const _isset, uint8 const _pollIntensity)
 
 Value ()
 
virtual void ReadXML (uint32 const _homeId, uint8 const _nodeId, uint8 const _commandClassId, TiXmlElement const *_valueElement)
 
virtual void WriteXML (TiXmlElement *_valueElement)
 
ValueID const & GetID () const
 
bool IsReadOnly () const
 
bool IsWriteOnly () const
 
bool IsSet () const
 
bool IsPolled () const
 
string const GetLabel () const
 
void SetLabel (string const &_label, string const lang="")
 
string const & GetUnits () const
 
void SetUnits (string const &_units)
 
string const GetHelp () const
 
void SetHelp (string const &_help, string const lang="")
 
uint8 const & GetPollIntensity () const
 
void SetPollIntensity (uint8 const &_intensity)
 
int32 GetMin () const
 
int32 GetMax () const
 
void SetChangeVerified (bool _verify)
 
bool GetChangeVerified ()
 
void SetRefreshAfterSet (bool _refreshAfterSet)
 
bool GetRefreshAfterSet ()
 
virtual string const GetAsString () const
 
virtual bool SetFromString (string const &)
 
bool Set ()
 
void sendValueRefresh (uint32 _unused)
 
- Public Member Functions inherited from OpenZWave::Internal::Platform::Ref
 Ref ()
 
void AddRef ()
 
int32 Release ()
 

Static Public Member Functions

static OpenZWave::ValueID::ValueGenre GetGenreEnumFromName (char const *_name)
 
static char const * GetGenreNameFromEnum (ValueID::ValueGenre _genre)
 
static OpenZWave::ValueID::ValueType GetTypeEnumFromName (char const *_name)
 
static char const * GetTypeNameFromEnum (ValueID::ValueType _type)
 

Protected Member Functions

virtual ~Value ()
 
bool IsCheckingChange () const
 
void SetCheckingChange (bool _check)
 
bool IsTargetValueSet () const
 
void OnValueRefreshed ()
 
void OnValueChanged ()
 
int VerifyRefreshedValue (void *_originalValue, void *_checkValue, void *_newValue, void *_targetValue, ValueID::ValueType _type, int _originalValueLength=0, int _checkValueLength=0, int _newValueLength=0, int _targetValueLength=0)
 
int CheckTargetValue (void *_newValue, void *_targetValue, ValueID::ValueType _type, int _newValueLength, int _targetValueLength)
 
- Protected Member Functions inherited from OpenZWave::Internal::Platform::Ref
virtual ~Ref ()
 

Protected Attributes

int32 m_min
 
int32 m_max
 
time_t m_refreshTime
 
bool m_verifyChanges
 
bool m_refreshAfterSet
 
ValueID m_id
 
bool m_targetValueSet
 
uint32 m_duration
 

Friends

class OpenZWave::Driver
 
class ValueStore
 

Detailed Description

Base class for values associated with a node.

Constructor & Destructor Documentation

OpenZWave::Internal::VC::Value::Value ( uint32 const  _homeId,
uint8 const  _nodeId,
ValueID::ValueGenre const  _genre,
uint8 const  _commandClassId,
uint8 const  _instance,
uint16 const  _index,
ValueID::ValueType const  _type,
string const &  _label,
string const &  _units,
bool const  _readOnly,
bool const  _writeOnly,
bool const  _isset,
uint8 const  _pollIntensity 
)
OpenZWave::Internal::VC::Value::Value ( )
OpenZWave::Internal::VC::Value::~Value ( )
protectedvirtual

Member Function Documentation

int OpenZWave::Internal::VC::Value::CheckTargetValue ( void *  _newValue,
void *  _targetValue,
ValueID::ValueType  _type,
int  _newValueLength,
int  _targetValueLength 
)
protected
virtual string const OpenZWave::Internal::VC::Value::GetAsString ( ) const
inlinevirtual

Reimplemented in OpenZWave::Internal::VC::ValueBitSet, OpenZWave::Internal::VC::ValueSchedule, OpenZWave::Internal::VC::ValueList, OpenZWave::Internal::VC::ValueDecimal, OpenZWave::Internal::VC::ValueBool, OpenZWave::Internal::VC::ValueString, OpenZWave::Internal::VC::ValueButton, OpenZWave::Internal::VC::ValueInt, OpenZWave::Internal::VC::ValueByte, OpenZWave::Internal::VC::ValueShort, and OpenZWave::Internal::VC::ValueRaw.

bool OpenZWave::Internal::VC::Value::GetChangeVerified ( )
inline
OpenZWave::ValueID::ValueGenre OpenZWave::Internal::VC::Value::GetGenreEnumFromName ( char const *  _name)
static
char const * OpenZWave::Internal::VC::Value::GetGenreNameFromEnum ( ValueID::ValueGenre  _genre)
static
std::string const OpenZWave::Internal::VC::Value::GetHelp ( ) const
ValueID const& OpenZWave::Internal::VC::Value::GetID ( ) const
inline
std::string const OpenZWave::Internal::VC::Value::GetLabel ( ) const
int32 OpenZWave::Internal::VC::Value::GetMax ( ) const
inline
int32 OpenZWave::Internal::VC::Value::GetMin ( ) const
inline
uint8 const& OpenZWave::Internal::VC::Value::GetPollIntensity ( ) const
inline
bool OpenZWave::Internal::VC::Value::GetRefreshAfterSet ( )
inline
OpenZWave::ValueID::ValueType OpenZWave::Internal::VC::Value::GetTypeEnumFromName ( char const *  _name)
static
char const * OpenZWave::Internal::VC::Value::GetTypeNameFromEnum ( ValueID::ValueType  _type)
static
string const& OpenZWave::Internal::VC::Value::GetUnits ( ) const
inline
bool OpenZWave::Internal::VC::Value::IsCheckingChange ( ) const
inlineprotected
bool OpenZWave::Internal::VC::Value::IsPolled ( ) const
inline
bool OpenZWave::Internal::VC::Value::IsReadOnly ( ) const
inline
bool OpenZWave::Internal::VC::Value::IsSet ( ) const
inline
bool OpenZWave::Internal::VC::Value::IsTargetValueSet ( ) const
inlineprotected
bool OpenZWave::Internal::VC::Value::IsWriteOnly ( ) const
inline
void OpenZWave::Internal::VC::Value::OnValueChanged ( )
protected
void OpenZWave::Internal::VC::Value::OnValueRefreshed ( )
protected
void OpenZWave::Internal::VC::Value::ReadXML ( uint32 const  _homeId,
uint8 const  _nodeId,
uint8 const  _commandClassId,
TiXmlElement const *  _valueElement 
)
virtual

Reimplemented in OpenZWave::Internal::VC::ValueList, OpenZWave::Internal::VC::ValueBitSet, OpenZWave::Internal::VC::ValueSchedule, OpenZWave::Internal::VC::ValueDecimal, OpenZWave::Internal::VC::ValueString, OpenZWave::Internal::VC::ValueBool, OpenZWave::Internal::VC::ValueButton, OpenZWave::Internal::VC::ValueInt, OpenZWave::Internal::VC::ValueByte, OpenZWave::Internal::VC::ValueShort, and OpenZWave::Internal::VC::ValueRaw.

void OpenZWave::Internal::VC::Value::sendValueRefresh ( uint32  _unused)
bool OpenZWave::Internal::VC::Value::Set ( )
void OpenZWave::Internal::VC::Value::SetChangeVerified ( bool  _verify)
inline
void OpenZWave::Internal::VC::Value::SetCheckingChange ( bool  _check)
inlineprotected
virtual bool OpenZWave::Internal::VC::Value::SetFromString ( string const &  )
inlinevirtual

Reimplemented in OpenZWave::Internal::VC::ValueBitSet, OpenZWave::Internal::VC::ValueList, OpenZWave::Internal::VC::ValueDecimal, OpenZWave::Internal::VC::ValueBool, OpenZWave::Internal::VC::ValueString, OpenZWave::Internal::VC::ValueInt, OpenZWave::Internal::VC::ValueByte, OpenZWave::Internal::VC::ValueShort, and OpenZWave::Internal::VC::ValueRaw.

void OpenZWave::Internal::VC::Value::SetHelp ( string const &  _help,
string const  lang = "" 
)
void OpenZWave::Internal::VC::Value::SetLabel ( string const &  _label,
string const  lang = "" 
)
void OpenZWave::Internal::VC::Value::SetPollIntensity ( uint8 const &  _intensity)
inline
void OpenZWave::Internal::VC::Value::SetRefreshAfterSet ( bool  _refreshAfterSet)
inline
void OpenZWave::Internal::VC::Value::SetUnits ( string const &  _units)
inline
int OpenZWave::Internal::VC::Value::VerifyRefreshedValue ( void *  _originalValue,
void *  _checkValue,
void *  _newValue,
void *  _targetValue,
ValueID::ValueType  _type,
int  _originalValueLength = 0,
int  _checkValueLength = 0,
int  _newValueLength = 0,
int  _targetValueLength = 0 
)
protected
void OpenZWave::Internal::VC::Value::WriteXML ( TiXmlElement *  _valueElement)
virtual

Reimplemented in OpenZWave::Internal::VC::ValueList, OpenZWave::Internal::VC::ValueBitSet, OpenZWave::Internal::VC::ValueSchedule, OpenZWave::Internal::VC::ValueDecimal, OpenZWave::Internal::VC::ValueString, OpenZWave::Internal::VC::ValueBool, OpenZWave::Internal::VC::ValueButton, OpenZWave::Internal::VC::ValueInt, OpenZWave::Internal::VC::ValueByte, OpenZWave::Internal::VC::ValueShort, and OpenZWave::Internal::VC::ValueRaw.

Friends And Related Function Documentation

friend class OpenZWave::Driver
friend
friend class ValueStore
friend

Member Data Documentation

uint32 OpenZWave::Internal::VC::Value::m_duration
protected
ValueID OpenZWave::Internal::VC::Value::m_id
protected
int32 OpenZWave::Internal::VC::Value::m_max
protected
int32 OpenZWave::Internal::VC::Value::m_min
protected
bool OpenZWave::Internal::VC::Value::m_refreshAfterSet
protected
time_t OpenZWave::Internal::VC::Value::m_refreshTime
protected
bool OpenZWave::Internal::VC::Value::m_targetValueSet
protected
bool OpenZWave::Internal::VC::Value::m_verifyChanges
protected
The documentation for this class was generated from the following files:
Generated on Tue Jan 24 2023 14:46:20 for OpenZWave Library by   doxygen 1.8.10