OpenZWave Library  1.2
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Association.h
Go to the documentation of this file.
1 //-----------------------------------------------------------------------------
2 //
3 // Association.h
4 //
5 // Implementation of the Z-Wave COMMAND_CLASS_ASSOCIATION
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 _Association_H
29 #define _Association_H
30 
31 #include <vector>
33 
34 namespace OpenZWave
35 {
38  class Association: public CommandClass
39  {
40  friend class Group;
41 
42  public:
43  static CommandClass* Create( uint32 const _homeId, uint8 const _nodeId ){ return new Association( _homeId, _nodeId ); }
44  virtual ~Association(){}
45 
46  static uint8 const StaticGetCommandClassId(){ return 0x85; }
47  static string const StaticGetCommandClassName(){ return "COMMAND_CLASS_ASSOCIATION"; }
48 
49  // From CommandClass
50  virtual void ReadXML( TiXmlElement const* _ccElement );
51  virtual void WriteXML( TiXmlElement* _ccElement );
52  virtual bool RequestState( uint32 const _requestFlags, uint8 const _instance, Driver::MsgQueue const _queue );
53  virtual bool RequestValue( uint32 const _requestFlags, uint8 const _index, uint8 const _instance, Driver::MsgQueue const _queue );
54  virtual uint8 const GetCommandClassId()const{ return StaticGetCommandClassId(); }
55  virtual string const GetCommandClassName()const{ return StaticGetCommandClassName(); }
56  virtual bool HandleMsg( uint8 const* _data, uint32 const _length, uint32 const _instance = 1 );
57 
58  void RequestAllGroups( uint32 const _requestFlags );
59  void Set( uint8 const _group, uint8 const _nodeId );
60  void Remove( uint8 const _group, uint8 const _nodeId );
61 
62  private:
63  Association( uint32 const _homeId, uint8 const _nodeId );
64  void QueryGroup( uint8 _groupIdx, uint32 const _requestFlags );
65  void AutoAssociate();
66 
67  bool m_queryAll; // When true, once a group has been queried, we request the next one.
68  uint8 m_numGroups; // Number of groups supported by the device. 255 is reported by certain manufacturers and requires special handling.
69  vector<uint8> m_pendingMembers; // Used to build a list of group members from multiple reports
70  };
71 
72 } // namespace OpenZWave
73 
74 #endif
75 
Implements COMMAND_CLASS_ASSOCIATION (0x85), a Z-Wave device command class.
Definition: Association.h:38
Definition: Bitfield.h:34
virtual uint8 const GetCommandClassId() const
Definition: Association.h:54
MsgQueue
Definition: Driver.h:583
void Set(uint8 const _group, uint8 const _nodeId)
Definition: Association.cpp:350
virtual ~Association()
Definition: Association.h:44
virtual bool RequestValue(uint32 const _requestFlags, uint8 const _index, uint8 const _instance, Driver::MsgQueue const _queue)
Definition: Association.cpp:158
virtual void WriteXML(TiXmlElement *_ccElement)
Definition: Association.cpp:114
static CommandClass * Create(uint32 const _homeId, uint8 const _nodeId)
Definition: Association.h:43
void RequestAllGroups(uint32 const _requestFlags)
Definition: Association.cpp:186
virtual bool HandleMsg(uint8 const *_data, uint32 const _length, uint32 const _instance=1)
Definition: Association.cpp:212
Base class for all Z-Wave command classes.
Definition: CommandClass.h:46
void Remove(uint8 const _group, uint8 const _nodeId)
Definition: Association.cpp:373
unsigned int uint32
Definition: Defs.h:69
Manages a group of devices (various nodes associated with each other).
Definition: Group.h:44
virtual string const GetCommandClassName() const
Definition: Association.h:55
static uint8 const StaticGetCommandClassId()
Definition: Association.h:46
virtual void ReadXML(TiXmlElement const *_ccElement)
Definition: Association.cpp:72
virtual bool RequestState(uint32 const _requestFlags, uint8 const _instance, Driver::MsgQueue const _queue)
Definition: Association.cpp:138
static string const StaticGetCommandClassName()
Definition: Association.h:47
unsigned char uint8
Definition: Defs.h:63