TCS::CountingConnector Class Reference

#include <CountingConnector.h>

Inheritance diagram for TCS::CountingConnector:

Collaboration diagram for TCS::CountingConnector:

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

Public Member Functions
	CountingConnector (const std::string &name, const std::string &input, const std::string &algorithm, const std::string &output)
virtual	~CountingConnector ()
InputConnector *	inputConnector () const
virtual bool	isCountingConnector () const
TCS::CountingAlg *	countingAlgorithm ()
const TCS::CountingAlg *	countingAlgorithm () const
virtual StatusCode	clearOutput ()
const Count &	count () const
const std::vector< TrigConf::TriggerLine > &	triggers () const
void	attachOutputData (const std::vector< TOBArray * > &)
TOBArray const *	output (const std::string &trigger) const
const std::vector< TOBArray const * > &	outputData () const
bool	isInputConnector () const
bool	isSortingConnector () const
bool	isDecisionConnector () 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. More...
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 More...
bool	m_isExecuted {false}
StatusCode	m_executionStatusCode {StatusCode::SUCCESS}
bool	m_hasInputOverflow
	whether the input data came with an overflow bit More...
bool	m_hasAmbiguity

Private Member Functions
void	setAlgorithm (TCS::ConfigurableAlg *alg)
void	setFirstOutputBit (unsigned int firstOutputBit)

Private Attributes
Count	m_count
TCS::CountingAlg *	m_countingAlgorithm
std::vector< TrigConf::TriggerLine >	m_triggers
std::vector< TOBArray const * >	m_outputData
ConnectorType	m_conntype { NONE }

Friends
class	TopoSteering
class	TopoSteeringStructure

Detailed Description

Definition at line 26 of file CountingConnector.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

CountingConnector()

CountingConnector::CountingConnector	(	const std::string &	name,
		const std::string &	input,
		const std::string &	algorithm,
		const std::string &	output
	)

Definition at line 17 of file CountingConnector.cxx.

                                            : 
   Connector(name, {input}, algorithm, {output}, COUNT),
   m_countingAlgorithm(0)
{}

~CountingConnector()

CountingConnector::~CountingConnector ( )

virtual

Definition at line 25 of file CountingConnector.cxx.

                                      {
   CountingConnector::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 CountingConnector::attachOutputData

(

const std::vector< TOBArray * > &

data

)

Definition at line 75 of file CountingConnector.cxx.

                                                                     {
   if(m_outputData.size() != 0) {
      TCS_EXCEPTION("Trying to attach data to multiplicity connector '" << name() <<"' which has already data attached");
   }
 
   for(TOBArray * x : data)
      m_outputData.push_back( dynamic_cast<const TOBArray*>(x) );
}

clearOutput()

TCS::StatusCode TCS::CountingConnector::clearOutput ( )

virtual

Implements TCS::Connector.

Definition at line 47 of file CountingConnector.cxx.

                                  { 
   for(TOBArray const * x : m_outputData) {
      delete x;
   }
   m_outputData.clear();
 
   // set counting to 0
   m_count.reset();
 
   return StatusCode::SUCCESS;
}

count()

const Count& TCS::CountingConnector::count ( ) const

inline

Definition at line 45 of file CountingConnector.h.

{ return m_count; }

countingAlgorithm() [1/2]

TCS::CountingAlg* TCS::CountingConnector::countingAlgorithm ( )

inline

Definition at line 40 of file CountingConnector.h.

{ return m_countingAlgorithm; }

countingAlgorithm() [2/2]

const TCS::CountingAlg* TCS::CountingConnector::countingAlgorithm ( ) const

inline

Definition at line 41 of file CountingConnector.h.

{ return m_countingAlgorithm; }

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 * CountingConnector::inputConnector

(

)

const

Definition at line 60 of file CountingConnector.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; }

inputNames()

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

inlineinherited

Definition at line 46 of file Connector.h.

{ return m_inputNames; }

isCountingConnector()

virtual bool TCS::CountingConnector::isCountingConnector ( ) const

inlinevirtual

Definition at line 38 of file CountingConnector.h.

{  return true; }

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 ((DecisionAlg*) algorithm())->numberOutputBits();
   } else {
      return 0;
   }
}

output()

TCS::TOBArray const * TCS::CountingConnector::output

(

const std::string &

trigger

)

const

Definition at line 34 of file CountingConnector.cxx.

                                                            {
   unsigned int index(0);
   for(const TrigConf::TriggerLine & tl : m_triggers) {
      if(tl.name() == trigger)
     return m_outputData[index];
      ++index;
   }
   TCS_EXCEPTION("Counting connector '" << name() << "' has no output trigger '" << trigger << "'");
   return nullptr;
}

outputData()

const std::vector<TOBArray const *>& TCS::CountingConnector::outputData ( ) const

inline

Definition at line 54 of file CountingConnector.h.

{ return m_outputData; }

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 CountingConnector::setAlgorithm ( TCS::ConfigurableAlg *  alg )

privatevirtual

Reimplemented from TCS::Connector.

Definition at line 65 of file CountingConnector.cxx.

                                                       {
   Connector::setAlgorithm(alg);
   m_countingAlgorithm = dynamic_cast<CountingAlg*>(alg);
   if(m_countingAlgorithm == nullptr && alg != nullptr) {
      TCS_EXCEPTION("Error: algorithm " << alg->name() << " is not a CountingAlg");
   }
}

setExecutionStatusCode()

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

inlineprotectedinherited

Definition at line 83 of file Connector.h.

{ m_executionStatusCode = statusCode; }

setFirstOutputBit()

void CountingConnector::setFirstOutputBit ( unsigned int  firstOutputBit )

private

Definition at line 86 of file CountingConnector.cxx.

                                                                {
   m_count.setFirstBit(firstOutputBit);
}

setIsExecuted()

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

inlineprotectedinherited

Definition at line 81 of file Connector.h.

{ m_isExecuted = isExecuted; }

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;
}

triggers()

const std::vector<TrigConf::TriggerLine>& TCS::CountingConnector::triggers ( ) const

inline

Definition at line 47 of file CountingConnector.h.

{ return m_triggers; }

Friends And Related Function Documentation

TopoSteering

friend class TopoSteering

friend

Definition at line 58 of file CountingConnector.h.

TopoSteeringStructure

friend class TopoSteeringStructure

friend

Definition at line 59 of file CountingConnector.h.

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.

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.

m_count

Count TCS::CountingConnector::m_count

private

Definition at line 68 of file CountingConnector.h.

m_countingAlgorithm

TCS::CountingAlg* TCS::CountingConnector::m_countingAlgorithm

private

Definition at line 70 of file CountingConnector.h.

m_executionStatusCode

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

protectedinherited

Definition at line 107 of file Connector.h.

m_hasAmbiguity

bool TCS::Connector::m_hasAmbiguity

protectedinherited

Definition at line 113 of file Connector.h.

m_hasInputOverflow

bool TCS::Connector::m_hasInputOverflow

protectedinherited

whether the input data came with an overflow bit

Definition at line 111 of file Connector.h.

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.

m_name

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

protectedinherited

Definition at line 92 of file Connector.h.

m_outputData

std::vector<TOBArray const *> TCS::CountingConnector::m_outputData

private

Definition at line 75 of file CountingConnector.h.

m_outputNames

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

protectedinherited

Definition at line 95 of file Connector.h.

m_triggers

std::vector<TrigConf::TriggerLine> TCS::CountingConnector::m_triggers

private

Definition at line 72 of file CountingConnector.h.

---

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

• CountingConnector.h
• CountingConnector.cxx