The Gaudi Framework  v41r0 (bdbe7744)
Loading...
Searching...
No Matches
Gaudi::TestSuite::Conditions::UserAlg Class Reference

Example of a simple algorithm using conditions via the ConditionAccessorHolder pattern. More...

Inheritance diagram for Gaudi::TestSuite::Conditions::UserAlg:
Collaboration diagram for Gaudi::TestSuite::Conditions::UserAlg:

Private Member Functions

StatusCode initialize () override
StatusCode execute (const EventContext &ctx) const override
StatusCode finalize () override

Private Attributes

ConditionAccessor< int > m_cond { this, "MyCondition", "condition/key" }
 Data member to access condition values for the current event.

Additional Inherited Members

Public Types inherited from Gaudi::TestSuite::Conditions::ConditionAccessorHolder< Algorithm >
using base_class
 Helper to expose this class to specializations without having to spell the whole name (see Gaudi::TestSuite::Conditions::UserAlg).
using ConditionContext
 Forward backend specific ConditionContext to specializations.
using ConditionKey
 Forward backend specific ConditionKey to specializations.
Public Types inherited from Gaudi::Algorithm
typedef Gaudi::PluginService::Factory< IAlgorithm *(const std::string &, ISvcLocator *)> Factory
Public Types inherited from extends< PropertyHolder< CommonMessaging< implements< IAlgorithm, IDataHandleHolder, IProperty, IStateful > > >, IDataHandleHolder >
using base_class
 Typedef to this class.
using extend_interfaces_base
 Typedef to the base of this class.
Public Types inherited from PropertyHolder< CommonMessaging< implements< IAlgorithm, IDataHandleHolder, IProperty, IStateful > > >
using PropertyHolderImpl
 Typedef used to refer to this class from derived classes, as in.
Public Types inherited from CommonMessaging< implements< IAlgorithm, IDataHandleHolder, IProperty, IStateful > >
using base_class
Public Types inherited from extend_interfaces< Interfaces... >
using ext_iids
 take union of the ext_iids of all Interfaces...
Public Member Functions inherited from Gaudi::TestSuite::Conditions::ConditionAccessorHolder< Algorithm >
StatusCode initialize () override
const ConditionContext & getConditionContext (const EventContext &ctx) const
 Helper to map the event being processed to the corresponding conditions slot.
Public Member Functions inherited from Gaudi::Algorithm
 Algorithm (std::string name, ISvcLocator *svcloc, std::string version=PACKAGE_VERSION)
 Constructor.
StatusCode sysStart () override
 Reinitialization method invoked by the framework.
StatusCode sysInitialize () override
 Initialization method invoked by the framework.
StatusCode sysReinitialize () override
 Reinitialization method invoked by the framework.
StatusCode sysRestart () override
 Restart method invoked by the framework.
StatusCode sysExecute (const EventContext &ctx) override
 The actions to be performed by the algorithm on an event.
StatusCode sysStop () override
 System stop.
StatusCode sysFinalize () override
 System finalization.
const std::string & name () const override
 The identifying name of the algorithm object.
const Gaudi::StringKey & nameKey () const override
const std::string & type () const override
 The type of the algorithm object.
void setType (std::string type) override
const std::string & version () const override
unsigned int index () const override
StatusCode configure () override
 Dummy implementation of IStateful::configure() method.
StatusCode terminate () override
 Dummy implementation of IStateful::terminate() method.
StatusCode initialize () override
 the default (empty) implementation of IStateful::initialize() method
StatusCode start () override
 the default (empty) implementation of IStateful::start() method
StatusCode stop () override
 the default (empty) implementation of IStateful::stop() method
StatusCode finalize () override
 the default (empty) implementation of IStateful::finalize() method
StatusCode reinitialize () override
 the default (empty) implementation of IStateful::reinitialize() method
StatusCode restart () override
 the default (empty) implementation of IStateful::restart() method
Gaudi::StateMachine::State FSMState () const override
 returns the current state of the algorithm
