OpenZWave Library 1.6.1914
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
35class TiXmlElement;
36
37namespace OpenZWave
38{
39 namespace Internal
40 {
41 namespace VC
42 {
43
47 class ValueDecimal: public Value
48 {
49
50 public:
51 ValueDecimal(uint32 const _homeId, uint8 const _nodeId, ValueID::ValueGenre const _genre, uint8 const _commandClassId, uint8 const _instance, uint16 const _index, string const& _label, string const& _units, bool const _readOnly, bool const _writeOnly, string const& _value, uint8 const _pollIntensity);
53 m_precision(0)
54 {
55 }
56 virtual ~ValueDecimal()
57 {
58 }
59
60 bool Set(string const& _value);
61 void OnValueRefreshed(string const& _value);
62 void SetTargetValue(string const _target, uint32 _duration = 0);
63
64 // From Value
65 virtual string const GetAsString() const
66 {
67 return GetValue();
68 }
69 virtual bool SetFromString(string const& _value)
70 {
71 return Set(_value);
72 }
73 virtual void ReadXML(uint32 const _homeId, uint8 const _nodeId, uint8 const _commandClassId, TiXmlElement const* _valueElement);
74 virtual void WriteXML(TiXmlElement* _valueElement);
75
76 string GetValue() const
77 {
78 return m_value;
79 }
81 {
82 return m_precision;
83 }
84 void SetPrecision(uint8 _precision)
85 {
86 m_precision = _precision;
87 }
88
89 private:
90
91 string m_value; // the current value
92 string m_valueCheck; // the previous value (used for double-checking spurious value reads)
93 string m_newValue; // a new value to be set on the appropriate device
94 uint8 m_precision;
95 string m_targetValue; // Target Value if supported.
96 };
97 } // namespace VC
98 } // namespace Internal
99} // namespace OpenZWave
100
101#endif
102
unsigned short uint16
Definition: Defs.h:88
unsigned int uint32
Definition: Defs.h:91
unsigned char uint8
Definition: Defs.h:85
Decimal value sent to/received from a node.
Definition: ValueDecimal.h:48
void SetPrecision(uint8 _precision)
Definition: ValueDecimal.h:84
virtual ~ValueDecimal()
Definition: ValueDecimal.h:56
virtual void WriteXML(TiXmlElement *_valueElement)
Definition: ValueDecimal.cpp:74
void SetTargetValue(string const _target, uint32 _duration=0)
Definition: ValueDecimal.cpp:103
virtual bool SetFromString(string const &_value)
Definition: ValueDecimal.h:69
virtual void ReadXML(uint32 const _homeId, uint8 const _nodeId, uint8 const _commandClassId, TiXmlElement const *_valueElement)
Definition: ValueDecimal.cpp:55
virtual string const GetAsString() const
Definition: ValueDecimal.h:65
uint8 GetPrecision() const
Definition: ValueDecimal.h:80
string GetValue() const
Definition: ValueDecimal.h:76
ValueDecimal()
Definition: ValueDecimal.h:52
Base class for values associated with a node.
Definition: Value.h:55
bool Set()
Definition: Value.cpp:289
void OnValueRefreshed()
Definition: Value.cpp:351
ValueGenre
Definition: ValueID.h:85
Definition: Bitfield.cpp:31