Association.h
Go to the documentation of this file.
//-----------------------------------------------------------------------------
//
// Association.h
//
// Implementation of the Z-Wave COMMAND_CLASS_ASSOCIATION
//
// Copyright (c) 2010 Mal Lansell <openzwave@lansell.org>
//
// SOFTWARE NOTICE AND LICENSE
//
// This file is part of OpenZWave.
//
// OpenZWave is free software: you can redistribute it and/or modify
// it under the terms of the GNU Lesser General Public License as published
// by the Free Software Foundation, either version 3 of the License,
// or (at your option) any later version.
//
// OpenZWave is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public License
// along with OpenZWave. If not, see <http://www.gnu.org/licenses/>.
//
//-----------------------------------------------------------------------------
#ifndef _Association_H
#define _Association_H
#include <vector>
#include "command_classes/CommandClass.h"
namespace OpenZWave
{
class Association: public CommandClass
{
friend class Group;
public:
static CommandClass* Create( uint32 const _homeId, uint8 const _nodeId ){ return new Association( _homeId, _nodeId ); }
virtual ~Association(){}
static uint8 const StaticGetCommandClassId(){ return 0x85; }
static string const StaticGetCommandClassName(){ return "COMMAND_CLASS_ASSOCIATION"; }
// From CommandClass
virtual void ReadXML( TiXmlElement const* _ccElement );
virtual void WriteXML( TiXmlElement* _ccElement );
virtual bool RequestState( uint32 const _requestFlags, uint8 const _instance, Driver::MsgQueue const _queue );
virtual bool RequestValue( uint32 const _requestFlags, uint8 const _index, uint8 const _instance, Driver::MsgQueue const _queue );
virtual uint8 const GetCommandClassId()const{ return StaticGetCommandClassId(); }
virtual string const GetCommandClassName()const{ return StaticGetCommandClassName(); }
virtual bool HandleMsg( uint8 const* _data, uint32 const _length, uint32 const _instance = 1 );
void RequestAllGroups( uint32 const _requestFlags );
void Set( uint8 const _group, uint8 const _nodeId );
void Remove( uint8 const _group, uint8 const _nodeId );
private:
Association( uint32 const _homeId, uint8 const _nodeId );
void QueryGroup( uint8 _groupIdx, uint32 const _requestFlags );
void AutoAssociate();
bool m_queryAll; // When true, once a group has been queried, we request the next one.
uint8 m_numGroups; // Number of groups supported by the device. 255 is reported by certain manufacturers and requires special handling.
vector<uint8> m_pendingMembers; // Used to build a list of group members from multiple reports
};
} // namespace OpenZWave
#endif
OpenZWave::Association
Implements COMMAND_CLASS_ASSOCIATION (0x85), a Z-Wave device command class.
Definition: Association.h:38
OpenZWave
Definition: Bitfield.h:34
OpenZWave::Driver::MsgQueue
MsgQueue
Definition: Driver.h:565
OpenZWave::Association::Set
void Set(uint8 const _group, uint8 const _nodeId)
Definition: Association.cpp:350
CommandClass.h
OpenZWave::Association::~Association
virtual ~Association()
Definition: Association.h:44
OpenZWave::Association::RequestValue
virtual bool RequestValue(uint32 const _requestFlags, uint8 const _index, uint8 const _instance, Driver::MsgQueue const _queue)
Definition: Association.cpp:158
OpenZWave::Association::WriteXML
virtual void WriteXML(TiXmlElement *_ccElement)
Definition: Association.cpp:114
OpenZWave::Association::Create
static CommandClass * Create(uint32 const _homeId, uint8 const _nodeId)
Definition: Association.h:43
OpenZWave::Association::GetCommandClassName
virtual string const GetCommandClassName() const
Definition: Association.h:55
OpenZWave::Association::RequestAllGroups
void RequestAllGroups(uint32 const _requestFlags)
Definition: Association.cpp:186
OpenZWave::Association::HandleMsg
virtual bool HandleMsg(uint8 const *_data, uint32 const _length, uint32 const _instance=1)
Definition: Association.cpp:212
OpenZWave::CommandClass
Base class for all Z-Wave command classes.
Definition: CommandClass.h:46
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:54
uint32
unsigned int uint32
Definition: Defs.h:80
OpenZWave::Group
Manages a group of devices (various nodes associated with each other).
Definition: Group.h:49
OpenZWave::Association::StaticGetCommandClassId
static uint8 const StaticGetCommandClassId()
Definition: Association.h:46
OpenZWave::Association::ReadXML
virtual void ReadXML(TiXmlElement const *_ccElement)
Definition: Association.cpp:72
OpenZWave::Association::RequestState
virtual bool RequestState(uint32 const _requestFlags, uint8 const _instance, Driver::MsgQueue const _queue)
Definition: Association.cpp:138
OpenZWave::Association::StaticGetCommandClassName
static string const StaticGetCommandClassName()
Definition: Association.h:47
uint8
unsigned char uint8
Definition: Defs.h:74