SCT_CablingTool Class Reference

of online and offline identifiers and also serial numbers More...

#include <SCT_CablingTool.h>

Inheritance diagram for SCT_CablingTool:

Collaboration diagram for SCT_CablingTool:

Public Member Functions
	SCT_CablingTool (const std::string &type, const std::string &name, const IInterface *parent)
virtual	~SCT_CablingTool ()=default
virtual StatusCode	initialize () override
virtual unsigned int	size (const EventContext &ctx) const override
	size of the data structure (for the SCT should be 8176, one for each module side)
virtual unsigned int	size () const override
virtual bool	empty (const EventContext &ctx) const override
	is the data structure empty?
virtual bool	empty () const override
virtual IdentifierHash	getHashFromOnlineId (const SCT_OnlineId &onlineId, const EventContext &ctx, const bool withWarnings=true) const override
	return offline hash, given the online Id (used by decoders)
virtual IdentifierHash	getHashFromOnlineId (const SCT_OnlineId &onlineId, const bool withWarnings=true) const override
virtual SCT_OnlineId	getOnlineIdFromHash (const IdentifierHash &hash, const EventContext &ctx) const override
	return the online Id, given a hash (used by simulation encoders)
virtual SCT_OnlineId	getOnlineIdFromHash (const IdentifierHash &hash) const override
virtual SCT_OnlineId	getOnlineIdFromOfflineId (const Identifier &offlineId, const EventContext &ctx) const override
	return the online Id, given an offlineId
virtual SCT_OnlineId	getOnlineIdFromOfflineId (const Identifier &offlineId) const override
virtual std::uint32_t	getRobIdFromHash (const IdentifierHash &hash, const EventContext &ctx) const override
	return the rob/rod Id, given a hash (used by simulation encoders)
virtual std::uint32_t	getRobIdFromHash (const IdentifierHash &hash) const override
virtual std::uint32_t	getRobIdFromOfflineId (const Identifier &offlineId, const EventContext &ctx) const override
	return the rob/rod Id, given an offlineId (used by simulation encoders)
virtual std::uint32_t	getRobIdFromOfflineId (const Identifier &offlineId) const override
virtual IdentifierHash	getHashFromSerialNumber (const SCT_SerialNumber &sn, const EventContext &ctx) const override
	get hash from a module serial number, needed in the conditions service because configurations are stored by module s/n
virtual IdentifierHash	getHashFromSerialNumber (const SCT_SerialNumber &sn) const override
virtual SCT_SerialNumber	getSerialNumberFromHash (const IdentifierHash &hash, const EventContext &ctx) const override
	get module serial number from hash, needed during filling of data structure
virtual SCT_SerialNumber	getSerialNumberFromHash (const IdentifierHash &hash) const override
virtual void	getAllRods (std::vector< std::uint32_t > &usersVector, const EventContext &ctx) const override
	fill a users vector with all the RodIds
virtual void	getAllRods (std::vector< std::uint32_t > &usersVector) const override
virtual void	getHashesForRod (std::vector< IdentifierHash > &usersVector, const std::uint32_t rodId, const EventContext &ctx) const override
	fill a user's vector with all the hash ids which belong to a given rod
virtual void	getHashesForRod (std::vector< IdentifierHash > &usersVector, const std::uint32_t rodId) const override

Private Member Functions
const SCT_CablingData *	getData (const EventContext &ctx) const

Private Attributes
SG::ReadCondHandleKey< SCT_CablingData >	m_data {this, "SCT_CablingData", "SCT_CablingData", "SCT_CablingData created by SCT_CablingCondAlgFromCoraCool"}
StringProperty	m_cablingDataSource
	the name of the data source
const SCT_ID *	m_idHelper {nullptr}
	helper for offlineId/hash conversions
bool	m_usingDatabase {true}

Detailed Description

of online and offline identifiers and also serial numbers

Definition at line 39 of file SCT_CablingTool.h.

Constructor & Destructor Documentation

SCT_CablingTool()

SCT_CablingTool::SCT_CablingTool	(	const std::string &	type,
		const std::string &	name,
		const IInterface *	parent )

Definition at line 43 of file SCT_CablingTool.cxx.

                                                                                                       :
  base_class(type, name, parent)
{
  declareProperty("DataSource", m_cablingDataSource=defaultSource);
}

