#include <src/ViewTester.h>

Inheritance diagram for Test::ViewTester:

[legend]

Collaboration diagram for Test::ViewTester:

[legend]

Public Member Functions
bool	isClonable () const override

StatusCode	execute () override
	the execution of the algorithm More...

StatusCode	initialize () override
	Its initialization. More...

StatusCode	finalize () override
	the finalization of the algorithm More...

	ViewTester (const std::string &name, ISvcLocator *pSvc)

Public Member Functions inherited from GaudiAlgorithm
StatusCode	initialize () override
	standard initialization method More...

StatusCode	execute () override
	standard execution method More...

StatusCode	finalize () override
	standard finalization method More...

StatusCode	sysExecute (const EventContext &ctx) override
	the generic actions for the execution. More...

void	put (IDataProviderSvc svc, DataObject object, const std::string &address, const bool useRootInTES=true) const
	Register a data object or container into Gaudi Event Transient Store. More...

void	put (IDataProviderSvc *svc, std::unique_ptr< DataObject > object, const std::string &address, const bool useRootInTES=true) const

const DataObject *	put (DataObject *object, const std::string &address, const bool useRootInTES=true) const
	Register a data object or container into Gaudi Event Transient Store. More...

const DataObject *	put (std::unique_ptr< DataObject > object, const std::string &address, const bool useRootInTES=true) const

template<class TYPE >
Gaudi::Utils::GetData< TYPE >::return_type	get (IDataProviderSvc *svc, const std::string &location, const bool useRootInTES=true) const
	Templated access to the data in Gaudi Transient Store. More...

template<class TYPE >
Gaudi::Utils::GetData< TYPE >::return_type	getIfExists (IDataProviderSvc *svc, const std::string &location, const bool useRootInTES=true) const
	Templated access to the data in Gaudi Transient Store. More...

template<class TYPE >
Gaudi::Utils::GetData< TYPE >::return_type	get (const std::string &location, const bool useRootInTES=true) const
	Templated access to the data from Gaudi Event Transient Store. More...

template<class TYPE >
Gaudi::Utils::GetData< TYPE >::return_type	getIfExists (const std::string &location, const bool useRootInTES=true) const
	Templated access to the data in Gaudi Transient Store. More...

template<class TYPE >
TYPE *	getDet (IDataProviderSvc *svc, const std::string &location) const
	Templated access to the detector data from the Gaudi Detector Transient Store. More...

template<class TYPE >
Gaudi::Utils::GetData< TYPE >::return_type	getDetIfExists (IDataProviderSvc *svc, const std::string &location) const
	Templated access to the detector data from the Gaudi Detector Transient Store. More...

template<class TYPE >
TYPE *	getDet (const std::string &location) const
	Templated access to the detector data from the Gaudi Detector Transient Store. More...

template<class TYPE >
Gaudi::Utils::GetData< TYPE >::return_type	getDetIfExists (const std::string &location) const
	Templated access to the detector data from the Gaudi Detector Transient Store. More...

template<class TYPE >
bool	exist (IDataProviderSvc *svc, const std::string &location, const bool useRootInTES=true) const
	Check the existence of a data object or container in the Gaudi Transient Event Store. More...

template<class TYPE >
bool	exist (const std::string &location, const bool useRootInTES=true) const
	Check the existence of a data object or container in the Gaudi Transient Event Store. More...

template<class TYPE >
bool	existDet (IDataProviderSvc *svc, const std::string &location) const
	Check the existence of detector objects in the Gaudi Transient Detector Store. More...

template<class TYPE >
bool	existDet (const std::string &location) const
	Check the existence of detector objects in the Gaudi Transient Detector Store. More...

template<class TYPE , class TYPE2 >
Gaudi::Utils::GetData< TYPE >::return_type	getOrCreate (IDataProviderSvc *svc, std::string_view location, const bool useRootInTES=true) const
	Get the existing data object from Gaudi Event Transient store. More...

template<class TYPE , class TYPE2 >
Gaudi::Utils::GetData< TYPE >::return_type	getOrCreate (const std::string &location, const bool useRootInTES=true) const
	Get the existing data object from Gaudi Event Transient store. More...

	GaudiAlgorithm (std::string name, ISvcLocator *pSvcLocator)
	Standard constructor. More...

	GaudiAlgorithm (const GaudiAlgorithm &)=delete

