Interface for a tool or service that returns a list of leaves (paths) in a transient store. More...

#include </builds/gaudi/Gaudi/GaudiKernel/include/GaudiKernel/IDataStoreLeaves.h>

Inheritance diagram for IDataStoreLeaves:

[legend]

Collaboration diagram for IDataStoreLeaves:

[legend]

Public Types
typedef std::vector< DataObject * >	LeavesList
	Returned type.

Public Types inherited from IInterface
enum class	Status : StatusCode::code_t { FAILURE = 0 , SUCCESS = 1 , NO_INTERFACE , VERSMISMATCH , LAST_ERROR }
	Return status. More...

using	iid = Gaudi::InterfaceId<IInterface, 0, 0>
	Interface ID.

using	ext_iids = Gaudi::interface_list<iid>
	Extra interfaces.

Public Member Functions
	DeclareInterfaceID (IDataStoreLeaves, 1, 0)
	InterfaceID.

virtual const LeavesList &	leaves () const =0
	Return the list of leaves.

Public Member Functions inherited from IAlgTool
	DeclareInterfaceID (IAlgTool, 4, 0)
	InterfaceID.

virtual const std::string &	type () const =0
	The type of an AlgTool, meaning the concrete AlgTool class.

virtual const IInterface *	parent () const =0
	The parent of the concrete AlgTool.

virtual StatusCode	configure ()=0
	Configuration (from OFFLINE to CONFIGURED).

virtual StatusCode	initialize ()=0
	Initialization (from CONFIGURED to INITIALIZED).

virtual StatusCode	start ()=0
	Start (from INITIALIZED to RUNNING).

virtual StatusCode	stop ()=0
	Stop (from RUNNING to INITIALIZED).

virtual StatusCode	finalize ()=0
	Finalize (from INITIALIZED to CONFIGURED).

virtual StatusCode	terminate ()=0
	Initialization (from CONFIGURED to OFFLINE).

virtual StatusCode	reinitialize ()=0
	Initialization (from INITIALIZED or RUNNING to INITIALIZED, via CONFIGURED).

virtual StatusCode	restart ()=0
	Initialization (from RUNNING to RUNNING, via INITIALIZED).

virtual Gaudi::StateMachine::State	FSMState () const =0
	Get the current state.

virtual StatusCode	sysInitialize ()=0
	Initialization of the Tool.

virtual StatusCode	sysStart ()=0
	Initialization of the Tool.

virtual StatusCode	sysStop ()=0
	Initialization of the Tool.

virtual StatusCode	sysFinalize ()=0
	Finalization of the Tool.

virtual StatusCode	sysReinitialize ()=0
	Initialization of the Tool.

virtual StatusCode	sysRestart ()=0
	Initialization of the Tool.

Public Member Functions inherited from INamedInterface
	DeclareInterfaceID (INamedInterface, 1, 0)
	InterfaceID.

virtual const std::string &	name () const =0
	Retrieve the name of the instance.

Public Member Functions inherited from IInterface
template<Gaudi::IsInterface TARGET>
TARGET *	cast ()

template<Gaudi::IsInterface TARGET>
TARGET const *	cast () const

template<typename TARGET> requires ( !Gaudi::IsInterface<TARGET> )
TARGET *	cast ()

template<typename TARGET> requires ( !Gaudi::IsInterface<TARGET> )
TARGET const *	cast () const

virtual std::vector< std::string >	getInterfaceNames () const =0
	Returns a vector of strings containing the names of all the implemented interfaces.

virtual unsigned long	addRef () const =0
	Increment the reference count of Interface instance.

virtual unsigned long	release () const =0
	Release Interface instance.

virtual unsigned long	refCount () const =0
	Current reference count.

virtual StatusCode	queryInterface (const InterfaceID &ti, void **pp)=0
	Set the void** to the pointer to the requested interface of the instance.

virtual	~IInterface ()=default
	Virtual destructor.

virtual void const *	i_cast (const InterfaceID &) const =0

void *	i_cast (const InterfaceID &iid)

Additional Inherited Members
Static Public Member Functions inherited from IInterface
static const InterfaceID &	interfaceID ()
	Return an instance of InterfaceID identifying the interface.

Protected Member Functions inherited from IInterface
virtual unsigned long	decRef () const =0
	Decrement reference count and return the new reference count.

Detailed Description

Interface for a tool or service that returns a list of leaves (paths) in a transient store.

Author: Marco Clemencic

Definition at line 23 of file IDataStoreLeaves.h.

Member Typedef Documentation

◆ LeavesList

typedef std::vector<DataObject*> IDataStoreLeaves::LeavesList

Returned type.

Definition at line 30 of file IDataStoreLeaves.h.

Member Function Documentation

◆ DeclareInterfaceID()

IDataStoreLeaves::DeclareInterfaceID	(	IDataStoreLeaves	,
		1	,
		0	)

InterfaceID.

◆ leaves()

virtual const LeavesList & IDataStoreLeaves::leaves ( ) const

pure virtual

Return the list of leaves.

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

GaudiKernel/include/GaudiKernel/IDataStoreLeaves.h

Public Types