Gaudi::StateMachine::State targetFSMState () const override
 returns the state the algorithm will be in after the ongoing transition
bool isEnabled () const override
 Is this algorithm enabled or disabled?
bool isSequence () const override
 Are we a Sequence?
unsigned int errorCount () const
 Get the number of failures of the algorithm.
SmartIF< IService > service (std::string_view name, const bool createIf=true, const bool quiet=false) const
 Return a pointer to the service identified by name (or "type/name").
template<class T>
SmartIF< T > service (std::string_view name, bool createIf=true, bool quiet=false) const
SmartIF< IAuditorSvc > & auditorSvc () const
 The standard auditor service.May not be invoked before sysInitialize() has been invoked.
SmartIF< IChronoStatSvc > & chronoSvc () const
 The standard Chrono & Stat service, Return a pointer to the service if present.
SmartIF< IDataProviderSvc > & detSvc () const
 The standard detector data service.
SmartIF< IConversionSvc > & detCnvSvc () const
 The standard detector data persistency conversion service.
SmartIF< IDataProviderSvc > & eventSvc () const
 The standard event data service.
SmartIF< IDataProviderSvc > & evtSvc () const
 shortcut for method eventSvc
SmartIF< IConversionSvc > & eventCnvSvc () const
 The standard event data persistency conversion service.
SmartIF< IHistogramSvc > & histoSvc () const
 The standard histogram service.
SmartIF< INTupleSvc > & ntupleSvc () const
 The standard N tuple service.
SmartIF< IRndmGenSvc > & randSvc () const
 The standard RandomGen service, Return a pointer to the service if present.
SmartIF< IToolSvc > & toolSvc () const
 The standard ToolSvc service, Return a pointer to the service if present.
SmartIF< IExceptionSvc > & exceptionSvc () const
 Get the exception Service.
SmartIF< IAlgContextSvc > & contextSvc () const
 get Algorithm Context Service
SmartIF< ITimelineSvc > & timelineSvc () const
SmartIF< ISvcLocator > & serviceLocator () const override
 The standard service locator.
SmartIF< ISvcLocator > & svcLoc () const
 shortcut for method serviceLocator
SmartIF< IHiveWhiteBoard > & whiteboard () const
SmartIF< IAlgExecStateSvc > & algExecStateSvc () const
bool registerContext () const
 register for Algorithm Context Service?
template<class T>
Gaudi::Details::PropertyBase * declareProperty (const std::string &name, ToolHandle< T > &hndl, const std::string &doc="none")
template<class T>
Gaudi::Details::PropertyBase * declareProperty (const std::string &name, ToolHandleArray< T > &hndlArr, const std::string &doc="none")
SmartIF< IMonitorSvc > & monitorSvc () const
 Access the monitor service.
template<class T>
void declareInfo (const std::string &name, const T &var, const std::string &desc) const
 Declare monitoring information.
void declareInfo (const std::string &name, const std::string &format, const void *var, int size, const std::string &desc) const
 Declare monitoring information (special case).
void acceptDHVisitor (IDataHandleVisitor *) const override
void registerTool (IAlgTool *tool) const
void deregisterTool (IAlgTool *tool) const
template<class T>
StatusCode declareTool (ToolHandle< T > &handle, bool createIf=true)
template<class T>
StatusCode declareTool (ToolHandle< T > &handle, const std::string &toolTypeAndName, bool createIf=true)
template<class T>
void addToolsArray (ToolHandleArray< T > &hndlArr)
const std::vector< IAlgTool * > & tools () const
bool isAsynchronous () const
void setAsynchronous (bool value)
unsigned int cardinality () const override
 Return the cardinality.
const AlgResources_t & neededResources () const override
AlgExecStateRef execState (const EventContext &ctx) const override
 get the AlgExecStateRef of current algorithm Actually a small wrapper around it, thus the plain object return type
std::ostream & toControlFlowExpression (std::ostream &os) const override
 Produce string represention of the control flow expression.