GaudiAlgorithm &	operator= (const GaudiAlgorithm &)=delete

SmartIF< INTupleSvc > &	evtColSvc () const
	Access the standard event collection service. More...

Public Member Functions inherited from GaudiCommon< Algorithm >
Gaudi::Utils::GetData< TYPE >::return_type	get (IDataProviderSvc *svc, std::string_view location, const bool useRootInTES=true) const
	Templated access to the data in Gaudi Transient Store. More...

Gaudi::Utils::GetData< TYPE >::return_type	getIfExists (IDataProviderSvc *svc, std::string_view location, const bool useRootInTES=true) const
	Quicker version of the get function which bypasses the check on the retrieved data. More...

bool	exist (IDataProviderSvc *svc, std::string_view location, const bool useRootInTES=true) const
	Check the existence of a data object or container in the Gaudi Transient Event Store. More...

Gaudi::Utils::GetData< TYPE >::return_type	getOrCreate (IDataProviderSvc *svc, std::string_view location, const bool useRootInTES=true) const
	Get the existing data object from Gaudi Event Transient store. More...

DataObject *	put (IDataProviderSvc *svc, std::unique_ptr< DataObject > object, std::string_view location, const bool useRootInTES=true) const
	Register a data object or container into Gaudi Event Transient Store. More...

DataObject *	put (IDataProviderSvc svc, DataObject object, std::string_view location, const bool useRootInTES=true) const

TOOL *	tool (std::string_view type, std::string_view name, const IInterface *parent=0, bool create=true) const
	Useful method for the easy location of tools. More...

TOOL *	tool (std::string_view type, const IInterface *parent=0, bool create=true) const
	A useful method for the easy location of tools. More...

SmartIF< SERVICE >	svc (std::string_view name, const bool create=true) const
	A useful method for the easy location of services. More...

IUpdateManagerSvc *	updMgrSvc () const
	Short-cut to locate the Update Manager Service. More...

StatusCode	Error (std::string_view msg, const StatusCode st=StatusCode::FAILURE, const size_t mx=10) const
	Print the error message and return with the given StatusCode. More...

StatusCode	Warning (std::string_view msg, const StatusCode st=StatusCode::FAILURE, const size_t mx=10) const
	Print the warning message and return with the given StatusCode. More...

StatusCode	Info (std::string_view msg, const StatusCode st=StatusCode::SUCCESS, const size_t mx=10) const
	Print the info message and return with the given StatusCode. More...

StatusCode	Print (std::string_view msg, const StatusCode st=StatusCode::SUCCESS, const MSG::Level lev=MSG::INFO) const
	Print the message and return with the given StatusCode. More...

void	Assert (const bool ok, std::string_view message="", const StatusCode sc=StatusCode(StatusCode::FAILURE, true)) const
	Assertion - throw exception if the given condition is not fulfilled. More...

void	Exception (std::string_view msg, const GaudiException &exc, const StatusCode sc=StatusCode(StatusCode::FAILURE, true)) const
	Create and (re)-throw a given GaudiException. More...

void	Exception (std::string_view msg, const std::exception &exc, const StatusCode sc=StatusCode(StatusCode::FAILURE, true)) const
	Create and (re)-throw a given exception. More...

void	Exception (std::string_view msg="no message", const StatusCode sc=StatusCode(StatusCode::FAILURE, true)) const
	Create and throw an exception with the given message. More...

StatEntity &	counter (std::string_view tag) const
	accessor to certain counter by name More...

StatEntity &	counter (std::string_view tag)

bool	typePrint () const
	Insert the actual C++ type of the algorithm/tool in the messages ? More...

bool	propsPrint () const
	Print properties at initialization ? More...

bool	statPrint () const
	Print statistical counters at finalization ? More...

bool	errorsPrint () const
	Print error counters at finalization ? More...

long	printStat (const MSG::Level level=MSG::ALWAYS) const
	perform the actual printout of statistical counters More...

long	printErrors (const MSG::Level level=MSG::ALWAYS) const
	perform the actual printout of error counters More...

