OpenZWave Library  1.5.0
Basic.h
Go to the documentation of this file.
1 //-----------------------------------------------------------------------------
2 //
3 // Basic.h
4 //
5 // Implementation of the Z-Wave COMMAND_CLASS_BASIC
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 _Basic_H
29 #define _Basic_H
30 
32 
33 namespace OpenZWave
34 {
35  class ValueByte;
36 
40  class Basic: public CommandClass
41  {
42  public:
43  static CommandClass* Create( uint32 const _homeId, uint8 const _nodeId ){ return new Basic( _homeId, _nodeId ); }
44  virtual ~Basic(){}
45 
46  static uint8 const StaticGetCommandClassId(){ return 0x20; }
47  static string const StaticGetCommandClassName(){ return "COMMAND_CLASS_BASIC"; }
48 
49  bool SetMapping( uint8 const _commandClassId, bool const _doLog = true ); // Map COMMAND_CLASS_BASIC messages to another command class
50  uint8 GetMapping(){ return m_mapping; }
51 
52  // From CommandClass
53  virtual void ReadXML( TiXmlElement const* _ccElement );
54  virtual void WriteXML( TiXmlElement* _ccElement );
55  virtual bool RequestState( uint32 const _requestFlags, uint8 const _instance, Driver::MsgQueue const _queue );
56  virtual bool RequestValue( uint32 const _requestFlags, uint16 const _index, uint8 const _instance, Driver::MsgQueue const _queue );
57  virtual uint8 const GetCommandClassId()const{ return StaticGetCommandClassId(); }
58  virtual string const GetCommandClassName()const{ return StaticGetCommandClassName(); }
59  virtual bool HandleMsg( uint8 const* _data, uint32 const _length, uint32 const _instance = 1 );
60  virtual bool SetValue( Value const& _value );
61 
62  void Set( uint8 const _level );
63 
64  protected:
65  virtual void CreateVars( uint8 const _instance );
66 
67  private:
68  Basic( uint32 const _homeId, uint8 const _nodeId );
69 
70  uint8 m_mapping;
71  bool m_ignoreMapping;
72  bool m_setAsReport;
73  std::vector<int> m_instances;
74  };
75 
76 } // namespace OpenZWave
77 
78 #endif
79 
Definition: Bitfield.h:34
MsgQueue
Definition: Driver.h:575
unsigned short uint16
Definition: Defs.h:93
virtual bool HandleMsg(uint8 const *_data, uint32 const _length, uint32 const _instance=1)
Definition: Basic.cpp:188
virtual bool SetValue(Value const &_value)
Definition: Basic.cpp:248
virtual string const GetCommandClassName() const
Definition: Basic.h:58
virtual uint8 const GetCommandClassId() const
Definition: Basic.h:57
Base class for all Z-Wave command classes.
Definition: CommandClass.h:54
uint8 GetMapping()
Definition: Basic.h:50
virtual void WriteXML(TiXmlElement *_ccElement)
Definition: Basic.cpp:106
virtual bool RequestValue(uint32 const _requestFlags, uint16 const _index, uint8 const _instance, Driver::MsgQueue const _queue)
Definition: Basic.cpp:159
unsigned int uint32
Definition: Defs.h:96
bool SetMapping(uint8 const _commandClassId, bool const _doLog=true)
Definition: Basic.cpp:307
virtual ~Basic()
Definition: Basic.h:44
Base class for values associated with a node.
Definition: Value.h:48
virtual void ReadXML(TiXmlElement const *_ccElement)
Definition: Basic.cpp:73
virtual bool RequestState(uint32 const _requestFlags, uint8 const _instance, Driver::MsgQueue const _queue)
Definition: Basic.cpp:135
Implements COMMAND_CLASS_BASIC (0x20), a Z-Wave device command class.
Definition: Basic.h:40
virtual void CreateVars(uint8 const _instance)
Definition: Basic.cpp:277
static string const StaticGetCommandClassName()
Definition: Basic.h:47
void Set(uint8 const _level)
Definition: Basic.cpp:289
static CommandClass * Create(uint32 const _homeId, uint8 const _nodeId)
Definition: Basic.h:43
static uint8 const StaticGetCommandClassId()
Definition: Basic.h:46
unsigned char uint8
Definition: Defs.h:90