The Gaudi Framework  master (594c33fa)
IMyTool Class Referenceabstract

#include </builds/gaudi/Gaudi/GaudiAlg/src/examples/IMyTool.h>

Inheritance diagram for IMyTool:
Collaboration diagram for IMyTool:

Public Member Functions

 DeclareInterfaceID (IMyTool, 2, 0)
 InterfaceID. More...
 
virtual const std::stringmessage () const =0
 Get a message. More...
 
virtual void doIt () const =0
 Do something. More...
 
 DeclareInterfaceID (IMyTool, 2, 0)
 InterfaceID. More...
 
virtual const std::stringmessage () const =0
 Get a message. More...
 
virtual void doIt () const =0
 Do something. More...
 
- Public Member Functions inherited from IAlgTool
 DeclareInterfaceID (IAlgTool, 4, 0)
 InterfaceID. More...
 
virtual const std::stringtype () const =0
 The type of an AlgTool, meaning the concrete AlgTool class. More...
 
virtual const IInterfaceparent () const =0
 The parent of the concrete AlgTool. More...
 
virtual StatusCode configure ()=0
 Configuration (from OFFLINE to CONFIGURED). More...
 
virtual StatusCode initialize ()=0
 Initialization (from CONFIGURED to INITIALIZED). More...
 
virtual StatusCode start ()=0
 Start (from INITIALIZED to RUNNING). More...
 
virtual StatusCode stop ()=0
 Stop (from RUNNING to INITIALIZED). More...
 
virtual StatusCode finalize ()=0
 Finalize (from INITIALIZED to CONFIGURED). More...
 
virtual StatusCode terminate ()=0
 Initialization (from CONFIGURED to OFFLINE). More...
 
virtual StatusCode reinitialize ()=0
 Initialization (from INITIALIZED or RUNNING to INITIALIZED, via CONFIGURED). More...
 
virtual StatusCode restart ()=0
 Initialization (from RUNNING to RUNNING, via INITIALIZED). More...
 
virtual Gaudi::StateMachine::State FSMState () const =0
 Get the current state. More...
 
virtual StatusCode sysInitialize ()=0
 Initialization of the Tool. More...
 
virtual StatusCode sysStart ()=0
 Initialization of the Tool. More...
 
virtual StatusCode sysStop ()=0
 Initialization of the Tool. More...
 
virtual StatusCode sysFinalize ()=0
 Finalization of the Tool. More...
 
virtual StatusCode sysReinitialize ()=0
 Initialization of the Tool. More...
 
virtual StatusCode sysRestart ()=0
 Initialization of the Tool. More...
 
- Public Member Functions inherited from INamedInterface
 DeclareInterfaceID (INamedInterface, 1, 0)
 InterfaceID. More...
 
virtual const std::stringname () const =0
 Retrieve the name of the instance. More...
 
- Public Member Functions inherited from IInterface
virtual void * i_cast (const InterfaceID &) const =0
 main cast function More...
 
virtual std::vector< std::stringgetInterfaceNames () const =0
 Returns a vector of strings containing the names of all the implemented interfaces. More...
 
virtual unsigned long addRef ()=0
 Increment the reference count of Interface instance. More...
 
virtual unsigned long release ()=0
 Release Interface instance. More...
 
virtual unsigned long refCount () const =0
 Current reference count. More...
 
virtual StatusCode queryInterface (const InterfaceID &ti, void **pp)=0
 Set the void** to the pointer to the requested interface of the instance. More...
 
virtual ~IInterface ()=default
 Virtual destructor. More...
 

Additional Inherited Members

- Public Types inherited from IInterface
enum  Status : StatusCode::code_t {
  Status::FAILURE = 0, Status::SUCCESS = 1, Status::NO_INTERFACE, Status::VERSMISMATCH,
  Status::LAST_ERROR
}
 Return status. More...
 
using iid = Gaudi::InterfaceId< IInterface, 0, 0 >
 Interface ID. More...
 
using ext_iids = Gaudi::interface_list< iid >
 Extra interfaces. More...
 
- Static Public Member Functions inherited from IInterface
static const InterfaceIDinterfaceID ()
 Return an instance of InterfaceID identifying the interface. More...
 

Detailed Description

Example of an Interface of a Algorithm Tool

Author
Pere Mato

Definition at line 22 of file IMyTool.h.

Member Function Documentation

◆ DeclareInterfaceID() [1/2]

IMyTool::DeclareInterfaceID ( IMyTool  ,
,
 
)

◆ DeclareInterfaceID() [2/2]

IMyTool::DeclareInterfaceID ( IMyTool  ,
,
 
)

◆ doIt() [1/2]

virtual void IMyTool::doIt ( ) const
pure virtual

Do something.

◆ doIt() [2/2]

virtual void IMyTool::doIt ( ) const
pure virtual

Do something.

◆ message() [1/2]

virtual const std::string& IMyTool::message ( ) const
pure virtual

Get a message.

◆ message() [2/2]

virtual const std::string& IMyTool::message ( ) const
pure virtual

Get a message.


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