OpenZWave Library: SwitchAll.h Source File

| OpenZWave Library 1.6.0

SwitchAll.h
Go to the documentation of this file.
1 //-----------------------------------------------------------------------------
2 //
3 // SwitchAll.h
4 //
5 // Implementation of the Z-Wave COMMAND_CLASS_SWITCH_ALL
6 //
7 // Copyright (c) 2010 Mal Lansell <openzwave@lansell.org>
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 _SwitchAll_H
29 #define _SwitchAll_H
30
31 #include "command_classes/CommandClass.h"
32
33 namespace OpenZWave
34 {
35 class ValueList;
36
40 class SwitchAll: public CommandClass
41 {
42 public:
43 static CommandClass* Create( uint32 const _homeId, uint8 const _nodeId ){ return new SwitchAll( _homeId, _nodeId ); }
44 virtual ~SwitchAll(){}
45
46 static uint8 const StaticGetCommandClassId(){ return 0x27; }
47 static string const StaticGetCommandClassName(){ return "COMMAND_CLASS_SWITCH_ALL"; }
48
49 static void On( Driver* _driver, uint8 const _nodeId );
50 static void Off( Driver* _driver, uint8 const _nodeId );
51
52 // From CommandClass
53 virtual bool RequestState( uint32 const _requestFlags, uint8 const _instance, Driver::MsgQueue const _queue );
54 virtual bool RequestValue( uint32 const _requestFlags, uint16 const _index, uint8 const _instance, Driver::MsgQueue const _queue );
55 virtual uint8 const GetCommandClassId()const{ return StaticGetCommandClassId(); }
56 virtual string const GetCommandClassName()const{ return StaticGetCommandClassName(); }
57 virtual bool HandleMsg( uint8 const* _data, uint32 const _length, uint32 const _instance = 1 );
58 virtual bool SetValue( Value const& _value );
59
60 protected:
61 virtual void CreateVars( uint8 const _instance );
62
63 private:
64 SwitchAll( uint32 const _homeId, uint8 const _nodeId ): CommandClass( _homeId, _nodeId ){}
65 };
66
67 } // namespace OpenZWave
68
69 #endif
70
OpenZWave::SwitchAll::RequestState
virtual bool RequestState(uint32 const _requestFlags, uint8 const _instance, Driver::MsgQueue const _queue)
Definition: SwitchAll.cpp:62
OpenZWave::SwitchAll::StaticGetCommandClassName
static string const StaticGetCommandClassName()
Definition: SwitchAll.h:47
OpenZWave
Definition: Bitfield.h:34
OpenZWave::Driver::MsgQueue
MsgQueue
Definition: Driver.h:591
uint16
unsigned short uint16
Definition: Defs.h:92
OpenZWave::SwitchAll::RequestValue
virtual bool RequestValue(uint32 const _requestFlags, uint16 const _index, uint8 const _instance, Driver::MsgQueue const _queue)
Definition: SwitchAll.cpp:81
CommandClass.h
OpenZWave::SwitchAll::CreateVars
virtual void CreateVars(uint8 const _instance)
Definition: SwitchAll.cpp:210
OpenZWave::SwitchAll::GetCommandClassName
virtual string const GetCommandClassName() const
Definition: SwitchAll.h:56
OpenZWave::CommandClass
Base class for all Z-Wave command classes.
Definition: CommandClass.h:55
OpenZWave::Driver
The Driver class handles communication between OpenZWave and a device attached via a serial port (typ...
Definition: Driver.h:64
OpenZWave::SwitchAll::On
static void On(Driver *_driver, uint8 const _nodeId)
Definition: SwitchAll.cpp:190
uint32
unsigned int uint32
Definition: Defs.h:95
OpenZWave::SwitchAll::StaticGetCommandClassId
static uint8 const StaticGetCommandClassId()
Definition: SwitchAll.h:46
OpenZWave::SwitchAll::Create
static CommandClass * Create(uint32 const _homeId, uint8 const _nodeId)
Definition: SwitchAll.h:43
OpenZWave::SwitchAll::SetValue
virtual bool SetValue(Value const &_value)
Definition: SwitchAll.cpp:138
OpenZWave::SwitchAll
Implements COMMAND_CLASS_SWITCH_ALL (0x27), a Z-Wave device command class.
Definition: SwitchAll.h:40
OpenZWave::SwitchAll::Off
static void Off(Driver *_driver, uint8 const _nodeId)
Definition: SwitchAll.cpp:170
OpenZWave::SwitchAll::~SwitchAll
virtual ~SwitchAll()
Definition: SwitchAll.h:44
OpenZWave::SwitchAll::HandleMsg
virtual bool HandleMsg(uint8 const *_data, uint32 const _length, uint32 const _instance=1)
Definition: SwitchAll.cpp:110
OpenZWave::Value
Base class for values associated with a node.
Definition: Value.h:48
OpenZWave::SwitchAll::GetCommandClassId
virtual uint8 const GetCommandClassId() const
Definition: SwitchAll.h:55
uint8
unsigned char uint8
Definition: Defs.h:89