OpenZWave Library  1.6.989
ValueByte.h
Go to the documentation of this file.
1 //-----------------------------------------------------------------------------
2 //
3 // ValueByte.h
4 //
5 // Represents an 8-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 _ValueByte_H
29 #define _ValueByte_H
30 
31 #include <string>
32 #include "Defs.h"
33 #include "value_classes/Value.h"
34 
35 class TiXmlElement;
36 
37 namespace OpenZWave
38 {
39  namespace Internal
40  {
41  namespace VC
42  {
43 
47  class ValueByte: public Value
48  {
49  public:
50  ValueByte(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, uint8 const _value, uint8 const _pollIntensity);
51  ValueByte();
52  virtual ~ValueByte()
53  {
54  }
55 
56  bool Set(uint8 const _value);
57  void OnValueRefreshed(uint8 const _value);
58 
59  // From Value
60  virtual string const GetAsString() const;
61  virtual bool SetFromString(string const& _value);
62  virtual void ReadXML(uint32 const _homeId, uint8 const _nodeId, uint8 const _commandClassId, TiXmlElement const* _valueElement);
63  virtual void WriteXML(TiXmlElement* _valueElement);
64 
65  uint8 GetValue() const
66  {
67  return m_value;
68  }
69 
70  private:
71  uint8 m_value; // the current value
72  uint8 m_valueCheck; // the previous value (used for double-checking spurious value reads)
73  };
74  } // namespace VC
75  } // namespace Internal
76 } // namespace OpenZWave
77 
78 #endif
79 
virtual bool SetFromString(string const &_value)
Definition: ValueByte.cpp:71
Definition: Bitfield.cpp:30
virtual void WriteXML(TiXmlElement *_valueElement)
Definition: ValueByte.cpp:104
bool Set()
Definition: Value.cpp:276
virtual void ReadXML(uint32 const _homeId, uint8 const _nodeId, uint8 const _commandClassId, TiXmlElement const *_valueElement)
Definition: ValueByte.cpp:85
unsigned short uint16
Definition: Defs.h:88
Byte value sent to/received from a node.
Definition: ValueByte.h:47
void OnValueRefreshed()
Definition: Value.cpp:336
unsigned int uint32
Definition: Defs.h:91
virtual string const GetAsString() const
Definition: ValueByte.cpp:64
uint8 GetValue() const
Definition: ValueByte.h:65
ValueByte()
Definition: ValueByte.cpp:58
virtual ~ValueByte()
Definition: ValueByte.h:52
ValueGenre
Definition: ValueID.h:84
Base class for values associated with a node.
Definition: Value.h:53
unsigned char uint8
Definition: Defs.h:85