Public Member Functions | Static Public Member Functions | Protected Attributes | List of all members
te::process::Connector Class Reference

Abstraction that represents a Connector between parameters of a Task. More...

#include <Connector.h>

Public Member Functions

void apply ()
 
void associate (te::process::Task *taskFrom, std::size_t paramIndexFrom, te::process::Task *taskTo, std::size_t paramIndexTo)
 Disassociates this connector from your tasks. More...
 
void clear ()
 Checks if the association is valid. More...
 
 Connector ()
 It initializes the Connector. More...
 
void disassociate ()
 Based on the association, gets the parameter from the taskFrom and pushes it into the taskTo. If the taskFrom is not ready, an exception will be thrown. More...
 
const std::string & getId () const
 
std::size_t getParamIndexFrom () const
 Gets the task 'to'. More...
 
std::size_t getParamIndexTo () const
 Check if an a association could be made between tasks and parameters indexes informed. More...
 
const te::process::Task * getTaskFrom () const
 Gets the param index 'from'. More...
 
const te::process::Task * getTaskTo () const
 Gets the param index 'to'. More...
 
bool isReady () const
 Gets the task 'from'. More...
 
bool isValid () const
 Checks if the parameter from the task from is ready to be pushed into the taskTo. More...
 
void setId (const std::string &id)
 Clears the association. More...
 
virtual ~Connector ()
 Virtual destructor. More...
 

Static Public Member Functions

static bool canAssociate (te::process::Task *taskFrom, std::size_t paramIndexFrom, te::process::Task *taskTo, std::size_t paramIndexTo, std::string &info)
 Associates the 'paramIndexFrom' output parameter of the 'taskFrom' to the 'paramIndexTo' input parameter of the 'taskTo'. More...
 

Protected Attributes

std::string m_id
 The ID of the connector. More...
 
bool m_isValid
 
std::size_t m_paramIndexFrom
 
std::size_t m_paramIndexTo
 
te::process::Task * m_taskFrom
 
te::process::Task * m_taskTo
 

Detailed Description

Abstraction that represents a Connector between parameters of a Task.

Definition at line 47 of file Connector.h.

Constructor & Destructor Documentation

◆ Connector()

te::process::Connector::Connector ( )

It initializes the Connector.

◆ ~Connector()

virtual te::process::Connector::~Connector ( )
virtual

Virtual destructor.

Gets the id of the connector

Member Function Documentation

◆ apply()

void te::process::Connector::apply ( )

◆ associate()

void te::process::Connector::associate ( te::process::Task *  taskFrom,
std::size_t  paramIndexFrom,
te::process::Task *  taskTo,
std::size_t  paramIndexTo 
)

Disassociates this connector from your tasks.

◆ canAssociate()

static bool te::process::Connector::canAssociate ( te::process::Task *  taskFrom,
std::size_t  paramIndexFrom,
te::process::Task *  taskTo,
std::size_t  paramIndexTo,
std::string &  info 
)
static

Associates the 'paramIndexFrom' output parameter of the 'taskFrom' to the 'paramIndexTo' input parameter of the 'taskTo'.

◆ clear()

void te::process::Connector::clear ( )

Checks if the association is valid.

◆ disassociate()

void te::process::Connector::disassociate ( )

Based on the association, gets the parameter from the taskFrom and pushes it into the taskTo. If the taskFrom is not ready, an exception will be thrown.

◆ getId()

const std::string& te::process::Connector::getId ( ) const

◆ getParamIndexFrom()

std::size_t te::process::Connector::getParamIndexFrom ( ) const

Gets the task 'to'.

◆ getParamIndexTo()

std::size_t te::process::Connector::getParamIndexTo ( ) const

Check if an a association could be made between tasks and parameters indexes informed.

◆ getTaskFrom()

const te::process::Task* te::process::Connector::getTaskFrom ( ) const

Gets the param index 'from'.

◆ getTaskTo()

const te::process::Task* te::process::Connector::getTaskTo ( ) const

Gets the param index 'to'.

◆ isReady()

bool te::process::Connector::isReady ( ) const

Gets the task 'from'.

◆ isValid()

bool te::process::Connector::isValid ( ) const

Checks if the parameter from the task from is ready to be pushed into the taskTo.

◆ setId()

void te::process::Connector::setId ( const std::string &  id)

Clears the association.

Member Data Documentation

◆ m_id

std::string te::process::Connector::m_id
protected

The ID of the connector.

Definition at line 100 of file Connector.h.

◆ m_isValid

bool te::process::Connector::m_isValid
protected

Definition at line 105 of file Connector.h.

◆ m_paramIndexFrom

std::size_t te::process::Connector::m_paramIndexFrom
protected

Definition at line 102 of file Connector.h.

◆ m_paramIndexTo

std::size_t te::process::Connector::m_paramIndexTo
protected

Definition at line 104 of file Connector.h.

◆ m_taskFrom

te::process::Task* te::process::Connector::m_taskFrom
protected

Definition at line 101 of file Connector.h.

◆ m_taskTo

te::process::Task* te::process::Connector::m_taskTo
protected

Definition at line 103 of file Connector.h.

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