compares pattern unit with client defined masks More...

#include <TBPatternUnitStreamerToolH8.h>

Inheritance diagram for TBPatternUnitStreamerToolH8:

Collaboration diagram for TBPatternUnitStreamerToolH8:

Public Types
typedef unsigned int	bit_mask
typedef std::map< std::string, bit_mask >	bit_mask_store
typedef std::string	pattern
typedef std::vector< pattern >	pattern_store

Public Member Functions
	TBPatternUnitStreamerToolH8 (const std::string &type, const std::string &name, const IInterface *parent)
virtual	~TBPatternUnitStreamerToolH8 ()
virtual StatusCode	initializeTool () override
virtual StatusCode	accept () override
virtual StatusCode	reject ()
virtual StatusCode	initialize () override
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	sysInitialize () override
	Perform system initialization for an algorithm.
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

Static Public Member Functions
static const InterfaceID &	interfaceID ()

Protected Member Functions
std::string	decodeBinary (bit_mask &theTrigger)
StatusCode	findPattern (const pattern_store &thePatterns, const bit_mask_store &theBitMasks, bit_mask &theMask)
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.

Protected Attributes
std::string	m_patternUnitKey
pattern_store	m_acceptPatternNames
pattern_store	m_rejectPatternNames
bit_mask	m_acceptPattern
bit_mask	m_rejectPattern
bit_mask_store	m_triggerBitMap

Private Types
typedef ServiceHandle< StoreGateSvc >	StoreGateSvc_t

Private Member Functions
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T, V, H > &hndl, const SG::VarHandleKeyType &)
	specialization for handling Gaudi::Property<SG::VarHandleKey>

Private Attributes
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

compares pattern unit with client defined masks

The TBPatternUnitStreamerTool compares the event pattern unit with client defined masks for acceptance and rejection. Pattern unit bits are addressed by name. The AcceptPattern property names a lit of bits required for acceptance, while RejectPattern names a list of bits required to reject the event.

Properties:

Parameters

PatternUnitName	- object key for the pattern unit (defaults to `TBTrigPat` )
AcceptPattern	- list of named bits required for acceptance
RejectPattern	- list of named bits required for rejection

Author: Monika Wielers

Date: July 28, 2004 - copy of TBPatternUnitStreamerTool adapted for H8

Definition at line 33 of file TBPatternUnitStreamerToolH8.h.

Member Typedef Documentation

◆ bit_mask

typedef unsigned int TBPatternUnitStreamerToolH8::bit_mask

Definition at line 37 of file TBPatternUnitStreamerToolH8.h.

◆ bit_mask_store

typedef std::map< std::string, bit_mask > TBPatternUnitStreamerToolH8::bit_mask_store

Definition at line 38 of file TBPatternUnitStreamerToolH8.h.

◆ pattern

typedef std::string TBPatternUnitStreamerToolH8::pattern

Definition at line 39 of file TBPatternUnitStreamerToolH8.h.

◆ pattern_store

typedef std::vector<pattern> TBPatternUnitStreamerToolH8::pattern_store

Definition at line 40 of file TBPatternUnitStreamerToolH8.h.

◆ StoreGateSvc_t

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

privateinherited

Definition at line 388 of file AthCommonDataStore.h.

Constructor & Destructor Documentation

◆ TBPatternUnitStreamerToolH8()

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

Definition at line 11 of file TBPatternUnitStreamerToolH8.cxx.

  : TBEventStreamerTool(type,name,parent)
    , m_patternUnitKey("TBTrigPat")
    , m_acceptPattern()
    , m_rejectPattern()
{
  declareProperty("PatternUnitName",m_patternUnitKey);
  declareProperty("AcceptPattern",  m_acceptPatternNames);
  declareProperty("RejectPattern",  m_rejectPatternNames);
  // pre-settings (to be moved to helper!)
  m_triggerBitMap["Physics"]     = 0x00000001;  // Physics accept
  m_triggerBitMap["Calibration"] = 0x00000002;  // Calib accept
  m_triggerBitMap["LED"]         = 0x00000002;  // LED (same as calib) accept
  m_triggerBitMap["Random"]      = 0x00000004;  // Random accept
  m_triggerBitMap["MonoCIS"]     = 0x00000008;  // MonoCIS accept
}

◆ ~TBPatternUnitStreamerToolH8()

TBPatternUnitStreamerToolH8::~TBPatternUnitStreamerToolH8 ( )

