OpenZWave Library: ValueButton.h Source File

| OpenZWave Library 1.6.0

ValueButton.h
Go to the documentation of this file.
1 //-----------------------------------------------------------------------------
2 //
3 // ValueButton.h
4 //
5 // Represents a write-only value that triggers activity in a device
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 _ValueButton_H
29 #define _ValueButton_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 class CommandClass;
42
46 class ValueButton: public Value
47 {
48 public:
49 ValueButton( uint32 const _homeId, uint8 const _nodeId, ValueID::ValueGenre const _genre, uint8 const _commandClassId, uint8 const _instance, uint16 const _index, string const& _label, uint8 const _pollIntensity );
50 ValueButton(): m_pressed( false ){}
51 virtual ~ValueButton(){}
52
53 bool PressButton();
54 bool ReleaseButton();
55
56 virtual string const GetAsString() const { return ( IsPressed() ? "true" : "false" ); }
57
58 // From Value
59 virtual void ReadXML( uint32 const _homeId, uint8 const _nodeId, uint8 const _commandClassId, TiXmlElement const* _valueElement );
60 virtual void WriteXML( TiXmlElement* _valueElement );
61
62 bool IsPressed()const{ return m_pressed; }
63
64 private:
65 bool m_pressed;
66 };
67
68 } // namespace OpenZWave
69
70 #endif
71
72
73
uint32
unsigned int uint32
Definition: Defs.h:95
OpenZWave::ValueButton::~ValueButton
virtual ~ValueButton()
Definition: ValueButton.h:51
OpenZWave::ValueButton::PressButton
bool PressButton()
Definition: ValueButton.cpp:90
OpenZWave::ValueButton::WriteXML
virtual void WriteXML(TiXmlElement *_valueElement)
Definition: ValueButton.cpp:78
OpenZWave::ValueID::ValueGenre
ValueGenre
Definition: ValueID.h:81
uint8
unsigned char uint8
Definition: Defs.h:89
OpenZWave::ValueButton::ReleaseButton
bool ReleaseButton()
Definition: ValueButton.cpp:103
OpenZWave::ValueButton
Button value.
Definition: ValueButton.h:47
OpenZWave::ValueButton::GetAsString
virtual string const GetAsString() const
Definition: ValueButton.h:56
OpenZWave::ValueButton::ReadXML
virtual void ReadXML(uint32 const _homeId, uint8 const _nodeId, uint8 const _commandClassId, TiXmlElement const *_valueElement)
Definition: ValueButton.cpp:63
OpenZWave::Value
Base class for values associated with a node.
Definition: Value.h:49
OpenZWave::ValueButton::IsPressed
bool IsPressed() const
Definition: ValueButton.h:62
Defs.h
OpenZWave::ValueButton::ValueButton
ValueButton()
Definition: ValueButton.h:50
Value.h
uint16
unsigned short uint16
Definition: Defs.h:92
OpenZWave
Definition: Bitfield.h:35