OMSimulatorLib
The OMSimulator project is a FMI-based co-simulation environment that supports ordinary (i.e., non-delayed) and TLM connections.
Public Member Functions | Friends | List of all members
oms::Connection Class Reference

** More...

#include <Connection.h>

Inheritance diagram for oms::Connection:
Inheritance graph
Collaboration diagram for oms::Connection:
Collaboration graph

Public Member Functions

 Connection (const oms::ComRef &conA, const oms::ComRef &conB, oms_connection_type_enu_t type=oms_connection_single)
 
 ~Connection ()
 
 Connection (const Connection &rhs)
 
Connectionoperator= (const Connection &rhs)
 
oms_status_enu_t exportToSSD (pugi::xml_node &root) const
 
const oms::ComRef getSignalA () const
 
const oms::ComRef getSignalB () const
 
const oms::ssd::ConnectionGeometrygetGeometry () const
 
void setGeometry (const oms::ssd::ConnectionGeometry *newGeometry)
 
void setTLMParameters (const oms_tlm_connection_parameters_t *parameters)
 
void setTLMParameters (double delay, double alpha, double linearimpedance, double angualrimpedance)
 
oms_tlm_connection_parameters_tgetTLMParameters () const
 
oms_connection_type_enu_t getType () const
 
bool isEqual (const oms::Connection &connection) const
 
bool isEqual (const oms::ComRef &signalA, const oms::ComRef &signalB) const
 
bool containsSignal (const oms::ComRef &signal)
 

Friends

bool operator== (const Connection &lhs, const Connection &rhs)
 
bool operator!= (const Connection &lhs, const Connection &rhs)
 

Additional Inherited Members

- Protected Attributes inherited from oms_connection_t
oms_connection_type_enu_t type
 Connection type, e.g. TLM. More...
 
char * conA
 Name of connector A. More...
 
char * conB
 Name of connector B. More...
 
ssd_connection_geometry_tgeometry
 Geometry information of the connection. More...
 
oms_tlm_connection_parameters_ttlmparameters
 TLM parameters (only for TLM connections) More...
 

Detailed Description

**

Constructor & Destructor Documentation

◆ Connection() [1/2]

oms::Connection::Connection ( const oms::ComRef conA,
const oms::ComRef conB,
oms_connection_type_enu_t  type = oms_connection_single 
)
Here is the call graph for this function:

◆ ~Connection()

oms::Connection::~Connection ( )

◆ Connection() [2/2]

oms::Connection::Connection ( const Connection rhs)

Member Function Documentation

◆ containsSignal()

bool oms::Connection::containsSignal ( const oms::ComRef signal)
Here is the call graph for this function:
Here is the caller graph for this function:

◆ exportToSSD()

oms_status_enu_t oms::Connection::exportToSSD ( pugi::xml_node &  root) const
Here is the call graph for this function:

◆ getGeometry()

const oms::ssd::ConnectionGeometry* oms::Connection::getGeometry ( ) const
inline
Here is the call graph for this function:
Here is the caller graph for this function:

◆ getSignalA()

const oms::ComRef oms::Connection::getSignalA ( ) const
inline
Here is the caller graph for this function:

◆ getSignalB()

const oms::ComRef oms::Connection::getSignalB ( ) const
inline
Here is the caller graph for this function:

◆ getTLMParameters()

oms_tlm_connection_parameters_t* oms::Connection::getTLMParameters ( ) const
inline

◆ getType()

oms_connection_type_enu_t oms::Connection::getType ( ) const
inline
Here is the call graph for this function:

◆ isEqual() [1/2]

bool oms::Connection::isEqual ( const oms::Connection connection) const
Here is the call graph for this function:
Here is the caller graph for this function:

◆ isEqual() [2/2]

bool oms::Connection::isEqual ( const oms::ComRef signalA,
const oms::ComRef signalB 
) const

◆ operator=()

oms::Connection & oms::Connection::operator= ( const Connection rhs)
Here is the call graph for this function:

◆ setGeometry()

void oms::Connection::setGeometry ( const oms::ssd::ConnectionGeometry newGeometry)
Here is the caller graph for this function:

◆ setTLMParameters() [1/2]

void oms::Connection::setTLMParameters ( const oms_tlm_connection_parameters_t parameters)
Here is the caller graph for this function:

◆ setTLMParameters() [2/2]

void oms::Connection::setTLMParameters ( double  delay,
double  alpha,
double  linearimpedance,
double  angualrimpedance 
)

Friends And Related Function Documentation

◆ operator!=

bool operator!= ( const Connection lhs,
const Connection rhs 
)
friend

◆ operator==

bool operator== ( const Connection lhs,
const Connection rhs 
)
friend

The documentation for this class was generated from the following files: