OpenZWave::Internal::VC::ValueBool Class Reference

Boolean value sent to/received from a node. More...

#include <ValueBool.h>

Inheritance diagram for OpenZWave::Internal::VC::ValueBool:

Collaboration diagram for OpenZWave::Internal::VC::ValueBool:

Public Member Functions
	ValueBool (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, bool const _value, uint8 const _pollIntensity)
	ValueBool ()
virtual	~ValueBool ()
bool	Set (bool const _value)
void	OnValueRefreshed (bool const _value)
void	SetTargetValue (bool const _target, uint32 _duration=0)
virtual string const	GetAsString () const
virtual bool	SetFromString (string const &_value)
virtual void	ReadXML (uint32 const _homeId, uint8 const _nodeId, uint8 const _commandClassId, TiXmlElement const *_valueElement)
virtual void	WriteXML (TiXmlElement *_valueElement)
bool	GetValue () 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

Boolean value sent to/received from a node.

Constructor & Destructor Documentation

ValueBool() [1/2]

OpenZWave::Internal::VC::ValueBool::ValueBool	(	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,
		bool const	_value,
		uint8 const	_pollIntensity )

ValueBool() [2/2]

OpenZWave::Internal::VC::ValueBool::ValueBool ( )

inline

~ValueBool()

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

inlinevirtual

Member Function Documentation

GetAsString()

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

inlinevirtual

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

GetValue()

bool OpenZWave::Internal::VC::ValueBool::GetValue ( ) const

inline

OnValueRefreshed()

void OpenZWave::Internal::VC::ValueBool::OnValueRefreshed

(

bool const

_value

)

ReadXML()

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

virtual

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

Set()

bool OpenZWave::Internal::VC::ValueBool::Set

(

bool const

_value

)

SetFromString()

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

virtual

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

SetTargetValue()

void OpenZWave::Internal::VC::ValueBool::SetTargetValue	(	bool const	_target,
		uint32	_duration = 0 )

WriteXML()

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

virtual

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

---

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

• ValueBool.h
• ValueBool.cpp