virtual

Definition at line 31 of file TBPatternUnitStreamerToolH8.cxx.

32{ }

Member Function Documentation

◆ accept()

StatusCode TBPatternUnitStreamerToolH8::accept ( )

overridevirtual

? ( thePattern & m_acceptPattern ) == m_acceptPattern

Implements TBEventStreamerTool.

Definition at line 134 of file TBPatternUnitStreamerToolH8.cxx.

{
  // messaging
  MsgStream report(msgSvc(),name());
  
  // retrieve pattern unit
  const TBTriggerPatternUnit* theTrigger;
  ATH_CHECK( evtStore()->retrieve(theTrigger,m_patternUnitKey) );
 
  //
  bit_mask thePattern = theTrigger->getTriggerWord() & 0x00ffffff;
 
  // check acceptance (AND requirement)
  bool globalAccept =  m_acceptPattern != 0x00000000
    ? ( thePattern & m_acceptPattern ) != 0x00000000
    : true;
 
  // check rejection (OR requirement)
  globalAccept = m_rejectPattern != 0x0000  
    ? globalAccept & ( ( thePattern & m_rejectPattern ) == 0x0000 )
    : globalAccept;
 
  return globalAccept
    ? StatusCode::SUCCESS
    : StatusCode::FAILURE;
}

◆ declareGaudiProperty()

Gaudi::Details::PropertyBase & AthCommonDataStore< AthCommonMsg< AlgTool > >::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< AlgTool > >::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());
  }

◆ decodeBinary()

std::string TBPatternUnitStreamerToolH8::decodeBinary ( bit_mask & theTrigger )

protected

Definition at line 166 of file TBPatternUnitStreamerToolH8.cxx.

{
  unsigned int nBits = sizeof(theTriggerWord) ;
  std::string thePattern;
  bit_mask testPattern = 0x00000001;
  
  for ( unsigned int i=0; i<nBits; i++ )
    {
      if ( ( theTriggerWord & testPattern ) == testPattern ) 
    {
      thePattern = thePattern + "X";
    }
      else
    { 
      thePattern = thePattern + "O";
    }
      testPattern *= 2;
    }
  return thePattern;
}

◆ detStore()

const ServiceHandle< StoreGateSvc > & AthCommonDataStore< AthCommonMsg< AlgTool > >::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< AlgTool > >::m_detStore

StoreGateSvc_t m_detStore

Definition AthCommonDataStore.h:393

◆ evtStore()

ServiceHandle< StoreGateSvc > & AthCommonDataStore< AthCommonMsg< AlgTool > >::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< AlgTool > >::m_evtStore

StoreGateSvc_t m_evtStore

Definition AthCommonDataStore.h:390

◆ extraDeps_update_handler()

void AthCommonDataStore< AthCommonMsg< AlgTool > >::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

◆ findPattern()

StatusCode TBPatternUnitStreamerToolH8::findPattern	(	const pattern_store &	thePatterns,
		const bit_mask_store &	theBitMasks,
		bit_mask &	theMask )

protected

Definition at line 187 of file TBPatternUnitStreamerToolH8.cxx.

{
  // messaging
  MsgStream report(msgSvc(),name());
 
  // build pattern
  for (const pattern& pat : listOfPatterns)
    {
      bit_mask_store::const_iterator findIter = 
    definedPattern.find(pat);
      if ( findIter != definedPattern.end() )
    {
      theMask = theMask | (*findIter).second;
    }
      else
    {
      report << MSG::WARNING
         << "requested pattern <"
         << pat
         << "> unknown, ignore..."
         << endmsg;
    }
    }
  return StatusCode::SUCCESS;
}

◆ initialize()

StatusCode TBEventStreamerTool::initialize ( )

overridevirtualinherited

Definition at line 17 of file TBEventStreamerTool.cxx.

{
  return this->initializeTool();
}

◆ initializeTool()

StatusCode TBPatternUnitStreamerToolH8::initializeTool ( )

overridevirtual

Reimplemented from TBEventStreamerTool.

Definition at line 38 of file TBPatternUnitStreamerToolH8.cxx.

