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 | Public Attributes | Friends | List of all members
oms::Connector Class Reference

Connector. More...

#include <Connector.h>

Inheritance diagram for oms::Connector:

Public Member Functions

 Connector (oms_causality_enu_t causality, oms_signal_type_enu_t type, const oms::ComRef &name, const oms::ComRef &owner)
 
 Connector (oms_causality_enu_t causality, oms_signal_type_enu_t type, const oms::ComRef &name, const oms::ComRef &owner, double height)
 
 ~Connector ()
 
 Connector (const Connector &rhs)
 
Connectoroperator= (const Connector &rhs)
 
oms_status_enu_t exportToSSD (pugi::xml_node &root) const
 
std::string getTypeString () const
 
std::string getCausalityString () const
 
 operator std::string () const
 
void setName (const oms::ComRef &name)
 
void setOwner (const oms::ComRef &owner)
 
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 getOwner () const
 
const oms::ComRef getName () const
 
const oms::ComRef getFullName () 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 isTypeBoolean () const
 
bool isTypeInteger () const
 
bool isTypeReal () const
 
bool isTypeString () const
 

Static Public Member Functions

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

Public Attributes

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 More...
 
std::map< std::string, std::string > enumerationName
 single entry map which contains connector name as key and enumerationName as value for a connector of type ssc:Enumeration More...
 

Friends

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

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,
const oms::ComRef owner 
)

◆ Connector() [2/3]

oms::Connector::Connector ( oms_causality_enu_t  causality,
oms_signal_type_enu_t  type,
const oms::ComRef name,
const oms::ComRef owner,
double  height 
)

◆ ~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

◆ exportToSSD()

oms_status_enu_t oms::Connector::exportToSSD ( pugi::xml_node &  root) const

◆ getCausality()

const oms_causality_enu_t oms::Connector::getCausality ( ) const
inline

◆ getCausalityString()

std::string oms::Connector::getCausalityString ( ) const

◆ getFullName()

const oms::ComRef oms::Connector::getFullName ( ) const
inline

◆ getGeometry()

const oms::ssd::ConnectorGeometry* oms::Connector::getGeometry ( ) const
inline

◆ getName()

const oms::ComRef oms::Connector::getName ( ) const
inline

◆ getOwner()

const oms::ComRef oms::Connector::getOwner ( ) const
inline

◆ getType()

const oms_signal_type_enu_t oms::Connector::getType ( ) const
inline

◆ getTypeString() [1/2]

std::string oms::Connector::getTypeString ( ) const

◆ getTypeString() [2/2]

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

◆ isCalculatedParameter()

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

◆ isInput()

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

◆ isOutput()

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

◆ isParameter()

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

◆ isTypeBoolean()

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

◆ isTypeInteger()

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

◆ isTypeReal()

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

◆ isTypeString()

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

◆ NewConnector()

oms::Connector * oms::Connector::NewConnector ( const pugi::xml_node &  node,
const std::string &  sspVersion,
const oms::ComRef owner 
)
static

◆ operator std::string()

oms::Connector::operator std::string ( ) const
inline

◆ operator=()

oms::Connector & oms::Connector::operator= ( const Connector rhs)

◆ setGeometry()

void oms::Connector::setGeometry ( const oms::ssd::ConnectorGeometry newGeometry)

◆ setName()

void oms::Connector::setName ( const oms::ComRef name)

◆ setOwner()

void oms::Connector::setOwner ( const oms::ComRef owner)

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

Member Data Documentation

◆ connectorUnits

std::map<std::string, std::map<std::string, std::string> > oms::Connector::connectorUnits

single entry map which contains unit as key and BaseUnits as value for a connector

◆ enumerationName

std::map<std::string, std::string> oms::Connector::enumerationName

single entry map which contains connector name as key and enumerationName as value for a connector of type ssc:Enumeration


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