ValueString.h
Go to the documentation of this file.
//-----------------------------------------------------------------------------
//
// ValueString.h
//
// Represents a string 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 _ValueString_H
#define _ValueString_H
#include <string>
#include "Defs.h"
#include "value_classes/Value.h"
class TiXmlElement;
namespace OpenZWave
{
class Msg;
class Node;
class ValueString: public Value
{
public:
ValueString( 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, string const& _value, uint8 const _pollIntensity );
ValueString(){}
virtual ~ValueString(){}
bool Set( string const& _value );
void OnValueRefreshed( string const& _value );
// From Value
virtual string const GetAsString() const { return GetValue(); }
virtual bool SetFromString( string const& _value ) { return Set( _value ); }
virtual void ReadXML( uint32 const _homeId, uint8 const _nodeId, uint8 const _commandClassId, TiXmlElement const* _valueElement );
virtual void WriteXML( TiXmlElement* _valueElement );
string GetValue()const{ return m_value; }
private:
string m_value; // the current value
string m_valueCheck; // the previous value (used for double-checking spurious value reads)
string m_newValue; // a new value to be set on the appropriate device
};
} // namespace OpenZWave
#endif
OpenZWave
Definition: Bitfield.h:34
OpenZWave::ValueString::WriteXML
virtual void WriteXML(TiXmlElement *_valueElement)
Definition: ValueString.cpp:93
OpenZWave::ValueString::GetValue
string GetValue() const
Definition: ValueString.h:60
OpenZWave::ValueString::~ValueString
virtual ~ValueString()
Definition: ValueString.h:49
OpenZWave::ValueString::ValueString
ValueString()
Definition: ValueString.h:48
OpenZWave::ValueString::GetAsString
virtual string const GetAsString() const
Definition: ValueString.h:55
Defs.h
OpenZWave::Value::OnValueRefreshed
void OnValueRefreshed()
Definition: Value.cpp:412
OpenZWave::ValueString::SetFromString
virtual bool SetFromString(string const &_value)
Definition: ValueString.h:56
uint32
unsigned int uint32
Definition: Defs.h:80
OpenZWave::ValueString
String value sent to/received from a node.
Definition: ValueString.h:44
OpenZWave::ValueString::ReadXML
virtual void ReadXML(uint32 const _homeId, uint8 const _nodeId, uint8 const _commandClassId, TiXmlElement const *_valueElement)
Definition: ValueString.cpp:68
Value.h
OpenZWave::Value
Base class for values associated with a node.
Definition: Value.h:47
OpenZWave::Value::Set
bool Set()
Definition: Value.cpp:350
OpenZWave::ValueID::ValueGenre
ValueGenre
Definition: ValueID.h:71
uint8
unsigned char uint8
Definition: Defs.h:74