mbsim  4.0.0
MBSim Kernel
MBSim::ModellingInterface Class Referenceabstract

Interface for models of arbitrary domains, e.g. electrical components. More...

#include <modelling_interface.h>

Inheritance diagram for MBSim::ModellingInterface:
[legend]

Public Member Functions

virtual ~ModellingInterface ()=default
 Destructor.
 
virtual void init (Element::InitStage stage, const InitConfigSet &config)=0
 initialize object at start of simulation with respect to contours and frames
 
virtual std::string getName () const =0
 Get the name of the model. More...
 
virtual void setName (std::string name)=0
 Set the name of the model. More...
 
virtual ElementgetParent ()=0
 
virtual const ElementgetParent () const =0
 
virtual void setParent (Element *parent_)=0
 
virtual void processModellList (std::vector< ModellingInterface * > &modellList, std::vector< MBSim::Object * > &objectList, std::vector< MBSim::Link * > &linkList)=0
 Process all models of the same type as the calling model. More...
 

Detailed Description

Interface for models of arbitrary domains, e.g. electrical components.

Author
Martin Foerg
Date
2009-05-04 initial commit (Martin Foerg)
2009-07-28 splitted interfaces (Thorsten Schindler)

Member Function Documentation

◆ getName()

virtual std::string MBSim::ModellingInterface::getName ( ) const
pure virtual

Get the name of the model.

Returns
The name

◆ processModellList()

virtual void MBSim::ModellingInterface::processModellList ( std::vector< ModellingInterface * > &  modellList,
std::vector< MBSim::Object * > &  objectList,
std::vector< MBSim::Link * > &  linkList 
)
pure virtual

Process all models of the same type as the calling model.

Parameters
modellListOn input, modellList contains all models. On output, modellList contains all models that are not processed, i.e. all models of different type.
objectListOn output, objectList contains all models that are objects.
linkListOn output, linkList contains all models that are links.

◆ setName()

virtual void MBSim::ModellingInterface::setName ( std::string  name)
pure virtual

Set the name of the model.

Parameters
nameThe name

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