TCS::Connector Class Reference

#include <Connector.h>

Inheritance diagram for TCS::Connector:

Collaboration diagram for TCS::Connector:

Public Types
enum	ConnectorType {   NONE =0 , INPUT , SORT , DECISION ,   COUNT }

Public Member Functions
	Connector (const std::string &name, ConnectorType conntype)
	Connector (const std::string &name, const std::vector< std::string > &inputnames, const std::string &algorithm, const std::vector< std::string > &outputnames, ConnectorType conntype)
virtual	~Connector ()
bool	isInputConnector () const
bool	isSortingConnector () const
bool	isDecisionConnector () const
bool	isCountingConnector () const
const std::string &	name () const
const std::string &	algorithmName () const
const std::vector< std::string > &	inputNames () const
const std::vector< std::string > &	outputNames () const
const std::vector< TCS::Connector * > &	inputConnectors () const
const TCS::ConfigurableAlg *	algorithm () const
virtual void	setAlgorithm (TCS::ConfigurableAlg *)
virtual StatusCode	clearOutput ()=0
StatusCode	reset ()
bool	isExecuted () const
StatusCode	executionStatusCode () const
unsigned int	numberOutputBits () const
void	toggleInputOverflow (const bool value)
	to be toggled after 'attachOutputData' is called.
bool	hasInputOverflow () const
void	toggleAmbiguity (const bool value)
bool	hasAmbiguity () const

Protected Member Functions
void	setIsExecuted (bool isExecuted)
void	setExecutionStatusCode (StatusCode statusCode)
std::vector< TCS::Connector * > &	inputConnectors ()
TCS::ConfigurableAlg *	algorithm ()

Protected Attributes
std::string	m_name {""}
std::string	m_algorithmName {""}
std::vector< std::string >	m_inputNames
std::vector< std::string >	m_outputNames
std::vector< TCS::Connector * >	m_inputConnectors
TCS::ConfigurableAlg *	m_algorithm { nullptr }
	the algorithm that belongs to this connector
bool	m_isExecuted {false}
StatusCode	m_executionStatusCode {StatusCode::SUCCESS}
bool	m_hasInputOverflow {false}
	whether the input data came with an overflow bit
bool	m_hasAmbiguity {false}

Private Attributes
ConnectorType	m_conntype { NONE }

Friends
class	TopoSteering
class	TopoSteeringStructure

Detailed Description

Definition at line 22 of file Connector.h.

Member Enumeration Documentation

ConnectorType

enum TCS::Connector::ConnectorType

Enumerator
NONE
INPUT
SORT
DECISION
COUNT

Definition at line 25 of file Connector.h.

{ NONE=0, INPUT, SORT, DECISION, COUNT };

Constructor & Destructor Documentation

Connector() [1/2]

TCS::Connector::Connector	(	const std::string &	name,
		ConnectorType	conntype )

Definition at line 31 of file Connector.cxx.

                                                    :
   m_name(name),
   m_conntype(conntype)
{}

Connector() [2/2]

TCS::Connector::Connector	(	const std::string &	name,
		const std::vector< std::string > &	inputnames,
		const std::string &	algorithm,
		const std::vector< std::string > &	outputnames,
		ConnectorType	conntype )

Definition at line 17 of file Connector.cxx.

                                                    :
   m_name(name),
   m_algorithmName(algorithm),
   m_inputNames(inputs),
   m_outputNames(outputs),
   m_conntype(conntype)
{}

~Connector()

TCS::Connector::~Connector ( )

virtual

Definition at line 38 of file Connector.cxx.

{}

Member Function Documentation

algorithm() [1/2]

TCS::ConfigurableAlg * TCS::Connector::algorithm ( )

inlineprotected

Definition at line 87 of file Connector.h.

{ return m_algorithm; }

algorithm() [2/2]

const TCS::ConfigurableAlg * TCS::Connector::algorithm ( ) const

inline

Definition at line 50 of file Connector.h.

{  return m_algorithm; }

algorithmName()

const std::string & TCS::Connector::algorithmName ( ) const

inline

Definition at line 45 of file Connector.h.

{  return m_algorithmName; }

clearOutput()

virtual StatusCode TCS::Connector::clearOutput ( )

pure virtual

Implemented in TCS::CountingConnector, TCS::DecisionConnector, TCS::InputConnector, and TCS::SortingConnector.

executionStatusCode()

StatusCode TCS::Connector::executionStatusCode ( ) const

inline

Definition at line 61 of file Connector.h.

{ return m_executionStatusCode; }

hasAmbiguity()

bool TCS::Connector::hasAmbiguity ( ) const

inline

Definition at line 73 of file Connector.h.

{ return m_hasAmbiguity; }

hasInputOverflow()

bool TCS::Connector::hasInputOverflow ( ) const

inline

Definition at line 70 of file Connector.h.

{ return m_hasInputOverflow; }

inputConnectors() [1/2]

std::vector< TCS::Connector * > & TCS::Connector::inputConnectors ( )

inlineprotected

Definition at line 85 of file Connector.h.

{ return m_inputConnectors; }

inputConnectors() [2/2]

const std::vector< TCS::Connector * > & TCS::Connector::inputConnectors ( ) const

inline

Definition at line 49 of file Connector.h.

{ return m_inputConnectors; }

inputNames()

const std::vector< std::string > & TCS::Connector::inputNames ( ) const

inline

Definition at line 46 of file Connector.h.

{ return m_inputNames; }

