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 int baseIndexForPlot;
46 
47  extern const PlotFeatureEnum plotRecursive, openMBV, debug;
48 
49  class DynamicSystemSolver;
50  class Frame;
51 
58  class Element : virtual public fmatvec::Atom {
59  public:
64  enum InitStage {
69  LASTINITSTAGE
70  };
71 
75  Element(const std::string &name);
76 
80  ~Element() override = default;
81 
82 #ifndef SWIG
83  [[noreturn]]
84 #endif
85  void throwError(const std::string &msg) const {
86  throw MBSimError(this, msg);
87  }
88 
93  virtual void setDynamicSystemSolver(DynamicSystemSolver *sys) { ds = sys; }
94 
100  virtual void plot();
101 
107  virtual void plotAtSpecialEvent() { }
108 
112  const std::string& getName() const { return name; }
113 
117  void setName(const std::string &str) { name = str; }
118 
119  // internal function do not use
120  void setPath(const std::string &str) { path=str; }
121 
126 
131  virtual void init(InitStage stage, const InitConfigSet &config);
132 
136  virtual void createPlotGroup();
137 
142  virtual H5::GroupBase *getFramesPlotGroup() { return nullptr; }
143  virtual H5::GroupBase *getContoursPlotGroup() { return nullptr; }
144  virtual H5::GroupBase *getGroupsPlotGroup() { return nullptr; }
145  virtual H5::GroupBase *getObjectsPlotGroup() { return nullptr; }
146  virtual H5::GroupBase *getLinksPlotGroup() { return nullptr; }
147  virtual H5::GroupBase *getConstraintsPlotGroup() { return nullptr; }
148  virtual H5::GroupBase *getObserversPlotGroup() { return nullptr; }
149 
152  bool getPlotFeature(const PlotFeatureEnum &pf) {
153  auto it=plotFeature.find(std::ref(pf));
154  if(it==plotFeature.end())
155  return false;
156  return it->second;
157  }
158 
164  virtual void setPlotFeature(const PlotFeatureEnum &pf, bool value);
165 
171  void setPlotFeatureForChildren(const PlotFeatureEnum &pf, bool value);
172 
178  void setPlotFeatureRecursive(const PlotFeatureEnum &pf, bool value) { setPlotFeature(pf,value); setPlotFeatureForChildren(pf,value); }
179 
180  virtual void initializeUsingXML(xercesc::DOMElement *element);
181 
186  template<class T> T* getByPath(const std::string &path, bool initialCaller=true) const;
187 
193  std::string getPath(const Element *relTo=nullptr, std::string sep="/") const;
194 
198  virtual Element* getChildByContainerAndName(const std::string &container, const std::string &name) const {
199  throwError("This element has no containers with childs.");
200  }
201 
202  virtual std::shared_ptr<OpenMBV::Group> getOpenMBVGrp() { return std::shared_ptr<OpenMBV::Group>(); }
203  virtual std::shared_ptr<OpenMBV::Group> getFramesOpenMBVGrp() { return std::shared_ptr<OpenMBV::Group>(); }
204  virtual std::shared_ptr<OpenMBV::Group> getContoursOpenMBVGrp() { return std::shared_ptr<OpenMBV::Group>(); }
205  virtual std::shared_ptr<OpenMBV::Group> getGroupsOpenMBVGrp() { return std::shared_ptr<OpenMBV::Group>(); }
206  virtual std::shared_ptr<OpenMBV::Group> getObjectsOpenMBVGrp() { return std::shared_ptr<OpenMBV::Group>(); }
207  virtual std::shared_ptr<OpenMBV::Group> getLinksOpenMBVGrp() { return std::shared_ptr<OpenMBV::Group>(); }
208  virtual std::shared_ptr<OpenMBV::Group> getConstraintsOpenMBVGrp() { return std::shared_ptr<OpenMBV::Group>(); }
209  virtual std::shared_ptr<OpenMBV::Group> getObserversOpenMBVGrp() { return std::shared_ptr<OpenMBV::Group>(); }
210 
211  virtual Element* getParent() {return parent;}
212  virtual const Element* getParent() const {return parent;}
213  virtual void setParent(Element* parent_) {parent = parent_;}
214 
219  std::vector<Element*> getDependencies() const { return dependency; }
220 
221  void addDependency(Element* ele) { if(ele) dependency.push_back(ele); }
222 
228  int computeLevel();
229 
230  virtual void updatePositions(Frame *frame) { }
231  virtual void updateVelocities(Frame *frame) { }
232  virtual void updateAccelerations(Frame *frame) { }
233  virtual void updateJacobians(Frame *frame, int j=0) { }
234  virtual void updateGyroscopicAccelerations(Frame *frame) { }
235 
236  virtual void resetUpToDate() { }
237 
238  const double& getTime() const;
239  double getStepSize() const;
240 
241 #ifndef SWIG
242  const MBXMLUtils::DOMEvalException& getDOMEvalError() const { return domEvalError; };
243 #endif
244 
245  protected:
246  Element *parent;
247 
251  std::string name;
252 
258  std::string path;
259 
260 #ifndef SWIG
263 #endif
264 
269 
274 
278  std::vector<double> plotVector;
279 
283  std::vector<std::string> plotColumns;
284 
289 
290  void updatePlotFeatures();
291 
295  std::vector<Element*> dependency;
296 
300  PlotFeatureMap plotFeature, plotFeatureForChildren;
301 
302  int convertIndex(int i) { return baseIndexForPlot+i; }
303 
304  void addToPlot(const std::string &name);
305  void addToPlot(const std::string &name, int size);
306  void addToPlot(const std::string &name, const std::vector<std::string> &iname);
307 
308  template<class AT> void plot(const AT &x) {
309  plotVector.push_back(x);
310  }
311  template<class Type, class AT> void plot(const fmatvec::Vector<Type,AT> &x) {
312  for(int i=0; i<x.size(); i++)
313  plotVector.push_back(x(i));
314  }
315  };
316 
317  template<class T>
318  T* Element::getByPath(const std::string &path, bool initialCaller) const {
319  try {
320  if(path.substr(0, 1) == "/") { // if absolute path ...
321  if(parent) // .. and a parent exists ...
322  return parent->getByPath<T>(path, false); // ... than call getByPath of the parent (walk to the top)
323  else // .. and no parent exits ...
324  return getByPath<T>(path.substr(1), false); // ... we are at top and call getByPath again with the leading "/" removed (call relative to top)
325  }
326  else if (path.substr(0, 3) == "../") { // if relative path to parent ...
327  if(!parent)
328  throwError("Reference to parent '"+path+"' requested but already at the root node.");
329  return parent->getByPath<T>(path.substr(3), false); // ... call getByPath of the parent with the leading "../" removed
330  }
331  else { // if relative path to a child ...
332  // extract the first path and all other paths (rest)
333  size_t idx=path.find('/');
334  std::string first=path.substr(0, idx);
335  std::string rest;
336  if(idx!=std::string::npos)
337  rest=path.substr(idx+1);
338  // get the object of the first child path by calling the virtual function getChildByContainerAndName
339  size_t pos0=first.find('[');
340  if(pos0==std::string::npos)
341  throwError("Syntax error in subreference '"+first+"': no [ found.");
342  std::string container=first.substr(0, pos0);
343  if(first[first.size()-1]!=']')
344  throwError("Syntax error in subreference '"+first+"': not ending with ].");
345  std::string name=first.substr(pos0+1, first.size()-pos0-2);
346  Element *e=getChildByContainerAndName(container, name);
347  // if their are other child paths call getByPath of e for this
348  if(!rest.empty())
349  return e->getByPath<T>(rest, false);
350  // this is the last relative path -> check type and return
351  auto *t=dynamic_cast<T*>(e);
352  if(t)
353  return t;
354  else
355  throwError("Cannot cast this element to type "+container+".");
356  }
357  }
358  catch(MBSimError &ex) {
359  if(initialCaller)
360  throwError("Evaluation of refernece '"+path+"' failed: Message from "+
361  ex.getPath()+": "+ex.getErrorMessage());
362  else
363  throw ex;
364  }
365  }
366 
367 }
368 
369 #endif
virtual void createPlotGroup()
creates the plotGroup for H5-output
Definition: element.cc:115
std::vector< Element * > getDependencies() const
checks dependency on other elements.
Definition: element.h:219
virtual void plot()
plots time dependent data
Definition: element.cc:71
virtual void setPlotFeature(const PlotFeatureEnum &pf, bool value)
Set a plot feature.
Definition: element.cc:210
bool getPlotFeature(const PlotFeatureEnum &pf)
Definition: element.h:152
virtual void init(InitStage stage, const InitConfigSet &config)
plots time series header
Definition: element.cc:82
DynamicSystemSolver * getDynamicSystemSolver()
Definition: element.h:125
solver interface for modelling and simulation of dynamic systems
Definition: dynamic_system_solver.h:58
Definition: element.h:65
std::vector< Element * > dependency
vector containing all dependencies.
Definition: element.h:295
virtual void plotAtSpecialEvent()
plots time dependent data at special events
Definition: element.h:107
PlotFeatureMap plotFeature
plot feature
Definition: element.h:300
H5::VectorSerie< double > * plotVectorSerie
time series
Definition: element.h:273
void setPlotFeatureRecursive(const PlotFeatureEnum &pf, bool value)
Set a plot feature for this object and the children of this object.
Definition: element.h:178
basic class of MBSim mainly for plotting
Definition: element.h:58
std::string path
The path of this object. Is set during the init stage reorganizeHierarchy. Before this the path is ca...
Definition: element.h:258
DynamicSystemSolver * ds
dynamic system
Definition: element.h:268
H5::GroupBase * getPlotGroup()
Definition: element.h:141
void setPlotFeatureForChildren(const PlotFeatureEnum &pf, bool value)
Set a plot feature for the children of this object.
Definition: element.cc:214
std::vector< std::string > plotColumns
columns of time series
Definition: element.h:283
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:150
Definition: element.h:67
InitStage
The stages of the initialization.
Definition: element.h:64
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:198
std::vector< double > plotVector
one entry of time series
Definition: element.h:278
const std::string & getName() const
Definition: element.h:112
~Element() override=default
destructor
std::string name
name of element
Definition: element.h:251
MBXMLUtils::DOMEvalException domEvalError
Special XML helper variable.
Definition: element.h:262
Definition: element.h:66
virtual void setDynamicSystemSolver(DynamicSystemSolver *sys)
sets the used dynamics system solver to the element
Definition: element.h:93
Definition: element.h:68
H5::GroupBase * plotGroup
associated plot group
Definition: element.h:288
void setName(const std::string &str)
Definition: element.h:117
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:240
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:318
Element(const std::string &name)
constructor
Definition: element.cc:68
namespace MBSim
Definition: bilateral_constraint.cc:29