long	printProps (const MSG::Level level=MSG::ALWAYS) const
	perform the actual printout of properties More...

void	registerCondition (const std::string &condition, StatusCode(CallerClass::*mf)()=nullptr)
	register the current instance to the UpdateManagerSvc as a consumer for a condition. More...

void	registerCondition (const std::string &condition, CondType &condPtrDest, StatusCode(CallerClass::mf)()=NULL)
	register the current instance to the UpdateManagerSvc as a consumer for a condition. More...

void	registerCondition (char condition, StatusCode(CallerClass::mf)()=NULL)
	just to avoid conflicts with the version using a pointer to a template class. More...

void	registerCondition (TargetClass condition, StatusCode(CallerClass::mf)()=NULL)
	register the current instance to the UpdateManagerSvc as a consumer for a condition. More...

StatusCode	runUpdate ()
	asks the UpdateManagerSvc to perform an update of the instance (if needed) without waiting the next BeginEvent incident. More...

	GaudiCommon (std::string name, ISvcLocator *pSvcLocator)
	Algorithm constructor - the SFINAE constraint below ensures that this is constructor is only defined if PBASE derives from Algorithm. More...

	GaudiCommon (std::string type, std::string name, const IInterface *ancestor)
	Tool constructor - SFINAE-ed to insure this constructor is only defined if PBASE derives from AlgTool. More...

	GaudiCommon ()=delete

	GaudiCommon (const GaudiCommon &)=delete

StatusCode	initialize () override
	standard initialization method More...

StatusCode	finalize () override
	standard finalization method More...

GaudiCommon &	operator= (const GaudiCommon &)=delete

StatusCode	release (const IInterface *interface) const
	Manual forced (and 'safe') release of the active tool or service. More...

const Services &	services () const
	get the list of aquired services More...

const std::string &	context () const
	Returns the "context" string. Used to identify different processing states. More...

Public Member Functions inherited from FixTESPath< BASE >
template<typename U = BASE, typename = std::enable_if_t<std::is_base_of_v<Gaudi::Algorithm, BASE>, U>>
	FixTESPath (std::string name, ISvcLocator *pSvcLocator)
	Algorithm constructor - the SFINAE constraint below ensures that this is constructor is only defined if BASE derives from Algorithm. More...

template<typename U = BASE, typename = std::enable_if_t<std::is_base_of_v<AlgTool, BASE>, U>>
	FixTESPath (std::string type, std::string name, const IInterface *ancestor)
	Tool constructor - SFINAE-ed to insure this constructor is only defined if BASE derives from AlgTool. More...

StatusCode	initialize () override

const std::string &	rootInTES () const
	Returns the "rootInTES" string. More...

std::string	fullTESLocation (std::string_view location, bool useRootInTES) const
	Returns the full correct event location given the rootInTes settings. More...

Private Member Functions
	ViewTester ()
	the default constructor is disabled More...

	ViewTester (const ViewTester &)
	the copy constructor is disabled More...

ViewTester &	operator= (const ViewTester &)
	the assignement operator is disabled More...

Private Attributes
Gaudi::Property< std::vector< std::string > >	m_inpKeys {this, "inpKeys", {}, ""}

Gaudi::Property< std::vector< std::string > >	m_outKeys {this, "outKeys", {}, ""}

std::vector< std::unique_ptr< DataObjectHandle< DataObject > > >	m_inputHandles

std::vector< std::unique_ptr< DataObjectHandle< DataObject > > >	m_outputHandles

Gaudi::Property< std::string >	m_baseViewName

Gaudi::Property< unsigned int >	m_viewNumber {this, "viewNumber", 0, "How many views to make"}

Gaudi::Property< std::string >	m_viewNodeName {this, "viewNodeName", "viewNode", "Name of node to attach views to"}

Additional Inherited Members
Protected Types inherited from GaudiCommon< Algorithm >
using	base_class = FixTESPath< Algorithm >

typedef std::map< std::string, StatEntity, std::less<> >	StatisticsOwn
	the actual type of general counters More...

typedef std::map< std::string, std::reference_wrapper< Gaudi::Accumulators::PrintableCounter >, std::less<> >	Statistics

