| The Gaudi Framework v29r1 (5cd95fa2)

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

- Namespace List
- Namespace Members

Namespaces | Classes | Typedefs | Enumerations | Functions
Tuples Namespace Reference

General namespace for Tuple properties. More...

## Namespaces
| detail
| Local

## Classes
class | ItemStore
| Simple class, which represents the local storage of N-tuple items of the given type. More...
class | Tuple
| A simple wrapper class over standard Gaudi NTuple::Tuple facility. More...
class | TupleColumn
| Helper class which allows to extend the functionality of Tuple with possibility to use your own representation of complex objects. More...
class | TupleItem
class | TupleObj
| A simple wrapper class over standard Gaudi NTuple::Tuple facility. More...

## Typedefs
typedef GaudiAlg::ID | TupleID
| the actual type for N-Tuple identifier (HBOOK-style) More...

## Enumerations
enum | Type { NTUPLE, EVTCOL }
| the list of available types for ntuples More...
enum | ErrorCodes { InvalidTuple = 100, InvalidColumn, InvalidOperation, InvalidObject, InvalidItem, TruncateValue = 200 }
| Tuple error codes. More...

## Functions
template<class ITEM >
TupleColumn< ITEM > | make_column (std::string name, const ITEM &item)
| helper function to create 'on-the-fly' the helper object Tuples::TupleColumn More...
template<class ITEM >
TupleColumn< const ITEM * > | make_column (std::string name, const ITEM *item)
| helper function to create 'on-the-fly' the helper object Tuples::TupleColumn More...
template<class ITEM >
TupleColumn< ITEM * > | make_column (std::string name, ITEM *item)
| helper function to create 'on-the-fly' the helper object Tuples::TupleColumn More...
template<class ITEM >
TupleColumn< ITEM > | Column (std::string name, const ITEM &item)
template<class ITEM >
TupleColumn< const ITEM * > | Column (std::string name, const ITEM *item)
template<class ITEM >
TupleColumn< ITEM * > | Column (std::string name, ITEM *item)
template<class OWNER >
TupleObj * | createTupleObj (const OWNER *owner, const std::string &name, NTuple::Tuple *tuple, const CLID &clid=CLID_ColumnWiseTuple, const Tuples::Type type=Tuples::NTUPLE)
| Templated helper functions allow to avoid heavy semantics of dealing with explicit type of class TupleObjImp. More...

## Detailed Description

General namespace for Tuple properties.

Tuples.h GaudiAlg/Tuples.h helper namespace to collect useful definitions, types, constants and functions, related to manipulations with N-Tuples and event tag collections.

helper namespace to collect useful definitions, types, constants and functions, related to manipulations with N-Tuples

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

Date
  2004-01-23

Author
  Vanya BELYAEV Ivan..nosp@m.Bely.nosp@m.aev@l.nosp@m.app..nosp@m.in2p3.nosp@m..fr

Date
  2005-08-06

## Typedef Documentation

typedef GaudiAlg::ID Tuples::TupleID

the actual type for N-Tuple identifier (HBOOK-style)

Definition at line 23 of file TupleID.h.

## Enumeration Type Documentation

enum Tuples::ErrorCodes

Tuple error codes.

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

Date
  2004-01-23

Enumerator
InvalidTuple |
InvalidColumn |
InvalidOperation |
InvalidObject |
InvalidItem |
TruncateValue |

Definition at line 96 of file TupleObj.h.

96 {
97 InvalidTuple = 100,
98 InvalidColumn,
99 InvalidOperation,
100 InvalidObject,
101 InvalidItem,
102 TruncateValue = 200
103 };
Tuples::InvalidTuple
Definition: TupleObj.h:97
Tuples::InvalidItem
Definition: TupleObj.h:101
Tuples::TruncateValue
Definition: TupleObj.h:102
Tuples::InvalidOperation
Definition: TupleObj.h:99
Tuples::InvalidColumn
Definition: TupleObj.h:98
Tuples::InvalidObject
Definition: TupleObj.h:100

enum Tuples::Type

the list of available types for ntuples

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

Date
  2004-01-23

Enumerator
NTUPLE |
EVTCOL |

Definition at line 84 of file TupleObj.h.

84 {
85 NTUPLE, // Analysis nTuple
86 EVTCOL // Event Collection
87 };
Tuples::EVTCOL
Definition: TupleObj.h:86
Tuples::NTUPLE
Definition: TupleObj.h:85

## Function Documentation

template<class ITEM >

