OpenZWave Library  1.2
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
ValueDecimal.h
Go to the documentation of this file.
1 //-----------------------------------------------------------------------------
2 //
3 // ValueDecimal.h
4 //
5 // Represents a value that may have a fractional component
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 _ValueDecimal_H
29 #define _ValueDecimal_H
30 
31 #include <string>
32 #include "Defs.h"
33 #include "value_classes/Value.h"
34 
35 class TiXmlElement;
36 
37 namespace OpenZWave
38 {
39  class Msg;
40  class Node;
41 
44  class ValueDecimal: public Value
45  {
46  friend class EnergyProduction;
47  friend class Meter;
48  friend class SensorMultilevel;
49  friend class ThermostatSetpoint;
50 
51  public:
52  ValueDecimal( uint32 const _homeId, uint8 const _nodeId, ValueID::ValueGenre const _genre, uint8 const _commandClassId, uint8 const _instance, uint8 const _index, string const& _label, string const& _units, bool const _readOnly, bool const _writeOnly, string const& _value, uint8 const _pollIntensity );
53  ValueDecimal(): m_precision( 0 ){}
54  virtual ~ValueDecimal(){}
55 
56  bool Set( string const& _value );
57  void OnValueRefreshed( string const& _value );
58 
59  // From Value
60  virtual string const GetAsString() const { return GetValue(); }
61  virtual bool SetFromString( string const& _value ) { return Set( _value ); }
62  virtual void ReadXML( uint32 const _homeId, uint8 const _nodeId, uint8 const _commandClassId, TiXmlElement const* _valueElement );
63  virtual void WriteXML( TiXmlElement* _valueElement );
64 
65  string GetValue()const{ return m_value; }
66  uint8 GetPrecision()const{ return m_precision; }
67 
68  private:
69  void SetPrecision( uint8 _precision ){ m_precision = _precision; }
70 
71  string m_value; // the current value
72  string m_valueCheck; // the previous value (used for double-checking spurious value reads)
73  string m_newValue; // a new value to be set on the appropriate device
74  uint8 m_precision;
75  };
76 
77 } // namespace OpenZWave
78 
79 #endif
80 
81 
82 
virtual ~ValueDecimal()
Definition: ValueDecimal.h:54
Decimal value sent to/received from a node.
Definition: ValueDecimal.h:44
Definition: Bitfield.h:34
Implements COMMAND_CLASS_THERMOSTAT_SETPOINT (0x43), a Z-Wave device command class.
Definition: ThermostatSetpoint.h:41
string GetValue() const
Definition: ValueDecimal.h:65
virtual string const GetAsString() const
Definition: ValueDecimal.h:60
Implements COMMAND_CLASS_METER (0x32), a Z-Wave device command class.
Definition: Meter.h:39
ValueDecimal()
Definition: ValueDecimal.h:53
void OnValueRefreshed()
Definition: Value.cpp:410
uint8 GetPrecision() const
Definition: ValueDecimal.h:66
unsigned int uint32
Definition: Defs.h:69
virtual void ReadXML(uint32 const _homeId, uint8 const _nodeId, uint8 const _commandClassId, TiXmlElement const *_valueElement)
Definition: ValueDecimal.cpp:70
virtual bool SetFromString(string const &_value)
Definition: ValueDecimal.h:61
virtual void WriteXML(TiXmlElement *_valueElement)
Definition: ValueDecimal.cpp:95
Implements COMMAND_CLASS_ENERGY_PRODUCTION (0x90), a Z-Wave device command class. ...
Definition: EnergyProduction.h:39
Base class for values associated with a node.
Definition: Value.h:44
Implements COMMAND_CLASS_SENSOR_MULTILEVEL (0x31), a Z-Wave device command class. ...
Definition: SensorMultilevel.h:39
bool Set()
Definition: Value.cpp:349
ValueGenre
Definition: ValueID.h:71
unsigned char uint8
Definition: Defs.h:63