OpenZWave Library  1.5.0
Alarm.h
Go to the documentation of this file.
1 //-----------------------------------------------------------------------------
2 //
3 // Alarm.h
4 //
5 // Implementation of the Z-Wave COMMAND_CLASS_ALARM
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 _Alarm_H
29 #define _Alarm_H
30 
32 
33 namespace OpenZWave
34 {
35  class ValueByte;
36 
40  class Alarm: public CommandClass
41  {
42  public:
43  static CommandClass* Create( uint32 const _homeId, uint8 const _nodeId ){ return new Alarm( _homeId, _nodeId ); }
44  virtual ~Alarm(){}
45 
47  static uint8 const StaticGetCommandClassId(){ return 0x71; }
49  static string const StaticGetCommandClassName(){ return "COMMAND_CLASS_ALARM"; }
50 
51  // From CommandClass
52  virtual bool RequestState( uint32 const _requestFlags, uint8 const _instance, Driver::MsgQueue const _queue );
53  virtual bool RequestValue( uint32 const _requestFlags, uint16 const _index, uint8 const _instance, Driver::MsgQueue const _queue );
55  virtual uint8 const GetCommandClassId()const{ return StaticGetCommandClassId(); }
57  virtual string const GetCommandClassName()const{ return StaticGetCommandClassName(); }
59  virtual bool HandleMsg( uint8 const* _data, uint32 const _length, uint32 const _instance = 1 );
60 
61  virtual uint8 GetMaxVersion(){ return 3; }
62 
63  private:
64  Alarm( uint32 const _homeId, uint8 const _nodeId );
65  multimap<uint8, uint8> m_TempValueIDs;
66  };
67 
68 } // namespace OpenZWave
69 
70 #endif
Definition: Bitfield.h:34
MsgQueue
Definition: Driver.h:575
virtual bool RequestValue(uint32 const _requestFlags, uint16 const _index, uint8 const _instance, Driver::MsgQueue const _queue)
Definition: Alarm.cpp:309
unsigned short uint16
Definition: Defs.h:93
virtual uint8 const GetCommandClassId() const
Get command class ID (1 byte) identifying this command class. (Inherited from CommandClass) ...
Definition: Alarm.h:55
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: Alarm.cpp:365
Implements COMMAND_CLASS_ALARM (0x71), a Z-Wave device command class.
Definition: Alarm.h:40
virtual ~Alarm()
Definition: Alarm.h:44
Base class for all Z-Wave command classes.
Definition: CommandClass.h:54
virtual bool RequestState(uint32 const _requestFlags, uint8 const _instance, Driver::MsgQueue const _queue)
Definition: Alarm.cpp:263
static CommandClass * Create(uint32 const _homeId, uint8 const _nodeId)
Definition: Alarm.h:43
unsigned int uint32
Definition: Defs.h:96
virtual uint8 GetMaxVersion()
Definition: Alarm.h:61
static string const StaticGetCommandClassName()
Get a string containing the name of this command class.
Definition: Alarm.h:49
static uint8 const StaticGetCommandClassId()
Get command class ID (1 byte) identifying this command class.
Definition: Alarm.h:47
virtual string const GetCommandClassName() const
Get a string containing the name of this command class. (Inherited from CommandClass) ...
Definition: Alarm.h:57
unsigned char uint8
Definition: Defs.h:90