oms::Connection Class Reference

** More...

#include <Connection.h>

Inheritance diagram for oms::Connection:

Collaboration diagram for oms::Connection:

Public Member Functions
	Connection (const oms::ComRef &conA, const oms::ComRef &conB, bool suppressUnitConversion=false, oms_connection_type_enu_t type=oms_connection_single)
	~Connection ()
	Connection (const Connection &rhs)
Connection &	operator= (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::ConnectionGeometry *	getGeometry () const
void	setGeometry (const oms::ssd::ConnectionGeometry *newGeometry, bool inverse=false)
void	setTLMParameters (const oms_tlm_connection_parameters_t *parameters)
void	setTLMParameters (double delay, double alpha, double linearimpedance, double angualrimpedance)
oms_tlm_connection_parameters_t *	getTLMParameters () 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
	"A->B" and "B->A" are treated the same More...
bool	isStrictEqual (const oms::ComRef &signalA, const oms::ComRef &signalB) const
	"A->B" is not strict equal "B->A" More...
bool	containsSignal (const oms::ComRef &signal) const
bool	containsSignalB (const oms::ComRef &signal) const
bool	getSuppressUnitConversion ()
oms_status_enu_t	rename (const oms::ComRef &cref, const oms::ComRef &newCref)

Static Public Member Functions
static bool	isValid (const ComRef &crefA, const ComRef &crefB, const Connector &conA, const Connector &conB)
	Checks a connection based on SSP-1.0 connection table. More...
static bool	isValidUnits (const ComRef &crefA, const ComRef &crefB, const Connector &conA, const Connector &conB)
static void	getSIUnits (const Connector &connector, std::map< std::string, std::string > &baseUnits)

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_t *	geometry
	Geometry information of the connection. More...
oms_tlm_connection_parameters_t *	tlmparameters
	TLM parameters (only for TLM connections) More...
bool	suppressUnitConversion
	boolean to specify automatic unit coversion between connections More...

Detailed Description

**

Constructor & Destructor Documentation

Connection() [1/2]

oms::Connection::Connection	(	const oms::ComRef &	conA,
		const oms::ComRef &	conB,
		bool	suppressUnitConversion = false,
		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

)

const

Here is the call graph for this function:

Here is the caller graph for this function:

containsSignalB()

bool oms::Connection::containsSignalB

(

const oms::ComRef &

signal

)

const

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:

getSIUnits()

void oms::Connection::getSIUnits ( const Connector &  connector, std::map< std::string, std::string > &  baseUnits  )

static

Here is the caller graph for this function:

getSuppressUnitConversion()

bool oms::Connection::getSuppressUnitConversion ( )

inline

Here is the call 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

"A->B" and "B->A" are treated the same

isStrictEqual()

bool oms::Connection::isStrictEqual	(	const oms::ComRef &	signalA,
		const oms::ComRef &	signalB
	)		const

"A->B" is not strict equal "B->A"

Here is the caller graph for this function:

isValid()

bool oms::Connection::isValid ( const ComRef &  crefA, const ComRef &  crefB, const Connector &  conA, const Connector &  conB  )

static

Checks a connection based on SSP-1.0 connection table.

Here is the call graph for this function:

Here is the caller graph for this function:

isValidUnits()

bool oms::Connection::isValidUnits ( const ComRef &  crefA, const ComRef &  crefB, const Connector &  conA, const Connector &  conB  )

static

Here is the call graph for this function:

Here is the caller graph for this function:

operator=()

oms::Connection & oms::Connection::operator=

(

const Connection &

rhs

)

Here is the call graph for this function:

rename()

oms_status_enu_t oms::Connection::rename	(	const oms::ComRef &	cref,
		const oms::ComRef &	newCref
	)

Here is the call graph for this function:

Here is the caller graph for this function:

setGeometry()

void oms::Connection::setGeometry	(	const oms::ssd::ConnectionGeometry *	newGeometry,
		bool	inverse = false
	)

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:

• /var/lib/jenkins1/ws/OMSimulator_om_maintenance_v1.21/src/OMSimulatorLib/Connection.h
• /var/lib/jenkins1/ws/OMSimulator_om_maintenance_v1.21/src/OMSimulatorLib/Connection.cpp