| # Gaudi Framework, version v25r0 |

Home |  | Generated: Mon Feb 17 2014

- Main Page
- Related Pages
- Modules
- Namespaces
- Classes
- Files

- Class List
- Class Index
- Class Hierarchy
- Class Members

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:
[legend]
Collaboration diagram for TupleTool:
[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::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.
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::string & | name () 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::string > | getInterfaceNames () 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 &)
TupleTool & | operator= (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 InterfaceID & | interfaceID ()
| 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 >
ICounterSummarySvc * | m_counterSummarySvc
| a pointer to the CounterSummarySvc
std::vector< std::string > | m_counterList
| list of counters to declare. Set by property CounterList. This can be a regular expression.
std::vector< std::string > | m_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

typedef Tuples::Tuple TupleTool::Tuple

Definition at line 24 of file TupleTool.h.

typedef GaudiAlg::TupleID TupleTool::TupleID

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

  type | tool type (?)
  name | tool name
  parent | pointer to parent component

Definition at line 33 of file TupleTool.cpp.

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

TupleTool::~TupleTool | ( |  | ) |
| virtual

destructor: virtual and protected

Definition at line 45 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
| inline virtual

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
| inline virtual

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
| inline virtual

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

ITupleTool* tool = .. ;
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

  title | unique title for ntuple
  clid | class 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
| inline virtual

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:

- /afs/cern.ch/sw/Gaudi/releases/GAUDI/GAUDI_v25r0/GaudiAlg/src/components/TupleTool.h
- /afs/cern.ch/sw/Gaudi/releases/GAUDI/GAUDI_v25r0/GaudiAlg/src/components/TupleTool.cpp