ISCT_CablingTool Class Reference

#include <ISCT_CablingTool.h>

Inheritance diagram for ISCT_CablingTool:

Collaboration diagram for ISCT_CablingTool:

Public Member Functions
virtual	~ISCT_CablingTool ()=default
	no-op destructor More...
	DeclareInterfaceID (ISCT_CablingTool, 1, 0)
	Creates the InterfaceID and interfaceID() method. More...
virtual IdentifierHash	getHashFromOnlineId (const SCT_OnlineId &onlineId, const bool withWarnings=true) const =0
	return offline hash, given the online Id (used by decoders) More...
virtual IdentifierHash	getHashFromOnlineId (const SCT_OnlineId &onlineId, const EventContext &ctx, const bool withWarnings=true) const =0
virtual SCT_OnlineId	getOnlineIdFromHash (const IdentifierHash &hash) const =0
	return the online Id, given a hash (used by simulation encoders) More...
virtual SCT_OnlineId	getOnlineIdFromHash (const IdentifierHash &hash, const EventContext &ctx) const =0
virtual std::uint32_t	getRobIdFromHash (const IdentifierHash &hash) const =0
	return the rob/rod Id, given a hash (used by simulation encoders) More...
virtual std::uint32_t	getRobIdFromHash (const IdentifierHash &hash, const EventContext &ctx) const =0
virtual SCT_OnlineId	getOnlineIdFromOfflineId (const Identifier &offlineId) const =0
	return the online Id, given an offlineId More...
virtual SCT_OnlineId	getOnlineIdFromOfflineId (const Identifier &offlineId, const EventContext &ctx) const =0
virtual std::uint32_t	getRobIdFromOfflineId (const Identifier &offlineId) const =0
	return the rob/rod Id, given an offlineId (used by simulation encoders) More...
virtual std::uint32_t	getRobIdFromOfflineId (const Identifier &offlineId, const EventContext &ctx) const =0
virtual unsigned int	size () const =0
	size of the data structure (for the SCT should be 8176, one for each module side) More...
virtual unsigned int	size (const EventContext &ctx) const =0
virtual bool	empty () const =0
	is the data structure empty? More...
virtual bool	empty (const EventContext &ctx) const =0
virtual IdentifierHash	getHashFromSerialNumber (const SCT_SerialNumber &sn) const =0
	get hash from a module serial number, needed in the conditions tool because configurations are stored by module s/n More...
virtual IdentifierHash	getHashFromSerialNumber (const SCT_SerialNumber &sn, const EventContext &ctx) const =0
virtual SCT_SerialNumber	getSerialNumberFromHash (const IdentifierHash &hash) const =0
	get module serial number from hash, needed during filling of data structure More...
virtual SCT_SerialNumber	getSerialNumberFromHash (const IdentifierHash &hash, const EventContext &ctx) const =0
virtual void	getAllRods (std::vector< std::uint32_t > &usersVector) const =0
	fill a users vector with all the RodIds More...
virtual void	getAllRods (std::vector< std::uint32_t > &usersVector, const EventContext &ctx) const =0
virtual void	getHashesForRod (std::vector< IdentifierHash > &usersVector, const std::uint32_t rodId) const =0
	fill a user's vector with all the hash ids which belong to a given rod More...
virtual void	getHashesForRod (std::vector< IdentifierHash > &usersVector, const std::uint32_t rodId, const EventContext &ctx) const =0

Detailed Description

Client interface to the cabling, providing conversions between online and offline identifiers

Definition at line 36 of file ISCT_CablingTool.h.

Constructor & Destructor Documentation

~ISCT_CablingTool()

virtual ISCT_CablingTool::~ISCT_CablingTool ( )

virtualdefault

no-op destructor

Member Function Documentation

DeclareInterfaceID()

ISCT_CablingTool::DeclareInterfaceID	(	ISCT_CablingTool	,
		1	,
		0
	)

Creates the InterfaceID and interfaceID() method.

empty() [1/2]

virtual bool ISCT_CablingTool::empty ( ) const

pure virtual

is the data structure empty?

empty() [2/2]

virtual bool ISCT_CablingTool::empty ( const EventContext &  ctx ) const

pure virtual

getAllRods() [1/2]

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

pure virtual

fill a users vector with all the RodIds

getAllRods() [2/2]

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

pure virtual

getHashesForRod() [1/2]

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

pure virtual

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

getHashesForRod() [2/2]

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

pure virtual

getHashFromOnlineId() [1/2]

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

pure virtual

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

getHashFromOnlineId() [2/2]

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

pure virtual

getHashFromSerialNumber() [1/2]

virtual IdentifierHash ISCT_CablingTool::getHashFromSerialNumber ( const SCT_SerialNumber &  sn ) const

pure virtual

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

getHashFromSerialNumber() [2/2]

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

pure virtual

getOnlineIdFromHash() [1/2]

virtual SCT_OnlineId ISCT_CablingTool::getOnlineIdFromHash ( const IdentifierHash &  hash ) const

pure virtual

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

getOnlineIdFromHash() [2/2]

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

pure virtual

getOnlineIdFromOfflineId() [1/2]

virtual SCT_OnlineId ISCT_CablingTool::getOnlineIdFromOfflineId ( const Identifier &  offlineId ) const

pure virtual

return the online Id, given an offlineId

getOnlineIdFromOfflineId() [2/2]

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

pure virtual

getRobIdFromHash() [1/2]

virtual std::uint32_t ISCT_CablingTool::getRobIdFromHash ( const IdentifierHash &  hash ) const

pure virtual

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

getRobIdFromHash() [2/2]

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

pure virtual

getRobIdFromOfflineId() [1/2]

virtual std::uint32_t ISCT_CablingTool::getRobIdFromOfflineId ( const Identifier &  offlineId ) const

pure virtual

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

getRobIdFromOfflineId() [2/2]

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

pure virtual

getSerialNumberFromHash() [1/2]

virtual SCT_SerialNumber ISCT_CablingTool::getSerialNumberFromHash ( const IdentifierHash &  hash ) const

pure virtual

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

getSerialNumberFromHash() [2/2]

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

pure virtual

size() [1/2]

virtual unsigned int ISCT_CablingTool::size ( ) const

pure virtual

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

size() [2/2]

virtual unsigned int ISCT_CablingTool::size ( const EventContext &  ctx ) const

pure virtual

---

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

• ISCT_CablingTool.h