OpenZWave Library  1.6.943
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 {
36  namespace Internal
37  {
38  namespace CC
39  {
43  class Association: public CommandClass
44  {
45  friend class OpenZWave::Group;
46 
47  public:
48  static CommandClass* Create(uint32 const _homeId, uint8 const _nodeId)
49  {
50  return new Association(_homeId, _nodeId);
51  }
52  virtual ~Association()
53  {
54  }
55 
57  {
58  return 0x85;
59  }
60  static string const StaticGetCommandClassName()
61  {
62  return "COMMAND_CLASS_ASSOCIATION";
63  }
64 
65  // From CommandClass
66  virtual void ReadXML(TiXmlElement const* _ccElement) override;
67  virtual void WriteXML(TiXmlElement* _ccElement) override;
68  virtual bool RequestState(uint32 const _requestFlags, uint8 const _instance, Driver::MsgQueue const _queue) override;
69  virtual bool RequestValue(uint32 const _requestFlags, uint16 const _index, uint8 const _instance, Driver::MsgQueue const _queue) override;
70  virtual uint8 const GetCommandClassId() const override
71  {
72  return StaticGetCommandClassId();
73  }
74  virtual string const GetCommandClassName() const override
75  {
77  }
78  virtual bool HandleMsg(uint8 const* _data, uint32 const _length, uint32 const _instance = 1) override;
79 
80  void RequestAllGroups(uint32 const _requestFlags);
81  void Set(uint8 const _group, uint8 const _nodeId);
82  void Remove(uint8 const _group, uint8 const _nodeId);
83 
84  private:
85  Association(uint32 const _homeId, uint8 const _nodeId);
86  void QueryGroup(uint8 _groupIdx, uint32 const _requestFlags);
87  void AutoAssociate();
88 
89  bool m_queryAll; // When true, once a group has been queried, we request the next one.
90  uint8 m_numGroups; // Number of groups supported by the device. 255 is reported by certain manufacturers and requires special handling.
91  vector<uint8> m_pendingMembers; // Used to build a list of group members from multiple reports
92  };
93  } // namespace CC
94  } // namespace Internal
95 } // namespace OpenZWave
96 
97 #endif
98 
Definition: Bitfield.cpp:30
MsgQueue
Definition: Driver.h:656
virtual uint8 const GetCommandClassId() const override
Definition: Association.h:70
unsigned short uint16
Definition: Defs.h:88
static uint8 const StaticGetCommandClassId()
Definition: Association.h:56
Implements COMMAND_CLASS_ASSOCIATION (0x85), a Z-Wave device command class.
Definition: Association.h:43
void Set(uint8 const _group, uint8 const _nodeId)
Definition: Association.cpp:322
virtual bool RequestValue(uint32 const _requestFlags, uint16 const _index, uint8 const _instance, Driver::MsgQueue const _queue) override
Definition: Association.cpp:144
void RequestAllGroups(uint32 const _requestFlags)
Definition: Association.cpp:167
Base class for all Z-Wave command classes.
Definition: CommandClass.h:60
void Remove(uint8 const _group, uint8 const _nodeId)
Definition: Association.cpp:341
virtual string const GetCommandClassName() const override
Definition: Association.h:74
static CommandClass * Create(uint32 const _homeId, uint8 const _nodeId)
Definition: Association.h:48
virtual void ReadXML(TiXmlElement const *_ccElement) override
Definition: Association.cpp:69
unsigned int uint32
Definition: Defs.h:91
virtual bool HandleMsg(uint8 const *_data, uint32 const _length, uint32 const _instance=1) override
Definition: Association.cpp:190
Manages a group of devices (various nodes associated with each other).
Definition: Group.h:71
virtual bool RequestState(uint32 const _requestFlags, uint8 const _instance, Driver::MsgQueue const _queue) override
Definition: Association.cpp:129
virtual void WriteXML(TiXmlElement *_ccElement) override
Definition: Association.cpp:108
virtual ~Association()
Definition: Association.h:52
static string const StaticGetCommandClassName()
Definition: Association.h:60
unsigned char uint8
Definition: Defs.h:85