OpenZWave Library: SoundSwitch.h Source File

| OpenZWave Library 1.6.0

SoundSwitch.h
Go to the documentation of this file.
1 //-----------------------------------------------------------------------------
2 //
3 // SoundSwitch.h
4 //
5 // Implementation of the Z-Wave COMMAND_CLASS_SOUND_SWITCH
6 //
7 // Copyright (c) 2014 Justin Hammond <Justin@dynam.ac>
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 _SoundSwitch_H
29 #define _SoundSwitch_H
30
31 #include "command_classes/CommandClass.h"
32
33 namespace OpenZWave
34 {
35 class ValueByte;
36 class ValueList;
37
41 class SoundSwitch: public CommandClass
42 {
43 private:
44 struct SoundSwitchToneInfo {
45 uint16 duration;
46 string name;
47 };
48 public:
49 static CommandClass* Create( uint32 const _homeId, uint8 const _nodeId ){ return new SoundSwitch( _homeId, _nodeId ); }
50 virtual ~SoundSwitch(){}
51
52 static uint8 const StaticGetCommandClassId(){ return 0x79; }
53 static string const StaticGetCommandClassName(){ return "COMMAND_CLASS_SOUND_SWITCH"; }
54
55 // From CommandClass
56 virtual bool RequestState( uint32 const _requestFlags, uint8 const _instance, Driver::MsgQueue const _queue );
57 virtual bool RequestValue( uint32 const _requestFlags, uint16 const _index, uint8 const _instance, Driver::MsgQueue const _queue );
58 virtual uint8 const GetCommandClassId()const{ return StaticGetCommandClassId(); }
59 virtual string const GetCommandClassName()const{ return StaticGetCommandClassName(); }
60 virtual bool HandleMsg( uint8 const* _data, uint32 const _length, uint32 const _instance = 1 );
61 virtual bool SetValue( Value const& _value );
62
63 protected:
64 virtual void CreateVars( uint8 const _instance );
65
66 private:
67 SoundSwitch( uint32 const _homeId, uint8 const _nodeId );
68
69 uint8 m_toneCount;
70 std::map<uint8, SoundSwitchToneInfo> m_toneInfo;
71 };
72
73 } // namespace OpenZWave
74
75 #endif
76
OpenZWave
Definition: Bitfield.h:34
OpenZWave::Driver::MsgQueue
MsgQueue
Definition: Driver.h:591
OpenZWave::SoundSwitch::StaticGetCommandClassName
static string const StaticGetCommandClassName()
Definition: SoundSwitch.h:53
uint16
unsigned short uint16
Definition: Defs.h:92
OpenZWave::SoundSwitch::GetCommandClassId
virtual uint8 const GetCommandClassId() const
Definition: SoundSwitch.h:58
CommandClass.h
OpenZWave::SoundSwitch::RequestValue
virtual bool RequestValue(uint32 const _requestFlags, uint16 const _index, uint8 const _instance, Driver::MsgQueue const _queue)
Definition: SoundSwitch.cpp:104
OpenZWave::SoundSwitch::StaticGetCommandClassId
static uint8 const StaticGetCommandClassId()
Definition: SoundSwitch.h:52
OpenZWave::SoundSwitch::RequestState
virtual bool RequestState(uint32 const _requestFlags, uint8 const _instance, Driver::MsgQueue const _queue)
Definition: SoundSwitch.cpp:84
OpenZWave::CommandClass
Base class for all Z-Wave command classes.
Definition: CommandClass.h:55
OpenZWave::SoundSwitch::SetValue
virtual bool SetValue(Value const &_value)
Definition: SoundSwitch.cpp:246
OpenZWave::SoundSwitch::CreateVars
virtual void CreateVars(uint8 const _instance)
Definition: SoundSwitch.cpp:308
uint32
unsigned int uint32
Definition: Defs.h:95
OpenZWave::SoundSwitch::GetCommandClassName
virtual string const GetCommandClassName() const
Definition: SoundSwitch.h:59
OpenZWave::SoundSwitch::HandleMsg
virtual bool HandleMsg(uint8 const *_data, uint32 const _length, uint32 const _instance=1)
Definition: SoundSwitch.cpp:135
OpenZWave::Value
Base class for values associated with a node.
Definition: Value.h:48
OpenZWave::SoundSwitch
Implements COMMAND_CLASS_SOUND_SWITCH (0x79), a Z-Wave device command class.
Definition: SoundSwitch.h:41
OpenZWave::SoundSwitch::~SoundSwitch
virtual ~SoundSwitch()
Definition: SoundSwitch.h:50
OpenZWave::SoundSwitch::Create
static CommandClass * Create(uint32 const _homeId, uint8 const _nodeId)
Definition: SoundSwitch.h:49
uint8
unsigned char uint8
Definition: Defs.h:89