OpenZWave Library: ValueByte.h Source File

| OpenZWave Library 1.6.0

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