| OpenZWave Library 1.6.0

Configuration.h
Go to the documentation of this file.
1 //-----------------------------------------------------------------------------
2 //
3 // Configuration.h
4 //
5 // Implementation of the Z-Wave COMMAND_CLASS_CONFIGURATION
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 _Configuration_H
29 #define _Configuration_H
30
31 #include <list>
32 #include "command_classes/CommandClass.h"
33
34 namespace OpenZWave
35 {
36 class Value;
37
41 class Configuration: public CommandClass
42 {
43 friend class Node;
44
45 public:
46 static CommandClass* Create( uint32 const _homeId, uint8 const _nodeId ){ return new Configuration( _homeId, _nodeId ); }
47 virtual ~Configuration(){}
48
49 static uint8 const StaticGetCommandClassId(){ return 0x70; }
50 static string const StaticGetCommandClassName(){ return "COMMAND_CLASS_CONFIGURATION"; }
51
52 virtual bool RequestValue( uint32 const _requestFlags, uint16 const _parameter, uint8 const _index, Driver::MsgQueue const _queue );
53 void Set( uint16 const _parameter, int32 const _value, uint8 const _size );
54
55 // From CommandClass
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 virtual bool SetValue( Value const& _value );
60
61 private:
62 Configuration( uint32 const _homeId, uint8 const _nodeId ): CommandClass( _homeId, _nodeId ){}
63 };
64
65 } // namespace OpenZWave
66
67 #endif
68
uint32
unsigned int uint32
Definition: Defs.h:95
OpenZWave::Configuration::RequestValue
virtual bool RequestValue(uint32 const _requestFlags, uint16 const _parameter, uint8 const _index, Driver::MsgQueue const _queue)
Definition: Configuration.cpp:231
OpenZWave::Node
The Node class describes a Z-Wave node object...typically a device on the Z-Wave network.
Definition: Node.h:66
OpenZWave::Configuration::StaticGetCommandClassId
static uint8 const StaticGetCommandClassId()
Definition: Configuration.h:49
OpenZWave::CommandClass
Base class for all Z-Wave command classes.
Definition: CommandClass.h:56
uint8
unsigned char uint8
Definition: Defs.h:89
OpenZWave::Configuration::Create
static CommandClass * Create(uint32 const _homeId, uint8 const _nodeId)
Definition: Configuration.h:46
OpenZWave::Configuration::SetValue
virtual bool SetValue(Value const &_value)
Definition: Configuration.cpp:167
OpenZWave::Configuration::GetCommandClassId
virtual uint8 const GetCommandClassId() const
Definition: Configuration.h:56
int32
signed int int32
Definition: Defs.h:94
OpenZWave::Configuration::~Configuration
virtual ~Configuration()
Definition: Configuration.h:47
OpenZWave::Configuration::StaticGetCommandClassName
static string const StaticGetCommandClassName()
Definition: Configuration.h:50
OpenZWave::Configuration::Set
void Set(uint16 const _parameter, int32 const _value, uint8 const _size)
Definition: Configuration.cpp:264
OpenZWave::Configuration::GetCommandClassName
virtual string const GetCommandClassName() const
Definition: Configuration.h:57
OpenZWave::Value
Base class for values associated with a node.
Definition: Value.h:49
CommandClass.h
OpenZWave::Configuration
Implements COMMAND_CLASS_CONFIGURATION (0x70), a Z-Wave device command class.
Definition: Configuration.h:42
OpenZWave::Driver::MsgQueue
MsgQueue
Definition: Driver.h:592
OpenZWave::Configuration::HandleMsg
virtual bool HandleMsg(uint8 const *_data, uint32 const _length, uint32 const _instance=1)
Definition: Configuration.cpp:57
uint16
unsigned short uint16
Definition: Defs.h:92
OpenZWave
Definition: Bitfield.h:35