Public Member Functions inherited from DataHandleHolderBase< PropertyHolder< CommonMessaging< implements< IAlgorithm, IDataHandleHolder, IProperty, IStateful > > > >
std::vector< Gaudi::DataHandle * > inputHandles () const override
std::vector< Gaudi::DataHandle * > outputHandles () const override
virtual const DataObjIDColl & extraInputDeps () const override
virtual const DataObjIDColl & extraOutputDeps () const override
void declare (Gaudi::DataHandle &handle) override
void renounce (Gaudi::DataHandle &handle) override
bool renounceInput (const DataObjID &id) override
const DataObjIDColl & inputDataObjs () const override
const DataObjIDColl & outputDataObjs () const override
void addDependency (const DataObjID &id, const Gaudi::DataHandle::Mode &mode) override
Public Member Functions inherited from extends< PropertyHolder< CommonMessaging< implements< IAlgorithm, IDataHandleHolder, IProperty, IStateful > > >, IDataHandleHolder >
void const * i_cast (const InterfaceID &tid) const override
 Implementation of IInterface::i_cast.
StatusCode queryInterface (const InterfaceID &ti, void **pp) override
 Implementation of IInterface::queryInterface.
std::vector< std::string > getInterfaceNames () const override
 Implementation of IInterface::getInterfaceNames.
Public Member Functions inherited from PropertyHolder< CommonMessaging< implements< IAlgorithm, IDataHandleHolder, IProperty, IStateful > > >
StatusCode setProperty (const Gaudi::Details::PropertyBase &p)
 Set the property from a property.
StatusCode setProperty (const std::string &name, const char *v)
 Special case for string literals.
StatusCode setProperty (const std::string &name, const std::string &v)
 Special case for std::string.
StatusCode setProperty (const std::string &name, const TYPE &value)
 set the property form the value
 PropertyHolder ()=default
Gaudi::Details::PropertyBase & declareProperty (Gaudi::Details::PropertyBase &prop)
 Declare a property.
Gaudi::Details::PropertyBase * declareRemoteProperty (const std::string &name, IProperty *rsvc, const std::string &rname="")
 Declare a remote property.
StatusCode setPropertyRepr (const std::string &n, const std::string &r) override
 set the property from name and value string representation
StatusCode getProperty (Gaudi::Details::PropertyBase *p) const override
 get the property
const std::vector< Gaudi::Details::PropertyBase * > & getProperties () const override
 get all properties
bool hasProperty (std::string_view name) const override
 Return true if we have a property with the given name.
Gaudi::Details::PropertyBase * property (std::string_view name) const
 \fixme property and bindPropertiesTo should be protected
void bindPropertiesTo (Gaudi::Interfaces::IOptionsSvc &optsSvc)
PropertyHolder & operator= (const PropertyHolder &)=delete
Public Member Functions inherited from CommonMessagingBase
virtual ~CommonMessagingBase ()=default
 Virtual destructor.
const SmartIF< IMessageSvc > & msgSvc () const
 The standard message service.
MsgStream & msgStream () const
 Return an uninitialized MsgStream.
MsgStream & msgStream (const MSG::Level level) const
 Predefined configurable message stream for the efficient printouts.
MsgStream & always () const
 shortcut for the method msgStream(MSG::ALWAYS)
MsgStream & fatal () const
 shortcut for the method msgStream(MSG::FATAL)
MsgStream & err () const
 shortcut for the method msgStream(MSG::ERROR)
MsgStream & error () const
 shortcut for the method msgStream(MSG::ERROR)
MsgStream & warning () const
 shortcut for the method msgStream(MSG::WARNING)
MsgStream & info () const
 shortcut for the method msgStream(MSG::INFO)
MsgStream & debug () const
 shortcut for the method msgStream(MSG::DEBUG)
MsgStream & verbose () const
 shortcut for the method msgStream(MSG::VERBOSE)
MsgStream & msg () const
 shortcut for the method msgStream(MSG::INFO)
MSG::Level msgLevel () const
 get the cached level (originally extracted from the embedded MsgStream)