~SCT_CablingTool()

virtual SCT_CablingTool::~SCT_CablingTool ( )

virtualdefault

Member Function Documentation

empty() [1/2]

bool SCT_CablingTool::empty ( ) const

overridevirtual

Definition at line 85 of file SCT_CablingTool.cxx.

                             {
  const EventContext& ctx{Gaudi::Hive::currentContext()};
  return empty(ctx);
}

empty() [2/2]

bool SCT_CablingTool::empty ( const EventContext & ctx ) const

overridevirtual

is the data structure empty?

Definition at line 80 of file SCT_CablingTool.cxx.

                                                    {
  return (size(ctx)==0);
}

getAllRods() [1/2]

void SCT_CablingTool::getAllRods ( std::vector< std::uint32_t > & usersVector ) const

overridevirtual

Definition at line 229 of file SCT_CablingTool.cxx.

                                                                     {
  const EventContext& ctx{Gaudi::Hive::currentContext()};
  getAllRods(usersVector, ctx);
}

getAllRods() [2/2]

void SCT_CablingTool::getAllRods ( std::vector< std::uint32_t > & usersVector, const EventContext & ctx ) const

overridevirtual

fill a users vector with all the RodIds

Definition at line 218 of file SCT_CablingTool.cxx.

                                                                                              {
  const SCT_CablingData* data{getData(ctx)};
  if (data==nullptr) {
    ATH_MSG_FATAL("Filling the cabling FAILED");
    return;
  }
 
  data->getRods(usersVector);
}

getData()

const SCT_CablingData * SCT_CablingTool::getData ( const EventContext & ctx ) const

private

Definition at line 253 of file SCT_CablingTool.cxx.

                                                      {
  SG::ReadCondHandle<SCT_CablingData> condData{m_data, ctx};
  return condData.retrieve();
}

getHashesForRod() [1/2]

void SCT_CablingTool::getHashesForRod ( std::vector< IdentifierHash > & usersVector, const std::uint32_t rodId ) const

overridevirtual

Definition at line 247 of file SCT_CablingTool.cxx.

                                                                                                      {
  const EventContext& ctx{Gaudi::Hive::currentContext()};
  getHashesForRod(usersVector, rodId, ctx);
}

getHashesForRod() [2/2]

void SCT_CablingTool::getHashesForRod ( std::vector< IdentifierHash > & usersVector, const std::uint32_t rodId, const EventContext & ctx ) const

overridevirtual

fill a user's vector with all the hash ids which belong to a given rod

Definition at line 235 of file SCT_CablingTool.cxx.

                                                                                                                               {
  SCT_OnlineId firstPossibleId{rodId, SCT_OnlineId::FIRST_FIBRE};
  const bool withWarnings{false};
  for (SCT_OnlineId i{firstPossibleId}; i!=SCT_OnlineId::INVALID_ONLINE_ID; ++i) {
    IdentifierHash thisHash(getHashFromOnlineId(i, ctx, withWarnings));
    if (thisHash != invalidHash) {
      usersVector.push_back(thisHash);
    }
  }
}

getHashFromOnlineId() [1/2]

IdentifierHash SCT_CablingTool::getHashFromOnlineId ( const SCT_OnlineId & onlineId, const bool withWarnings = true ) const

overridevirtual

Definition at line 115 of file SCT_CablingTool.cxx.

                                                                                                {
  const EventContext& ctx{Gaudi::Hive::currentContext()};
  return getHashFromOnlineId(onlineId, ctx, withWarnings);
}

getHashFromOnlineId() [2/2]

IdentifierHash SCT_CablingTool::getHashFromOnlineId ( const SCT_OnlineId & onlineId, const EventContext & ctx, const bool withWarnings = true ) const

overridevirtual

return offline hash, given the online Id (used by decoders)

Definition at line 92 of file SCT_CablingTool.cxx.

                                                                                                                         {
  //is it valid at all?
  if (not onlineId.is_valid()) {
    if (withWarnings) ATH_MSG_WARNING("Invalid online id ("<<std::hex<<onlineId<<") "<<std::dec);
    return invalidHash;
  }
  //is it specifically valid for the given datasource?
  if (not onlineId.is_valid(m_usingDatabase)) {
    const std::string alternative=m_usingDatabase?"text file cabling":"cabling from database";
    if (withWarnings) ATH_MSG_WARNING("Invalid online id ("<<std::hex<<onlineId<<") try using the "<<alternative<<std::dec);
    return invalidHash;
  }
 
  const SCT_CablingData* data{getData(ctx)};
  if (data==nullptr) {
    ATH_MSG_FATAL("Filling the cabling FAILED");
    return invalidHash;
  }
 
  return data->getHashFromOnlineId(onlineId);
}

