OpenZWave Library  1.6.734
Classes | Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
OpenZWave::CommandClass Class Referenceabstract

Base class for all Z-Wave command classes. More...

#include <CommandClass.h>

+ Inheritance diagram for OpenZWave::CommandClass:
+ Collaboration diagram for OpenZWave::CommandClass:

Classes

struct  RefreshValue
 

Public Types

enum  { RequestFlag_Static = 0x00000001, RequestFlag_Session = 0x00000002, RequestFlag_Dynamic = 0x00000004, RequestFlag_AfterMark = 0x00000008 }
 
enum  StaticRequest { StaticRequest_Instances = 0x01, StaticRequest_Values = 0x02, StaticRequest_Version = 0x04 }
 
typedef struct OpenZWave::CommandClass::RefreshValue RefreshValue
 

Public Member Functions

 CommandClass (uint32 const _homeId, uint8 const _nodeId)
 
virtual ~CommandClass ()
 
virtual void ReadXML (TiXmlElement const *_ccElement)
 
virtual void WriteXML (TiXmlElement *_ccElement)
 
virtual bool RequestState (uint32 const _requestFlags, uint8 const _instance, Driver::MsgQueue const _queue)
 
virtual bool RequestValue (uint32 const _requestFlags, uint16 const _index, uint8 const _instance, Driver::MsgQueue const _queue)
 
virtual void refreshValuesOnWakeup ()
 
virtual uint8 const GetCommandClassId () const =0
 
virtual string const GetCommandClassName () const =0
 
string const GetCommandClassLabel ()
 
void SetCommandClassLabel (string label)
 
virtual bool HandleMsg (uint8 const *_data, uint32 const _length, uint32 const _instance=1)=0
 
virtual bool HandleIncomingMsg (uint8 const *_data, uint32 const _length, uint32 const _instance=1)
 
virtual bool SetValue (Value const &_value)
 
virtual void SetValueBasic (uint8 const _instance, uint8 const _level)
 
virtual void SetVersion (uint8 const _version)
 
bool RequestStateForAllInstances (uint32 const _requestFlags, Driver::MsgQueue const _queue)
 
bool CheckForRefreshValues (Value const *_value)
 
virtual uint8 GetMaxVersion ()
 
uint8 GetVersion () const
 
Bitfield const * GetInstances () const
 
uint32 GetHomeId () const
 
uint8 GetNodeId () const
 
DriverGetDriver () const
 
NodeGetNodeUnsafe () const
 
ValueGetValue (uint8 const _instance, uint16 const _index)
 
bool RemoveValue (uint8 const _instance, uint16 const _index)
 
uint8 GetEndPoint (uint8 const _instance)
 
uint8 GetInstance (uint8 const _endPoint)
 
void SetInstances (uint8 const _instances)
 
void SetInstance (uint8 const _endPoint)
 
virtual void SetInstanceLabel (uint8 const _instance, char *label)
 
string GetInstanceLabel (uint8 const _instance)
 
uint8 GetNumInstances ()
 
void SetAfterMark ()
 
void SetEndPoint (uint8 const _instance, uint8 const _endpoint)
 
bool IsAfterMark () const
 
bool IsSecured () const
 
void SetSecured ()
 
bool IsSecureSupported () const
 
void ClearSecureSupport ()
 
void SetSecureSupport ()
 
void SetInNIF ()
 
bool IsInNIF ()
 
string ExtractValue (uint8 const *_data, uint8 *_scale, uint8 *_precision, uint8 _valueOffset=1) const
 
void AppendValue (Msg *_msg, string const &_value, uint8 const _scale) const
 
uint8 const GetAppendValueSize (string const &_value) const
 
int32 ValueToInteger (string const &_value, uint8 *o_precision, uint8 *o_size) const
 
void UpdateMappedClass (uint8 const _instance, uint8 const _classId, uint8 const _value)
 
virtual void CreateVars (uint8 const _instance, uint8 const _index)
 
bool HasStaticRequest (uint8_t _request) const
 
void SetStaticRequest (uint8_t _request)
 
void ClearStaticRequest (uint8_t _request)
 
uint32 GetSentCnt () const
 
uint32 GetReceivedCnt () const
 
void SentCntIncr ()
 
void ReceivedCntIncr ()
 

Protected Member Functions

virtual void CreateVars (uint8 const _instance)
 
void ReadValueRefreshXML (TiXmlElement const *_ccElement)
 