TupleColumn<ITEM> Tuples::Column | ( | std::string | name,
|  | const ITEM & | item
| ) |  |
| inline

Definition at line 318 of file Tuple.h.

319 {
320 return make_column( std::move( name ), item );
321 }
Tuples::make_column
TupleColumn< ITEM * > make_column(std::string name, ITEM *item)
helper function to create &#39;on-the-fly&#39; the helper object Tuples::TupleColumn
Definition: Tuple.h:312
std::move
T move(T...args)
template<class ITEM >

TupleColumn<const ITEM*> Tuples::Column | ( | std::string | name,
|  | const ITEM * | item
| ) |  |
| inline

Definition at line 324 of file Tuple.h.

325 {
326 return make_column( std::move( name ), item );
327 }
Tuples::make_column
TupleColumn< ITEM * > make_column(std::string name, ITEM *item)
helper function to create &#39;on-the-fly&#39; the helper object Tuples::TupleColumn
Definition: Tuple.h:312
std::move
T move(T...args)
template<class ITEM >

TupleColumn<ITEM*> Tuples::Column | ( | std::string | name,
|  | ITEM * | item
| ) |  |
| inline

Definition at line 330 of file Tuple.h.

331 {
332 return make_column( std::move( name ), item );
333 }
Tuples::make_column
TupleColumn< ITEM * > make_column(std::string name, ITEM *item)
helper function to create &#39;on-the-fly&#39; the helper object Tuples::TupleColumn
Definition: Tuple.h:312
std::move
T move(T...args)
template<class OWNER >

TupleObj* Tuples::createTupleObj | ( | const OWNER * | owner,
|  | const std::string & | name,
|  | NTuple::Tuple * | tuple,
|  | const CLID & | clid = `CLID_ColumnWiseTuple`,
|  | const Tuples::Type | type = `Tuples::NTUPLE`
| ) |  |
| inline

Templated helper functions allow to avoid heavy semantics of dealing with explicit type of class TupleObjImp.

const GaudiAlgorithm* algo = ... ;
NTuple::Tuple* tuple = ... ;
TupleObj* obj = createTupleObj( algo , " my tuple 1 " , ntuple ) ;
const GaudiTool* tool = ... ;
NTuple::Tuple* tuple2 = ... ;
TupleObj* obj2 = createTupleObj( tool , " my tuple 2 " , ntuple2 ) ;

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

Date
  2004-1-24

Definition at line 231 of file TupleDetail.h.

233 {
234 return detail::createTupleObj( detail::make_handler( owner, &OWNER::Error ),
235 detail::make_handler( owner, &OWNER::Warning ), name, tuple, clid, type );
236 }
Tuples::createTupleObj
TupleObj * createTupleObj(const OWNER *owner, const std::string &name, NTuple::Tuple *tuple, const CLID &clid=CLID_ColumnWiseTuple, const Tuples::Type type=Tuples::NTUPLE)
Templated helper functions allow to avoid heavy semantics of dealing with explicit type of class Tupl...
Definition: TupleDetail.h:231
gaudirun.type
type
Definition: gaudirun.py:133
Tuples::detail::make_handler
ErrorHandler< OBJECT, FUNCTION > make_handler(const OBJECT *object, FUNCTION function)
Templated helper functions allow to avoid heavy semantics of dealing with explicit type of class Erro...
Definition: TupleDetail.h:206
template<class ITEM >

TupleColumn<ITEM> Tuples::make_column | ( | std::string | name,
|  | const ITEM & | item
| ) |  |
| inline

helper function to create 'on-the-fly' the helper object Tuples::TupleColumn

Definition at line 294 of file Tuple.h.

295 {
296 return TupleColumn<ITEM>( std::move( name ), item );
297 }
std::move
T move(T...args)
template<class ITEM >

TupleColumn<const ITEM*> Tuples::make_column | ( | std::string | name,
|  | const ITEM * | item
| ) |  |
| inline

helper function to create 'on-the-fly' the helper object Tuples::TupleColumn

Definition at line 303 of file Tuple.h.

304 {
305 return TupleColumn<const ITEM*>( std::move( name ), item );
306 }
std::move
T move(T...args)
template<class ITEM >

TupleColumn<ITEM*> Tuples::make_column | ( | std::string | name,
|  | ITEM * | item
| ) |  |
| inline

helper function to create 'on-the-fly' the helper object Tuples::TupleColumn

Definition at line 312 of file Tuple.h.

313 {
314 return TupleColumn<ITEM*>( std::move( name ), item );
315 }
std::move
T move(T...args)