isCountingConnector()

bool TCS::Connector::isCountingConnector ( ) const

inline

Definition at line 42 of file Connector.h.

{ return m_conntype == COUNT; }

isDecisionConnector()

bool TCS::Connector::isDecisionConnector ( ) const

inline

Definition at line 41 of file Connector.h.

{ return m_conntype == DECISION; }

isExecuted()

bool TCS::Connector::isExecuted ( ) const

inline

Definition at line 59 of file Connector.h.

{ return m_isExecuted; }

isInputConnector()

bool TCS::Connector::isInputConnector ( ) const

inline

Definition at line 39 of file Connector.h.

{ return m_conntype == INPUT; }

isSortingConnector()

bool TCS::Connector::isSortingConnector ( ) const

inline

Definition at line 40 of file Connector.h.

{ return m_conntype == SORT; }

name()

const std::string & TCS::Connector::name ( ) const

inline

Definition at line 44 of file Connector.h.

{ return m_name; }

numberOutputBits()

unsigned int TCS::Connector::numberOutputBits

(

)

const

Definition at line 70 of file Connector.cxx.

                                     {
   if(isDecisionConnector()) {
      return (static_cast<const DecisionAlg*>(algorithm()))->numberOutputBits();
   } else {
      return 0;
   }
}

outputNames()

const std::vector< std::string > & TCS::Connector::outputNames ( ) const

inline

Definition at line 47 of file Connector.h.

{ return m_outputNames; }

reset()

TCS::StatusCode TCS::Connector::reset

(

)

Definition at line 48 of file Connector.cxx.

                    {
   StatusCode sc(StatusCode::SUCCESS);
 
   // clear the output data
   //coverity[USELESS_CALL:FALSE]
   sc &= clearOutput();
   m_hasInputOverflow = false;
   m_hasAmbiguity = false;
 
   // reset the algorithm
   if(m_algorithm)
      //coverity[USELESS_CALL:FALSE]
      sc &= m_algorithm->reset();
 
   // reset the execution flags
   m_isExecuted = false;
   m_executionStatusCode = StatusCode::SUCCESS;
 
   return sc;
}

setAlgorithm()

void TCS::Connector::setAlgorithm ( TCS::ConfigurableAlg * alg )

virtual

Reimplemented in TCS::CountingConnector, TCS::DecisionConnector, and TCS::SortingConnector.

Definition at line 42 of file Connector.cxx.

                                                  {  // alg ownership is with the factory
   m_algorithm = alg;
}

setExecutionStatusCode()

void TCS::Connector::setExecutionStatusCode ( StatusCode statusCode )

inlineprotected

Definition at line 83 of file Connector.h.

{ m_executionStatusCode = statusCode; }

setIsExecuted()

void TCS::Connector::setIsExecuted ( bool isExecuted )

inlineprotected

Definition at line 81 of file Connector.h.

{ m_isExecuted = isExecuted; }

toggleAmbiguity()

void TCS::Connector::toggleAmbiguity

(

const bool

value

)

Definition at line 83 of file Connector.cxx.

{
    m_hasAmbiguity = value;
}

toggleInputOverflow()

void TCS::Connector::toggleInputOverflow

(

const bool

value

)

to be toggled after 'attachOutputData' is called.

This flag is reset with reset().

Definition at line 78 of file Connector.cxx.

{
    m_hasInputOverflow = value;
}

Friends And Related Symbol Documentation

TopoSteering

friend class TopoSteering

friend

Definition at line 77 of file Connector.h.

TopoSteeringStructure

friend class TopoSteeringStructure

friend

Definition at line 78 of file Connector.h.

Member Data Documentation

m_algorithm

TCS::ConfigurableAlg* TCS::Connector::m_algorithm { nullptr }

protected

the algorithm that belongs to this connector

Definition at line 102 of file Connector.h.

{ nullptr };

m_algorithmName

std::string TCS::Connector::m_algorithmName {""}

protected

Definition at line 93 of file Connector.h.

{""};

m_conntype

ConnectorType TCS::Connector::m_conntype { NONE }

private

Definition at line 117 of file Connector.h.

{ NONE };

m_executionStatusCode

StatusCode TCS::Connector::m_executionStatusCode {StatusCode::SUCCESS}

protected

Definition at line 107 of file Connector.h.

{StatusCode::SUCCESS}; // StatusCode of last execution (for cache)

m_hasAmbiguity

bool TCS::Connector::m_hasAmbiguity {false}

protected

Definition at line 113 of file Connector.h.

{false};

m_hasInputOverflow

bool TCS::Connector::m_hasInputOverflow {false}

protected

whether the input data came with an overflow bit

Definition at line 111 of file Connector.h.

{false};

m_inputConnectors

std::vector<TCS::Connector*> TCS::Connector::m_inputConnectors

protected

Definition at line 98 of file Connector.h.

m_inputNames

std::vector<std::string> TCS::Connector::m_inputNames

protected

Definition at line 94 of file Connector.h.

m_isExecuted

bool TCS::Connector::m_isExecuted {false}

protected

Definition at line 105 of file Connector.h.

{false};             // true if connector alg(s) have been executed on current event (must be reset at begin of event

m_name

std::string TCS::Connector::m_name {""}

protected

Definition at line 92 of file Connector.h.

{""};

m_outputNames

std::vector<std::string> TCS::Connector::m_outputNames

protected

Definition at line 95 of file Connector.h.

---

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

• Connector.h
• Connector.cxx