Gaudi Framework, version v24r2

Home   Generated: Wed Dec 4 2013
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
Public Types | Public Member Functions | Private Member Functions | List of all members
TupleTool Class Reference

#include <components/TupleTool.h>

Inheritance diagram for TupleTool:
Inheritance graph
[legend]
Collaboration diagram for TupleTool:
Collaboration graph
[legend]

Public Types

typedef Tuples::Tuple Tuple
 
typedef GaudiAlg::TupleID TupleID
 
- Public Types inherited from ITupleTool
typedef Tuples::TupleID TupleID
 
typedef Tuples::Tuple Tuple
 

Public Member Functions

 TupleTool (const std::string &type, const std::string &name, const IInterface *parent)
 Standard constructor.
 
virtual ~TupleTool ()
 destructor: virtual and protected
 
virtual Tuple nTuple (const std::string &title, const CLID &clid=CLID_ColumnWiseTuple) const
 get N-tuple object ( book on-demand ) with unique identidier
 
virtual Tuple nTuple (const TupleID &ID, const std::string &title="", const CLID &clid=CLID_ColumnWiseTuple) const
 
virtual Tuple evtCol (const std::string &title, const CLID &clid=CLID_RowWiseTuple) const
 
virtual Tuple evtCol (const TupleID &ID, const std::string &title="", const CLID &clid=CLID_RowWiseTuple) const
 
- Public Member Functions inherited from ITupleTool
 DeclareInterfaceID (ITupleTool, 2, 0)
 InterfaceID.
 
- Public Member Functions inherited from IAlgTool
 DeclareInterfaceID (IAlgTool, 3, 0)
 InterfaceID.
 
virtual ~IAlgTool ()
 Virtual destructor.
 
virtual const std::stringtype () 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.
 
virtual unsigned long refCount () const =0
 Current number of reference counts.
 
- Public Member Functions inherited from INamedInterface
 DeclareInterfaceID (INamedInterface, 1, 0)
 InterfaceID.
 
virtual const std::stringname () const =0
 Retrieve the name of the instance.
 
virtual ~INamedInterface ()
 Virtual destructor (always needed for abstract classes).
 
- Public Member Functions inherited from IInterface
virtual void * i_cast (const InterfaceID &) const =0
 main cast function
 
virtual std::vector< std::stringgetInterfaceNames () const =0
 Returns a vector of strings containing the names of all the implemented interfaces.
 
virtual unsigned long addRef ()=0
 Increment the reference count of Interface instance.
 
virtual unsigned long release ()=0
 Release Interface instance.
 
virtual StatusCode queryInterface (const InterfaceID &ti, void **pp)=0
 Set the void** to the pointer to the requested interface of the instance.
 
virtual ~IInterface ()
 Virtual destructor.
 

Private Member Functions

 TupleTool ()
 
 TupleTool (const TupleTool &)
 
TupleTooloperator= (const TupleTool &)
 

Additional Inherited Members

- Static Public Member Functions inherited from GaudiTool
static bool enableSummary (bool)
 enable/disable summary
 
static bool summaryEnabled ()
 is summary enabled?
 
- Static Public Member Functions inherited from IInterface
static const InterfaceIDinterfaceID ()
 Return an instance of InterfaceID identifying the interface.
 
- Protected Types inherited from GaudiCommon< AlgTool >
typedef std::map< std::string,
StatEntity
Statistics
 the actual type of general counters
 
typedef std::map< std::string,
unsigned int
Counter
 the actual type error/warning counter
 
typedef std::vector< IAlgTool * > AlgTools
 storage for active tools
 
typedef GaudiUtils::HashMap
< std::string, SmartIF
< IService > > 
Services
 storage for active services
 
- Protected Member Functions inherited from GaudiTupleTool
 GaudiTupleTool (const std::string &type, const std::string &name, const IInterface *parent)
 standard constructor
 
virtual ~GaudiTupleTool ()
 destructor
 