Protected Attributes

CompatOptionManager m_com
 
CompatOptionManager m_dom
 

Detailed Description

Base class for all Z-Wave command classes.

Member Typedef Documentation

◆ RefreshValue

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
Enumerator
RequestFlag_Static 

Values that never change.

RequestFlag_Session 

Values that change infrequently, and so only need to be requested at start up, or via a manual refresh.

RequestFlag_Dynamic 

Values that change and will be requested if polling is enabled on the node.

RequestFlag_AfterMark 

Values relevent to Controlling CC, not Controlled CC.

◆ StaticRequest

Enumerator
StaticRequest_Instances 
StaticRequest_Values 
StaticRequest_Version 

Constructor & Destructor Documentation

◆ CommandClass()

CommandClass::CommandClass ( uint32 const  _homeId,
uint8 const  _nodeId 
)

◆ ~CommandClass()

CommandClass::~CommandClass ( )
virtual

Member Function Documentation

◆ AppendValue()

void CommandClass::AppendValue ( Msg _msg,
string const &  _value,
uint8 const  _scale 
) const

Append a floating-point value to a message.

Parameters
_msgThe message to which the value should be appended.
_valueA string containing a decimal number to be appended.
_scaleA byte indicating the scale corresponding to this value (e.g., 1=F and 0=C for temperatures).
See also
Msg

◆ CheckForRefreshValues()

bool CommandClass::CheckForRefreshValues ( Value const *  _value)

◆ ClearSecureSupport()

void OpenZWave::CommandClass::ClearSecureSupport ( )
inline

◆ ClearStaticRequest()

void CommandClass::ClearStaticRequest ( uint8_t  _request)

◆ CreateVars() [1/2]

virtual void OpenZWave::CommandClass::CreateVars ( uint8 const  _instance)
inlineprotectedvirtual

◆ CreateVars() [2/2]

virtual void OpenZWave::CommandClass::CreateVars ( uint8 const  _instance,
uint8 const  _index 
)
inlinevirtual

Reimplemented in OpenZWave::ThermostatSetpoint.

◆ ExtractValue()

string CommandClass::ExtractValue ( uint8 const *  _data,
uint8 _scale,
uint8 _precision,
uint8  _valueOffset = 1 
) const

◆ GetAppendValueSize()

uint8 const CommandClass::GetAppendValueSize ( string const &  _value) const

◆ GetCommandClassId()

virtual uint8 const OpenZWave::CommandClass::GetCommandClassId ( ) const
pure virtual

◆ GetCommandClassLabel()

string const CommandClass::GetCommandClassLabel ( )

◆ GetCommandClassName()

virtual string const OpenZWave::CommandClass::GetCommandClassName ( ) const
pure virtual

◆ GetDriver()

Driver * CommandClass::GetDriver ( ) const

◆ GetEndPoint()

uint8 OpenZWave::CommandClass::GetEndPoint ( uint8 const  _instance)
inline

◆ GetHomeId()

uint32 OpenZWave::CommandClass::GetHomeId ( ) const
inline

◆ GetInstance()

uint8 OpenZWave::CommandClass::GetInstance ( uint8 const  _endPoint)
inline

◆ GetInstanceLabel()

string CommandClass::GetInstanceLabel ( uint8 const  _instance)

◆ GetInstances()

Bitfield const* OpenZWave::CommandClass::GetInstances ( ) const
inline

◆ GetMaxVersion()

virtual uint8 OpenZWave::CommandClass::GetMaxVersion ( )
inlinevirtual

◆ GetNodeId()

uint8 OpenZWave::CommandClass::GetNodeId ( ) const
inline

◆ GetNodeUnsafe()

Node * CommandClass::GetNodeUnsafe ( ) const

◆ GetNumInstances()

uint8 OpenZWave::CommandClass::GetNumInstances ( )
inline

◆ GetReceivedCnt()

uint32 OpenZWave::CommandClass::GetReceivedCnt ( ) const
inline

◆ GetSentCnt()

uint32 OpenZWave::CommandClass::GetSentCnt ( ) const
inline

◆ GetValue()

Value * CommandClass::GetValue ( uint8 const  _instance,
uint16 const  _index 
)

◆ GetVersion()

uint8 OpenZWave::CommandClass::GetVersion ( ) const
inline

◆ HandleIncomingMsg()

