OpenZWave Library  1.4.3102
Public Types | Public Member Functions | Static Public Member Functions | List of all members
OpenZWave::MultiInstance Class Reference

Implements COMMAND_CLASS_MULTI_INSTANCE (0x60), a Z-Wave device command class. More...

#include <MultiInstance.h>

+ Inheritance diagram for OpenZWave::MultiInstance:
+ Collaboration diagram for OpenZWave::MultiInstance:

Public Types

enum  MultiInstanceCmd {
  MultiInstanceCmd_Get = 0x04, MultiInstanceCmd_Report = 0x05, MultiInstanceCmd_Encap = 0x06, MultiChannelCmd_EndPointGet = 0x07,
  MultiChannelCmd_EndPointReport = 0x08, MultiChannelCmd_CapabilityGet = 0x09, MultiChannelCmd_CapabilityReport = 0x0a, MultiChannelCmd_EndPointFind = 0x0b,
  MultiChannelCmd_EndPointFindReport = 0x0c, MultiChannelCmd_Encap = 0x0d
}
 
enum  MultiInstanceMapping { MultiInstanceMapAll, MultiInstanceMapEndPoints, MultiInstanceMapOther }
 
- Public Types inherited from OpenZWave::CommandClass
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

virtual ~MultiInstance ()
 
bool RequestInstances ()
 
virtual void ReadXML (TiXmlElement const *_ccElement)
 
virtual void WriteXML (TiXmlElement *_ccElement)
 
virtual uint8 const GetCommandClassId () const
 
virtual string const GetCommandClassName () const
 
virtual bool HandleMsg (uint8 const *_data, uint32 const _length, uint32 const _instance=1)
 
virtual uint8 GetMaxVersion ()
 
MultiInstanceMapping GetEndPointMap ()
 
- Public Member Functions inherited from OpenZWave::CommandClass
 CommandClass (uint32 const _homeId, uint8 const _nodeId)
 
virtual ~CommandClass ()
 
virtual bool RequestState (uint32 const _requestFlags, uint8 const _instance, Driver::MsgQueue const _queue)
 
virtual bool RequestValue (uint32 const _requestFlags, uint8 const _index, uint8 const _instance, Driver::MsgQueue const _queue)
 
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)
 
uint8 GetVersion () const
 
Bitfield const * GetInstances () const
 
uint32 GetHomeId () const
 
uint8 GetNodeId () const
 
DriverGetDriver () const
 
NodeGetNodeUnsafe () const
 
ValueGetValue (uint8 const _instance, uint8 const _index)
 
bool RemoveValue (uint8 const _instance, uint8 const _index)
 
uint8 GetEndPoint (uint8 const _instance)
 
uint8 GetInstance (uint8 const _endPoint)
 
void SetInstances (uint8 const _instances)
 
void SetInstance (uint8 const _endPoint)
 
void SetAfterMark ()
 
void SetEndPoint (uint8 const _instance, uint8 const _endpoint)
 
bool IsAfterMark () const
 
bool IsCreateVars () const
 
bool IsGetSupported () 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 _request) const
 
void SetStaticRequest (uint8 _request)
 
void ClearStaticRequest (uint8 _request)
 
uint32 GetSentCnt () const
 
uint32 GetReceivedCnt () const
 
void SentCntIncr ()
 
void ReceivedCntIncr ()
 

Static Public Member Functions

static CommandClassCreate (uint32 const _homeId, uint8 const _nodeId)
 
static uint8 const StaticGetCommandClassId ()
 
static string const StaticGetCommandClassName ()
 

Additional Inherited Members

- Protected Member Functions inherited from OpenZWave::CommandClass
virtual void CreateVars (uint8 const _instance)
 
void ReadValueRefreshXML (TiXmlElement const *_ccElement)
 

Detailed Description

Implements COMMAND_CLASS_MULTI_INSTANCE (0x60), a Z-Wave device command class.

Member Enumeration Documentation

Enumerator
MultiInstanceCmd_Get 
MultiInstanceCmd_Report 
MultiInstanceCmd_Encap 
MultiChannelCmd_EndPointGet 
MultiChannelCmd_EndPointReport 
MultiChannelCmd_CapabilityGet 
MultiChannelCmd_CapabilityReport 
MultiChannelCmd_EndPointFind 
MultiChannelCmd_EndPointFindReport 
MultiChannelCmd_Encap 
Enumerator
MultiInstanceMapAll 
MultiInstanceMapEndPoints 
MultiInstanceMapOther 

Constructor & Destructor Documentation

virtual OpenZWave::MultiInstance::~MultiInstance ( )
inlinevirtual

Member Function Documentation

static CommandClass* OpenZWave::MultiInstance::Create ( uint32 const  _homeId,
uint8 const  _nodeId 
)
inlinestatic
virtual uint8 const OpenZWave::MultiInstance::GetCommandClassId ( ) const
inlinevirtual
virtual string const OpenZWave::MultiInstance::GetCommandClassName ( ) const
inlinevirtual
MultiInstanceMapping OpenZWave::MultiInstance::GetEndPointMap ( )
inline
virtual uint8 OpenZWave::MultiInstance::GetMaxVersion ( )
inlinevirtual

Reimplemented from OpenZWave::CommandClass.

bool MultiInstance::HandleMsg ( uint8 const *  _data,
uint32 const  _length,
uint32 const  _instance = 1 
)
virtual
void MultiInstance::ReadXML ( TiXmlElement const *  _ccElement)
virtual

Reimplemented from OpenZWave::CommandClass.

bool MultiInstance::RequestInstances ( )
static uint8 const OpenZWave::MultiInstance::StaticGetCommandClassId ( )
inlinestatic
static string const OpenZWave::MultiInstance::StaticGetCommandClassName ( )
inlinestatic
void MultiInstance::WriteXML ( TiXmlElement *  _ccElement)
virtual

Reimplemented from OpenZWave::CommandClass.


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