OpenZWave Library: SceneActivation.h Source File

| OpenZWave Library 1.6.0

SceneActivation.h
Go to the documentation of this file.
1 //-----------------------------------------------------------------------------
2 //
3 // SceneActivation.h
4 //
5 // Implementation of the Z-Wave COMMAND_CLASS_SCENE_ACTIVATION
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 _SceneActivation_H
29 #define _SceneActivation_H
30
31 #include "command_classes/CommandClass.h"
32 #include "TimerThread.h"
33
34 namespace OpenZWave
35 {
36 class ValueByte;
37
41 class SceneActivation: public CommandClass, private Timer
42 {
43 public:
44 static CommandClass* Create( uint32 const _homeId, uint8 const _nodeId ){ return new SceneActivation( _homeId, _nodeId ); }
45 virtual ~SceneActivation(){}
46
48 static uint8 const StaticGetCommandClassId(){ return 0x2B; }
50 static string const StaticGetCommandClassName(){ return "COMMAND_CLASS_SCENE_ACTIVATION"; }
51
52 // From CommandClass
54 virtual uint8 const GetCommandClassId()const{ return StaticGetCommandClassId(); }
56 virtual string const GetCommandClassName()const{ return StaticGetCommandClassName(); }
58 virtual bool HandleIncommingMsg( uint8 const* _data, uint32 const _length, uint32 const _instance = 1 );
59 virtual bool HandleMsg( uint8 const* _data, uint32 const _length, uint32 const _instance = 1 );
60
61 protected:
62 virtual void CreateVars( uint8 const _instance );
63
64 private:
65 void ClearScene(uint32 id);
66 SceneActivation( uint32 const _homeId, uint8 const _nodeId );
67
68 };
69
70 } // namespace OpenZWave
71
72 #endif
OpenZWave
Definition: Bitfield.h:34
OpenZWave::SceneActivation::HandleMsg
virtual bool HandleMsg(uint8 const *_data, uint32 const _length, uint32 const _instance=1)
Definition: SceneActivation.cpp:127
OpenZWave::SceneActivation::Create
static CommandClass * Create(uint32 const _homeId, uint8 const _nodeId)
Definition: SceneActivation.h:44
TimerThread.h
OpenZWave::SceneActivation::~SceneActivation
virtual ~SceneActivation()
Definition: SceneActivation.h:45
CommandClass.h
OpenZWave::SceneActivation::GetCommandClassName
virtual string const GetCommandClassName() const
Get a string containing the name of this command class. (Inherited from CommandClass)
Definition: SceneActivation.h:56
OpenZWave::SceneActivation::HandleIncommingMsg
virtual bool HandleIncommingMsg(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: SceneActivation.cpp:70
OpenZWave::CommandClass
Base class for all Z-Wave command classes.
Definition: CommandClass.h:55
OpenZWave::Timer
Timer SubClass for automatically registering/unregistering Timer Callbacks if the instance goes out o...
Definition: TimerThread.h:128
OpenZWave::SceneActivation
Implements COMMAND_CLASS_SCENEACTIVATION (0x2B), a Z-Wave device command class.
Definition: SceneActivation.h:41
uint32
unsigned int uint32
Definition: Defs.h:95
OpenZWave::SceneActivation::StaticGetCommandClassId
static uint8 const StaticGetCommandClassId()
Get command class ID (1 byte) identifying this command class.
Definition: SceneActivation.h:48
OpenZWave::SceneActivation::StaticGetCommandClassName
static string const StaticGetCommandClassName()
Get a string containing the name of this command class.
Definition: SceneActivation.h:50
OpenZWave::SceneActivation::CreateVars
virtual void CreateVars(uint8 const _instance)
Definition: SceneActivation.cpp:161
OpenZWave::SceneActivation::GetCommandClassId
virtual uint8 const GetCommandClassId() const
Get command class ID (1 byte) identifying this command class. (Inherited from CommandClass)
Definition: SceneActivation.h:54
uint8
unsigned char uint8
Definition: Defs.h:89