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

◆ Value() [1/2]

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
	)

◆ Value() [2/2]

OpenZWave::Internal::VC::Value::Value ( )

◆ ~Value()

OpenZWave::Internal::VC::Value::~Value ( )

protectedvirtual

Member Function Documentation

◆ CheckTargetValue()

int OpenZWave::Internal::VC::Value::CheckTargetValue	(	void *	_newValue,
		void *	_targetValue,
		ValueID::ValueType	_type,
		int	_newValueLength,
		int	_targetValueLength
	)

protected

◆ GetAsString()

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.

◆ GetChangeVerified()

bool OpenZWave::Internal::VC::Value::GetChangeVerified ( )

inline

◆ GetGenreEnumFromName()

OpenZWave::ValueID::ValueGenre OpenZWave::Internal::VC::Value::GetGenreEnumFromName ( char const * _name )

static

◆ GetGenreNameFromEnum()

char const * OpenZWave::Internal::VC::Value::GetGenreNameFromEnum ( ValueID::ValueGenre _genre )

static

◆ GetHelp()

std::string const OpenZWave::Internal::VC::Value::GetHelp ( ) const

◆ GetID()

ValueID const& OpenZWave::Internal::VC::Value::GetID ( ) const

inline

◆ GetLabel()

std::string const OpenZWave::Internal::VC::Value::GetLabel ( ) const

◆ GetMax()

int32 OpenZWave::Internal::VC::Value::GetMax ( ) const

inline

◆ GetMin()

int32 OpenZWave::Internal::VC::Value::GetMin ( ) const

inline

◆ GetPollIntensity()

uint8 const& OpenZWave::Internal::VC::Value::GetPollIntensity ( ) const

inline

◆ GetRefreshAfterSet()

bool OpenZWave::Internal::VC::Value::GetRefreshAfterSet ( )

inline

◆ GetTypeEnumFromName()

OpenZWave::ValueID::ValueType OpenZWave::Internal::VC::Value::GetTypeEnumFromName ( char const * _name )

static

◆ GetTypeNameFromEnum()

char const * OpenZWave::Internal::VC::Value::GetTypeNameFromEnum ( ValueID::ValueType _type )

static

◆ GetUnits()

string const& OpenZWave::Internal::VC::Value::GetUnits ( ) const

inline

◆ IsCheckingChange()

bool OpenZWave::Internal::VC::Value::IsCheckingChange ( ) const

inlineprotected

◆ IsPolled()

bool OpenZWave::Internal::VC::Value::IsPolled ( ) const

inline

◆ IsReadOnly()

bool OpenZWave::Internal::VC::Value::IsReadOnly ( ) const

inline

◆ IsSet()

bool OpenZWave::Internal::VC::Value::IsSet ( ) const

inline

◆ IsTargetValueSet()

bool OpenZWave::Internal::VC::Value::IsTargetValueSet ( ) const

inlineprotected

◆ IsWriteOnly()

bool OpenZWave::Internal::VC::Value::IsWriteOnly ( ) const

inline

◆ OnValueChanged()

void OpenZWave::Internal::VC::Value::OnValueChanged ( )

protected

◆ OnValueRefreshed()

void OpenZWave::Internal::VC::Value::OnValueRefreshed ( )

protected

◆ ReadXML()

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.

◆ sendValueRefresh()

void OpenZWave::Internal::VC::Value::sendValueRefresh ( uint32 _unused )

◆ Set()

bool OpenZWave::Internal::VC::Value::Set ( )

◆ SetChangeVerified()

void OpenZWave::Internal::VC::Value::SetChangeVerified ( bool _verify )

inline

◆ SetCheckingChange()

void OpenZWave::Internal::VC::Value::SetCheckingChange ( bool _check )

inlineprotected

◆ SetFromString()

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.

◆ SetHelp()

void OpenZWave::Internal::VC::Value::SetHelp	(	string const &	_help,
		string const	lang = `""`
	)

◆ SetLabel()

void OpenZWave::Internal::VC::Value::SetLabel	(	string const &	_label,
		string const	lang = `""`
	)

◆ SetPollIntensity()

void OpenZWave::Internal::VC::Value::SetPollIntensity ( uint8 const & _intensity )

inline

◆ SetRefreshAfterSet()

void OpenZWave::Internal::VC::Value::SetRefreshAfterSet ( bool _refreshAfterSet )

inline

◆ SetUnits()

void OpenZWave::Internal::VC::Value::SetUnits ( string const & _units )

inline

◆ VerifyRefreshedValue()

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

◆ WriteXML()

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

◆ OpenZWave::Driver

friend class OpenZWave::Driver

friend

◆ ValueStore

friend class ValueStore

friend

Member Data Documentation

◆ m_duration

uint32 OpenZWave::Internal::VC::Value::m_duration

protected

◆ m_id

ValueID OpenZWave::Internal::VC::Value::m_id

protected

◆ m_max

int32 OpenZWave::Internal::VC::Value::m_max

protected

◆ m_min

int32 OpenZWave::Internal::VC::Value::m_min

protected

◆ m_refreshAfterSet

bool OpenZWave::Internal::VC::Value::m_refreshAfterSet

protected

◆ m_refreshTime

time_t OpenZWave::Internal::VC::Value::m_refreshTime

protected

◆ m_targetValueSet

bool OpenZWave::Internal::VC::Value::m_targetValueSet

protected

◆ m_verifyChanges

bool OpenZWave::Internal::VC::Value::m_verifyChanges

protected

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

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

◆ Value() [1/2]

◆ Value() [2/2]

◆ ~Value()

Member Function Documentation

◆ CheckTargetValue()

◆ GetAsString()

◆ GetChangeVerified()

◆ GetGenreEnumFromName()

◆ GetGenreNameFromEnum()

◆ GetHelp()

◆ GetID()

◆ GetLabel()

◆ GetMax()

◆ GetMin()

◆ GetPollIntensity()

◆ GetRefreshAfterSet()

◆ GetTypeEnumFromName()

◆ GetTypeNameFromEnum()

◆ GetUnits()

◆ IsCheckingChange()

◆ IsPolled()

◆ IsReadOnly()

◆ IsSet()

◆ IsTargetValueSet()

◆ IsWriteOnly()

◆ OnValueChanged()

◆ OnValueRefreshed()

◆ ReadXML()

◆ sendValueRefresh()

◆ Set()

◆ SetChangeVerified()

◆ SetCheckingChange()

◆ SetFromString()

◆ SetHelp()

◆ SetLabel()

◆ SetPollIntensity()

◆ SetRefreshAfterSet()

◆ SetUnits()

◆ VerifyRefreshedValue()

◆ WriteXML()

Friends And Related Function Documentation

◆ OpenZWave::Driver

◆ ValueStore

Member Data Documentation

◆ m_duration

◆ m_id

◆ m_max

◆ m_min

◆ m_refreshAfterSet

◆ m_refreshTime

◆ m_targetValueSet

◆ m_verifyChanges