mbsim 4.0.0 MBSim Kernel

modelling_interface.h
1 /* Copyright (C) 2004-2009 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 _MODELLING_INTERFACE_H_
21 #define _MODELLING_INTERFACE_H_
22
23 namespace MBSim {
24
25 class Object;
26 class Link;
27 class Element;
28
35 class ModellingInterface : public virtual fmatvec::Atom {
36 public:
37
41 virtual ~ModellingInterface() = default;;
42
46 virtual void init(Element::InitStage stage, const InitConfigSet &config) = 0;
47
52 virtual std::string getName() const = 0;
53
58 virtual void setName(std::string name) = 0;
59
60 virtual Element* getParent() = 0;
61 virtual const Element* getParent() const = 0;
62 virtual void setParent(Element* parent_) = 0;
63
72 virtual void processModellList(std::vector<ModellingInterface*> &modellList, std::vector<MBSim::Object*> &objectList, std::vector<MBSim::Link*> &linkList) = 0;
73 };
74
75 }
76
77 #endif /* _MODELLING_INTERFACE_H_ */
78
MBSim::ModellingInterface::processModellList
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.
MBSim::ModellingInterface::getName
virtual std::string getName() const =0
Get the name of the model.
MBSim::ModellingInterface::init
virtual void init(Element::InitStage stage, const InitConfigSet &config)=0
initialize object at start of simulation with respect to contours and frames
MBSim::Element
basic class of MBSim mainly for plotting
Definition: element.h:56
MBSim::Element::InitStage
InitStage
The stages of the initialization.
Definition: element.h:62
MBSim::ModellingInterface
Interface for models of arbitrary domains, e.g. electrical components.
Definition: modelling_interface.h:35
MBSim::ModellingInterface::setName
virtual void setName(std::string name)=0
Set the name of the model.
MBSim::ModellingInterface::~ModellingInterface
virtual ~ModellingInterface()=default
Destructor.
MBSim
namespace MBSim
Definition: bilateral_constraint.cc:30