{ 
  // messages
  MsgStream report(msgSvc(),name());
 
  // form accept trigger pattern
  m_acceptPattern = 0x00000000;
  if ( (this->findPattern(m_acceptPatternNames,
              m_triggerBitMap,
              m_acceptPattern)).isFailure())
    {
      report << MSG::ERROR
         << "cannot build accept pattern mask."
         << endmsg;
      return StatusCode::FAILURE;
    }
 
  // form reject trigger pattern
  m_rejectPattern = 0x00000000;
  if ( (this->findPattern(m_rejectPatternNames,
              m_triggerBitMap,
              m_rejectPattern)).isFailure() )
    {
      report << MSG::ERROR
         << "cannot build reject pattern mask."
         << endmsg;
      return StatusCode::FAILURE;
    }
 
  // print pattern matrices
  report << MSG::INFO << " " << endmsg;
  report << MSG::INFO << "                      ###################" << endmsg;
  report << MSG::INFO << "                      # TriggerPatterns #" << endmsg;
  report << MSG::INFO << "                      ###################" << endmsg;
  report << MSG::INFO << " " << endmsg;
  report << MSG::INFO << "         +-+-+-+-+-+-+" << endmsg;
  report << MSG::INFO << "         |   | C |   |" << endmsg;
  report << MSG::INFO << "         |   | a |   |" << endmsg;
  report << MSG::INFO << "         |   | l |   |" << endmsg;
  report << MSG::INFO << "         |   | i |   |" << endmsg;
  report << MSG::INFO << "         | P | b |   |" << endmsg;
  report << MSG::INFO << "         | h | r | R |" << endmsg;
  report << MSG::INFO << "         | y | a | a |" << endmsg;
  report << MSG::INFO << "         | s | t | n |" << endmsg;
  report << MSG::INFO << "         | i | i | d |" << endmsg;
  report << MSG::INFO << "         | c | o | o |" << endmsg;
  report << MSG::INFO << "         | s | n | m |" << endmsg;
  report << MSG::INFO << "+--------+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+" << endmsg;
  std::string decoded = this->decodeBinary(m_acceptPattern);
  report << MSG::INFO << "| accept | " ;
  for ( unsigned int i=0; i<std::min(decoded.length(),m_triggerBitMap.size());
    i++ )
    {
      report << MSG::INFO << decoded.substr(i,1) << " | ";
    }
//   report << MSG::INFO
//   << " (0x" << std::setw(8) << std::setfill('0') 
//   << std::setiosflags(std::ios_base::hex) << m_acceptPattern << ")" 
//   << std::setiosflags(std::ios_base::dec)
//   << endmsg;      
  report << MSG::INFO << "+--------+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+" << endmsg;
  report << MSG::INFO << "| reject | ";
  decoded = this->decodeBinary(m_rejectPattern);
  for ( unsigned int i=0; i<std::min(decoded.length(),m_triggerBitMap.size());
    i++ )
    {
      report << MSG::INFO << decoded.substr(i,1) << " | ";
    }
//   report << MSG::INFO
//   << " (0x" << std::setw(8) << std::setfill('0')
//   << std::setiosflags(std::ios_base::hex) << m_rejectPattern << ")" 
//   << std::setiosflags(std::ios_base::dec)
//   << endmsg;
  report << MSG::INFO << "+--------+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+" << endmsg;
  report << MSG::INFO << "| ignore | ";
  bit_mask ignorePattern = ~( m_rejectPattern ^ m_acceptPattern );
  decoded = this->decodeBinary(ignorePattern);
  for ( unsigned int i=0; i<std::min(decoded.length(),m_triggerBitMap.size()); 
    i++ )
    {
      report << MSG::INFO << decoded.substr(i,1) << " | ";
    }
//   report << MSG::INFO
//   << " (0x" << std::setw(8) << std::setfill('0')
//   << std::setiosflags(std::ios_base::hex) << ignorePattern << ")" 
//   << std::setiosflags(std::ios_base::dec)
//   << endmsg;
  report << MSG::INFO << "+--------+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+" << endmsg;
 
  return StatusCode::SUCCESS;
}

◆ inputHandles()

virtual std::vector< Gaudi::DataHandle * > AthCommonDataStore< AthCommonMsg< AlgTool > >::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.

◆ interfaceID()

const InterfaceID & TBEventStreamerTool::interfaceID ( )

inlinestaticinherited

Definition at line 30 of file TBEventStreamerTool.h.

30{ return IID_TBEventStreamerTool;}

IID_TBEventStreamerTool

static const InterfaceID IID_TBEventStreamerTool("TBEventStreamerTool", 1, 0)

◆ msg()

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

inlineinherited

