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