OpenZWave Library  1.6.0
Protection.h
Go to the documentation of this file.
1 //-----------------------------------------------------------------------------
2 //
3 // Protection.h
4 //
5 // Implementation of the Z-Wave COMMAND_CLASS_PROTECTION
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 _Protection_H
29 #define _Protection_H
30 
32 
33 namespace OpenZWave
34 {
35  class ValueList;
36 
40  class Protection: public CommandClass
41  {
42  public:
44  {
48  };
49 
50  static CommandClass* Create( uint32 const _homeId, uint8 const _nodeId ){ return new Protection( _homeId, _nodeId ); }
51  virtual ~Protection(){}
52 
53  static uint8 const StaticGetCommandClassId(){ return 0x75; }
54  static string const StaticGetCommandClassName(){ return "COMMAND_CLASS_PROTECTION"; }
55 
56  // From CommandClass
57  virtual bool RequestState( uint32 const _requestFlags, uint8 const _instance, Driver::MsgQueue const _queue );
58  virtual bool RequestValue( uint32 const _requestFlags, uint16 const _index, uint8 const _instance, Driver::MsgQueue const _queue );
59  virtual uint8 const GetCommandClassId()const{ return StaticGetCommandClassId(); }
60  virtual string const GetCommandClassName()const{ return StaticGetCommandClassName(); }
61  virtual bool HandleMsg( uint8 const* _data, uint32 const _length, uint32 const _instance = 1 );
62  virtual bool SetValue( Value const& _value );
63 
64  protected:
65  virtual void CreateVars( uint8 const _instance );
66 
67  private:
68  Protection( uint32 const _homeId, uint8 const _nodeId ): CommandClass( _homeId, _nodeId ){}
69  };
70 
71 } // namespace OpenZWave
72 
73 #endif
74 
virtual bool RequestValue(uint32 const _requestFlags, uint16 const _index, uint8 const _instance, Driver::MsgQueue const _queue)
Definition: Protection.cpp:81
Definition: Bitfield.h:34
MsgQueue
Definition: Driver.h:591
virtual ~Protection()
Definition: Protection.h:51
unsigned short uint16
Definition: Defs.h:92
virtual bool RequestState(uint32 const _requestFlags, uint8 const _instance, Driver::MsgQueue const _queue)
Definition: Protection.cpp:62
static uint8 const StaticGetCommandClassId()
Definition: Protection.h:53
virtual bool HandleMsg(uint8 const *_data, uint32 const _length, uint32 const _instance=1)
Definition: Protection.cpp:110
Definition: Protection.h:47
Base class for all Z-Wave command classes.
Definition: CommandClass.h:55
ProtectionEnum
Definition: Protection.h:43
virtual bool SetValue(Value const &_value)
Definition: Protection.cpp:142
unsigned int uint32
Definition: Defs.h:95
virtual string const GetCommandClassName() const
Definition: Protection.h:60
Implements COMMAND_CLASS_PROTECTION (0x75), a Z-Wave device command class.
Definition: Protection.h:40
static CommandClass * Create(uint32 const _homeId, uint8 const _nodeId)
Definition: Protection.h:50
virtual uint8 const GetCommandClassId() const
Definition: Protection.h:59
virtual void CreateVars(uint8 const _instance)
Definition: Protection.cpp:174
Base class for values associated with a node.
Definition: Value.h:48
static string const StaticGetCommandClassName()
Definition: Protection.h:54
unsigned char uint8
Definition: Defs.h:89