MBSim

Project Page
Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | Private Attributes
MBSim::Element Class Reference

basic class of MBSim mainly for plotting More...

#include <element.h>

Inheritance diagram for MBSim::Element:
MBSim::Contour MBSim::DynamicSystem MBSim::ExtraDynamic MBSim::Frame MBSim::Link MBSim::Object MBSim::PlotCartesianCoordinates MBSim::PlotCylinderCoordinates MBSim::PlotFrame MBSim::PlotFrame MBSim::PlotNaturalCoordinates MBSim::PlotRigidBodyGroup MBSim::PlotRigidBodyGroup

List of all members.

Public Member Functions

 Element (const std::string &name)
 constructor
virtual ~Element ()
 destructor
virtual void initDataInterfaceBase (DynamicSystemSolver *parentds)
 TODO.
virtual std::string getType () const
virtual void setDynamicSystemSolver (DynamicSystemSolver *sys)
virtual void plot (double t, double dt=1)
 plots time dependent data
virtual void plotAtSpecialEvent (double t, double dt=1)
 plots time dependent data at special events
virtual void closePlot ()
 closes plot file
const std::string & getName () const
const std::string getShortName () const
void setName (const std::string &str)
DynamicSystemSolver * getDynamicSystemSolver ()
virtual void init (InitStage stage)
 plots time series header
virtual void createPlotGroup ()
 creates the plotGroup for H5-output
H5::Group * getPlotGroup ()
virtual void setPlotFeature (PlotFeature pf, PlotFeatureStatus value)
 Set a plot feature.
void setPlotFeatureForChildren (PlotFeature pf, PlotFeatureStatus value)
 Set a plot feature for the children of this object.
void setPlotFeatureRecursive (PlotFeature pf, PlotFeatureStatus value)
 Set a plot feature for this object and the children of this object.
PlotFeatureStatus getPlotFeature (PlotFeature pf)
PlotFeatureStatus getPlotFeatureForChildren (PlotFeature pf)
virtual void initializeUsingXML (TiXmlElement *element)
template<class T >
T * getByPath (std::string path)
 a general element access
virtual Element * getByPathSearch (std::string path)
 a general element search by path
virtual Element * getParent ()
virtual const Element * getParent () const
virtual void setParent (Element *parent_)
std::string getPath (char pathDelim='.')

Static Public Member Functions

static double getDouble (TiXmlElement *e)
static int getInt (TiXmlElement *e)
static bool getBool (TiXmlElement *e)
static fmatvec::Vec getVec (TiXmlElement *e, int rows=0)
static fmatvec::Mat getMat (TiXmlElement *e, int rows=0, int cols=0)
static fmatvec::SqrMat getSqrMat (TiXmlElement *e, int size=0)
static fmatvec::SymMat getSymMat (TiXmlElement *e, int size=0)

Protected Member Functions

void updatePlotFeatures ()

Protected Attributes

Element * parent
std::string name
 name of element
DynamicSystemSolver * ds
 dynamic system
H5::VectorSerie< double > * plotVectorSerie
 time series
std::vector< double > plotVector
 one entry of time series
std::vector< std::string > plotColumns
 columns of time series
H5::Group * plotGroup
 associated plot group

Private Attributes

PlotFeatureStatus plotFeature [LASTPLOTFEATURE]
 plot feature
PlotFeatureStatus plotFeatureForChildren [LASTPLOTFEATURE]

Detailed Description

basic class of MBSim mainly for plotting

Author:
Martin Foerg
Date:
2009-03-24 plot feature energy (Thorsten Schindler)
2009-07-28 splitted interfaces (Thorsten Schindler)

Member Function Documentation

DynamicSystemSolver* MBSim::Element::getDynamicSystemSolver ( )
inline
Returns:
dynamic system solver

Reimplemented in MBSim::DynamicSystemSolver.

const std::string& MBSim::Element::getName ( ) const
inline
Returns:
element name
std::string MBSim::Element::getPath ( char  pathDelim = '.')
Returns:
full path of the object
Parameters:
delimiterof the path

Reimplemented in MBSim::DynamicSystem.

PlotFeatureStatus MBSim::Element::getPlotFeature ( PlotFeature  pf)
inline
Returns:
plot feature

Reimplemented in MBSim::DynamicSystem, and MBSim::Object.

PlotFeatureStatus MBSim::Element::getPlotFeatureForChildren ( PlotFeature  pf)
inline
Returns:
plot feature for derived classes

Reimplemented in MBSim::DynamicSystem, and MBSim::Object.

H5::Group* MBSim::Element::getPlotGroup ( )
inline
Returns:
associated plot group

Reimplemented in MBSim::DynamicSystem, and MBSim::Object.

const std::string MBSim::Element::getShortName ( ) const
inline
Returns:
the short name of the element (without hierarchical structure)
virtual std::string MBSim::Element::getType ( ) const
inlinevirtual
virtual void MBSim::Element::init ( InitStage  stage)
virtual
virtual void MBSim::Element::plot ( double  t,
double  dt = 1 
)
virtual
virtual void MBSim::Element::plotAtSpecialEvent ( double  t,
double  dt = 1 
)
inlinevirtual

plots time dependent data at special events

Parameters:
simulationtime
simulationtime step size for derivative calculation

Reimplemented in MBSim::DynamicSystem.

virtual void MBSim::Element::setDynamicSystemSolver ( DynamicSystemSolver *  sys)
inlinevirtual
Parameters:
TODO

Reimplemented in MBSim::DynamicSystem, and MBSim::Body.

void MBSim::Element::setName ( const std::string &  str)
inline
Parameters:
elementname
virtual void MBSim::Element::setPlotFeature ( PlotFeature  pf,
PlotFeatureStatus  value 
)
inlinevirtual

Set a plot feature.

Set the plot feature pf of this object to enabled, disabled or unset. If unset, this object uses the value of the plot feature pf of its parent object.

Reimplemented in MBSim::Contour.

void MBSim::Element::setPlotFeatureForChildren ( PlotFeature  pf,
PlotFeatureStatus  value 
)
inline

Set a plot feature for the children of this object.

Set the plot feature pf of all children which plot feature is unset to enabled, disabled or unset.

void MBSim::Element::setPlotFeatureRecursive ( PlotFeature  pf,
PlotFeatureStatus  value 
)
inline

Set a plot feature for this object and the children of this object.

This is a convenience function. It simply calls setPlotFeature and setPlotFeatureForChildren.


The documentation for this class was generated from the following file: