OpenZWave Library 1.6.1914
ValueInt.h
Go to the documentation of this file.
1//-----------------------------------------------------------------------------
2//
3// ValueInt.h
4//
5// Represents a 32-bit value
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 _ValueInt_H
29#define _ValueInt_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 ValueInt: public Value
48 {
49 public:
50 ValueInt(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, int32 const _value, uint8 const _pollIntensity);
51 ValueInt();
52 virtual ~ValueInt()
53 {
54 }
55
56 bool Set(int32 const _value);
57 void OnValueRefreshed(int32 const _value);
58 void SetTargetValue(int32 const _target, uint32 _duration = 0);
59
60
61 // From Value
62 virtual string const GetAsString() const;
63 virtual bool SetFromString(string const& _value);
64 virtual void ReadXML(uint32 const _homeId, uint8 const _nodeId, uint8 const _commandClassId, TiXmlElement const* _valueElement);
65 virtual void WriteXML(TiXmlElement* _valueElement);
66
68 {
69 return m_value;
70 }
71
72 private:
73 int32 m_value; // the current value
74 int32 m_valueCheck; // the previous value (used for double-checking spurious value reads)
75 int32 m_targetValue; // Target Value
76 };
77 } // namespace VC
78 } // namespace Internal
79} // namespace OpenZWave
80
81#endif
unsigned short uint16
Definition: Defs.h:88
unsigned int uint32
Definition: Defs.h:91
signed int int32
Definition: Defs.h:90
unsigned char uint8
Definition: Defs.h:85
Integer value sent to/received from a node.
Definition: ValueInt.h:48
virtual ~ValueInt()
Definition: ValueInt.h:52
virtual bool SetFromString(string const &_value)
Definition: ValueInt.cpp:74
int32 GetValue() const
Definition: ValueInt.h:67
void SetTargetValue(int32 const _target, uint32 _duration=0)
Definition: ValueInt.cpp:135
virtual void WriteXML(TiXmlElement *_valueElement)
Definition: ValueInt.cpp:103
ValueInt()
Definition: ValueInt.cpp:59
virtual void ReadXML(uint32 const _homeId, uint8 const _nodeId, uint8 const _commandClassId, TiXmlElement const *_valueElement)
Definition: ValueInt.cpp:84
virtual string const GetAsString() const
Definition: ValueInt.cpp:67
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