typedef std::map< std::string, unsigned int, std::less<> >	Counter
	the actual type error/warning counter More...

typedef std::vector< IAlgTool * >	AlgTools
	storage for active tools More...

typedef std::vector< SmartIF< IService > >	Services
	storage for active services More...

Protected Member Functions inherited from GaudiCommon< Algorithm >
StatusCode	releaseTool (const IAlgTool *tool) const
	manual forced (and 'safe') release of the tool More...

StatusCode	releaseSvc (const IInterface *svc) const
	manual forced (and 'safe') release of the service More...

Protected Attributes inherited from GaudiCommon< Algorithm >
SmartIF< ICounterSummarySvc >	m_counterSummarySvc
	a pointer to the CounterSummarySvc More...

Static Protected Attributes inherited from GaudiCommon< Algorithm >
static const bool	IgnoreRootInTES
	Simple definition to be used with the new useRootInTES argument get<TYPE> and put methods. More...

static const bool	UseRootInTES
	Simple definition to be used with the new useRootInTES argument get<TYPE> and put methods. More...

Detailed Description

Definition at line 25 of file ViewTester.h.

Constructor & Destructor Documentation

◆ ViewTester() [1/3]

ViewTester::ViewTester	(	const std::string &	name,
		ISvcLocator *	pSvc
	)

Definition at line 26 of file ViewTester.cpp.

28 : GaudiAlgorithm( name, pSvc ) {}

gaudiComponentHelp.name

name

Definition: gaudiComponentHelp.py:52

GaudiAlgorithm::GaudiAlgorithm

GaudiAlgorithm(std::string name, ISvcLocator *pSvcLocator)

Standard constructor.

Definition: GaudiAlgorithm.cpp:45

◆ ViewTester() [2/3]

Test::ViewTester::ViewTester ( )

private

the default constructor is disabled

◆ ViewTester() [3/3]

Test::ViewTester::ViewTester ( const ViewTester & )

private

the copy constructor is disabled

Member Function Documentation

◆ execute()

StatusCode ViewTester::execute ( )

override

the execution of the algorithm

Definition at line 62 of file ViewTester.cpp.

 {
   SmartIF<IScheduler> scheduler( serviceLocator()->service( "AvalancheSchedulerSvc" ) );
   if ( !scheduler ) {
     fatal() << "Unable to load AvalancheSchedulerSvc" << endmsg;
     return StatusCode::FAILURE;
   }
 
   const auto& context = getContext();
 
   // Report if currently running in a view
   if ( !context.hasExtension<std::string>() )
     info() << "Running in whole event context" << endmsg;
   else
     info() << "Running in view " << context.getExtension<std::string>() << endmsg;
 
   // If a node name is specified (and not already in view), do view scheduling
   if ( !m_viewNodeName.empty() && !context.hasExtension<std::string>() ) {
     if ( m_viewNumber > 0 ) {
       // Make views
       for ( unsigned int viewIndex = 0; viewIndex < m_viewNumber; ++viewIndex ) {
         // Make event context for the view
         auto               viewContext = std::make_unique<EventContext>( context.evt(), context.slot() );
         const std::string& viewName    = viewContext->setExtension( m_baseViewName + std::to_string( viewIndex ) );
 
         StatusCode sc = scheduler->scheduleEventView( &context, m_viewNodeName, std::move( viewContext ) );
         if ( sc.isSuccess() )
           info() << "Attached view " << viewName << " to node " << m_viewNodeName.toString() << " for " << context
                  << endmsg;
         else
           error() << "Unable to attach view " << viewName << " to node " << m_viewNodeName.toString() << " for "
                   << context << endmsg;
       }
     } else {
       // Disable the view node if there are no views
       scheduler->scheduleEventView( &context, m_viewNodeName, nullptr )
           .ignore( /* AUTOMATICALLY ADDED FOR gaudi/Gaudi!763 */ );
     }
   }
 
   VERBOSE_MSG << "outputs number: " << m_outputHandles.size() << endmsg;
   for ( auto& outputHandle : m_outputHandles ) {
     if ( !outputHandle->isValid() ) continue;
 
     VERBOSE_MSG << "put to TS: " << outputHandle->objKey() << endmsg;
     outputHandle->put( std::make_unique<DataObject>() );
   }
 
   setFilterPassed( true );
 
   return StatusCode::SUCCESS;
 }

