#include <SCT_ReadoutTestAlg.h>

Inheritance diagram for SCT_ReadoutTestAlg:

Collaboration diagram for SCT_ReadoutTestAlg:

Public Member Functions
	SCT_ReadoutTestAlg (const std::string &name, ISvcLocator *pSvcLocator)
virtual	~SCT_ReadoutTestAlg ()=default
virtual StatusCode	initialize () override
	Usual framework methods for an Algorithm.
virtual StatusCode	execute () override
virtual StatusCode	finalize () override
virtual StatusCode	sysInitialize () override
	Override sysInitialize.
virtual const DataObjIDColl &	extraOutputDeps () const override
	Return the list of extra output dependencies.
ServiceHandle< StoreGateSvc > &	evtStore ()
	The standard `StoreGateSvc` (event store) Returns (kind of) a pointer to the `StoreGateSvc`.
const ServiceHandle< StoreGateSvc > &	detStore () const
	The standard `StoreGateSvc/DetectorStore` Returns (kind of) a pointer to the `StoreGateSvc`.
virtual StatusCode	sysStart () override
	Handle START transition.
virtual std::vector< Gaudi::DataHandle * >	inputHandles () const override
	Return this algorithm's input handles.
virtual std::vector< Gaudi::DataHandle * >	outputHandles () const override
	Return this algorithm's output handles.
Gaudi::Details::PropertyBase &	declareProperty (Gaudi::Property< T, V, H > &t)
void	updateVHKA (Gaudi::Details::PropertyBase &)
MsgStream &	msg () const
bool	msgLvl (const MSG::Level lvl) const

Protected Member Functions
void	renounceArray (SG::VarHandleKeyArray &handlesArray)
	remove all handles from I/O resolution
std::enable_if_t< std::is_void_v< std::result_of_t< decltype(&T::renounce)(T)> > &&!std::is_base_of_v< SG::VarHandleKeyArray, T > &&std::is_base_of_v< Gaudi::DataHandle, T >, void >	renounce (T &h)
void	extraDeps_update_handler (Gaudi::Details::PropertyBase &ExtraDeps)
	Add StoreName to extra input/output deps as needed.

Private Types
typedef ServiceHandle< StoreGateSvc >	StoreGateSvc_t

Private Member Functions
short	bin2dec (const char *bin)
	Function to convert the configuration string into an int.
SCT_Chip	initialiseChip (short id, std::string configString)
	Initialise a chip given its id and configuration string.
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T, V, H > &hndl, const SG::VarHandleKeyType &)
	specialization for handling Gaudi::Property<SG::VarHandleKey>

Private Attributes
ToolHandle< ISCT_ReadoutTool >	m_readout {this, "SCT_ReadoutTool", "SCT_ReadoutTool", "Handle to the SCT_ReadoutTool"}
	List of chips for that module.
std::vector< SCT_Chip >	m_chips
StringArrayProperty	m_chipConfigs {this, "ChipConfigurationList", {}, "The configuration of the chips in that module (from job options)"}
IntegerProperty	m_moduleId {this, "ModuleId", 168497152, "The Module identifier (from job options)"}
BooleanProperty	m_link0ok {this, "Link0Status", true, "Status of link 0 (from job options)"}
BooleanProperty	m_link1ok {this, "Link1Status", true, "Status of link 1 (from job options)"}
DataObjIDColl	m_extendedExtraObjects
StoreGateSvc_t	m_evtStore
	Pointer to StoreGate (event store by default)
StoreGateSvc_t	m_detStore
	Pointer to StoreGate (detector store by default)
std::vector< SG::VarHandleKeyArray * >	m_vhka
bool	m_varHandleArraysDeclared

Detailed Description

Definition at line 37 of file SCT_ReadoutTestAlg.h.

Member Typedef Documentation

◆ StoreGateSvc_t

typedef ServiceHandle<StoreGateSvc> AthCommonDataStore< AthCommonMsg< Algorithm > >::StoreGateSvc_t

