Tuples::Tuple Class Reference

A simple wrapper class over standard Gaudi NTuple::Tuple facility. More...

#include <GaudiAlg/Tuple.h>

Collaboration diagram for Tuples::Tuple:

Public Member Functions
	Tuple (TupleObj *tuple)
	standard constructor
	Tuple (const Tuple &tuple)
	copy constructor
virtual	~Tuple ()
	destructor
Tuple &	operator= (const Tuple &tuple)
	assignment operator Tuples could be assigned in a safe way
TupleObj *	operator-> () const
	get the pointer to the underlying object
bool	valid () const
	check the validity of the tuple object

Protected Member Functions
TupleObj *	tuple () const
	Return the underlying tuple object.

Private Member Functions
	Tuple ()
	default constructor is private

Private Attributes
TupleObj *	m_tuple
	The tuple object.

Detailed Description

A simple wrapper class over standard Gaudi NTuple::Tuple facility.

The main advantages of local ntuples with respect to 'standard' Gaudi NTuples ( NTuple::Tuple ) is their "locality". For 'standard' ntuples one need

1. Define all ntuple columns/items as data members of the algorithm
2. Book the NTuple::Tuple object using INTupleSvc
3. Add all defined columns/items to the booked ntuple
4. Fill ntuple records

Usually the first step is done in the header file (separate file!) of the algorithm, the second and the third steps are done in initialize() method of the algorithm and the fourth step is done somewhere in execute() method of the same algorithm. Such approach requires to keep track of the tuple structure through different method and event through different files. And even minor modification of the structure of the ntuple will require the modification of at least 2 methods and 2 files.

The Tuples::Tuple wrapper over standard Gaudi NTuple::Tuple class solves all above listed problems with "non-local" nature of Gaudi NTuple::Tuple objects.

Tuples::Tuple object is booked and used 'locally'. One does not need to pre-book the ntuple or its columns/items somewhere in different compilation units or other methods different from the actual point of using the ntuple.

The simplest example of usage Tuple object:

Tuple tuple = nTuple( "some more or less unique tuple title ");
for( Loop D0 = loop( "K- pi+", "D0" ) , D0 , ++D0 )
{
   tuple -> column ( "mass" , M  ( D0 ) / GeV ) ;
   tuple -> column ( "pt"   , PT ( D0 ) / GeV ) ;
   tuple -> column ( "p"    , P  ( D0 ) / GeV ) ;
   tuple -> write  () ;
}

One could fill some Tuple variables in one go

Tuple tuple = nTuple( "some more or less unique tuple title ");
for( Loop D0 = loop( "K- pi+", "D0" ) , D0 , ++D0 )
{
   tuple -> column ( "mass"      , M  ( D0 ) / GeV ) ;
   tuple -> fill   ( "pt , p "   , PT ( D0 ) / GeV , P(D0) / GeV ) ;
   tuple -> write  () ;
}

Even ALL variables could be filled in one go:

Tuple tuple = nTuple( "some more or less unique tuple title ");
for( Loop D0 = loop( "K- pi+", "D0" ) , D0 , ++D0 )
{
   tuple -> fill   ( "mass pt , p ", M(D0)/GeV,PT(D0)/GeV,P(D0)/GeV ) ;
   tuple -> write  () ;
}

All these techniques could be easily combined in arbitrary ways

See Also

GaudiTupleAlg

TupleObj

Author

Vanya BELYAEV Ivan..nosp@m.Bely.nosp@m.aev@i.nosp@m.tep..nosp@m.ru

Date

2003-02-24

Definition at line 115 of file Tuple.h.

Constructor & Destructor Documentation

Tuples::Tuple::Tuple

(

Tuples::TupleObj *

tuple

)

standard constructor

Standard constructor.

Parameters

tuple

pointer to "real" tuple object

Definition at line 24 of file Tuple.cpp.

  : m_tuple( tuple )
{
  if( 0 != m_tuple ) { m_tuple -> addRef () ; }
}

Tuples::Tuple::Tuple

(

const Tuple &

tuple

)

copy constructor

Definition at line 35 of file Tuple.cpp.

  : m_tuple ( tuple.m_tuple )
{
  if( 0 != m_tuple ) { m_tuple ->addRef() ; }
}

Tuples::Tuple::~Tuple ( )

virtual

destructor

Definition at line 68 of file Tuple.cpp.

{
  if( 0 != m_tuple ) { m_tuple->release() ; }
}

Tuples::Tuple::Tuple ( )

private

default constructor is private

Member Function Documentation

TupleObj* Tuples::Tuple::operator-> ( ) const

inline

get the pointer to the underlying object

Returns

pointer to underlying TupleObj

Definition at line 140 of file Tuple.h.

{ return      tuple () ; }

Tuples::Tuple & Tuples::Tuple::operator=

(

const Tuple &

tuple

)

assignment operator Tuples could be assigned in a safe way

Parameters

tuple

tuple to be assigned

Definition at line 48 of file Tuple.cpp.

{
  // self assigenment
  if( &tuple == this ) { return *this; }
  // temporary variable
  Tuples::TupleObj* tmp = tuple.m_tuple ;
  // increse reference count
  if( 0 !=    tmp  ) { tmp     -> addRef  () ; }
  // decrease reference count
  if( 0 != m_tuple ) { m_tuple -> release () ; }
  // assign
  m_tuple = tmp ;
  //
  return *this ;
}

TupleObj* Tuples::Tuple::tuple ( ) const

inlineprotected

Return the underlying tuple object.

Definition at line 148 of file Tuple.h.

{ return m_tuple ; }

bool Tuples::Tuple::valid ( ) const

inline

check the validity of the tuple object

Definition at line 143 of file Tuple.h.

{ return 0 != tuple () ; }

Member Data Documentation

TupleObj* Tuples::Tuple::m_tuple

private

The tuple object.

Definition at line 158 of file Tuple.h.

---

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

• /afs/cern.ch/sw/Gaudi/releases/GAUDI/GAUDI_v23r6/GaudiAlg/GaudiAlg/Tuple.h
• /afs/cern.ch/sw/Gaudi/releases/GAUDI/GAUDI_v23r6/GaudiAlg/src/lib/Tuple.cpp