Definition at line 24 of file AthCommonMsg.h.

                                {
    return this->msgStream();
  }

◆ msgLvl()

bool AthCommonMsg< AlgTool >::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< AlgTool > >::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.

◆ reject()

StatusCode TBEventStreamerTool::reject ( )

virtualinherited

Definition at line 27 of file TBEventStreamerTool.cxx.

{
  return this->accept().isFailure()
    ? StatusCode::SUCCESS
    : StatusCode::FAILURE;
}

◆ 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< AlgTool > >::renounce ( T & h )

inlineprotectedinherited

Definition at line 380 of file AthCommonDataStore.h.

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

◆ renounceArray()

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

inlineprotectedinherited

remove all handles from I/O resolution

Definition at line 364 of file AthCommonDataStore.h.

                                                          {
    handlesArray.renounce();
  }

◆ sysInitialize()

virtual StatusCode AthCommonDataStore< AthCommonMsg< AlgTool > >::sysInitialize ( )

overridevirtualinherited

Perform system initialization for an algorithm.

We override this to declare all the elements of handle key arrays at the end of initialization. See comments on updateVHKA.

Reimplemented in asg::AsgMetadataTool, AthCheckedComponent< AthAlgTool >, AthCheckedComponent<::AthAlgTool >, and DerivationFramework::CfAthAlgTool.

◆ sysStart()

virtual StatusCode AthCommonDataStore< AthCommonMsg< AlgTool > >::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< AlgTool > >::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_acceptPattern

bit_mask TBPatternUnitStreamerToolH8::m_acceptPattern

protected

Definition at line 65 of file TBPatternUnitStreamerToolH8.h.

◆ m_acceptPatternNames

pattern_store TBPatternUnitStreamerToolH8::m_acceptPatternNames

protected

Definition at line 58 of file TBPatternUnitStreamerToolH8.h.

◆ m_detStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< AlgTool > >::m_detStore

privateinherited

Pointer to StoreGate (detector store by default)

Definition at line 393 of file AthCommonDataStore.h.

◆ m_evtStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< AlgTool > >::m_evtStore

privateinherited

Pointer to StoreGate (event store by default)

Definition at line 390 of file AthCommonDataStore.h.

◆ m_patternUnitKey

std::string TBPatternUnitStreamerToolH8::m_patternUnitKey

protected

Definition at line 57 of file TBPatternUnitStreamerToolH8.h.

◆ m_rejectPattern

bit_mask TBPatternUnitStreamerToolH8::m_rejectPattern

protected

Definition at line 66 of file TBPatternUnitStreamerToolH8.h.

◆ m_rejectPatternNames

pattern_store TBPatternUnitStreamerToolH8::m_rejectPatternNames

protected

Definition at line 59 of file TBPatternUnitStreamerToolH8.h.

◆ m_triggerBitMap

bit_mask_store TBPatternUnitStreamerToolH8::m_triggerBitMap

protected

Definition at line 67 of file TBPatternUnitStreamerToolH8.h.

◆ m_varHandleArraysDeclared

bool AthCommonDataStore< AthCommonMsg< AlgTool > >::m_varHandleArraysDeclared

privateinherited

Definition at line 399 of file AthCommonDataStore.h.

◆ m_vhka

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

privateinherited

Definition at line 398 of file AthCommonDataStore.h.

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

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ bit_mask

◆ bit_mask_store

◆ pattern

◆ pattern_store

◆ StoreGateSvc_t

Constructor & Destructor Documentation

◆ TBPatternUnitStreamerToolH8()

◆ ~TBPatternUnitStreamerToolH8()

Member Function Documentation

◆ accept()

◆ declareGaudiProperty()

◆ declareProperty()

◆ decodeBinary()

◆ detStore()

◆ evtStore()

◆ extraDeps_update_handler()

◆ findPattern()

◆ initialize()

◆ initializeTool()

◆ inputHandles()

◆ interfaceID()

◆ msg()

◆ msgLvl()

◆ outputHandles()

◆ reject()

◆ renounce()

◆ renounceArray()

◆ sysInitialize()

◆ sysStart()

◆ updateVHKA()

Member Data Documentation

◆ m_acceptPattern

◆ m_acceptPatternNames

◆ m_detStore

◆ m_evtStore

◆ m_patternUnitKey

◆ m_rejectPattern

◆ m_rejectPatternNames

◆ m_triggerBitMap

◆ m_varHandleArraysDeclared

◆ m_vhka