OpenZWave Library  1.6.896
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  namespace Internal
36  {
37  namespace CC
38  {
39 
43  class Indicator: public CommandClass
44  {
45  public:
46  static CommandClass* Create(uint32 const _homeId, uint8 const _nodeId)
47  {
48  return new Indicator(_homeId, _nodeId);
49  }
50  virtual ~Indicator()
51  {
52  }
53 
55  {
56  return 0x87;
57  }
58  static string const StaticGetCommandClassName()
59  {
60  return "COMMAND_CLASS_INDICATOR";
61  }
62 
63  // From CommandClass
64  virtual bool RequestState(uint32 const _requestFlags, uint8 const _instance, Driver::MsgQueue const _queue) override;
65  virtual bool RequestValue(uint32 const _requestFlags, uint16 const _index, uint8 const _instance, Driver::MsgQueue const _queue) override;
66  virtual uint8 const GetCommandClassId() const override
67  {
68  return StaticGetCommandClassId();
69  }
70  virtual string const GetCommandClassName() const override
71  {
73  }
74  virtual bool HandleMsg(uint8 const* _data, uint32 const _length, uint32 const _instance = 1) override;
75  virtual bool SetValue(Internal::VC::Value const& _value) override;
76 
77  protected:
78  virtual void CreateVars(uint8 const _instance) override;
79 
80  private:
81  Indicator(uint32 const _homeId, uint8 const _nodeId) :
82  CommandClass(_homeId, _nodeId)
83  {
84  }
85  };
86  } // namespace CC
87  } // namespace Internal
88 } // namespace OpenZWave
89 
90 #endif
91 
virtual uint8 const GetCommandClassId() const override
Definition: Indicator.h:66
Definition: Bitfield.cpp:30
MsgQueue
Definition: Driver.h:658
virtual bool RequestState(uint32 const _requestFlags, uint8 const _instance, Driver::MsgQueue const _queue) override
Definition: Indicator.cpp:56
unsigned short uint16
Definition: Defs.h:89
virtual void CreateVars(uint8 const _instance) override
Definition: Indicator.cpp:144
virtual bool SetValue(Internal::VC::Value const &_value) override
Definition: Indicator.cpp:118
static CommandClass * Create(uint32 const _homeId, uint8 const _nodeId)
Definition: Indicator.h:46
Base class for all Z-Wave command classes.
Definition: CommandClass.h:60
static uint8 const StaticGetCommandClassId()
Definition: Indicator.h:54
unsigned int uint32
Definition: Defs.h:92
virtual ~Indicator()
Definition: Indicator.h:50
virtual string const GetCommandClassName() const override
Definition: Indicator.h:70
static string const StaticGetCommandClassName()
Definition: Indicator.h:58
virtual bool RequestValue(uint32 const _requestFlags, uint16 const _index, uint8 const _instance, Driver::MsgQueue const _queue) override
Definition: Indicator.cpp:70
virtual bool HandleMsg(uint8 const *_data, uint32 const _length, uint32 const _instance=1) override
Definition: Indicator.cpp:96
Base class for values associated with a node.
Definition: Value.h:53
Implements COMMAND_CLASS_INDICATOR (0x87), a Z-Wave device command class.
Definition: Indicator.h:43
unsigned char uint8
Definition: Defs.h:86