CeresEngine::Connection Class Reference

A class that describes the connection between an input and an output slot. More...

#include <CeresEngine/Renderer/RenderGraph/RenderGraphSlot.hpp>

Inheritance diagram for CeresEngine::Connection:

Public Types
enum class	Status { Connected , Disconnected }

Public Member Functions
	Connection (InputSlot &input, OutputSlot &output)
	~Connection ()
InputSlot &	getInput () const
	The slot connected to the input end of the connection.
OutputSlot &	getOutput () const
	The slot connected to the output end of the connection.
Status	getStatus () const noexcept
	A value that indicates the connection status.
bool	isConnected () const noexcept
bool	isDisconnected () const noexcept
void	disconnect ()
	Disconnects the connection.
Public Member Functions inherited from CeresEngine::RefCounted< Connection >
	RefCounted (Args &&... args)
	Creates a new RefCounted object and constructs a new Deleter by forwarding Args to it.
void	retain () noexcept
	Retains the object by increment it's reference count by one.
bool	release () noexcept
	Relases the object by decrementing it's reference count by one.

Protected Member Functions
void	didConnect ()
void	didDisconnect ()

Private Attributes
InputSlot &	mInput
	The slot connected to the input end of the connection.
OutputSlot &	mOutput
	The slot connected to the output end of the connection.
Status	mStatus = Status::Disconnected
	A value that indicates the connection status.

Friends
class	Slot

Detailed Description

A class that describes the connection between an input and an output slot.

Member Enumeration Documentation

Status

enum class CeresEngine::Connection::Status

strong

Enumerator
Connected
Disconnected

Constructor & Destructor Documentation

Connection()

CeresEngine::Connection::Connection ( InputSlot &  input, OutputSlot &  output  )

inlineexplicit

~Connection()

CeresEngine::Connection::~Connection

(

)

Member Function Documentation

didConnect()

void CeresEngine::Connection::didConnect ( )

protected

didDisconnect()

void CeresEngine::Connection::didDisconnect ( )

protected

disconnect()

void CeresEngine::Connection::disconnect

(

)

Disconnects the connection.

getInput()

InputSlot & CeresEngine::Connection::getInput ( ) const

inline

The slot connected to the input end of the connection.

getOutput()

OutputSlot & CeresEngine::Connection::getOutput ( ) const

inline

The slot connected to the output end of the connection.

getStatus()

Status CeresEngine::Connection::getStatus ( ) const

inlinenoexcept

A value that indicates the connection status.

isConnected()

bool CeresEngine::Connection::isConnected ( ) const

inlinenoexcept

Returns

true if the connection is active.

isDisconnected()

bool CeresEngine::Connection::isDisconnected ( ) const

inlinenoexcept

Returns

true if the connection is not active.

Friends And Related Symbol Documentation

Slot

friend class Slot

friend

Member Data Documentation

mInput

InputSlot& CeresEngine::Connection::mInput

private

The slot connected to the input end of the connection.

mOutput

OutputSlot& CeresEngine::Connection::mOutput

private

The slot connected to the output end of the connection.

mStatus

Status CeresEngine::Connection::mStatus = Status::Disconnected

private

A value that indicates the connection status.

---

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

• /Users/Rogiel/Developer/CeresEngine/Engine/Sources/CeresEngine/Renderer/RenderGraph/RenderGraphSlot.hpp