OpenZWave Library  1.5.0
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 
35 class TiXmlElement;
36 
37 namespace OpenZWave
38 {
39  class Msg;
40  class Node;
41 
44  class ValueSchedule: public Value
45  {
46  public:
47  ValueSchedule( 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, uint8 const _pollIntensity );
48  ValueSchedule();
49  virtual ~ValueSchedule(){}
50 
51  bool SetSwitchPoint( uint8 const _hours, uint8 const _minutes, int8 const _setback );
52  bool RemoveSwitchPoint( uint8 const _idx );
53  void ClearSwitchPoints(){ m_numSwitchPoints = 0; }
54  bool GetSwitchPoint( uint8 const _idx, uint8* o_hours, uint8* o_minutes, int8* o_setback )const;
55  bool FindSwitchPoint( uint8 const _hours, uint8 const _minutes, uint8* o_idx )const;
56  uint8 GetNumSwitchPoints()const{ return m_numSwitchPoints; }
57 
58  bool Set();
59  void OnValueRefreshed();
60 
61  virtual string const GetAsString() const;
62 
63  // From Value
64  virtual void ReadXML( uint32 const _homeId, uint8 const _nodeId, uint8 const _commandClassId, TiXmlElement const* _valueElement );
65  virtual void WriteXML( TiXmlElement* _valueElement );
66 
67  private:
68  struct SwitchPoint
69  {
70  uint8 m_hours;
71  uint8 m_minutes;
72  int8 m_setback;
73  };
74 
75  SwitchPoint m_switchPoints[9];
76  uint8 m_numSwitchPoints;
77  };
78 
79 } // namespace OpenZWave
80 
81 #endif
Definition: Bitfield.h:34
virtual void WriteXML(TiXmlElement *_valueElement)
Definition: ValueSchedule.cpp:130
bool SetSwitchPoint(uint8 const _hours, uint8 const _minutes, int8 const _setback)
Definition: ValueSchedule.cpp:201
bool FindSwitchPoint(uint8 const _hours, uint8 const _minutes, uint8 *o_idx) const
Definition: ValueSchedule.cpp:325
bool Set()
Definition: ValueSchedule.cpp:165
signed char int8
Definition: Defs.h:73
unsigned int uint32
Definition: Defs.h:80
ValueSchedule()
Definition: ValueSchedule.cpp:66
uint8 GetNumSwitchPoints() const
Definition: ValueSchedule.h:56
virtual string const GetAsString() const
Definition: ValueSchedule.cpp:362
virtual ~ValueSchedule()
Definition: ValueSchedule.h:49
void ClearSwitchPoints()
Definition: ValueSchedule.h:53
bool GetSwitchPoint(uint8 const _idx, uint8 *o_hours, uint8 *o_minutes, int8 *o_setback) const
Definition: ValueSchedule.cpp:289
Base class for values associated with a node.
Definition: Value.h:47
bool RemoveSwitchPoint(uint8 const _idx)
Definition: ValueSchedule.cpp:262
void OnValueRefreshed()
Definition: ValueSchedule.cpp:178
ValueGenre
Definition: ValueID.h:71
virtual void ReadXML(uint32 const _homeId, uint8 const _nodeId, uint8 const _commandClassId, TiXmlElement const *_valueElement)
Definition: ValueSchedule.cpp:79
Schedule sent to/received from a node.
Definition: ValueSchedule.h:44
unsigned char uint8
Definition: Defs.h:74