virtual StatusCode initialize ()
 standard initialization method
 
virtual StatusCode finalize ()
 standard finalization method
 
- Protected Member Functions inherited from ITupleTool
virtual ~ITupleTool ()
 Destructor.
 
- Protected Attributes inherited from GaudiCommon< AlgTool >
ICounterSummarySvcm_counterSummarySvc
 a pointer to the CounterSummarySvc
 
std::vector< std::stringm_counterList
 list of counters to declare. Set by property CounterList. This can be a regular expression.
 
std::vector< std::stringm_statEntityList
 
- Static Protected Attributes inherited from GaudiCommon< AlgTool >
static const bool IgnoreRootInTES
 Simple definition to be used with the new useRootInTES argument get<TYPE> and put methods.
 
static const bool UseRootInTES
 Simple definition to be used with the new useRootInTES argument get<TYPE> and put methods.
 

Detailed Description

Author
Vanya BELYAEV Ivan..nosp@m.Bely.nosp@m.aev@i.nosp@m.tep..nosp@m.ru
Date
2004-06-28

Definition at line 20 of file TupleTool.h.

Member Typedef Documentation

Definition at line 24 of file TupleTool.h.

Definition at line 25 of file TupleTool.h.

Constructor & Destructor Documentation

TupleTool::TupleTool ( const std::string type,
const std::string name,
const IInterface parent 
)

Standard constructor.

See Also
GaudiTupleTool
GaudiHistoTool
GaudiTool
AlgTool
Parameters
typetool type (?)
nametool name
parentpointer to parent component

Definition at line 37 of file TupleTool.cpp.

: GaudiTupleTool ( type, name , parent )
{
declareInterface<ITupleTool>(this);
}
TupleTool::~TupleTool ( )
virtual

destructor: virtual and protected

Definition at line 49 of file TupleTool.cpp.

{}
TupleTool::TupleTool ( )
private
TupleTool::TupleTool ( const TupleTool )
private

Member Function Documentation

virtual Tuple TupleTool::evtCol ( const std::string title,
const CLID clid = CLID_RowWiseTuple 
) const
inlinevirtual

Implements ITupleTool.

Definition at line 77 of file TupleTool.h.

{ return GaudiTupleTool::evtCol ( title , clid ) ; }
virtual Tuple TupleTool::evtCol ( const TupleID ID,
const std::string title = "",
const CLID clid = CLID_RowWiseTuple 
) const
inlinevirtual

Implements ITupleTool.

Definition at line 82 of file TupleTool.h.

{ return GaudiTupleTool::evtCol ( ID , title , clid ) ; }
virtual Tuple TupleTool::nTuple ( const std::string title,
const CLID clid = CLID_ColumnWiseTuple 
) const
inlinevirtual

get N-tuple object ( book on-demand ) with unique identidier

Tuple tuple = tool-> nTuple( 'My tuple' ) ;
tuple->column( "A" , sin(0.1) );
tuple->column( "B" , cos(0.1) );
tuple->column( "C" , tan(0.1) );
tuple->write()

NTuple will be booked with automatically assigned numerical ID

Parameters
titleunique title for ntuple
clidclass identifier
Returns
ntuple object

Implements ITupleTool.

Definition at line 65 of file TupleTool.h.

{ return GaudiTupleTool::nTuple ( title , clid ) ; }
virtual Tuple TupleTool::nTuple ( const TupleID ID,
const std::string title = "",
const CLID clid = CLID_ColumnWiseTuple 
) const
inlinevirtual

Implements ITupleTool.

Definition at line 71 of file TupleTool.h.

{ return GaudiTupleTool::nTuple ( ID , title , clid ) ; }
TupleTool& TupleTool::operator= ( const TupleTool )
private

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

Generated at Wed Dec 4 2013 14:33:20 for Gaudi Framework, version v24r2 by Doxygen version 1.8.2 written by Dimitri van Heesch, © 1997-2004