privateinherited

Definition at line 388 of file AthCommonDataStore.h.

Constructor & Destructor Documentation

◆ SCT_ReadoutTestAlg()

SCT_ReadoutTestAlg::SCT_ReadoutTestAlg	(	const std::string &	name,
		ISvcLocator *	pSvcLocator )

Definition at line 20 of file SCT_ReadoutTestAlg.cxx.

                                                                                      : 
  AthAlgorithm(name, pSvcLocator)
{
}

◆ ~SCT_ReadoutTestAlg()

virtual SCT_ReadoutTestAlg::~SCT_ReadoutTestAlg ( )

virtualdefault

Member Function Documentation

◆ bin2dec()

short SCT_ReadoutTestAlg::bin2dec ( const char * bin )

private

Function to convert the configuration string into an int.

Definition at line 70 of file SCT_ReadoutTestAlg.cxx.

{
  short b, k, m, n;
  short len;
  short sum{0};
  
  len = strlen(bin) - 1;
  for (k = 0; k <= len; k++) {
    n = (bin[k] - '0'); // char to numeric value
    if ((n > 1) or (n < 0)) {
      ATH_MSG_ERROR("ERROR! BINARY has only 1 and 0!");
      return 0;
    }
      
    for (b = 1, m = len; m > k; m--) {
      // 1 2 4 8 16 32 64 ... place-values, reversed here
      b *= 2;
    }
 
    // sum it up
    sum = sum + n * b;
  }
  return sum;
}

◆ declareGaudiProperty()

Gaudi::Details::PropertyBase & AthCommonDataStore< AthCommonMsg< Algorithm > >::declareGaudiProperty	(	Gaudi::Property< T, V, H > &	hndl,
		const SG::VarHandleKeyType &	)

inlineprivateinherited

specialization for handling Gaudi::Property<SG::VarHandleKey>

Definition at line 156 of file AthCommonDataStore.h.

  {
    return *AthCommonDataStore<PBASE>::declareProperty(hndl.name(),
                                                       hndl.value(), 
                                                       hndl.documentation());
 
  }

◆ declareProperty()

Gaudi::Details::PropertyBase & AthCommonDataStore< AthCommonMsg< Algorithm > >::declareProperty ( Gaudi::Property< T, V, H > & t )

inlineinherited

Definition at line 145 of file AthCommonDataStore.h.

                                                                     {
    typedef typename SG::HandleClassifier<T>::type htype;
    return AthCommonDataStore<PBASE>::declareGaudiProperty(t, htype());
  }

◆ detStore()

const ServiceHandle< StoreGateSvc > & AthCommonDataStore< AthCommonMsg< Algorithm > >::detStore ( ) const

inlineinherited

The standard StoreGateSvc/DetectorStore Returns (kind of) a pointer to the StoreGateSvc.

Definition at line 95 of file AthCommonDataStore.h.

95{ return m_detStore; }

AthCommonDataStore< AthCommonMsg< Algorithm > >::m_detStore

StoreGateSvc_t m_detStore

Definition AthCommonDataStore.h:393

◆ evtStore()

ServiceHandle< StoreGateSvc > & AthCommonDataStore< AthCommonMsg< Algorithm > >::evtStore ( )

inlineinherited

The standard StoreGateSvc (event store) Returns (kind of) a pointer to the StoreGateSvc.

Definition at line 85 of file AthCommonDataStore.h.

85{ return m_evtStore; }

AthCommonDataStore< AthCommonMsg< Algorithm > >::m_evtStore

StoreGateSvc_t m_evtStore

Definition AthCommonDataStore.h:390

◆ execute()

StatusCode SCT_ReadoutTestAlg::execute ( )

overridevirtual

