TCS::SortingConnector Class Reference

#include <SortingConnector.h>

Inheritance diagram for TCS::SortingConnector:

Collaboration diagram for TCS::SortingConnector:

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

Public Member Functions
	SortingConnector (const std::string &input, const std::string &algorithm, const std::string &output)
virtual	~SortingConnector ()
InputConnector *	inputConnector () const
std::string	inputName () const
std::string	outputName () const
void	attachOutputData (const TOBArray *data)
const TOBArray *	outputData () const
void	setAlgorithm (ConfigurableAlg *alg)
SortingAlg *	sortingAlgorithm ()
StatusCode	clearOutput ()
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
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
std::vector< TCS::Connector * > &	inputConnectors ()
TCS::ConfigurableAlg *	algorithm ()
void	setIsExecuted (bool isExecuted)
void	setExecutionStatusCode (StatusCode statusCode)

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
SortingAlg *	m_sortingAlgorithm { nullptr }
TOBArray const *	m_outputData { nullptr }
ConnectorType	m_conntype { NONE }

Detailed Description

Definition at line 24 of file SortingConnector.h.

Member Enumeration Documentation

ConnectorType

enum TCS::Connector::ConnectorType

inherited

Enumerator
NONE
INPUT
SORT
DECISION
COUNT

Definition at line 25 of file Connector.h.

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

Constructor & Destructor Documentation

SortingConnector()

SortingConnector::SortingConnector	(	const std::string &	input,
		const std::string &	algorithm,
		const std::string &	output )

Definition at line 14 of file SortingConnector.cxx.

                                                          :
   Connector(output, {input}, algorithm, {output}, SORT)
{}

~SortingConnector()

SortingConnector::~SortingConnector ( )

virtual

Definition at line 21 of file SortingConnector.cxx.

                                    {
   clearOutput();
}

Member Function Documentation

algorithm() [1/2]

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

inlineprotectedinherited

Definition at line 87 of file Connector.h.

{ return m_algorithm; }

algorithm() [2/2]

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

inlineinherited

Definition at line 50 of file Connector.h.

{  return m_algorithm; }

algorithmName()

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

inlineinherited

Definition at line 45 of file Connector.h.

{  return m_algorithmName; }

attachOutputData()

void SortingConnector::attachOutputData

(

const TOBArray *

data

)

Definition at line 52 of file SortingConnector.cxx.

                                                       {
   if(m_outputData != 0) {
      TCS_EXCEPTION("Trying to attach data to input connector '" << name() << "' which has already data attached");
   }
   m_outputData = data;
}

clearOutput()

TCS::StatusCode TCS::SortingConnector::clearOutput ( )

virtual

Implements TCS::Connector.

Definition at line 27 of file SortingConnector.cxx.

                                 {
   delete m_outputData;
   m_outputData = 0;
   return StatusCode::SUCCESS;
}

executionStatusCode()

StatusCode TCS::Connector::executionStatusCode ( ) const

inlineinherited

Definition at line 61 of file Connector.h.

{ return m_executionStatusCode; }

hasAmbiguity()

bool TCS::Connector::hasAmbiguity ( ) const

inlineinherited

Definition at line 73 of file Connector.h.

{ return m_hasAmbiguity; }

hasInputOverflow()

bool TCS::Connector::hasInputOverflow ( ) const

inlineinherited

Definition at line 70 of file Connector.h.

{ return m_hasInputOverflow; }

inputConnector()

InputConnector * SortingConnector::inputConnector

(

)

const

Definition at line 35 of file SortingConnector.cxx.

                                       {
   return dynamic_cast<InputConnector*>(m_inputConnectors[0]);
}

inputConnectors() [1/2]

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

inlineprotectedinherited

Definition at line 85 of file Connector.h.

{ return m_inputConnectors; }

inputConnectors() [2/2]

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

inlineinherited

Definition at line 49 of file Connector.h.

{ return m_inputConnectors; }

inputName()

std::string TCS::SortingConnector::inputName ( ) const

inline

Definition at line 35 of file SortingConnector.h.

{ return m_inputNames.size()>0 ? m_inputNames[0] : ""; }

inputNames()

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

inlineinherited

Definition at line 46 of file Connector.h.

{ return m_inputNames; }

isCountingConnector()

bool TCS::Connector::isCountingConnector ( ) const

inlineinherited

Definition at line 42 of file Connector.h.

{ return m_conntype == COUNT; }

isDecisionConnector()

bool TCS::Connector::isDecisionConnector ( ) const

inlineinherited

