OpenZWave::Internal::VC::ValueSchedule Class Reference

Schedule sent to/received from a node. More...

#include <ValueSchedule.h>

Inheritance diagram for OpenZWave::Internal::VC::ValueSchedule:

Collaboration diagram for OpenZWave::Internal::VC::ValueSchedule:

Public Member Functions
	ValueSchedule (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, uint8 const _pollIntensity)
	ValueSchedule ()
virtual	~ValueSchedule ()
bool	SetSwitchPoint (uint8 const _hours, uint8 const _minutes, int8 const _setback)
bool	RemoveSwitchPoint (uint8 const _idx)
void	ClearSwitchPoints ()
bool	GetSwitchPoint (uint8 const _idx, uint8 *o_hours, uint8 *o_minutes, int8 *o_setback) const
bool	FindSwitchPoint (uint8 const _hours, uint8 const _minutes, uint8 *o_idx) const
uint8	GetNumSwitchPoints () const
bool	Set ()
void	OnValueRefreshed ()
virtual string const	GetAsString () const
virtual void	ReadXML (uint32 const _homeId, uint8 const _nodeId, uint8 const _commandClassId, TiXmlElement const *_valueElement)
virtual void	WriteXML (TiXmlElement *_valueElement)
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 ()
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 ()

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

Schedule sent to/received from a node.

Constructor & Destructor Documentation

ValueSchedule() [1/2]

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

ValueSchedule() [2/2]

OpenZWave::Internal::VC::ValueSchedule::ValueSchedule

(

)

~ValueSchedule()

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

inlinevirtual

Member Function Documentation

ClearSwitchPoints()

void OpenZWave::Internal::VC::ValueSchedule::ClearSwitchPoints ( )

inline

FindSwitchPoint()

bool OpenZWave::Internal::VC::ValueSchedule::FindSwitchPoint	(	uint8 const	_hours,
		uint8 const	_minutes,
		uint8 *	o_idx ) const

GetAsString()

std::string const OpenZWave::Internal::VC::ValueSchedule::GetAsString ( ) const

virtual

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

GetNumSwitchPoints()

uint8 OpenZWave::Internal::VC::ValueSchedule::GetNumSwitchPoints ( ) const

inline

GetSwitchPoint()

bool OpenZWave::Internal::VC::ValueSchedule::GetSwitchPoint	(	uint8 const	_idx,
		uint8 *	o_hours,
		uint8 *	o_minutes,
		int8 *	o_setback ) const

OnValueRefreshed()

void OpenZWave::Internal::VC::ValueSchedule::OnValueRefreshed

(

)

ReadXML()

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

virtual

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

RemoveSwitchPoint()

bool OpenZWave::Internal::VC::ValueSchedule::RemoveSwitchPoint

(

uint8 const

_idx

)

Set()

bool OpenZWave::Internal::VC::ValueSchedule::Set

(

)

SetSwitchPoint()

bool OpenZWave::Internal::VC::ValueSchedule::SetSwitchPoint	(	uint8 const	_hours,
		uint8 const	_minutes,
		int8 const	_setback )

WriteXML()

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

virtual

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

---

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

• ValueSchedule.h
• ValueSchedule.cpp