Definition at line 44 of file SCT_ReadoutTestAlg.cxx.

                                       {
  //This method is only used to test the readout tool, and only used within this package,
  // so the INFO level messages have no impact on performance of the tool when used by clients
 
  ATH_MSG_INFO("Calling execute");
 
  ATH_MSG_INFO( "Chips before readout ..." );
  for (const SCT_Chip& chip: m_chips) ATH_MSG_INFO(chip);
 
  // Determin readout for this module
  ATH_CHECK(m_readout->determineReadout(Identifier{m_moduleId}, m_chips, m_link0ok, m_link1ok));
  
  ATH_MSG_INFO("Chips after readout ...");
  for (const SCT_Chip& chip: m_chips) ATH_MSG_INFO(chip);
 
  return StatusCode::SUCCESS;
}

◆ extraDeps_update_handler()

void AthCommonDataStore< AthCommonMsg< Algorithm > >::extraDeps_update_handler ( Gaudi::Details::PropertyBase & ExtraDeps )

protectedinherited

Add StoreName to extra input/output deps as needed.

use the logic of the VarHandleKey to parse the DataObjID keys supplied via the ExtraInputs and ExtraOuputs Properties to add the StoreName if it's not explicitly given

◆ extraOutputDeps()

const DataObjIDColl & AthAlgorithm::extraOutputDeps ( ) const

overridevirtualinherited

Return the list of extra output dependencies.

This list is extended to include symlinks implied by inheritance relations.

Definition at line 50 of file AthAlgorithm.cxx.

{
  // If we didn't find any symlinks to add, just return the collection
  // from the base class.  Otherwise, return the extended collection.
  if (!m_extendedExtraObjects.empty()) {
    return m_extendedExtraObjects;
  }
  return Algorithm::extraOutputDeps();
}

◆ finalize()

StatusCode SCT_ReadoutTestAlg::finalize ( )

overridevirtual

Definition at line 63 of file SCT_ReadoutTestAlg.cxx.

                                        {
  ATH_MSG_INFO("Calling finalize");
 
  return StatusCode::SUCCESS;
}

◆ initialiseChip()

SCT_Chip SCT_ReadoutTestAlg::initialiseChip	(	short	id,
		std::string	configString )

private

Initialise a chip given its id and configuration string.

Definition at line 96 of file SCT_ReadoutTestAlg.cxx.

                                                                            {
  // Opposite convention for LSB
  std::reverse(configString.begin(), configString.end());
  short config{bin2dec(configString.c_str())};
  const int minus1{-1};
  return {id, config, static_cast<uint32_t>(minus1), static_cast<uint32_t>(minus1), static_cast<uint32_t>(minus1), static_cast<uint32_t>(minus1)};
}

◆ initialize()

StatusCode SCT_ReadoutTestAlg::initialize ( )

overridevirtual

Usual framework methods for an Algorithm.

Definition at line 26 of file SCT_ReadoutTestAlg.cxx.

                                          {  
  ATH_MSG_INFO("Calling initialize");
 
  // Retrieve readout tool
  ATH_CHECK(m_readout.retrieve());
 
  // Initalise chips configured in job options and add to vector
  std::vector<std::string>::const_iterator itr{m_chipConfigs.begin()};
  std::vector<std::string>::const_iterator end{m_chipConfigs.end()};
 
  for (short ichip{0}; itr != end; ++itr, ++ichip) {
    m_chips.push_back(initialiseChip(ichip, *itr));
  } 
 
  return StatusCode::SUCCESS;
}

◆ inputHandles()

virtual std::vector< Gaudi::DataHandle * > AthCommonDataStore< AthCommonMsg< Algorithm > >::inputHandles ( ) const

overridevirtualinherited

Return this algorithm's input handles.

We override this to include handle instances from key arrays if they have not yet been declared. See comments on updateVHKA.

◆ msg()

MsgStream & AthCommonMsg< Algorithm >::msg ( ) const

inlineinherited

Definition at line 24 of file AthCommonMsg.h.

                                {
    return this->msgStream();
  }

◆ msgLvl()

bool AthCommonMsg< Algorithm >::msgLvl ( const MSG::Level lvl ) const