bool CommandClass::HandleIncomingMsg ( uint8 const *  _data,
uint32 const  _length,
uint32 const  _instance = 1 
)
virtual

◆ HandleMsg()

virtual bool OpenZWave::CommandClass::HandleMsg ( uint8 const *  _data,
uint32 const  _length,
uint32 const  _instance = 1 
)
pure virtual

◆ HasStaticRequest()

bool OpenZWave::CommandClass::HasStaticRequest ( uint8_t  _request) const
inline

◆ IsAfterMark()

bool OpenZWave::CommandClass::IsAfterMark ( ) const
inline

◆ IsInNIF()

bool OpenZWave::CommandClass::IsInNIF ( )
inline

◆ IsSecured()

bool OpenZWave::CommandClass::IsSecured ( ) const
inline

◆ IsSecureSupported()

bool OpenZWave::CommandClass::IsSecureSupported ( ) const
inline

◆ ReadValueRefreshXML()

void CommandClass::ReadValueRefreshXML ( TiXmlElement const *  _ccElement)
protected

◆ ReadXML()

void CommandClass::ReadXML ( TiXmlElement const *  _ccElement)
virtual

◆ ReceivedCntIncr()

void OpenZWave::CommandClass::ReceivedCntIncr ( )
inline

◆ refreshValuesOnWakeup()

void CommandClass::refreshValuesOnWakeup ( )
virtual

◆ RemoveValue()

bool CommandClass::RemoveValue ( uint8 const  _instance,
uint16 const  _index 
)

◆ RequestState()

virtual bool OpenZWave::CommandClass::RequestState ( uint32 const  _requestFlags,
uint8 const  _instance,
Driver::MsgQueue const  _queue 
)
inlinevirtual

◆ RequestStateForAllInstances()

bool CommandClass::RequestStateForAllInstances ( uint32 const  _requestFlags,
Driver::MsgQueue const  _queue 
)

◆ RequestValue()

virtual bool OpenZWave::CommandClass::RequestValue ( uint32 const  _requestFlags,
uint16 const  _index,
uint8 const  _instance,
Driver::MsgQueue const  _queue 
)
inlinevirtual

◆ SentCntIncr()

void OpenZWave::CommandClass::SentCntIncr ( )
inline

◆ SetAfterMark()

void OpenZWave::CommandClass::SetAfterMark ( )
inline

◆ SetCommandClassLabel()

void CommandClass::SetCommandClassLabel ( string  label)

◆ SetEndPoint()

void OpenZWave::CommandClass::SetEndPoint ( uint8 const  _instance,
uint8 const  _endpoint 
)
inline

◆ SetInNIF()

void OpenZWave::CommandClass::SetInNIF ( )
inline

◆ SetInstance()

void CommandClass::SetInstance ( uint8 const  _endPoint)

◆ SetInstanceLabel()

void CommandClass::SetInstanceLabel ( uint8 const  _instance,
char *  label 
)
virtual

Reimplemented in OpenZWave::MultiInstance.

◆ SetInstances()

void CommandClass::SetInstances ( uint8 const  _instances)

◆ SetSecured()

void OpenZWave::CommandClass::SetSecured ( )
inline

◆ SetSecureSupport()

void OpenZWave::CommandClass::SetSecureSupport ( )
inline

◆ SetStaticRequest()

void CommandClass::SetStaticRequest ( uint8_t  _request)

◆ SetValue()

virtual bool OpenZWave::CommandClass::SetValue ( Value const &  _value)
inlinevirtual

◆ SetValueBasic()

virtual void OpenZWave::CommandClass::SetValueBasic ( uint8 const  _instance,
uint8 const  _level 
)
inlinevirtual

◆ SetVersion()

void CommandClass::SetVersion ( uint8 const  _version)
virtual

◆ UpdateMappedClass()

void CommandClass::UpdateMappedClass ( uint8 const  _instance,
uint8 const  _classId,
uint8 const  _value 
)

◆ ValueToInteger()

int32 CommandClass::ValueToInteger ( string const &  _value,
uint8 o_precision,
uint8 o_size 
) const

◆ WriteXML()

void CommandClass::WriteXML ( TiXmlElement *  _ccElement)
virtual

Member Data Documentation

◆ m_com

CompatOptionManager OpenZWave::CommandClass::m_com
protected

◆ m_dom

CompatOptionManager OpenZWave::CommandClass::m_dom
protected

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