Definition at line 41 of file Connector.h.

{ return m_conntype == DECISION; }

isExecuted()

bool TCS::Connector::isExecuted ( ) const

inlineinherited

Definition at line 59 of file Connector.h.

{ return m_isExecuted; }

isInputConnector()

bool TCS::Connector::isInputConnector ( ) const

inlineinherited

Definition at line 39 of file Connector.h.

{ return m_conntype == INPUT; }

isSortingConnector()

bool TCS::Connector::isSortingConnector ( ) const

inlineinherited

Definition at line 40 of file Connector.h.

{ return m_conntype == SORT; }

name()

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

inlineinherited

Definition at line 44 of file Connector.h.

{ return m_name; }

numberOutputBits()

unsigned int TCS::Connector::numberOutputBits ( ) const

inherited

Definition at line 68 of file Connector.cxx.

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

outputData()

const TOBArray * TCS::SortingConnector::outputData ( ) const

inline

Definition at line 41 of file SortingConnector.h.

{ return m_outputData; }

outputName()

std::string TCS::SortingConnector::outputName ( ) const

inline

Definition at line 37 of file SortingConnector.h.

{ return m_outputNames.size()>0 ? m_outputNames[0] : ""; }

outputNames()

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

inlineinherited

Definition at line 47 of file Connector.h.

{ return m_outputNames; }

reset()

TCS::StatusCode TCS::Connector::reset ( )

inherited

Definition at line 48 of file Connector.cxx.

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

setAlgorithm()

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

virtual

Reimplemented from TCS::Connector.

Definition at line 41 of file SortingConnector.cxx.

                                                      {
   Connector::setAlgorithm(alg);
   m_sortingAlgorithm = dynamic_cast<SortingAlg*>(alg); // set a local copy
   if(m_sortingAlgorithm == nullptr && alg != nullptr) {
      TCS_EXCEPTION("Error: algorithm" << alg->name() << " is not a sorting alg");
   }
}

setExecutionStatusCode()

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

inlineprotectedinherited

Definition at line 83 of file Connector.h.

{ m_executionStatusCode = statusCode; }

setIsExecuted()

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

inlineprotectedinherited

Definition at line 81 of file Connector.h.

{ m_isExecuted = isExecuted; }

sortingAlgorithm()

SortingAlg * TCS::SortingConnector::sortingAlgorithm ( )

inline

Definition at line 45 of file SortingConnector.h.

{  return m_sortingAlgorithm; }

toggleAmbiguity()

void TCS::Connector::toggleAmbiguity ( const bool value )

inherited

Definition at line 81 of file Connector.cxx.

{
    m_hasAmbiguity = value;
}

toggleInputOverflow()

void TCS::Connector::toggleInputOverflow ( const bool value )

inherited

to be toggled after 'attachOutputData' is called.

This flag is reset with reset().

Definition at line 76 of file Connector.cxx.

{
    m_hasInputOverflow = value;
}

Member Data Documentation

m_algorithm

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

protectedinherited

the algorithm that belongs to this connector

Definition at line 102 of file Connector.h.

{ nullptr };

m_algorithmName

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

protectedinherited

Definition at line 93 of file Connector.h.

{""};

m_conntype

ConnectorType TCS::Connector::m_conntype { NONE }

privateinherited

Definition at line 117 of file Connector.h.

{ NONE };

m_executionStatusCode

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

protectedinherited

Definition at line 107 of file Connector.h.

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

m_hasAmbiguity

bool TCS::Connector::m_hasAmbiguity {false}

protectedinherited

Definition at line 113 of file Connector.h.

{false};

m_hasInputOverflow

bool TCS::Connector::m_hasInputOverflow {false}

protectedinherited

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

protectedinherited

Definition at line 98 of file Connector.h.

m_inputNames

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

protectedinherited

Definition at line 94 of file Connector.h.

m_isExecuted

bool TCS::Connector::m_isExecuted {false}

protectedinherited

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 {""}

protectedinherited

Definition at line 92 of file Connector.h.

{""};

m_outputData

TOBArray const* TCS::SortingConnector::m_outputData { nullptr }

private

Definition at line 54 of file SortingConnector.h.

{ nullptr };

m_outputNames

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

protectedinherited

Definition at line 95 of file Connector.h.

m_sortingAlgorithm

SortingAlg* TCS::SortingConnector::m_sortingAlgorithm { nullptr }

private

Definition at line 51 of file SortingConnector.h.

{ nullptr };

---

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

• SortingConnector.h
• SortingConnector.cxx