OMSimulatorLib
The OMSimulator project is a FMI-based co-simulation environment that supports ordinary (i.e., non-delayed) and TLM connections.
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 #if !defined(NO_TLM)
40 #include "TLMBusConnector.h"
41 #endif
42 #include "OMSimulator/Types.h"
43 
44 namespace oms
45 {
49  class Element : protected oms_element_t
50  {
51  public:
52  Element(oms_element_enu_t type, const ComRef& name);
53  ~Element();
54 
55  const oms_element_enu_t getType() const {return type;}
56  const oms::ComRef getName() const {return oms::ComRef(name);}
57  oms::Connector** getConnectors() const {return reinterpret_cast<oms::Connector**>(connectors);}
58  const oms::ssd::ElementGeometry* getGeometry() const {return reinterpret_cast<oms::ssd::ElementGeometry*>(geometry);}
59 
60  void setName(const ComRef& name);
61  void setGeometry(const oms::ssd::ElementGeometry* newGeometry);
62  void setConnectors(oms::Connector** newConnectors);
63  void setBusConnectors(oms::BusConnector **newBusConnectors);
64 #if !defined(NO_TLM)
65  void setTLMBusConnectors(oms::TLMBusConnector **newTLMBusConnectors);
66 #endif
67  void setSubElements(oms_element_t** subelements);
68 
69  private:
70  // methods to copy the object
71  Element(const Element& rhs);
72  Element& operator=(const Element& rhs);
73  };
74 }
75 
76 #endif
oms
Definition: AlgLoop.h:44
oms::Element::~Element
~Element()
Definition: Element.cpp:48
ComRef.h
oms::ComRef
ComRef - component reference.
Definition: ComRef.h:46
oms::Element::setName
void setName(const ComRef &name)
Definition: Element.cpp:59
oms::Element::setBusConnectors
void setBusConnectors(oms::BusConnector **newBusConnectors)
Definition: Element.cpp:84
oms::Element
Element.
Definition: Element.h:49
oms::Element::getConnectors
oms::Connector ** getConnectors() const
Definition: Element.h:57
oms::ssp::Draft20180219::ssd::elements
const char * elements
Definition: Tags.cpp:54
oms::Element::setTLMBusConnectors
void setTLMBusConnectors(oms::TLMBusConnector **newTLMBusConnectors)
Definition: Element.cpp:90
Element.h
oms::Element::getGeometry
const oms::ssd::ElementGeometry * getGeometry() const
Definition: Element.h:58
oms::BusConnector
BusConnector.
Definition: BusConnector.h:20
oms::ssd::ElementGeometry
Definition: ElementGeometry.h:45
oms::Element::setSubElements
void setSubElements(oms_element_t **subelements)
Definition: Element.cpp:96
oms::Element::setGeometry
void setGeometry(const oms::ssd::ElementGeometry *newGeometry)
Definition: Element.cpp:67
BusConnector.h
oms::ssp::Draft20180219::ssd::connectors
const char * connectors
Definition: Tags.cpp:51
Connector.h
oms::Element::operator=
Element & operator=(const Element &rhs)
not implemented
oms::allocateAndCopyString
char * allocateAndCopyString(const char *source)
Definition: OMSString.cpp:38
oms::Element::getName
const oms::ComRef getName() const
Definition: Element.h:56
oms::ComRef::c_str
const char * c_str() const
Definition: ComRef.h:75
ElementGeometry.h
oms::Element::setConnectors
void setConnectors(oms::Connector **newConnectors)
Definition: Element.cpp:79
OMSString.h
oms::Element::getType
const oms_element_enu_t getType() const
Definition: Element.h:55
oms::Connector
Connector.
Definition: Connector.h:49
oms::TLMBusConnector
TLMBusConnector.
Definition: TLMBusConnector.h:96
oms::Element::Element
Element(oms_element_enu_t type, const ComRef &name)
Definition: Element.cpp:37