OMSimulatorLib
The OMSimulator project is a FMI-based co-simulation environment that supports ordinary (i.e., non-delayed) and TLM connections.
Connector.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_CONNECTOR_H_
33 #define _OMS_CONNECTOR_H_
34 
35 #include "ComRef.h"
36 #include "ssd/ConnectorGeometry.h"
37 #include "OMSimulator/Types.h"
38 
39 #include <string>
40 #include <map>
41 
42 #include <pugixml.hpp>
43 
44 namespace oms
45 {
49  class Connector : protected oms_connector_t
50  {
51  public:
52  Connector(oms_causality_enu_t causality, oms_signal_type_enu_t type, const oms::ComRef& name, const oms::ComRef& owner);
53  Connector(oms_causality_enu_t causality, oms_signal_type_enu_t type, const oms::ComRef& name, const oms::ComRef& owner, double height);
54  ~Connector();
55 
56  // methods to copy the object
57  Connector(const Connector& rhs);
58  Connector& operator=(const Connector& rhs);
59 
60  // you have to free the memory yourself
61  static Connector* NewConnector(const pugi::xml_node& node, const std::string& sspVersion, const oms::ComRef& owner);
62 
63  oms_status_enu_t exportToSSD(pugi::xml_node& root) const;
64  static std::string getTypeString(const pugi::xml_node& node, const std::string& sspVersion);
65  std::string getTypeString() const;
66  std::string getCausalityString() const;
67 
68  operator std::string() const {return std::string(name);}
69 
70  void setName(const oms::ComRef& name);
71  void setOwner(const oms::ComRef& owner);
72  void setGeometry(const oms::ssd::ConnectorGeometry* newGeometry);
73 
74  std::map<std::string, std::map<std::string, std::string>> connectorUnits;
75  std::map<std::string, std::string> enumerationName;
76 
77  const oms_causality_enu_t getCausality() const {return causality;}
78  const oms_signal_type_enu_t getType() const {return type;}
79  const oms::ComRef getOwner() const {return oms::ComRef(owner);}
80  const oms::ComRef getName() const {return oms::ComRef(name);}
81  const oms::ComRef getFullName() const {return getOwner() + getName();}
82  const oms::ssd::ConnectorGeometry* getGeometry() const {return reinterpret_cast<oms::ssd::ConnectorGeometry*>(geometry);}
83  Connector addPrefix(const ComRef& prefix) const;
84 
85  bool isInput() const { return oms_causality_input == causality; }
86  bool isOutput() const { return oms_causality_output == causality; }
87  bool isParameter() const { return oms_causality_parameter == causality; }
88  bool isCalculatedParameter() const { return oms_causality_calculatedParameter == causality; }
89 
90  bool isTypeBoolean() const { return oms_signal_type_boolean == type; }
91  bool isTypeInteger() const { return oms_signal_type_integer == type || oms_signal_type_enum == type; }
92  bool isTypeReal() const { return oms_signal_type_real == type; }
93  bool isTypeString() const { return oms_signal_type_string == type; }
94 
95  private:
96  friend bool operator==(const Connector& v1, const Connector& v2);
97  friend bool operator!=(const Connector& v1, const Connector& v2);
98  };
99 
100  bool operator==(const Connector& v1, const Connector& v2);
101  bool operator!=(const Connector& v1, const Connector& v2);
102 }
103 
104 #endif
oms::Connector::getCausality
const oms_causality_enu_t getCausality() const
Definition: Connector.h:77
oms
Definition: AlgLoop.h:44
oms::Connector::getTypeString
std::string getTypeString() const
Definition: Connector.cpp:312
oms::Connector::isCalculatedParameter
bool isCalculatedParameter() const
Definition: Connector.h:88
oms::Connector::enumerationName
std::map< std::string, std::string > enumerationName
single entry map which contains connector name as key and enumerationName as value for a connector of...
Definition: Connector.h:75
ComRef.h
oms::ssd::ConnectorGeometry::setPosition
void setPosition(double x, double y)
Definition: ConnectorGeometry.h:54
oms::Connector::isTypeBoolean
bool isTypeBoolean() const
Definition: Connector.h:90
oms::Connector::isInput
bool isInput() const
Definition: Connector.h:85
oms::Connector::setName
void setName(const oms::ComRef &name)
Definition: Connector.cpp:263
oms::ComRef
ComRef - component reference.
Definition: ComRef.h:46
oms::Connector::getType
const oms_signal_type_enu_t getType() const
Definition: Connector.h:78
oms::ssp::Version1_0::ssc::integer_type
const char * integer_type
Definition: Tags.cpp:86
oms::ssp::Version1_0::ssc::real_type
const char * real_type
Definition: Tags.cpp:85
oms::Connector::isOutput
bool isOutput() const
Definition: Connector.h:86
oms::ssp::Version1_0::ssc::enumeration_type
const char * enumeration_type
Definition: Tags.cpp:89
Tags.h
oms::operator==
bool operator==(const ComRef &lhs, const ComRef &rhs)
Definition: ComRef.cpp:210
oms::Connector::setGeometry
void setGeometry(const oms::ssd::ConnectorGeometry *newGeometry)
Definition: Connector.cpp:283
oms::Connector::isTypeReal
bool isTypeReal() const
Definition: Connector.h:92
oms::Connector::operator!=
friend bool operator!=(const Connector &v1, const Connector &v2)
oms::ssp::Draft20180219::ssd::connector
const char * connector
Definition: Tags.cpp:49
oms::Connector::connectorUnits
std::map< std::string, std::map< std::string, std::string > > connectorUnits
single entry map which contains unit as key and BaseUnits as value for a connector
Definition: Connector.h:74
oms::Connector::addPrefix
Connector addPrefix(const ComRef &prefix) const
Definition: Connector.cpp:295
oms::Connector::NewConnector
static Connector * NewConnector(const pugi::xml_node &node, const std::string &sspVersion, const oms::ComRef &owner)
Definition: Connector.cpp:124
oms::Connector::exportToSSD
oms_status_enu_t exportToSSD(pugi::xml_node &root) const
Definition: Connector.cpp:211
oms::ssp::Version1_0::ssc::boolean_type
const char * boolean_type
Definition: Tags.cpp:87
ConnectorGeometry.h
oms::ssp::Version1_0::ssc::string_type
const char * string_type
Definition: Tags.cpp:88
oms::Connector::isTypeString
bool isTypeString() const
Definition: Connector.h:93
oms::operator!=
bool operator!=(const ComRef &lhs, const ComRef &rhs)
Definition: ComRef.cpp:215
oms::Connector::Connector
Connector(oms_causality_enu_t causality, oms_signal_type_enu_t type, const oms::ComRef &name, const oms::ComRef &owner)
Definition: Connector.cpp:40
Connector.h
oms::Connector::operator==
friend bool operator==(const Connector &v1, const Connector &v2)
oms::allocateAndCopyString
char * allocateAndCopyString(const char *source)
Definition: OMSString.cpp:38
oms::Connector::isParameter
bool isParameter() const
Definition: Connector.h:87
oms::Connector::getCausalityString
std::string getCausalityString() const
Definition: Connector.cpp:339
oms::Connector::~Connector
~Connector()
Definition: Connector.cpp:81
oms::Connector::setOwner
void setOwner(const oms::ComRef &owner)
Definition: Connector.cpp:273
oms::Connector::getName
const oms::ComRef getName() const
Definition: Connector.h:80
oms::ssd::ConnectorGeometry
Definition: ConnectorGeometry.h:45
oms::ComRef::c_str
const char * c_str() const
Definition: ComRef.h:75
logError
#define logError(msg)
Definition: Logging.h:102
oms::Connector::getGeometry
const oms::ssd::ConnectorGeometry * getGeometry() const
Definition: Connector.h:82
OMSString.h
oms::ssp::Version1_0::ssc::binary_type
const char * binary_type
Definition: Tags.cpp:90
oms::Connector
Connector.
Definition: Connector.h:49
oms::Connector::getFullName
const oms::ComRef getFullName() const
Definition: Connector.h:81
Logging.h
oms::Connector::getOwner
const oms::ComRef getOwner() const
Definition: Connector.h:79
Variable.h
oms::Connector::isTypeInteger
bool isTypeInteger() const
Definition: Connector.h:91
oms::ssp::Draft20180219::ssd::connector_geometry
const char * connector_geometry
Definition: Tags.cpp:50
oms::Connector::operator=
Connector & operator=(const Connector &rhs)
Definition: Connector.cpp:102