The Gaudi Framework  master (ff829712)
Loading...
Searching...
No Matches
IDataStreamTool Class Referenceabstract

#include <GaudiKernel/IDataStreamTool.h>

Inheritance diagram for IDataStreamTool:
Collaboration diagram for IDataStreamTool:

Public Types

typedef std::vector< std::string > StreamSpecs
 
typedef long size_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 (IDataStreamTool, 2, 0)
 InterfaceID.
 
virtual StatusCode initializeStream (EventSelectorDataStream *)=0
 
virtual StatusCode finalizeStream (EventSelectorDataStream *)=0
 
virtual StatusCode getNextStream (const EventSelectorDataStream *&, size_type &)=0
 
virtual StatusCode getPreviousStream (const EventSelectorDataStream *&, size_type &)=0
 
virtual StatusCode addStream (const std::string &)=0
 
virtual StatusCode addStreams (const StreamSpecs &)=0
 
virtual StatusCode eraseStream (const std::string &)=0
 
virtual EventSelectorDataStreamgetStream (size_type)=0
 
virtual EventSelectorDataStreamgetStream (const std::string &)=0
 
virtual EventSelectorDataStreamlastStream ()=0
 
virtual size_type size ()=0
 
virtual StatusCode clear ()=0
 
- 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 IInterfaceparent () 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)
 

Protected Member Functions

virtual StatusCode createSelector (const std::string &, const std::string &, IEvtSelector *&)=0
 
virtual StatusCode createStream (const std::string &, const std::string &, EventSelectorDataStream *&)=0
 
- Protected Member Functions inherited from IInterface
virtual unsigned long decRef () const =0
 Decrement reference count and return the new reference count.
 

Additional Inherited Members

- Static Public Member Functions inherited from IInterface
static const InterfaceIDinterfaceID ()
 Return an instance of InterfaceID identifying the interface.
 

Detailed Description

Author
Andres Felipe Osorio Oliveros
Marco Clemencic
Date
2006-09-21

Definition at line 27 of file IDataStreamTool.h.

Member Typedef Documentation

◆ size_type

Definition at line 33 of file IDataStreamTool.h.

◆ StreamSpecs

typedef std::vector<std::string> IDataStreamTool::StreamSpecs

Definition at line 32 of file IDataStreamTool.h.

Member Function Documentation

◆ addStream()

virtual StatusCode IDataStreamTool::addStream ( const std::string & )
pure virtual

◆ addStreams()

virtual StatusCode IDataStreamTool::addStreams ( const StreamSpecs & )
pure virtual

◆ clear()

virtual StatusCode IDataStreamTool::clear ( )
pure virtual

◆ createSelector()

virtual StatusCode IDataStreamTool::createSelector ( const std::string & ,
const std::string & ,
IEvtSelector *&  )
protectedpure virtual

◆ createStream()

virtual StatusCode IDataStreamTool::createStream ( const std::string & ,
const std::string & ,
EventSelectorDataStream *&  )
protectedpure virtual

◆ DeclareInterfaceID()

IDataStreamTool::DeclareInterfaceID ( IDataStreamTool ,
2 ,
0  )

◆ eraseStream()

virtual StatusCode IDataStreamTool::eraseStream ( const std::string & )
pure virtual

◆ finalizeStream()

virtual StatusCode IDataStreamTool::finalizeStream ( EventSelectorDataStream * )
pure virtual

◆ getNextStream()

virtual StatusCode IDataStreamTool::getNextStream ( const EventSelectorDataStream *& ,
size_type &  )
pure virtual

◆ getPreviousStream()

virtual StatusCode IDataStreamTool::getPreviousStream ( const EventSelectorDataStream *& ,
size_type &  )
pure virtual

◆ getStream() [1/2]

virtual EventSelectorDataStream * IDataStreamTool::getStream ( const std::string & )
pure virtual

◆ getStream() [2/2]

virtual EventSelectorDataStream * IDataStreamTool::getStream ( size_type )
pure virtual

◆ initializeStream()

virtual StatusCode IDataStreamTool::initializeStream ( EventSelectorDataStream * )
pure virtual

◆ lastStream()

virtual EventSelectorDataStream * IDataStreamTool::lastStream ( )
pure virtual

◆ size()

virtual size_type IDataStreamTool::size ( )
pure virtual

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