inlineinherited

Definition at line 30 of file AthCommonMsg.h.

                                               {
    return this->msgLevel(lvl);
  }

◆ outputHandles()

virtual std::vector< Gaudi::DataHandle * > AthCommonDataStore< AthCommonMsg< Algorithm > >::outputHandles ( ) const

overridevirtualinherited

Return this algorithm's output handles.

We override this to include handle instances from key arrays if they have not yet been declared. See comments on updateVHKA.

◆ renounce()

std::enable_if_t< std::is_void_v< std::result_of_t< decltype(&T::renounce)(T)> > &&!std::is_base_of_v< SG::VarHandleKeyArray, T > &&std::is_base_of_v< Gaudi::DataHandle, T >, void > AthCommonDataStore< AthCommonMsg< Algorithm > >::renounce ( T & h )

inlineprotectedinherited

Definition at line 380 of file AthCommonDataStore.h.

  {
    h.renounce();
    PBASE::renounce (h);
  }

◆ renounceArray()

void AthCommonDataStore< AthCommonMsg< Algorithm > >::renounceArray ( SG::VarHandleKeyArray & handlesArray )

inlineprotectedinherited

remove all handles from I/O resolution

Definition at line 364 of file AthCommonDataStore.h.

                                                          {
    handlesArray.renounce();
  }

◆ sysInitialize()

StatusCode AthAlgorithm::sysInitialize ( )

overridevirtualinherited

Override sysInitialize.

Override sysInitialize from the base class.

Loop through all output handles, and if they're WriteCondHandles, automatically register them and this Algorithm with the CondSvc

Scan through all outputHandles, and if they're WriteCondHandles, register them with the CondSvc

Reimplemented from AthCommonDataStore< AthCommonMsg< Algorithm > >.

Reimplemented in AthAnalysisAlgorithm, AthFilterAlgorithm, AthHistogramAlgorithm, and PyAthena::Alg.

Definition at line 66 of file AthAlgorithm.cxx.

                                       {
  StatusCode sc=AthCommonDataStore<AthCommonMsg<Algorithm>>::sysInitialize();
 
  if (sc.isFailure()) {
    return sc;
  }
  ServiceHandle<ICondSvc> cs("CondSvc",name());
  for (auto h : outputHandles()) {
    if (h->isCondition() && h->mode() == Gaudi::DataHandle::Writer) {
      // do this inside the loop so we don't create the CondSvc until needed
      if ( cs.retrieve().isFailure() ) {
        ATH_MSG_WARNING("no CondSvc found: won't autoreg WriteCondHandles");
        return StatusCode::SUCCESS;
      }
      if (cs->regHandle(this,*h).isFailure()) {
        sc = StatusCode::FAILURE;
        ATH_MSG_ERROR("unable to register WriteCondHandle " << h->fullKey()
                      << " with CondSvc");
      }
    }
  }
  return sc;
}

◆ sysStart()

virtual StatusCode AthCommonDataStore< AthCommonMsg< Algorithm > >::sysStart ( )

overridevirtualinherited

Handle START transition.

We override this in order to make sure that conditions handle keys can cache a pointer to the conditions container.

◆ updateVHKA()

void AthCommonDataStore< AthCommonMsg< Algorithm > >::updateVHKA ( Gaudi::Details::PropertyBase & )

inlineinherited

Definition at line 308 of file AthCommonDataStore.h.

                                               {
    // debug() << "updateVHKA for property " << p.name() << " " << p.toString() 
    //         << "  size: " << m_vhka.size() << endmsg;
    for (auto &a : m_vhka) {
      std::vector<SG::VarHandleKey*> keys = a->keys();
      for (auto k : keys) {
        k->setOwner(this);
      }
    }
  }

Member Data Documentation

◆ m_chipConfigs

StringArrayProperty SCT_ReadoutTestAlg::m_chipConfigs {this, "ChipConfigurationList", {}, "The configuration of the chips in that module (from job options)"}

