OpenZWave Library 1.6.0
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 class Msg;
40 class Node;
41 class CommandClass;
42
46 class ValueBool: public Value
47 {
48 public:
49 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 );
51 virtual ~ValueBool(){}
52
53 bool Set( bool const _value );
54 void OnValueRefreshed( bool const _value );
55
56 // From Value
57 virtual string const GetAsString() const { return ( GetValue() ? "True" : "False" ); }
58 virtual bool SetFromString( string const& _value );
59 virtual void ReadXML( uint32 const _homeId, uint8 const _nodeId, uint8 const _commandClassId, TiXmlElement const* _valueElement );
60 virtual void WriteXML( TiXmlElement* _valueElement );
61
62 bool GetValue()const{ return m_value; }
63
64 private:
65 bool m_value; // the current index in the m_items vector
66 bool m_valueCheck; // the previous value (used for double-checking spurious value reads)
67 };
68
69} // namespace OpenZWave
70
71#endif
72
73
74
unsigned short uint16
Definition: Defs.h:92
unsigned int uint32
Definition: Defs.h:95
unsigned char uint8
Definition: Defs.h:89
Boolean value sent to/received from a node.
Definition: ValueBool.h:47
virtual bool SetFromString(string const &_value)
Definition: ValueBool.cpp:65
virtual string const GetAsString() const
Definition: ValueBool.h:57
virtual void WriteXML(TiXmlElement *_valueElement)
Definition: ValueBool.cpp:108
virtual void ReadXML(uint32 const _homeId, uint8 const _nodeId, uint8 const _commandClassId, TiXmlElement const *_valueElement)
Definition: ValueBool.cpp:83
virtual ~ValueBool()
Definition: ValueBool.h:51
bool GetValue() const
Definition: ValueBool.h:62
ValueBool()
Definition: ValueBool.h:50
ValueGenre
Definition: ValueID.h:81
Base class for values associated with a node.
Definition: Value.h:49
void OnValueRefreshed()
Definition: Value.cpp:405
bool Set()
Definition: Value.cpp:343
Definition: Bitfield.h:35