128 lines
4.2 KiB
C++
128 lines
4.2 KiB
C++
//-----------------------------------------------------------------------------
|
|
//
|
|
// Value.h
|
|
//
|
|
// Base class for all OpenZWave Value Classes
|
|
//
|
|
// 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 _Value_H
|
|
#define _Value_H
|
|
|
|
#include <string>
|
|
#include <sys/time.h>
|
|
#include "../Defs.h"
|
|
#include "../platform/Ref.h"
|
|
#include "ValueID.h"
|
|
|
|
class TiXmlElement;
|
|
|
|
namespace OpenZWave
|
|
{
|
|
class Node;
|
|
|
|
/** \brief Base class for values associated with a node.
|
|
*/
|
|
class Value: public Ref
|
|
{
|
|
friend class Driver;
|
|
friend class ValueStore;
|
|
|
|
public:
|
|
Value( uint32 const _homeId, uint8 const _nodeId, ValueID::ValueGenre const _genre, uint8 const _commandClassId, uint8 const _instance, uint8 const _index, ValueID::ValueType const _type, string const& _label, string const& _units, bool const _readOnly, bool const _writeOnly, bool const _isset, uint8 const _pollIntensity );
|
|
Value();
|
|
|
|
virtual void ReadXML( uint32 const _homeId, uint8 const _nodeId, uint8 const _commandClassId, TiXmlElement const* _valueElement );
|
|
virtual void WriteXML( TiXmlElement* _valueElement );
|
|
|
|
ValueID const& GetID()const{ return m_id; }
|
|
bool IsReadOnly()const{ return m_readOnly; }
|
|
bool IsWriteOnly()const{ return m_writeOnly; }
|
|
bool IsSet()const{ return m_isSet; }
|
|
bool IsPolled()const{ return m_pollIntensity != 0; }
|
|
|
|
string const& GetLabel()const{ return m_label; }
|
|
void SetLabel( string const& _label ){ m_label = _label; }
|
|
|
|
string const& GetUnits()const{ return m_units; }
|
|
void SetUnits( string const& _units ){ m_units = _units; }
|
|
|
|
string const& GetHelp()const{ return m_help; }
|
|
void SetHelp( string const& _help ){ m_help = _help; }
|
|
|
|
uint8 const& GetPollIntensity()const{ return m_pollIntensity; }
|
|
void SetPollIntensity( uint8 const& _intensity ){ m_pollIntensity = _intensity; }
|
|
|
|
int32 GetMin()const{ return m_min; }
|
|
int32 GetMax()const{ return m_max; }
|
|
|
|
void SetChangeVerified( bool _verify ){ m_verifyChanges = _verify; }
|
|
|
|
virtual string const GetAsString() const { return ""; }
|
|
virtual bool SetFromString( string const& _value ) { return false; }
|
|
|
|
bool Set(); // For the user to change a value in a device
|
|
|
|
// Helpers
|
|
static ValueID::ValueGenre GetGenreEnumFromName( char const* _name );
|
|
static char const* GetGenreNameFromEnum( ValueID::ValueGenre _genre );
|
|
static ValueID::ValueType GetTypeEnumFromName( char const* _name );
|
|
static char const* GetTypeNameFromEnum( ValueID::ValueType _type );
|
|
|
|
protected:
|
|
virtual ~Value();
|
|
|
|
// void SetIsSet() { m_isSet = true; } // TODO: consider removing this...it's never called since m_isSet is set in ValueChanged and ValueRefreshed
|
|
bool IsCheckingChange()const{ return m_checkChange; }
|
|
void SetCheckingChange( bool _check ) { m_checkChange = _check; }
|
|
void OnValueRefreshed(); // A value in a device has been refreshed
|
|
void OnValueChanged(); // The refreshed value actually changed
|
|
int VerifyRefreshedValue( void* _originalValue, void* _checkValue, void* _newValue, int _type, int _length = 0 );
|
|
|
|
int32 m_min;
|
|
int32 m_max;
|
|
|
|
time_t m_refreshTime; // time_t identifying when this value was last refreshed
|
|
bool m_verifyChanges; // if true, apparent changes are verified; otherwise, they're not
|
|
|
|
private:
|
|
ValueID m_id;
|
|
string m_label;
|
|
string m_units;
|
|
string m_help;
|
|
bool m_readOnly;
|
|
bool m_writeOnly;
|
|
bool m_isSet;
|
|
uint8 m_affectsLength;
|
|
uint8* m_affects;
|
|
bool m_affectsAll;
|
|
bool m_checkChange;
|
|
uint8 m_pollIntensity;
|
|
};
|
|
|
|
} // namespace OpenZWave
|
|
|
|
#endif
|
|
|
|
|
|
|