OMSimulatorLib
The OMSimulator project is a FMI-based co-simulation environment.
Element.h
Go to the documentation of this file.
1 /*
2  * This file is part of OpenModelica.
3  *
4  * Copyright (c) 1998-CurrentYear, Open Source Modelica Consortium (OSMC),
5  * c/o Linköpings universitet, Department of Computer and Information Science,
6  * SE-58183 Linköping, Sweden.
7  *
8  * All rights reserved.
9  *
10  * THIS PROGRAM IS PROVIDED UNDER THE TERMS OF GPL VERSION 3 LICENSE OR
11  * THIS OSMC PUBLIC LICENSE (OSMC-PL) VERSION 1.2.
12  * ANY USE, REPRODUCTION OR DISTRIBUTION OF THIS PROGRAM CONSTITUTES
13  * RECIPIENT'S ACCEPTANCE OF THE OSMC PUBLIC LICENSE OR THE GPL VERSION 3,
14  * ACCORDING TO RECIPIENTS CHOICE.
15  *
16  * The OpenModelica software and the Open Source Modelica
17  * Consortium (OSMC) Public License (OSMC-PL) are obtained
18  * from OSMC, either from the above address,
19  * from the URLs: http://www.ida.liu.se/projects/OpenModelica or
20  * http://www.openmodelica.org, and in the OpenModelica distribution.
21  * GNU version 3 is obtained from: http://www.gnu.org/copyleft/gpl.html.
22  *
23  * This program is distributed WITHOUT ANY WARRANTY; without
24  * even the implied warranty of MERCHANTABILITY or FITNESS
25  * FOR A PARTICULAR PURPOSE, EXCEPT AS EXPRESSLY SET FORTH
26  * IN THE BY RECIPIENT SELECTED SUBSIDIARY LICENSE CONDITIONS OF OSMC-PL.
27  *
28  * See the full OSMC Public License conditions for more details.
29  *
30  */
31 
32 #ifndef _OMS_ELEMENT_H_
33 #define _OMS_ELEMENT_H_
34 
35 #include "BusConnector.h"
36 #include "ComRef.h"
37 #include "Connector.h"
38 #include "ssd/ElementGeometry.h"
39 #include "OMSimulator/Types.h"
40 
41 namespace oms
42 {
46  class Element : protected oms_element_t
47  {
48  public:
49  Element(oms_element_enu_t type, const ComRef& name);
50  ~Element();
51 
52  const oms_element_enu_t getType() const {return type;}
53  const oms::ComRef getName() const {return oms::ComRef(name);}
54  oms::Connector** getConnectors() const {return reinterpret_cast<oms::Connector**>(connectors);}
55  const oms::ssd::ElementGeometry* getGeometry() const {return reinterpret_cast<oms::ssd::ElementGeometry*>(geometry);}
56 
57  void setName(const ComRef& name);
58  void setGeometry(const oms::ssd::ElementGeometry* newGeometry);
59  void setConnectors(oms::Connector** newConnectors);
60  void setBusConnectors(oms::BusConnector **newBusConnectors);
61  void setSubElements(oms_element_t** subelements);
62 
63  private:
64  // methods to copy the object
65  Element(const Element& rhs);
66  Element& operator=(const Element& rhs);
67  };
68 }
69 
70 #endif
BusConnector.
Definition: BusConnector.h:21
ComRef - component reference.
Definition: ComRef.h:47
Connector.
Definition: Connector.h:50
Element.
Definition: Element.h:47
void setGeometry(const oms::ssd::ElementGeometry *newGeometry)
Definition: Element.cpp:66
Element(oms_element_enu_t type, const ComRef &name)
Definition: Element.cpp:37
void setSubElements(oms_element_t **subelements)
Definition: Element.cpp:88
const oms::ComRef getName() const
Definition: Element.h:53
void setName(const ComRef &name)
Definition: Element.cpp:58
Element & operator=(const Element &rhs)
not implemented
void setConnectors(oms::Connector **newConnectors)
Definition: Element.cpp:78
~Element()
Definition: Element.cpp:47
const oms::ssd::ElementGeometry * getGeometry() const
Definition: Element.h:55
Element(const Element &rhs)
not implemented
const oms_element_enu_t getType() const
Definition: Element.h:52
oms::Connector ** getConnectors() const
Definition: Element.h:54
void setBusConnectors(oms::BusConnector **newBusConnectors)
Definition: Element.cpp:83
Definition: ElementGeometry.h:46
const char * connectors
Definition: Tags.cpp:49
Definition: AlgLoop.h:45