OpenZWave Library  1.5.0
CentralScene.h
Go to the documentation of this file.
1 //-----------------------------------------------------------------------------
2 //
3 // CentralScene.h
4 //
5 // Implementation of the Z-Wave COMMAND_CLASS_CENTRAL_SCENE
6 //
7 // Copyright (c) 2012 Greg Satz <satz@iranger.com>
8 //
9 // SOFTWARE NOTICE AND LICENSE
10 //
11 // This file is part of OpenZWave.
12 //
13 // OpenZWave is free software: you can redistribute it and/or modify
14 // it under the terms of the GNU Lesser General Public License as published
15 // by the Free Software Foundation, either version 3 of the License,
16 // or (at your option) any later version.
17 //
18 // OpenZWave is distributed in the hope that it will be useful,
19 // but WITHOUT ANY WARRANTY; without even the implied warranty of
20 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 // GNU Lesser General Public License for more details.
22 //
23 // You should have received a copy of the GNU Lesser General Public License
24 // along with OpenZWave. If not, see <http://www.gnu.org/licenses/>.
25 //
26 //-----------------------------------------------------------------------------
27 
28 #ifndef _CentralScene_H
29 #define _CentralScene_H
30 
32 
33 namespace OpenZWave
34 {
35  class ValueByte;
36 
40  class CentralScene: public CommandClass
41  {
42  public:
43  static CommandClass* Create( uint32 const _homeId, uint8 const _nodeId ){ return new CentralScene( _homeId, _nodeId ); }
44  virtual ~CentralScene(){}
45 
47  static uint8 const StaticGetCommandClassId(){ return 0x5B; }
49  static string const StaticGetCommandClassName(){ return "COMMAND_CLASS_CENTRAL_SCENE"; }
50 
51  // From CommandClass
53  virtual uint8 const GetCommandClassId()const{ return StaticGetCommandClassId(); }
55  virtual string const GetCommandClassName()const{ return StaticGetCommandClassName(); }
56  virtual uint8 GetMaxVersion(){ return 3; }
58  virtual bool HandleMsg( uint8 const* _data, uint32 const _length, uint32 const _instance = 1 );
60  void CreateVars( uint8 const _instance );
68  void createSupportedKeyAttributesValues(uint8 keyAttributes, uint8 sceneNumber, uint8 index, uint8 instance);
69  void ReadXML( TiXmlElement const* _ccElement );
70  void WriteXML( TiXmlElement* _ccElement );
71  bool RequestState( uint32 const _requestFlags, uint8 const _instance, Driver::MsgQueue const _queue );
72  bool RequestValue( uint32 const _requestFlags, uint16 const _what, uint8 const _instance, Driver::MsgQueue const _queue );
73  private:
74  CentralScene( uint32 const _homeId, uint8 const _nodeId );
75  int32 m_scenecount;
76  };
77 
78 } // namespace OpenZWave
79 
80 #endif
Definition: Bitfield.h:34
MsgQueue
Definition: Driver.h:575
virtual string const GetCommandClassName() const
Get a string containing the name of this command class. (Inherited from CommandClass) ...
Definition: CentralScene.h:55
unsigned short uint16
Definition: Defs.h:93
bool RequestValue(uint32 const _requestFlags, uint16 const _what, uint8 const _instance, Driver::MsgQueue const _queue)
Definition: CentralScene.cpp:144
virtual uint8 const GetCommandClassId() const
Get command class ID (1 byte) identifying this command class. (Inherited from CommandClass) ...
Definition: CentralScene.h:53
bool RequestState(uint32 const _requestFlags, uint8 const _instance, Driver::MsgQueue const _queue)
Definition: CentralScene.cpp:122
Base class for all Z-Wave command classes.
Definition: CommandClass.h:54
Implements COMMAND_CLASS_CENTRAL_SCENE (0x5B), a Z-Wave device command class.
Definition: CentralScene.h:40
void createSupportedKeyAttributesValues(uint8 keyAttributes, uint8 sceneNumber, uint8 index, uint8 instance)
Definition: CentralScene.cpp:369
signed int int32
Definition: Defs.h:95
static uint8 const StaticGetCommandClassId()
Get command class ID (1 byte) identifying this command class.
Definition: CentralScene.h:47
unsigned int uint32
Definition: Defs.h:96
virtual uint8 GetMaxVersion()
Definition: CentralScene.h:56
void CreateVars(uint8 const _instance)
Create Default Vars for this CC.
Definition: CentralScene.cpp:343
void WriteXML(TiXmlElement *_ccElement)
Definition: CentralScene.cpp:186
void ReadXML(TiXmlElement const *_ccElement)
Definition: CentralScene.cpp:168
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) ...
Definition: CentralScene.cpp:203
static CommandClass * Create(uint32 const _homeId, uint8 const _nodeId)
Definition: CentralScene.h:43
virtual ~CentralScene()
Definition: CentralScene.h:44
static string const StaticGetCommandClassName()
Get a string containing the name of this command class.
Definition: CentralScene.h:49
unsigned char uint8
Definition: Defs.h:90