OpenZWave Library: MultiChannelAssociation.h Source File

| OpenZWave Library 1.6.0

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