om::engine::base::Connection Class Reference

An object that represents a data connection between entity components. More...

#include <omEngineConnection.h>

Inheritance diagram for om::engine::base::Connection:

Public Member Functions
	Connection ()
	Create a new default connection that is not connected to anything. More...
	Connection (Connector *newConnector1, Connector *newConnector2)
	Create a new connection between the specified two connectors. More...
Connector *	getConnector1 () const
	Return a pointer to the first connector in this connection, the source of the data. More...
void	setConnector1 (Connector *newConnector1)
	Set a pointer to the first connector in this connection, the source of the data. More...
Connector *	getConnector2 () const
	Return a pointer to the second connector in this connection, the source of the data. More...
void	setConnector2 (Connector *newConnector2)
	Set a pointer to the second connector in this connection, the source of the data. More...
const Time &	getPeriod () const
	Return the nominal period at which this connection should be updated during a simulation. More...
void	setPeriod (const Time &newPeriod)
	Set the nominal period at which this connection should be updated during a simulation. More...
ConnectionFlags &	getFlags ()
	Return a reference to an object that contains boolean parameters of the connection. More...
const ConnectionFlags &	getFlags () const
	Return an object that contains boolean parameters of the connection. More...
void	setFlags (const ConnectionFlags &newFlags)
	Set an object that contains boolean parameters of the connection. More...
Bool	flagIsSet (ConnectionFlags::Flag flag) const
	Return whether or not the specified boolan flag is set for this connection. More...
Bool	flagsAreSet (const ConnectionFlags &otherFlags) const
	Return whether or not all of the specified boolan flags are set for this connection. More...
void	setFlag (ConnectionFlags::Flag flag, Bool newIsSet=true)
	Set whether or not the specified boolan flag is set for this connection. More...
Bool	isDisabled () const
	Return whether or not this connection is currently disabled. More...
Bool	getIsEnabled () const
	Return whether or not this connection is currently enabled. More...
void	setIsEnabled (Bool newIsEnabled)
	Set whether or not this connection should be enabled. More...

Detailed Description

An object that represents a data connection between entity components.

Constructor & Destructor Documentation

om::engine::base::Connection::Connection ( )

inline

Create a new default connection that is not connected to anything.

om::engine::base::Connection::Connection ( Connector *  newConnector1, Connector *  newConnector2  )

inline

Create a new connection between the specified two connectors.

Member Function Documentation

Connector* om::engine::base::Connection::getConnector1 ( ) const

inline

Return a pointer to the first connector in this connection, the source of the data.

void om::engine::base::Connection::setConnector1 ( Connector *  newConnector1 )

inline

Set a pointer to the first connector in this connection, the source of the data.

Connector* om::engine::base::Connection::getConnector2 ( ) const

inline

Return a pointer to the second connector in this connection, the source of the data.

void om::engine::base::Connection::setConnector2 ( Connector *  newConnector2 )

inline

Set a pointer to the second connector in this connection, the source of the data.

const Time& om::engine::base::Connection::getPeriod ( ) const

inline

Return the nominal period at which this connection should be updated during a simulation.

void om::engine::base::Connection::setPeriod ( const Time &  newPeriod )

inline

Set the nominal period at which this connection should be updated during a simulation.

ConnectionFlags& om::engine::base::Connection::getFlags ( )

inline

Return a reference to an object that contains boolean parameters of the connection.

const ConnectionFlags& om::engine::base::Connection::getFlags ( ) const

inline

Return an object that contains boolean parameters of the connection.

void om::engine::base::Connection::setFlags ( const ConnectionFlags &  newFlags )

inline

Set an object that contains boolean parameters of the connection.

Bool om::engine::base::Connection::flagIsSet ( ConnectionFlags::Flag  flag ) const

inline

Return whether or not the specified boolan flag is set for this connection.

Bool om::engine::base::Connection::flagsAreSet ( const ConnectionFlags &  otherFlags ) const

inline

Return whether or not all of the specified boolan flags are set for this connection.

void om::engine::base::Connection::setFlag ( ConnectionFlags::Flag  flag, Bool  newIsSet = true  )

inline

Set whether or not the specified boolan flag is set for this connection.

Bool om::engine::base::Connection::isDisabled ( ) const

inline

Return whether or not this connection is currently disabled.

Bool om::engine::base::Connection::getIsEnabled ( ) const

inline

Return whether or not this connection is currently enabled.

void om::engine::base::Connection::setIsEnabled ( Bool  newIsEnabled )

inline

Set whether or not this connection should be enabled.

---

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

• omEngineConnection.h