mbsim  4.0.0
MBSim Kernel
element.h
1 /* Copyright (C) 2004-2014 MBSim Development Team
2  *
3  * This library is free software; you can redistribute it and/or
4  * modify it under the terms of the GNU Lesser General Public
5  * License as published by the Free Software Foundation; either
6  * version 2.1 of the License, or (at your option) any later version.
7  *
8  * This library is distributed in the hope that it will be useful,
9  * but WITHOUT ANY WARRANTY; without even the implied warranty of
10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
11  * Lesser General Public License for more details.
12  *
13  * You should have received a copy of the GNU Lesser General Public
14  * License along with this library; if not, write to the Free Software
15  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
16  *
17  * Contact: martin.o.foerg@googlemail.com
18  */
19 
20 #ifndef _ELEMENT_H_
21 #define _ELEMENT_H_
22 
23 #include "fmatvec/fmatvec.h"
24 #include "fmatvec/atom.h"
25 #include "mbsim/objectfactory.h"
26 #include "mbsim/utils/plotfeatureenum.h"
27 #include "mbsim/utils/initconfigenum.h"
28 #include "mbsim/namespace.h"
29 #include "mbsim/mbsim_event.h"
30 #include <hdf5serie/vectorserie.h>
31 
32 namespace OpenMBV {
33  class Group;
34 }
35 
36 namespace H5 {
37  class Group;
38 }
39 
43 namespace MBSim {
44 
45  extern const PlotFeatureEnum plotRecursive, openMBV, debug, separateFilePerGroup;
46 
47  class DynamicSystemSolver;
48  class Frame;
49 
56  class Element : virtual public fmatvec::Atom {
57  public:
62  enum InitStage {
67  LASTINITSTAGE
68  };
69 
73  Element(const std::string &name);
74 
78  ~Element() override = default;
79 
80 #ifndef SWIG
81  [[noreturn]]
82 #endif
83  void throwError(const std::string &msg) const {
84  throw MBSimError(this, msg);
85  }
86 
91  virtual void setDynamicSystemSolver(DynamicSystemSolver *sys) { ds = sys; }
92 
98  virtual void plot();
99 
105  virtual void plotAtSpecialEvent() { }
106 
110  const std::string& getName() const { return name; }
111 
115  void setName(const std::string &str) { name = str; }
116 
117  // internal function do not use
118  void setPath(const std::string &str) { path=str; }
119 
124 
129  virtual void init(InitStage stage, const InitConfigSet &config);
130 
134  virtual void createPlotGroup();
135 
140  virtual H5::GroupBase *getFramesPlotGroup() { return nullptr; }
141  virtual H5::GroupBase *getContoursPlotGroup() { return nullptr; }
142  virtual H5::GroupBase *getGroupsPlotGroup() { return nullptr; }
143  virtual H5::GroupBase *getObjectsPlotGroup() { return nullptr; }
144  virtual H5::GroupBase *getLinksPlotGroup() { return nullptr; }
145  virtual H5::GroupBase *getConstraintsPlotGroup() { return nullptr; }
146  virtual H5::GroupBase *getObserversPlotGroup() { return nullptr; }
147 
150  bool getPlotFeature(const PlotFeatureEnum &pf) {
151  auto it=plotFeature.find(std::ref(pf));
152  if(it==plotFeature.end())
153  return false;
154  return it->second;
155  }
156 
162  virtual void setPlotFeature(const PlotFeatureEnum &pf, bool value);
163 
169  void setPlotFeatureForChildren(const PlotFeatureEnum &pf, bool value);
170 
176  void setPlotFeatureRecursive(const PlotFeatureEnum &pf, bool value) { setPlotFeature(pf,value); setPlotFeatureForChildren(pf,value); }
177 
178  virtual void initializeUsingXML(xercesc::DOMElement *element);
179 
184  template<class T> T* getByPath(const std::string &path, bool initialCaller=true) const;
185 
191  std::string getPath(const Element *relTo=nullptr, std::string sep="/") const;
192 
196  virtual Element* getChildByContainerAndName(const std::string &container, const std::string &name) const {
197  throwError("This element has no containers with childs.");
198  }
199 
200  virtual std::shared_ptr<OpenMBV::Group> getOpenMBVGrp() { return std::shared_ptr<OpenMBV::Group>(); }
201  virtual std::shared_ptr<OpenMBV::Group> getFramesOpenMBVGrp() { return std::shared_ptr<OpenMBV::Group>(); }
202  virtual std::shared_ptr<OpenMBV::Group> getContoursOpenMBVGrp() { return std::shared_ptr<OpenMBV::Group>(); }
203  virtual std::shared_ptr<OpenMBV::Group> getGroupsOpenMBVGrp() { return std::shared_ptr<OpenMBV::Group>(); }
204  virtual std::shared_ptr<OpenMBV::Group> getObjectsOpenMBVGrp() { return std::shared_ptr<OpenMBV::Group>(); }
205  virtual std::shared_ptr<OpenMBV::Group> getLinksOpenMBVGrp() { return std::shared_ptr<OpenMBV::Group>(); }
206  virtual std::shared_ptr<OpenMBV::Group> getConstraintsOpenMBVGrp() { return std::shared_ptr<OpenMBV::Group>(); }
207  virtual std::shared_ptr<OpenMBV::Group> getObserversOpenMBVGrp() { return std::shared_ptr<OpenMBV::Group>(); }
208 
209  virtual Element* getParent() {return parent;}
210  virtual const Element* getParent() const {return parent;}
211  virtual void setParent(Element* parent_) {parent = parent_;}
212 
217  std::vector<Element*> getDependencies() const { return dependency; }
218 
219  void addDependency(Element* ele) { if(ele) dependency.push_back(ele); }
220 
226  int computeLevel();
227 
228  virtual void updatePositions(Frame *frame) { }
229  virtual void updateVelocities(Frame *frame) { }
230  virtual void updateAccelerations(Frame *frame) { }
231  virtual void updateJacobians(Frame *frame, int j=0) { }
232  virtual void updateGyroscopicAccelerations(Frame *frame) { }
233 
234  virtual void resetUpToDate() { }
235 
236  const double& getTime() const;
237  double getStepSize() const;
238 
239 #ifndef SWIG
240  const MBXMLUtils::DOMEvalException& getDOMEvalError() const { return domEvalError; };
241 #endif
242 
243  protected:
244  Element *parent;
245 
249  std::string name;
250 
256  std::string path;
257 
258 #ifndef SWIG
261 #endif
262 
267 
272 
276  std::vector<double> plotVector;
277 
281  std::vector<std::string> plotColumns;
282 
287 
288  void updatePlotFeatures();
289 
293  std::vector<Element*> dependency;
294 
298  PlotFeatureMap plotFeature, plotFeatureForChildren;
299  };
300 
301  template<class T>
302  T* Element::getByPath(const std::string &path, bool initialCaller) const {
303  try {
304  if(path.substr(0, 1) == "/") { // if absolute path ...
305  if(parent) // .. and a parent exists ...
306  return parent->getByPath<T>(path, false); // ... than call getByPath of the parent (walk to the top)
307  else // .. and no parent exits ...
308  return getByPath<T>(path.substr(1), false); // ... we are at top and call getByPath again with the leading "/" removed (call relative to top)
309  }
310  else if (path.substr(0, 3) == "../") { // if relative path to parent ...
311  if(!parent)
312  throwError("Reference to parent '"+path+"' requested but already at the root node.");
313  return parent->getByPath<T>(path.substr(3), false); // ... call getByPath of the parent with the leading "../" removed
314  }
315  else { // if relative path to a child ...
316  // extract the first path and all other paths (rest)
317  size_t idx=path.find('/');
318  std::string first=path.substr(0, idx);
319  std::string rest;
320  if(idx!=std::string::npos)
321  rest=path.substr(idx+1);
322  // get the object of the first child path by calling the virtual function getChildByContainerAndName
323  size_t pos0=first.find('[');
324  if(pos0==std::string::npos)
325  throwError("Syntax error in subreference '"+first+"': no [ found.");
326  std::string container=first.substr(0, pos0);
327  if(first[first.size()-1]!=']')
328  throwError("Syntax error in subreference '"+first+"': not ending with ].");
329  std::string name=first.substr(pos0+1, first.size()-pos0-2);
330  Element *e=getChildByContainerAndName(container, name);
331  // if their are other child paths call getByPath of e for this
332  if(!rest.empty())
333  return e->getByPath<T>(rest, false);
334  // this is the last relative path -> check type and return
335  auto *t=dynamic_cast<T*>(e);
336  if(t)
337  return t;
338  else
339  throwError("Cannot cast this element to type "+container+".");
340  }
341  }
342  catch(MBSimError &ex) {
343  if(initialCaller)
344  throwError("Evaluation of refernece '"+path+"' failed: Message from "+
345  ex.getPath()+": "+ex.getErrorMessage());
346  else
347  throw ex;
348  }
349  }
350 
351 }
352 
353 #endif
virtual void createPlotGroup()
creates the plotGroup for H5-output
Definition: element.cc:117
std::vector< Element * > getDependencies() const
checks dependency on other elements.
Definition: element.h:217
virtual void plot()
plots time dependent data
Definition: element.cc:73
virtual void setPlotFeature(const PlotFeatureEnum &pf, bool value)
Set a plot feature.
Definition: element.cc:212
bool getPlotFeature(const PlotFeatureEnum &pf)
Definition: element.h:150
virtual void init(InitStage stage, const InitConfigSet &config)
plots time series header
Definition: element.cc:84
DynamicSystemSolver * getDynamicSystemSolver()
Definition: element.h:123
solver interface for modelling and simulation of dynamic systems
Definition: dynamic_system_solver.h:56
Definition: element.h:63
std::vector< Element * > dependency
vector containing all dependencies.
Definition: element.h:293
virtual void plotAtSpecialEvent()
plots time dependent data at special events
Definition: element.h:105
PlotFeatureMap plotFeature
plot feature
Definition: element.h:298
H5::VectorSerie< double > * plotVectorSerie
time series
Definition: element.h:271
void setPlotFeatureRecursive(const PlotFeatureEnum &pf, bool value)
Set a plot feature for this object and the children of this object.
Definition: element.h:176
basic class of MBSim mainly for plotting
Definition: element.h:56
std::string path
The path of this object. Is set during the init stage reorganizeHierarchy. Before this the path is ca...
Definition: element.h:256
DynamicSystemSolver * ds
dynamic system
Definition: element.h:266
H5::GroupBase * getPlotGroup()
Definition: element.h:139
void setPlotFeatureForChildren(const PlotFeatureEnum &pf, bool value)
Set a plot feature for the children of this object.
Definition: element.cc:216
std::vector< std::string > plotColumns
columns of time series
Definition: element.h:281
Definition: plotfeatureenum.h:29
std::string getPath(const Element *relTo=nullptr, std::string sep="/") const
Return the path of this object. If relativeTo is not NULL return a relative path to relativeTo....
Definition: element.cc:152
std::ostream & msg(MsgType type) const
Definition: element.h:65
InitStage
The stages of the initialization.
Definition: element.h:62
virtual Element * getChildByContainerAndName(const std::string &container, const std::string &name) const
Get the Element named name in the container named container.
Definition: element.h:196
std::vector< double > plotVector
one entry of time series
Definition: element.h:276
const std::string & getName() const
Definition: element.h:110
~Element() override=default
destructor
std::string name
name of element
Definition: element.h:249
MBXMLUtils::DOMEvalException domEvalError
Special XML helper variable.
Definition: element.h:260
Definition: element.h:64
virtual void setDynamicSystemSolver(DynamicSystemSolver *sys)
sets the used dynamics system solver to the element
Definition: element.h:91
Definition: element.h:66
H5::GroupBase * plotGroup
associated plot group
Definition: element.h:286
void setName(const std::string &str)
Definition: element.h:115
basic error class for mbsim
Definition: mbsim_event.h:39
int computeLevel()
computes the length of the pathes in the graph that represents the dependencies between all elements.
Definition: element.cc:242
T * getByPath(const std::string &path, bool initialCaller=true) const
Get the object of type T represented by the path path. Do not set any argurment other than path!
Definition: element.h:302
Element(const std::string &name)
constructor
Definition: element.cc:70
namespace MBSim
Definition: eigenanalyzer.cc:47