ValueShort.h
Go to the documentation of this file.
//-----------------------------------------------------------------------------
//
// ValueShort.h
//
// Represents a 16-bit value
//
// Copyright (c) 2010 Mal Lansell <openzwave@lansell.org>
//
// SOFTWARE NOTICE AND LICENSE
//
// This file is part of OpenZWave.
//
// OpenZWave is free software: you can redistribute it and/or modify
// it under the terms of the GNU Lesser General Public License as published
// by the Free Software Foundation, either version 3 of the License,
// or (at your option) any later version.
//
// OpenZWave is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public License
// along with OpenZWave. If not, see <http://www.gnu.org/licenses/>.
//
//-----------------------------------------------------------------------------
#ifndef _ValueShort_H
#define _ValueShort_H
#include <string>
#include "Defs.h"
#include "value_classes/Value.h"
class TiXmlElement;
namespace OpenZWave
{
class Msg;
class Node;
class ValueShort: public Value
{
public:
ValueShort( uint32 const _homeId, uint8 const _nodeId, ValueID::ValueGenre const _genre, uint8 const _commandClassId, uint8 const _instance, uint8 const _index, string const& _label, string const& _units, bool const _readOnly, bool const _writeOnly, int16 const _value, uint8 const _pollIntensity );
ValueShort();
virtual ~ValueShort(){}
bool Set( int16 const _value );
void OnValueRefreshed( int16 const _value );
// From Value
virtual string const GetAsString() const;
virtual bool SetFromString( string const& _value );
virtual void ReadXML( uint32 const _homeId, uint8 const _nodeId, uint8 const _commandClassId, TiXmlElement const* _valueElement );
virtual void WriteXML( TiXmlElement* _valueElement );
int16 GetValue()const{ return m_value; }
private:
int16 m_value; // the current value
int16 m_valueCheck; // the previous value (used for double-checking spurious value reads)
};
} // namespace OpenZWave
#endif
OpenZWave
Definition: Bitfield.h:34
OpenZWave::ValueShort
Short value sent to/received from a node.
Definition: ValueShort.h:44
OpenZWave::ValueShort::GetValue
int16 GetValue() const
Definition: ValueShort.h:60
OpenZWave::ValueShort::ReadXML
virtual void ReadXML(uint32 const _homeId, uint8 const _nodeId, uint8 const _commandClassId, TiXmlElement const *_valueElement)
Definition: ValueShort.cpp:109
OpenZWave::ValueShort::~ValueShort
virtual ~ValueShort()
Definition: ValueShort.h:49
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:412
int16
signed short int16
Definition: Defs.h:76
uint32
unsigned int uint32
Definition: Defs.h:80
Value.h
OpenZWave::Value
Base class for values associated with a node.
Definition: Value.h:47
OpenZWave::ValueShort::ValueShort
ValueShort()
Definition: ValueShort.cpp:72
OpenZWave::Value::Set
bool Set()
Definition: Value.cpp:350
OpenZWave::ValueID::ValueGenre
ValueGenre
Definition: ValueID.h:71
OpenZWave::ValueShort::WriteXML
virtual void WriteXML(TiXmlElement *_valueElement)
Definition: ValueShort.cpp:134
uint8
unsigned char uint8
Definition: Defs.h:74