OpenZWave Library 1.6.1914
Loading...
Searching...
No Matches
ValueSchedule.h
Go to the documentation of this file.
1//-----------------------------------------------------------------------------
2//
3// ValueSchedule.h
4//
5// A one day schedule for the Climate Control Schedule command class
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 _ValueSchedule_H
29#define _ValueSchedule_H
30
31#include <string>
32#include "Defs.h"
33#include "value_classes/Value.h"
34
35class TiXmlElement;
36
37namespace OpenZWave
38{
39 namespace Internal
40 {
41 namespace VC
42 {
43
47 class ValueSchedule: public Value
48 {
49 public:
50 ValueSchedule(uint32 const _homeId, uint8 const _nodeId, ValueID::ValueGenre const _genre, uint8 const _commandClassId, uint8 const _instance, uint16 const _index, string const& _label, string const& _units, bool const _readOnly, bool const _writeOnly, uint8 const _pollIntensity);
53 {
54 }
55
56 bool SetSwitchPoint(uint8 const _hours, uint8 const _minutes, int8 const _setback);
57 bool RemoveSwitchPoint(uint8 const _idx);
59 {
60 m_numSwitchPoints = 0;
61 }
62 bool GetSwitchPoint(uint8 const _idx, uint8* o_hours, uint8* o_minutes, int8* o_setback) const;
63 bool FindSwitchPoint(uint8 const _hours, uint8 const _minutes, uint8* o_idx) const;
65 {
66 return m_numSwitchPoints;
67 }
68
69 bool Set();
70 void OnValueRefreshed();
71
72 virtual string const GetAsString() const;
73
74 // From Value
75 virtual void ReadXML(uint32 const _homeId, uint8 const _nodeId, uint8 const _commandClassId, TiXmlElement const* _valueElement);
76 virtual void WriteXML(TiXmlElement* _valueElement);
77
78 private:
79 struct SwitchPoint
80 {
81 uint8 m_hours;
82 uint8 m_minutes;
83 int8 m_setback;
84 };
85
86 SwitchPoint m_switchPoints[9];
87 uint8 m_numSwitchPoints;
88 };
89 } // namespace VC
90 } // namespace Internal
91} // namespace OpenZWave
92
93#endif
unsigned short uint16
Definition Defs.h:88
unsigned int uint32
Definition Defs.h:91
signed char int8
Definition Defs.h:84
unsigned char uint8
Definition Defs.h:85
Schedule sent to/received from a node.
Definition ValueSchedule.h:48
bool RemoveSwitchPoint(uint8 const _idx)
Definition ValueSchedule.cpp:233
void OnValueRefreshed()
Definition ValueSchedule.cpp:154
virtual void WriteXML(TiXmlElement *_valueElement)
Definition ValueSchedule.cpp:111
virtual void ReadXML(uint32 const _homeId, uint8 const _nodeId, uint8 const _commandClassId, TiXmlElement const *_valueElement)
Definition ValueSchedule.cpp:66
virtual string const GetAsString() const
Definition ValueSchedule.cpp:320
bool SetSwitchPoint(uint8 const _hours, uint8 const _minutes, int8 const _setback)
Definition ValueSchedule.cpp:175
ValueSchedule()
Definition ValueSchedule.cpp:56
virtual ~ValueSchedule()
Definition ValueSchedule.h:52
bool GetSwitchPoint(uint8 const _idx, uint8 *o_hours, uint8 *o_minutes, int8 *o_setback) const
Definition ValueSchedule.cpp:257
void ClearSwitchPoints()
Definition ValueSchedule.h:58
bool Set()
Definition ValueSchedule.cpp:143
uint8 GetNumSwitchPoints() const
Definition ValueSchedule.h:64
bool FindSwitchPoint(uint8 const _hours, uint8 const _minutes, uint8 *o_idx) const
Definition ValueSchedule.cpp:287
Base class for values associated with a node.
Definition Value.h:55
ValueGenre
Definition ValueID.h:85
Definition Bitfield.cpp:31