OpenZWave Library: Meter.h Source File

| OpenZWave Library 1.6.0

Meter.h
Go to the documentation of this file.
1//-----------------------------------------------------------------------------
2//
3// Meter.h
4//
5// Implementation of the Z-Wave COMMAND_CLASS_METER
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 _Meter_H
29#define _Meter_H
30
31#include "command_classes/CommandClass.h"
32
33namespace OpenZWave
34{
35 class ValueDecimal;
36
40 class Meter: public CommandClass
41 {
42 public:
43 static CommandClass* Create( uint32 const _homeId, uint8 const _nodeId ){ return new Meter( _homeId, _nodeId ); }
44 virtual ~Meter(){}
45
46 static uint8 const StaticGetCommandClassId(){ return 0x32; }
47 static string const StaticGetCommandClassName(){ return "COMMAND_CLASS_METER"; }
48
49 // From CommandClass
50 virtual bool RequestState( uint32 const _requestFlags, uint8 const _instance, Driver::MsgQueue const _queue );
51 virtual bool RequestValue( uint32 const _requestFlags, uint16 const _index, uint8 const _instance, Driver::MsgQueue const _queue );
52 virtual uint8 const GetCommandClassId()const{ return StaticGetCommandClassId(); }
53 virtual string const GetCommandClassName()const{ return StaticGetCommandClassName(); }
54 virtual bool HandleMsg( uint8 const* _data, uint32 const _length, uint32 const _instance = 1 );
55 virtual bool SetValue( Value const& _value );
56 virtual uint8 GetMaxVersion(){ return 3; }
57
58 protected:
59 virtual void CreateVars( uint8 const _instance );
60
61 private:
62 Meter( uint32 const _homeId, uint8 const _nodeId );
63
64 bool HandleSupportedReport( uint8 const* _data, uint32 const _length, uint32 const _instance = 1 );
65 bool HandleReport( uint8 const* _data, uint32 const _length, uint32 const _instance = 1 );
66
67 };
68
69} // namespace OpenZWave
70
71
72#endif
73
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::CommandClass
Base class for all Z-Wave command classes.
Definition: CommandClass.h:56
OpenZWave::Driver::MsgQueue
MsgQueue
Definition: Driver.h:592
OpenZWave::Meter
Implements COMMAND_CLASS_METER (0x32), a Z-Wave device command class.
Definition: Meter.h:41
OpenZWave::Meter::GetCommandClassId
virtual uint8 const GetCommandClassId() const
Definition: Meter.h:52
OpenZWave::Meter::HandleMsg
virtual bool HandleMsg(uint8 const *_data, uint32 const _length, uint32 const _instance=1)
Definition: Meter.cpp:221
OpenZWave::Meter::GetCommandClassName
virtual string const GetCommandClassName() const
Definition: Meter.h:53
OpenZWave::Meter::Create
static CommandClass * Create(uint32 const _homeId, uint8 const _nodeId)
Definition: Meter.h:43
OpenZWave::Meter::SetValue
virtual bool SetValue(Value const &_value)
Definition: Meter.cpp:524
OpenZWave::Meter::StaticGetCommandClassId
static uint8 const StaticGetCommandClassId()
Definition: Meter.h:46
OpenZWave::Meter::~Meter
virtual ~Meter()
Definition: Meter.h:44
OpenZWave::Meter::RequestState
virtual bool RequestState(uint32 const _requestFlags, uint8 const _instance, Driver::MsgQueue const _queue)
Definition: Meter.cpp:144
OpenZWave::Meter::CreateVars
virtual void CreateVars(uint8 const _instance)
Definition: Meter.cpp:553
OpenZWave::Meter::StaticGetCommandClassName
static string const StaticGetCommandClassName()
Definition: Meter.h:47
OpenZWave::Meter::RequestValue
virtual bool RequestValue(uint32 const _requestFlags, uint16 const _index, uint8 const _instance, Driver::MsgQueue const _queue)
Definition: Meter.cpp:180
OpenZWave::Meter::GetMaxVersion
virtual uint8 GetMaxVersion()
Definition: Meter.h:56
OpenZWave::Value
Base class for values associated with a node.
Definition: Value.h:49
OpenZWave
Definition: Bitfield.h:35