getHashFromSerialNumber() [1/2]

IdentifierHash SCT_CablingTool::getHashFromSerialNumber ( const SCT_SerialNumber & sn ) const

overridevirtual

Definition at line 191 of file SCT_CablingTool.cxx.

                                                                         {
  const EventContext& ctx{Gaudi::Hive::currentContext()};
  return getHashFromSerialNumber(sn, ctx);
}

getHashFromSerialNumber() [2/2]

IdentifierHash SCT_CablingTool::getHashFromSerialNumber ( const SCT_SerialNumber & sn, const EventContext & ctx ) const

overridevirtual

get hash from a module serial number, needed in the conditions service because configurations are stored by module s/n

Definition at line 178 of file SCT_CablingTool.cxx.

                                                                                                  {
  if (not sn.isWellFormed()) return invalidHash;
 
  const SCT_CablingData* data{getData(ctx)};
  if (data==nullptr) {
    ATH_MSG_FATAL("Filling the cabling FAILED");
    return invalidHash;
  }
 
  return data->getHashFromSerialNumber(sn);
}

getOnlineIdFromHash() [1/2]

SCT_OnlineId SCT_CablingTool::getOnlineIdFromHash ( const IdentifierHash & hash ) const

overridevirtual

Definition at line 133 of file SCT_CablingTool.cxx.

                                                                     {
  const EventContext& ctx{Gaudi::Hive::currentContext()};
  return getOnlineIdFromHash(hash, ctx);
}

getOnlineIdFromHash() [2/2]

SCT_OnlineId SCT_CablingTool::getOnlineIdFromHash ( const IdentifierHash & hash, const EventContext & ctx ) const

overridevirtual

return the online Id, given a hash (used by simulation encoders)

Definition at line 122 of file SCT_CablingTool.cxx.

                                                                                              {
  const SCT_CablingData* data{getData(ctx)};
  if (data==nullptr) {
    ATH_MSG_FATAL("Filling the cabling FAILED");
    return invalidId;
  }
  
  return data->getOnlineIdFromHash(hash);
}

getOnlineIdFromOfflineId() [1/2]

SCT_OnlineId SCT_CablingTool::getOnlineIdFromOfflineId ( const Identifier & offlineId ) const

overridevirtual

Definition at line 147 of file SCT_CablingTool.cxx.

                                                                           {
  const EventContext& ctx{Gaudi::Hive::currentContext()};
  return getOnlineIdFromOfflineId(offlineId, ctx);
}

getOnlineIdFromOfflineId() [2/2]

SCT_OnlineId SCT_CablingTool::getOnlineIdFromOfflineId ( const Identifier & offlineId, const EventContext & ctx ) const

overridevirtual

return the online Id, given an offlineId

Definition at line 140 of file SCT_CablingTool.cxx.

                                                                                                    {
  if (not offlineId.is_valid()) return invalidId;
  IdentifierHash hash(m_idHelper->wafer_hash(offlineId));
  return getOnlineIdFromHash(hash, ctx);
}

getRobIdFromHash() [1/2]

std::uint32_t SCT_CablingTool::getRobIdFromHash ( const IdentifierHash & hash ) const

overridevirtual

Definition at line 159 of file SCT_CablingTool.cxx.

                                                                  {
  const EventContext& ctx{Gaudi::Hive::currentContext()};
  return getRobIdFromHash(hash, ctx);
}

getRobIdFromHash() [2/2]

std::uint32_t SCT_CablingTool::getRobIdFromHash ( const IdentifierHash & hash, const EventContext & ctx ) const

overridevirtual

return the rob/rod Id, given a hash (used by simulation encoders)

Definition at line 154 of file SCT_CablingTool.cxx.

                                                                                           {
  return getOnlineIdFromHash(hash, ctx).rod();
}

getRobIdFromOfflineId() [1/2]