bool msgLevel (MSG::Level lvl) const
 get the output level from the embedded MsgStream
Public Attributes inherited from Gaudi::Algorithm
friend AlgorithmManager
Protected Member Functions inherited from Gaudi::Algorithm
bool setAsynchronousTimeline ()
std::vector< IAlgTool * > & tools ()
bool isInitialized () const override
 Has the Algorithm already been initialized?
bool isFinalized () const override
 Has the Algorithm already been finalized?
void setIndex (const unsigned int &idx) override
 set instantiation index of Alg
bool isReEntrant () const override
Protected Member Functions inherited from DataHandleHolderBase< PropertyHolder< CommonMessaging< implements< IAlgorithm, IDataHandleHolder, IProperty, IStateful > > > >
void initDataHandleHolder ()
 initializes all handles - called by the sysInitialize method of any descendant of this
Protected Member Functions inherited from CommonMessaging< implements< IAlgorithm, IDataHandleHolder, IProperty, IStateful > >
MSG::Level setUpMessaging () const override final
 Set up local caches.
MSG::Level resetMessaging ()
 Reinitialize internal states.
void updateMsgStreamOutputLevel (int level)
 Update the output level of the cached MsgStream.
Protected Attributes inherited from Gaudi::Algorithm
std::unique_ptr< IDataHandleVisitor > m_updateDataHandles
 Hook for for derived classes to provide a custom visitor for data handles.
Protected Attributes inherited from DataHandleHolderBase< PropertyHolder< CommonMessaging< implements< IAlgorithm, IDataHandleHolder, IProperty, IStateful > > > >
DataObjIDColl m_inputDataObjs
DataObjIDColl m_outputDataObjs

Detailed Description

Example of a simple algorithm using conditions via the ConditionAccessorHolder pattern.

Definition at line 17 of file User.cpp.

Member Function Documentation

◆ execute()

StatusCode Gaudi::TestSuite::Conditions::UserAlg::execute ( const EventContext & ctx) const
inlineoverrideprivate

Definition at line 33 of file User.cpp.

33 {
34 // get the condition slot for the current event
35 const auto& condCtx = getConditionContext( ctx );
36 // get the condition value from the current condition slot.
37 const auto& cond = m_cond.get( condCtx );
38
39 info() << "got condition value " << cond << endmsg;
40
42 }
MsgStream & endmsg(MsgStream &s)
MsgStream Modifier: endmsg. Calls the output method of the MsgStream.
Definition MsgStream.h:198
MsgStream & info() const
shortcut for the method msgStream(MSG::INFO)
const ConditionContext & getConditionContext(const EventContext &ctx) const
ConditionAccessor< int > m_cond
Data member to access condition values for the current event.
Definition User.cpp:22
constexpr static const auto SUCCESS
Definition StatusCode.h:99

◆ finalize()

StatusCode Gaudi::TestSuite::Conditions::UserAlg::finalize ( )
inlineoverrideprivate

Definition at line 44 of file User.cpp.

44 {
45 info() << "finalize" << endmsg;
46
47 return base_class::finalize();
48 }
StatusCode finalize() override
the default (empty) implementation of IStateful::finalize() method
Definition Algorithm.h:181

◆ initialize()

StatusCode Gaudi::TestSuite::Conditions::UserAlg::initialize ( )
inlineoverrideprivate

Definition at line 24 of file User.cpp.

24 {
25 auto status = base_class::initialize();
26 if ( !status ) return status;
27
28 info() << "initialize" << endmsg;
29
30 return status;
31 }

Member Data Documentation

◆ m_cond

ConditionAccessor<int> Gaudi::TestSuite::Conditions::UserAlg::m_cond { this, "MyCondition", "condition/key" }
private

Data member to access condition values for the current event.

Definition at line 22 of file User.cpp.

22{ this, "MyCondition", "condition/key" };

The documentation for this class was generated from the following file:
  • GaudiTestSuite/src/ConditionAccessor/User.cpp