OpenZWave Library: Protection.h Source File

| 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
31 #include "command_classes/CommandClass.h"
32
33 namespace OpenZWave
34 {
35 class ValueList;
36
40 class Protection: public CommandClass
41 {
42 public:
43 enum ProtectionEnum
44 {
45 Protection_Unprotected = 0,
46 Protection_Sequence,
47 Protection_NOP
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
uint32
unsigned int uint32
Definition: Defs.h:95
OpenZWave::CommandClass
Base class for all Z-Wave command classes.
Definition: CommandClass.h:56
uint8
unsigned char uint8
Definition: Defs.h:89
OpenZWave::Protection::RequestValue
virtual bool RequestValue(uint32 const _requestFlags, uint16 const _index, uint8 const _instance, Driver::MsgQueue const _queue)
Definition: Protection.cpp:81
OpenZWave::Protection::~Protection
virtual ~Protection()
Definition: Protection.h:51
OpenZWave::Protection::Protection_Sequence
@ Protection_Sequence
Definition: Protection.h:46
OpenZWave::Protection::GetCommandClassName
virtual string const GetCommandClassName() const
Definition: Protection.h:60
OpenZWave::Protection::SetValue
virtual bool SetValue(Value const &_value)
Definition: Protection.cpp:142
OpenZWave::Protection::Create
static CommandClass * Create(uint32 const _homeId, uint8 const _nodeId)
Definition: Protection.h:50
OpenZWave::Protection::Protection_NOP
@ Protection_NOP
Definition: Protection.h:47
OpenZWave::Protection::HandleMsg
virtual bool HandleMsg(uint8 const *_data, uint32 const _length, uint32 const _instance=1)
Definition: Protection.cpp:110
OpenZWave::Protection::GetCommandClassId
virtual uint8 const GetCommandClassId() const
Definition: Protection.h:59
OpenZWave::Value
Base class for values associated with a node.
Definition: Value.h:49
OpenZWave::Protection::ProtectionEnum
ProtectionEnum
Definition: Protection.h:44
OpenZWave::Protection::CreateVars
virtual void CreateVars(uint8 const _instance)
Definition: Protection.cpp:174
CommandClass.h
OpenZWave::Protection::StaticGetCommandClassName
static string const StaticGetCommandClassName()
Definition: Protection.h:54
OpenZWave::Protection::RequestState
virtual bool RequestState(uint32 const _requestFlags, uint8 const _instance, Driver::MsgQueue const _queue)
Definition: Protection.cpp:62
OpenZWave::Protection::StaticGetCommandClassId
static uint8 const StaticGetCommandClassId()
Definition: Protection.h:53
OpenZWave::Driver::MsgQueue
MsgQueue
Definition: Driver.h:592
OpenZWave::Protection::Protection_Unprotected
@ Protection_Unprotected
Definition: Protection.h:45
uint16
unsigned short uint16
Definition: Defs.h:92
OpenZWave::Protection
Implements COMMAND_CLASS_PROTECTION (0x75), a Z-Wave device command class.
Definition: Protection.h:41
OpenZWave
Definition: Bitfield.h:35