OpenZWave Library 1.4.0
Loading...
Searching...
No Matches
OpenZWave::SceneActivation Class Reference

Implements COMMAND_CLASS_SCENEACTIVATION (0x2B), a Z-Wave device command class. More...

#include <SceneActivation.h>

Inheritance diagram for OpenZWave::SceneActivation:
Collaboration diagram for OpenZWave::SceneActivation:

Public Member Functions

virtual ~SceneActivation ()
virtual uint8 const GetCommandClassId () const
 Get command class ID (1 byte) identifying this command class. (Inherited from CommandClass).
virtual string const GetCommandClassName () const
 Get a string containing the name of this command class. (Inherited from CommandClass).
virtual bool HandleMsg (uint8 const *_data, uint32 const _length, uint32 const _instance=1)
 Handle a response to a message associated with this command class. (Inherited from CommandClass).
Public Member Functions inherited from OpenZWave::CommandClass
 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, 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)
virtual uint8 GetMaxVersion ()
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 ()
 Get command class ID (1 byte) identifying this command class.
static string const StaticGetCommandClassName ()
 Get a string containing the name of this command class.

Additional Inherited Members

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
Protected Member Functions inherited from OpenZWave::CommandClass
virtual void CreateVars (uint8 const _instance)
void ReadValueRefreshXML (TiXmlElement const *_ccElement)

Detailed Description

Implements COMMAND_CLASS_SCENEACTIVATION (0x2B), a Z-Wave device command class.

Constructor & Destructor Documentation

◆ ~SceneActivation()

virtual OpenZWave::SceneActivation::~SceneActivation ( )
inlinevirtual

Member Function Documentation

◆ Create()

CommandClass * OpenZWave::SceneActivation::Create ( uint32 const _homeId,
uint8 const _nodeId )
inlinestatic

◆ GetCommandClassId()

virtual uint8 const OpenZWave::SceneActivation::GetCommandClassId ( ) const
inlinevirtual

Get command class ID (1 byte) identifying this command class. (Inherited from CommandClass).

Implements OpenZWave::CommandClass.

◆ GetCommandClassName()

virtual string const OpenZWave::SceneActivation::GetCommandClassName ( ) const
inlinevirtual

Get a string containing the name of this command class. (Inherited from CommandClass).

Implements OpenZWave::CommandClass.

◆ HandleMsg()

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

Handle a response to a message associated with this command class. (Inherited from CommandClass).

Implements OpenZWave::CommandClass.

◆ StaticGetCommandClassId()

uint8 const OpenZWave::SceneActivation::StaticGetCommandClassId ( )
inlinestatic

Get command class ID (1 byte) identifying this command class.

◆ StaticGetCommandClassName()

string const OpenZWave::SceneActivation::StaticGetCommandClassName ( )
inlinestatic

Get a string containing the name of this command class.


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