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