OpenZWave Library: ValueShort.h Source File

| OpenZWave Library 1.6.0

ValueShort.h
Go to the documentation of this file.
1 //-----------------------------------------------------------------------------
2 //
3 // ValueShort.h
4 //
5 // Represents a 16-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 _ValueShort_H
29 #define _ValueShort_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 class Msg;
40 class Node;
41
45 class ValueShort: public Value
46 {
47 public:
48 ValueShort( 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, int16 const _value, uint8 const _pollIntensity );
49 ValueShort();
50 virtual ~ValueShort(){}
51
52 bool Set( int16 const _value );
53 void OnValueRefreshed( int16 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 int16 GetValue()const{ return m_value; }
62
63 private:
64 int16 m_value; // the current value
65 int16 m_valueCheck; // the previous value (used for double-checking spurious value reads)
66 };
67
68 } // namespace OpenZWave
69
70 #endif
OpenZWave
Definition: Bitfield.h:34
OpenZWave::ValueShort
Short value sent to/received from a node.
Definition: ValueShort.h:45
OpenZWave::ValueShort::GetValue
int16 GetValue() const
Definition: ValueShort.h:61
OpenZWave::ValueShort::ReadXML
virtual void ReadXML(uint32 const _homeId, uint8 const _nodeId, uint8 const _commandClassId, TiXmlElement const *_valueElement)
Definition: ValueShort.cpp:109
uint16
unsigned short uint16
Definition: Defs.h:92
OpenZWave::ValueShort::~ValueShort
virtual ~ValueShort()
Definition: ValueShort.h:50
OpenZWave::ValueShort::GetAsString
virtual string const GetAsString() const
Definition: ValueShort.cpp:83
Defs.h
OpenZWave::ValueShort::SetFromString
virtual bool SetFromString(string const &_value)
Definition: ValueShort.cpp:92
OpenZWave::Value::OnValueRefreshed
void OnValueRefreshed()
Definition: Value.cpp:405
int16
signed short int16
Definition: Defs.h:91
uint32
unsigned int uint32
Definition: Defs.h:95
Value.h
OpenZWave::Value
Base class for values associated with a node.
Definition: Value.h:48
OpenZWave::ValueShort::ValueShort
ValueShort()
Definition: ValueShort.cpp:72
OpenZWave::Value::Set
bool Set()
Definition: Value.cpp:343
OpenZWave::ValueID::ValueGenre
ValueGenre
Definition: ValueID.h:80
OpenZWave::ValueShort::WriteXML
virtual void WriteXML(TiXmlElement *_valueElement)
Definition: ValueShort.cpp:134
uint8
unsigned char uint8
Definition: Defs.h:89