OpenZWave::Internal::VC::ValueList Class Reference

List of values sent to/received from a node. More...

#include <ValueList.h>

Inheritance diagram for OpenZWave::Internal::VC::ValueList:

Collaboration diagram for OpenZWave::Internal::VC::ValueList:

Classes
struct	Item
	An item (element) in the list of values. More...

Public Member Functions
	ValueList (uint32 const _homeId, uint8 const _nodeId, ValueID::ValueGenre const _genre, uint8 const _commandClassId, uint8 const _instance, uint16 const _index, string const &_label, string const &_units, bool const _readOnly, bool const _writeOnly, vector< Item > const &_items, int32 const _valueIdx, uint8 const _pollIntensity, uint8 const _size=4)
	ValueList ()
virtual	~ValueList ()
bool	SetByLabel (string const &_label)
bool	SetByValue (int32 const _value)
void	OnValueRefreshed (int32 const _valueIdx)
virtual string const	GetAsString () const
virtual bool	SetFromString (string const &_value)
void	SetTargetValue (int32 const _target, uint32 _duration=0)
virtual void	ReadXML (uint32 const _homeId, uint8 const _nodeId, uint8 const _commandClassId, TiXmlElement const *_valueElement)
virtual void	WriteXML (TiXmlElement *_valueElement)
Item const *	GetItem () const
int32	GetItemIdxByLabel (string const &_label) const
int32	GetItemIdxByValue (int32 const _value) const
bool	GetItemLabels (vector< string > *o_items)
bool	GetItemValues (vector< int32 > *o_values)
uint8	GetSize () const
Public Member Functions inherited from 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 ()
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 ()
bool	Set ()
void	sendValueRefresh (uint32 _unused)
Public Member Functions inherited from OpenZWave::Internal::Platform::Ref
	Ref ()
void	AddRef ()
int32	Release ()

Additional Inherited Members
Static Public Member Functions inherited from OpenZWave::Internal::VC::Value
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 inherited from OpenZWave::Internal::VC::Value
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 inherited from OpenZWave::Internal::VC::Value
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

Detailed Description

List of values sent to/received from a node.

Constructor & Destructor Documentation

ValueList() [1/2]

OpenZWave::Internal::VC::ValueList::ValueList	(	uint32 const	_homeId,
		uint8 const	_nodeId,
		ValueID::ValueGenre const	_genre,
		uint8 const	_commandClassId,
		uint8 const	_instance,
		uint16 const	_index,
		string const &	_label,
		string const &	_units,
		bool const	_readOnly,
		bool const	_writeOnly,
		vector< Item > const &	_items,
		int32 const	_valueIdx,
		uint8 const	_pollIntensity,
		uint8 const	_size = 4 )

ValueList() [2/2]

OpenZWave::Internal::VC::ValueList::ValueList

(

)

~ValueList()

virtual OpenZWave::Internal::VC::ValueList::~ValueList ( )

inlinevirtual

Member Function Documentation

GetAsString()

virtual string const OpenZWave::Internal::VC::ValueList::GetAsString ( ) const

inlinevirtual

Reimplemented from OpenZWave::Internal::VC::Value.

GetItem()

ValueList::Item const * OpenZWave::Internal::VC::ValueList::GetItem

(

)

const

GetItemIdxByLabel()

int32 OpenZWave::Internal::VC::ValueList::GetItemIdxByLabel

(

string const &

_label

)

const

GetItemIdxByValue()

int32 OpenZWave::Internal::VC::ValueList::GetItemIdxByValue

(

int32 const

_value

)

const

GetItemLabels()

bool OpenZWave::Internal::VC::ValueList::GetItemLabels

(

vector< string > *

o_items

)

GetItemValues()

bool OpenZWave::Internal::VC::ValueList::GetItemValues

(

vector< int32 > *

o_values

)

GetSize()

uint8 OpenZWave::Internal::VC::ValueList::GetSize ( ) const

inline

OnValueRefreshed()

void OpenZWave::Internal::VC::ValueList::OnValueRefreshed

(

int32 const

_valueIdx

)

ReadXML()

void OpenZWave::Internal::VC::ValueList::ReadXML ( uint32 const _homeId, uint8 const _nodeId, uint8 const _commandClassId, TiXmlElement const * _valueElement )

virtual

Reimplemented from OpenZWave::Internal::VC::Value.

SetByLabel()

bool OpenZWave::Internal::VC::ValueList::SetByLabel

(

string const &

_label

)

SetByValue()

bool OpenZWave::Internal::VC::ValueList::SetByValue

(

int32 const

_value

)

SetFromString()

virtual bool OpenZWave::Internal::VC::ValueList::SetFromString ( string const & _value )

inlinevirtual

Reimplemented from OpenZWave::Internal::VC::Value.

SetTargetValue()

void OpenZWave::Internal::VC::ValueList::SetTargetValue	(	int32 const	_target,
		uint32	_duration = 0 )

WriteXML()

void OpenZWave::Internal::VC::ValueList::WriteXML ( TiXmlElement * _valueElement )

virtual

Reimplemented from OpenZWave::Internal::VC::Value.

---

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

• ValueList.h
• ValueList.cpp