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

Connector. More...

#include <Connector.h>

Inheritance diagram for oms::Connector:
Inheritance graph
Collaboration diagram for oms::Connector:
Collaboration graph

Public Member Functions

 Connector (oms_causality_enu_t causality, oms_signal_type_enu_t type, const oms::ComRef &name)
 
 Connector (oms_causality_enu_t causality, oms_signal_type_enu_t type, const oms::ComRef &name, double height)
 
 ~Connector ()
 
oms_status_enu_t exportToSSD (pugi::xml_node &root) const
 
 Connector (const Connector &rhs)
 
Connectoroperator= (const Connector &rhs)
 
 operator std::string () const
 
void setName (const oms::ComRef &name)
 
void setGeometry (const oms::ssd::ConnectorGeometry *newGeometry)
 
const oms_causality_enu_t getCausality () const
 
const oms_signal_type_enu_t getType () const
 
const oms::ComRef getName () const
 
const oms::ssd::ConnectorGeometrygetGeometry () const
 
Connector addPrefix (const ComRef &prefix) const
 
bool isInput () const
 
bool isOutput () const
 
bool isParameter () const
 
bool isCalculatedParameter () const
 
bool isTypeReal () const
 
bool isTypeInteger () const
 
bool isTypeBoolean () const
 

Static Public Member Functions

static ConnectorNewConnector (const pugi::xml_node &node, const std::string &sspVersion)
 
static std::string getTypeString (const pugi::xml_node &node, const std::string &sspVersion)
 

Friends

bool operator== (const Connector &v1, const Connector &v2)
 
bool operator!= (const Connector &v1, const Connector &v2)
 

Additional Inherited Members

- Protected Attributes inherited from oms_connector_t
oms_causality_enu_t causality
 input/output/parameter More...
 
oms_signal_type_enu_t type
 Type of the connector. More...
 
char * name
 Name of the connector. More...
 
ssd_connector_geometry_tgeometry
 Geometry information of the connector. More...
 

Detailed Description

Connector.

Constructor & Destructor Documentation

◆ Connector() [1/3]

oms::Connector::Connector ( oms_causality_enu_t  causality,
oms_signal_type_enu_t  type,
const oms::ComRef name 
)
Here is the call graph for this function:
Here is the caller graph for this function:

◆ Connector() [2/3]

oms::Connector::Connector ( oms_causality_enu_t  causality,
oms_signal_type_enu_t  type,
const oms::ComRef name,
double  height 
)
Here is the call graph for this function:

◆ ~Connector()

oms::Connector::~Connector ( )

◆ Connector() [3/3]

oms::Connector::Connector ( const Connector rhs)

Member Function Documentation

◆ addPrefix()

oms::Connector oms::Connector::addPrefix ( const ComRef prefix) const
Here is the call graph for this function:
Here is the caller graph for this function:

◆ exportToSSD()

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

◆ getCausality()

const oms_causality_enu_t oms::Connector::getCausality ( ) const
inline
Here is the caller graph for this function:

◆ getGeometry()

const oms::ssd::ConnectorGeometry* oms::Connector::getGeometry ( ) const
inline
Here is the call graph for this function:

◆ getName()

const oms::ComRef oms::Connector::getName ( ) const
inline
Here is the caller graph for this function:

◆ getType()

const oms_signal_type_enu_t oms::Connector::getType ( ) const
inline
Here is the caller graph for this function:

◆ getTypeString()

std::string oms::Connector::getTypeString ( const pugi::xml_node &  node,
const std::string &  sspVersion 
)
static
Here is the caller graph for this function:

◆ isCalculatedParameter()

bool oms::Connector::isCalculatedParameter ( ) const
inline
Here is the caller graph for this function:

◆ isInput()

bool oms::Connector::isInput ( ) const
inline
Here is the caller graph for this function:

◆ isOutput()

bool oms::Connector::isOutput ( ) const
inline
Here is the caller graph for this function:

◆ isParameter()

bool oms::Connector::isParameter ( ) const
inline
Here is the caller graph for this function:

◆ isTypeBoolean()

bool oms::Connector::isTypeBoolean ( ) const
inline

◆ isTypeInteger()

bool oms::Connector::isTypeInteger ( ) const
inline

◆ isTypeReal()

bool oms::Connector::isTypeReal ( ) const
inline
Here is the caller graph for this function:

◆ NewConnector()

oms::Connector * oms::Connector::NewConnector ( const pugi::xml_node &  node,
const std::string &  sspVersion 
)
static
Here is the call graph for this function:
Here is the caller graph for this function:

◆ operator std::string()

oms::Connector::operator std::string ( ) const
inline
Here is the call graph for this function:

◆ operator=()

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

◆ setGeometry()

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

◆ setName()

void oms::Connector::setName ( const oms::ComRef name)
Here is the call graph for this function:
Here is the caller graph for this function:

Friends And Related Function Documentation

◆ operator!=

bool operator!= ( const Connector v1,
const Connector v2 
)
friend

◆ operator==

bool operator== ( const Connector v1,
const Connector v2 
)
friend

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