Mercurial > projects > hoofbaby

comparison deps/Platinum/Source/Core/PltStateVariable.h @ 0:3425707ddbf6

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Initial import (hopefully this mercurial stuff works...)
author fraserofthenight
date Mon, 06 Jul 2009 08:06:28 -0700
parents
children
comparison
equal deleted inserted replaced
-1:000000000000 0:3425707ddbf6
1 /*****************************************************************
2 |
3 | Platinum - Service State Variable
4 |
5 | Copyright (c) 2004-2008, Plutinosoft, LLC.
6 | All rights reserved.
7 | http://www.plutinosoft.com
8 |
9 | This program is free software; you can redistribute it and/or
10 | modify it under the terms of the GNU General Public License
11 | as published by the Free Software Foundation; either version 2
12 | of the License, or (at your option) any later version.
13 |
14 | OEMs, ISVs, VARs and other distributors that combine and
15 | distribute commercially licensed software with Platinum software
16 | and do not wish to distribute the source code for the commercially
17 | licensed software under version 2, or (at your option) any later
18 | version, of the GNU General Public License (the "GPL") must enter
19 | into a commercial license agreement with Plutinosoft, LLC.
20 |
21 | This program is distributed in the hope that it will be useful,
22 | but WITHOUT ANY WARRANTY; without even the implied warranty of
23 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
24 | GNU General Public License for more details.
25 |
26 | You should have received a copy of the GNU General Public License
27 | along with this program; see the file LICENSE.txt. If not, write to
28 | the Free Software Foundation, Inc.,
29 | 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
30 | http://www.gnu.org/licenses/gpl-2.0.html
31 |
32 ****************************************************************/
33
34 #ifndef _PLT_STATE_VARIABLE_H_
35 #define _PLT_STATE_VARIABLE_H_
36
37 /*----------------------------------------------------------------------
38 | includes
39 +---------------------------------------------------------------------*/
40 #include "Neptune.h"
41
42 /*----------------------------------------------------------------------
43 | forward declarations
44 +---------------------------------------------------------------------*/
45 class PLT_Argument;
46 class PLT_Service;
47
48 /*----------------------------------------------------------------------
49 | NPT_AllowedValueRange class
50 +---------------------------------------------------------------------*/
51 typedef struct {
52 NPT_Int32 min_value;
53 NPT_Int32 max_value;
54 NPT_Int32 step;
55 } NPT_AllowedValueRange;
56
57 /*----------------------------------------------------------------------
58 | PLT_StateVariable class
59 +---------------------------------------------------------------------*/
60 class PLT_StateVariable
61 {
62 public:
63 PLT_StateVariable(PLT_Service* service);
64 ~PLT_StateVariable();
65
66 NPT_Result GetSCPDXML(NPT_XmlElementNode* node);
67 PLT_Service* GetService();
68 bool IsSendingEvents(bool indirectly = false);
69 void DisableIndirectEventing();
70 NPT_Result SetRate(NPT_TimeInterval rate);
71 NPT_Result SetValue(const char* value);
72 NPT_Result ValidateValue(const char* value);
73
74 const NPT_String& GetName() const { return m_Name; }
75 const NPT_String& GetValue() const { return m_Value; }
76 const NPT_String& GetDataType() const { return m_DataType; }
77
78 static PLT_StateVariable* Find(NPT_List<PLT_StateVariable*>& vars,
79 const char* name);
80
81 protected:
82 bool IsReadyToPublish();
83
84 protected:
85 friend class PLT_Service;
86
87 //members
88 PLT_Service* m_Service;
89 NPT_AllowedValueRange* m_AllowedValueRange;
90 NPT_String m_Name;
91 NPT_String m_DataType;
92 NPT_String m_DefaultValue;
93 bool m_IsSendingEvents;
94 bool m_IsSendingEventsIndirectly;
95 NPT_TimeInterval m_Rate;
96 NPT_TimeStamp m_LastEvent;
97 NPT_Array<NPT_String*> m_AllowedValues;
98 NPT_String m_Value;
99 };
100
101 /*----------------------------------------------------------------------
102 | PLT_StateVariableNameFinder
103 +---------------------------------------------------------------------*/
104 class PLT_StateVariableNameFinder
105 {
106 public:
107 // methods
108 PLT_StateVariableNameFinder(const char* name) : m_Name(name) {}
109 virtual ~PLT_StateVariableNameFinder() {}
110
111 bool operator()(const PLT_StateVariable* const & state_variable) const {
112 return state_variable->GetName().Compare(m_Name, true) ? false : true;
113 }
114
115 private:
116 // members
117 NPT_String m_Name;
118 };
119
120 /*----------------------------------------------------------------------
121 | PLT_ListStateVariableNameFinder
122 +---------------------------------------------------------------------*/
123 class PLT_ListStateVariableNameFinder
124 {
125 public:
126 // methods
127 PLT_ListStateVariableNameFinder(const char* name) : m_Name(name) {}
128 virtual ~PLT_ListStateVariableNameFinder() {}
129
130 bool operator()(const PLT_StateVariable* const & state_variable) const {
131 return state_variable->GetName().Compare(m_Name, true) ? false : true;
132 }
133
134 private:
135 // members
136 NPT_String m_Name;
137 };
138
139 #endif /* _PLT_STATE_VARIABLE_H_ */