OpenZWave Library: Lock.h Source File

| OpenZWave Library 1.6.0

Loading...
Searching...
No Matches
Lock.h
Go to the documentation of this file.
1//-----------------------------------------------------------------------------
2//
3// Lock.h
4//
5// Implementation of the Z-Wave COMMAND_CLASS_LOCK
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 _Lock_H
29#define _Lock_H
30
31#include "command_classes/CommandClass.h"
32
33namespace OpenZWave
34{
35 class ValueBool;
36
40 class Lock: public CommandClass
41 {
42 public:
43 static CommandClass* Create( uint32 const _homeId, uint8 const _nodeId ){ return new Lock( _homeId, _nodeId ); }
44 virtual ~Lock(){}
45
46 static uint8 const StaticGetCommandClassId(){ return 0x76; }
47 static string const StaticGetCommandClassName(){ return "COMMAND_CLASS_LOCK"; }
48
49 // From CommandClass
50 virtual bool RequestState( uint32 const _requestFlags, uint8 const _instance, Driver::MsgQueue const _queue );
51 virtual bool RequestValue( uint32 const _requestFlags, uint16 const _index, uint8 const _instance, Driver::MsgQueue const _queue );
52 virtual uint8 const GetCommandClassId()const{ return StaticGetCommandClassId(); }
53 virtual string const GetCommandClassName()const{ return StaticGetCommandClassName(); }
54 virtual bool HandleMsg( uint8 const* _data, uint32 const _length, uint32 const _instance = 1 );
55 virtual bool SetValue( Value const& _value );
56
57 protected:
58 virtual void CreateVars( uint8 const _instance );
59
60 private:
61 Lock( uint32 const _homeId, uint8 const _nodeId ): CommandClass( _homeId, _nodeId ){}
62 };
63
64} // namespace OpenZWave
65
66#endif
67
CommandClass.h
uint16
unsigned short uint16
Definition Defs.h:92
uint32
unsigned int uint32
Definition Defs.h:95
uint8
unsigned char uint8
Definition Defs.h:89
OpenZWave::CommandClass
Base class for all Z-Wave command classes.
Definition CommandClass.h:56
OpenZWave::Driver::MsgQueue
MsgQueue
Definition Driver.h:592
OpenZWave::Lock
Implements COMMAND_CLASS_LOCK (0x76), a Z-Wave device command class.
Definition Lock.h:41
OpenZWave::Lock::GetCommandClassId
virtual uint8 const GetCommandClassId() const
Definition Lock.h:52
OpenZWave::Lock::StaticGetCommandClassId
static uint8 const StaticGetCommandClassId()
Definition Lock.h:46
OpenZWave::Lock::Create
static CommandClass * Create(uint32 const _homeId, uint8 const _nodeId)
Definition Lock.h:43
OpenZWave::Lock::CreateVars
virtual void CreateVars(uint8 const _instance)
Definition Lock.cpp:156
OpenZWave::Lock::StaticGetCommandClassName
static string const StaticGetCommandClassName()
Definition Lock.h:47
OpenZWave::Lock::RequestState
virtual bool RequestState(uint32 const _requestFlags, uint8 const _instance, Driver::MsgQueue const _queue)
Definition Lock.cpp:52
OpenZWave::Lock::RequestValue
virtual bool RequestValue(uint32 const _requestFlags, uint16 const _index, uint8 const _instance, Driver::MsgQueue const _queue)
Definition Lock.cpp:71
OpenZWave::Lock::HandleMsg
virtual bool HandleMsg(uint8 const *_data, uint32 const _length, uint32 const _instance=1)
Definition Lock.cpp:101
OpenZWave::Lock::~Lock
virtual ~Lock()
Definition Lock.h:44
OpenZWave::Lock::GetCommandClassName
virtual string const GetCommandClassName() const
Definition Lock.h:53
OpenZWave::Lock::SetValue
virtual bool SetValue(Value const &_value)
Definition Lock.cpp:127
OpenZWave::Value
Base class for values associated with a node.
Definition Value.h:49
OpenZWave
Definition Bitfield.h:35