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