private

Definition at line 53 of file SCT_ReadoutTestAlg.h.

53{this, "ChipConfigurationList", {}, "The configuration of the chips in that module (from job options)"};

◆ m_chips

std::vector<SCT_Chip> SCT_ReadoutTestAlg::m_chips

private

Definition at line 51 of file SCT_ReadoutTestAlg.h.

◆ m_detStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< Algorithm > >::m_detStore

privateinherited

Pointer to StoreGate (detector store by default)

Definition at line 393 of file AthCommonDataStore.h.

◆ m_evtStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< Algorithm > >::m_evtStore

privateinherited

Pointer to StoreGate (event store by default)

Definition at line 390 of file AthCommonDataStore.h.

◆ m_extendedExtraObjects

DataObjIDColl AthAlgorithm::m_extendedExtraObjects

privateinherited

Definition at line 79 of file AthAlgorithm.h.

◆ m_link0ok

BooleanProperty SCT_ReadoutTestAlg::m_link0ok {this, "Link0Status", true, "Status of link 0 (from job options)"}

private

Definition at line 55 of file SCT_ReadoutTestAlg.h.

55{this, "Link0Status", true, "Status of link 0 (from job options)"};

◆ m_link1ok

BooleanProperty SCT_ReadoutTestAlg::m_link1ok {this, "Link1Status", true, "Status of link 1 (from job options)"}

private

Definition at line 56 of file SCT_ReadoutTestAlg.h.

56{this, "Link1Status", true, "Status of link 1 (from job options)"};

◆ m_moduleId

IntegerProperty SCT_ReadoutTestAlg::m_moduleId {this, "ModuleId", 168497152, "The Module identifier (from job options)"}

private

Definition at line 54 of file SCT_ReadoutTestAlg.h.

54{this, "ModuleId", 168497152, "The Module identifier (from job options)"};

◆ m_readout

ToolHandle<ISCT_ReadoutTool> SCT_ReadoutTestAlg::m_readout {this, "SCT_ReadoutTool", "SCT_ReadoutTool", "Handle to the SCT_ReadoutTool"}

private

List of chips for that module.

Modified in execute This should be OK because this is a test alg.

Definition at line 48 of file SCT_ReadoutTestAlg.h.

48{this, "SCT_ReadoutTool", "SCT_ReadoutTool", "Handle to the SCT_ReadoutTool"};

◆ m_varHandleArraysDeclared

bool AthCommonDataStore< AthCommonMsg< Algorithm > >::m_varHandleArraysDeclared

privateinherited

Definition at line 399 of file AthCommonDataStore.h.

◆ m_vhka

std::vector<SG::VarHandleKeyArray*> AthCommonDataStore< AthCommonMsg< Algorithm > >::m_vhka

privateinherited

Definition at line 398 of file AthCommonDataStore.h.

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

Public Member Functions

Protected Member Functions

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ StoreGateSvc_t

Constructor & Destructor Documentation

◆ SCT_ReadoutTestAlg()

◆ ~SCT_ReadoutTestAlg()

Member Function Documentation

◆ bin2dec()

◆ declareGaudiProperty()

◆ declareProperty()

◆ detStore()

◆ evtStore()

◆ execute()

◆ extraDeps_update_handler()

◆ extraOutputDeps()

◆ finalize()

◆ initialiseChip()

◆ initialize()

◆ inputHandles()

◆ msg()

◆ msgLvl()

◆ outputHandles()

◆ renounce()

◆ renounceArray()

◆ sysInitialize()

◆ sysStart()

◆ updateVHKA()

Member Data Documentation

◆ m_chipConfigs

◆ m_chips

◆ m_detStore

◆ m_evtStore

◆ m_extendedExtraObjects

◆ m_link0ok

◆ m_link1ok

◆ m_moduleId

◆ m_readout

◆ m_varHandleArraysDeclared

◆ m_vhka