◆ finalize()

StatusCode ViewTester::finalize ( )

override

the finalization of the algorithm

Definition at line 117 of file ViewTester.cpp.

 {
   return GaudiAlgorithm::finalize();
 }

◆ initialize()

StatusCode ViewTester::initialize ( )

override

Its initialization.

Definition at line 30 of file ViewTester.cpp.

                                   {
   auto sc = GaudiAlgorithm::initialize();
   if ( !sc ) return sc;
 
   // This is a bit ugly. There is no way to declare a vector of DataObjectHandles, so
   // we need to wait until initialize when we've read in the input and output key
   // properties, and know their size, and then turn them
   // into Handles and register them with the framework by calling declareProperty. We
   // could call declareInput/declareOutput on them too.
 
   int i = 0;
   for ( auto k : m_inpKeys ) {
     DEBUG_MSG << "adding input key " << k << endmsg;
     m_inputHandles.emplace_back( std::make_unique<DataObjectHandle<DataObject>>( k, Gaudi::DataHandle::Reader, this ) );
     declareProperty( "dummy_in_" + std::to_string( i ), *( m_inputHandles.back() ) );
     i++;
   }
 
   i = 0;
   for ( auto k : m_outKeys ) {
     DEBUG_MSG << "adding output key " << k << endmsg;
     m_outputHandles.emplace_back(
         std::make_unique<DataObjectHandle<DataObject>>( k, Gaudi::DataHandle::Writer, this ) );
     declareProperty( "dummy_out_" + std::to_string( i ), *( m_outputHandles.back() ) );
     i++;
   }
 
   return sc;
 }

◆ isClonable()

bool Test::ViewTester::isClonable ( ) const

inlineoverride

Definition at line 28 of file ViewTester.h.

28 { return true; }

◆ operator=()

ViewTester& Test::ViewTester::operator= ( const ViewTester & )

private

the assignement operator is disabled

Member Data Documentation

◆ m_baseViewName

Gaudi::Property<std::string> Test::ViewTester::m_baseViewName

private

Initial value:

{this, "baseViewName", "view",

"Views to be named this, plus a numerical index"}

Definition at line 54 of file ViewTester.h.

◆ m_inpKeys

Gaudi::Property<std::vector<std::string> > Test::ViewTester::m_inpKeys {this, "inpKeys", {}, ""}

private

Definition at line 48 of file ViewTester.h.

◆ m_inputHandles

std::vector<std::unique_ptr<DataObjectHandle<DataObject> > > Test::ViewTester::m_inputHandles

private

Definition at line 50 of file ViewTester.h.

◆ m_outKeys

Gaudi::Property<std::vector<std::string> > Test::ViewTester::m_outKeys {this, "outKeys", {}, ""}

private

Definition at line 49 of file ViewTester.h.

◆ m_outputHandles

std::vector<std::unique_ptr<DataObjectHandle<DataObject> > > Test::ViewTester::m_outputHandles

private

Definition at line 51 of file ViewTester.h.

◆ m_viewNodeName

Gaudi::Property<std::string> Test::ViewTester::m_viewNodeName {this, "viewNodeName", "viewNode", "Name of node to attach views to"}

private

Definition at line 57 of file ViewTester.h.

◆ m_viewNumber

Gaudi::Property<unsigned int> Test::ViewTester::m_viewNumber {this, "viewNumber", 0, "How many views to make"}

private

Definition at line 56 of file ViewTester.h.

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

GaudiHive/src/ViewTester.h
GaudiHive/src/ViewTester.cpp

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ViewTester() [1/3]

◆ ViewTester() [2/3]

◆ ViewTester() [3/3]

Member Function Documentation

◆ execute()

◆ finalize()

◆ initialize()

◆ isClonable()

◆ operator=()

Member Data Documentation

◆ m_baseViewName

◆ m_inpKeys

◆ m_inputHandles

◆ m_outKeys

◆ m_outputHandles

◆ m_viewNodeName

◆ m_viewNumber