ValueButton.h
Go to the documentation of this file.
//-----------------------------------------------------------------------------
//
// ValueButton.h
//
// Represents a write-only value that triggers activity in a device
//
// 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 _ValueButton_H
#define _ValueButton_H
#include <string>
#include "Defs.h"
#include "value_classes/Value.h"
class TiXmlElement;
namespace OpenZWave
{
class Msg;
class Node;
class CommandClass;
class ValueButton: public Value
{
public:
ValueButton( uint32 const _homeId, uint8 const _nodeId, ValueID::ValueGenre const _genre, uint8 const _commandClassId, uint8 const _instance, uint8 const _index, string const& _label, uint8 const _pollIntensity );
ValueButton(): m_pressed( false ){}
virtual ~ValueButton(){}
bool PressButton();
bool ReleaseButton();
virtual string const GetAsString() const { return ( IsPressed() ? "true" : "false" ); }
// From Value
virtual void ReadXML( uint32 const _homeId, uint8 const _nodeId, uint8 const _commandClassId, TiXmlElement const* _valueElement );
virtual void WriteXML( TiXmlElement* _valueElement );
bool IsPressed()const{ return m_pressed; }
private:
bool m_pressed;
};
} // namespace OpenZWave
#endif
OpenZWave
Definition: Bitfield.h:34
OpenZWave::ValueButton::~ValueButton
virtual ~ValueButton()
Definition: ValueButton.h:50
Defs.h
OpenZWave::ValueButton
Button value ???.
Definition: ValueButton.h:45
OpenZWave::ValueButton::WriteXML
virtual void WriteXML(TiXmlElement *_valueElement)
Definition: ValueButton.cpp:78
OpenZWave::ValueButton::ValueButton
ValueButton()
Definition: ValueButton.h:49
uint32
unsigned int uint32
Definition: Defs.h:80
OpenZWave::ValueButton::ReleaseButton
bool ReleaseButton()
Definition: ValueButton.cpp:103
OpenZWave::ValueButton::GetAsString
virtual string const GetAsString() const
Definition: ValueButton.h:55
Value.h
OpenZWave::ValueButton::PressButton
bool PressButton()
Definition: ValueButton.cpp:90
OpenZWave::Value
Base class for values associated with a node.
Definition: Value.h:47
OpenZWave::ValueButton::ReadXML
virtual void ReadXML(uint32 const _homeId, uint8 const _nodeId, uint8 const _commandClassId, TiXmlElement const *_valueElement)
Definition: ValueButton.cpp:63
OpenZWave::ValueID::ValueGenre
ValueGenre
Definition: ValueID.h:71
OpenZWave::ValueButton::IsPressed
bool IsPressed() const
Definition: ValueButton.h:61
uint8
unsigned char uint8
Definition: Defs.h:74