std::uint32_t SCT_CablingTool::getRobIdFromOfflineId ( const Identifier & offlineId ) const

overridevirtual

Definition at line 171 of file SCT_CablingTool.cxx.

                                                                        {
  const EventContext& ctx{Gaudi::Hive::currentContext()};
  return getRobIdFromOfflineId(offlineId, ctx);
}

getRobIdFromOfflineId() [2/2]

std::uint32_t SCT_CablingTool::getRobIdFromOfflineId ( const Identifier & offlineId, const EventContext & ctx ) const

overridevirtual

return the rob/rod Id, given an offlineId (used by simulation encoders)

Definition at line 166 of file SCT_CablingTool.cxx.

                                                                                                 {
  return getOnlineIdFromOfflineId(offlineId, ctx).rod();
}

getSerialNumberFromHash() [1/2]

SCT_SerialNumber SCT_CablingTool::getSerialNumberFromHash ( const IdentifierHash & hash ) const

overridevirtual

Definition at line 212 of file SCT_CablingTool.cxx.

                                                                         {
  const EventContext& ctx{Gaudi::Hive::currentContext()};
  return getSerialNumberFromHash(hash, ctx);
}

getSerialNumberFromHash() [2/2]

SCT_SerialNumber SCT_CablingTool::getSerialNumberFromHash ( const IdentifierHash & hash, const EventContext & ctx ) const

overridevirtual

get module serial number from hash, needed during filling of data structure

Definition at line 197 of file SCT_CablingTool.cxx.

                                                                                                  {
  if (not hash.is_valid()) return invalidSn;
  //hash must be even
  IdentifierHash evenHash{even(hash)};
  
  const SCT_CablingData* data{getData(ctx)};
  if (data==nullptr) {
    ATH_MSG_FATAL("Filling the cabling FAILED");
    return invalidSn;
  }
 
  return data->getSerialNumberFromHash(evenHash);
}

initialize()

StatusCode SCT_CablingTool::initialize ( )

overridevirtual

Definition at line 51 of file SCT_CablingTool.cxx.

                            {
  ATH_MSG_DEBUG("Initialize SCT cabling");
  const std::string cablingDataSource = m_cablingDataSource.value();
  m_usingDatabase=(cablingDataSource == coracool) or (cablingDataSource == coolVectorPayload) or (cablingDataSource == file);
  ATH_CHECK(detStore()->retrieve(m_idHelper, "SCT_ID"));
  ATH_CHECK(m_data.initialize());
  return StatusCode::SUCCESS;
}

size() [1/2]

unsigned int SCT_CablingTool::size ( ) const

overridevirtual

Definition at line 73 of file SCT_CablingTool.cxx.

                            {
  const EventContext& ctx{Gaudi::Hive::currentContext()};
  return size(ctx);
}

size() [2/2]

unsigned int SCT_CablingTool::size ( const EventContext & ctx ) const

overridevirtual

size of the data structure (for the SCT should be 8176, one for each module side)

Definition at line 62 of file SCT_CablingTool.cxx.

                                                   {
  const SCT_CablingData* data{getData(ctx)};
  if (data==nullptr) {
    ATH_MSG_FATAL("Filling the cabling FAILED");
    return 0;
  }
 
  return data->getHashEntries();
}

Member Data Documentation

m_cablingDataSource

StringProperty SCT_CablingTool::m_cablingDataSource

private

the name of the data source

Definition at line 98 of file SCT_CablingTool.h.

m_data

SG::ReadCondHandleKey<SCT_CablingData> SCT_CablingTool::m_data {this, "SCT_CablingData", "SCT_CablingData", "SCT_CablingData created by SCT_CablingCondAlgFromCoraCool"}

private

Definition at line 97 of file SCT_CablingTool.h.

{this, "SCT_CablingData", "SCT_CablingData", "SCT_CablingData created by SCT_CablingCondAlgFromCoraCool"};

m_idHelper

const SCT_ID* SCT_CablingTool::m_idHelper {nullptr}

private

helper for offlineId/hash conversions

Definition at line 99 of file SCT_CablingTool.h.

{nullptr}; 

m_usingDatabase

bool SCT_CablingTool::m_usingDatabase {true}

private

Definition at line 100 of file SCT_CablingTool.h.

{true};

---

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

• SCT_CablingTool.h
• SCT_CablingTool.cxx