OMSimulatorLib
The OMSimulator project is a FMI-based co-simulation environment that supports ordinary (i.e., non-delayed) and TLM connections.
Connection.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_CONNECTION_H_
33 #define _OMS_CONNECTION_H_
34 
35 #include "ComRef.h"
36 #include "Types.h"
37 #include "ssd/ConnectionGeometry.h"
38 
39 #include <string>
40 
41 namespace oms
42 {
44  // * \brief Connection
45  // * /
46  class Connection : protected oms_connection_t
47  {
48  public:
50  ~Connection();
51 
52  // methods to copy the object
53  Connection(const Connection& rhs);
54  Connection& operator=(const Connection& rhs);
55 
56  oms_status_enu_t exportToSSD(pugi::xml_node& root) const;
57 
58  const oms::ComRef getSignalA() const {return oms::ComRef(conA);}
59  const oms::ComRef getSignalB() const {return oms::ComRef(conB);}
60 
62  void setGeometry(const oms::ssd::ConnectionGeometry* newGeometry);
63  void setTLMParameters(const oms_tlm_connection_parameters_t* parameters);
64  void setTLMParameters(double delay, double alpha, double linearimpedance, double angualrimpedance);
66 
68 
69  bool isEqual(const oms::Connection& connection) const;
70  bool isEqual(const oms::ComRef& signalA, const oms::ComRef& signalB) const;
71  bool containsSignal(const oms::ComRef& signal);
72 
73  private:
74  friend bool operator==(const Connection& lhs, const Connection& rhs);
75  friend bool operator!=(const Connection& lhs, const Connection& rhs);
76  };
77 
78  inline bool operator==(const Connection& lhs, const Connection& rhs) {return lhs.isEqual(rhs);}
79  inline bool operator!=(const Connection& lhs, const Connection& rhs) {return !(lhs == rhs);}
80 }
81 
82 #endif
void setTLMParameters(const oms_tlm_connection_parameters_t *parameters)
Definition: Connection.cpp:152
oms_connection_type_enu_t type
Connection type, e.g. TLM.
Definition: Types.h:351
friend bool operator==(const Connection &lhs, const Connection &rhs)
Definition: Connection.h:78
bool isEqual(const oms::Connection &connection) const
Definition: Connection.cpp:180
oms_status_enu_t exportToSSD(pugi::xml_node &root) const
Definition: Connection.cpp:112
Connection between two connectors.
Definition: Types.h:350
Connection & operator=(const Connection &rhs)
Definition: Connection.cpp:85
char * conB
Name of connector B.
Definition: Types.h:353
oms_status_enu_t
Definition: Types.h:43
char * conA
Name of connector A.
Definition: Types.h:352
Connection(const oms::ComRef &conA, const oms::ComRef &conB, oms_connection_type_enu_t type=oms_connection_single)
Definition: Connection.cpp:41
oms_connection_type_enu_t
Connection type.
Definition: Types.h:127
bool containsSignal(const oms::ComRef &signal)
Definition: Connection.cpp:187
ComRef - component reference.
Definition: ComRef.h:43
oms_tlm_connection_parameters_t * getTLMParameters() const
Definition: Connection.h:65
oms_tlm_connection_parameters_t * tlmparameters
TLM parameters (only for TLM connections)
Definition: Types.h:355
const oms::ComRef getSignalB() const
Definition: Connection.h:59
const oms::ssd::ConnectionGeometry * getGeometry() const
Definition: Connection.h:61
~Connection()
Definition: Connection.cpp:60
FMI conncection (directed & undelayed signal connection)
Definition: Types.h:128
Definition: BusConnector.h:15
Parameters for TLM connection.
Definition: Types.h:340
Definition: ConnectionGeometry.h:45
**
Definition: Connection.h:46
const oms::ComRef getSignalA() const
Definition: Connection.h:58
ssd_connection_geometry_t * geometry
Geometry information of the connection.
Definition: Types.h:354
oms_connection_type_enu_t getType() const
Definition: Connection.h:67
friend bool operator!=(const Connection &lhs, const Connection &rhs)
Definition: Connection.h:79
const char * signal
Definition: Tags.cpp:38
void setGeometry(const oms::ssd::ConnectionGeometry *newGeometry)
Definition: Connection.cpp:143