| OpenZWave Library 1.6.0

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