1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
|
/******************************************************************************
* SOFA, Simulation Open-Framework Architecture, version 1.0 beta 4 *
* (c) 2006-2009 MGH, INRIA, USTL, UJF, CNRS *
* *
* This library 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 2.1 of the License, or (at *
* your option) any later version. *
* *
* This library 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 this library; if not, write to the Free Software Foundation, *
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. *
*******************************************************************************
* SOFA :: Framework *
* *
* Authors: M. Adam, J. Allard, B. Andre, P-J. Bensoussan, S. Cotin, C. Duriez,*
* H. Delingette, F. Falipou, F. Faure, S. Fonteneau, L. Heigeas, C. Mendoza, *
* M. Nesme, P. Neumann, J-P. de la Plata Alcade, F. Poyer and F. Roy *
* *
* Contact information: contact@sofa-framework.org *
******************************************************************************/
#ifndef SOFA_CORE_OBJECTMODEL_BASEDATA_H
#define SOFA_CORE_OBJECTMODEL_BASEDATA_H
#if !defined(__GNUC__) || (__GNUC__ > 3 || (_GNUC__ == 3 && __GNUC_MINOR__ > 3))
#pragma once
#endif
#include <list>
#include <iostream>
#include <typeinfo>
#include <sofa/core/core.h>
#include <sofa/core/objectmodel/DDGNode.h>
namespace sofa
{
namespace core
{
namespace objectmodel
{
/**
* \brief Abstract base class for all fields, independently of their type.
*
*/
class SOFA_CORE_API BaseData : public DDGNode
{
public:
/** Constructor
* \param l long name
* \param h help
* \param m true iff the argument is mandatory
*/
BaseData( const char* h, bool isDisplayed=true, bool isReadOnly=false )
: help(h), group(""), widget("")
, m_counter(0), m_isDisplayed(isDisplayed), m_isReadOnly(isReadOnly)/*, parent(NULL), writer(NULL)*/
{}
/// Base destructor
virtual ~BaseData()
{
}
/// Read the command line
virtual bool read( std::string& str ) = 0;
/// Print the value of the associated variable
virtual void printValue( std::ostream& ) const =0;
/// Print the value of the associated variable
virtual std::string getValueString() const=0;
/// Print the value type of the associated variable
virtual std::string getValueTypeString() const=0;
/// Get help message
const char* getHelp() const { return help; }
/// Set help message
void setHelp(const char* val) { help = val; }
/// @deprecated Set help message
void setHelpMsg(const char* val) { help = val; }
/// Get group
const char* getGroup() const { return group; }
/// Set group
void setGroup(const char* val) { group = val; }
/// Get widget
const char* getWidget() const { return widget; }
/// Set widget
void setWidget(const char* val) { widget = val; }
/// True if the value has been modified
bool isSet() const { return m_counter > 0; }
/// True if the Data has to be displayed in the GUI
bool isDisplayed() const { return m_isDisplayed; }
/// True if the Data will be readable only in the GUI
bool isReadOnly() const { return m_isReadOnly; }
/// Can dynamically change the status of a Data, by making it appear or disappear
void setDisplayed(bool b){m_isDisplayed = b;}
/// Can dynamically change the status of a Data, by making it readOnly
void setReadOnly(bool b){m_isReadOnly = b;}
/// Return the number of changes since creation
/// This can be used to efficiently detect changes
int getCounter() const { return m_counter; }
/// Set for this Data the value of its parent value
virtual bool setParentValue(BaseData* parent) = 0;
/// Update the value of this Data
void update()
{
dirty = false;
for(std::list<DDGNode*>::iterator it=inputs.begin(); it!=inputs.end(); ++it)
{
if ((*it)->isDirty())
{
(*it)->update();
}
if (updateFromParentValue(dynamic_cast<BaseData*>(*it)))
break;
}
}
protected:
/// Update this Data from the value of its parent
virtual bool updateFromParentValue(BaseData* parent) = 0;
/// Help message
const char* help;
/// group
const char* group;
/// widget
const char* widget;
/// Number of changes since creation
int m_counter;
/// True if the Data will be displayed in the GUI
bool m_isDisplayed;
/// True if the Data will be readable only in the GUI
bool m_isReadOnly;
/// Helper method to decode the type name to a more readable form if possible
static std::string decodeTypeName(const std::type_info& t);
/// Helper method to get the type name of type T
template<class T>
static std::string typeName(const T* = NULL)
{
return decodeTypeName(typeid(T));
}
};
} // namespace objectmodel
} // namespace core
} // namespace sofa
#endif
|
