| The Gaudi Framework v32r1 (f65d50dc)

Public Member Functions | Private Types | Private Member Functions | Private Attributes | Friends | List of all members
Tuples::ItemStore< VALUE > Class Template Referencefinal

Simple class, which represents the local storage of N-tuple items of the given type. More...

`#include <GaudiAlg/TuplePut.h>`

Collaboration diagram for Tuples::ItemStore< VALUE >:
[legend]

## Public Member Functions
| ItemStore ()=default
| constructor : create empty map More...

## Private Types
typedef GaudiUtils::HashMap< std::string, std::unique_ptr< NTuple::Item< VALUE > > > | Store

## Private Member Functions
NTuple::Item< VALUE > * | getItem (const std::string &key, Tuples::TupleObj *tuple)
| the only one method: More...
| ItemStore (const ItemStore &)=delete
ItemStore & | operator= (const ItemStore &)=delete

## Private Attributes
Store | m_map
| the underlying map More...

## Friends
class | TupleObj

## Detailed Description

### template<class VALUE>
class Tuples::ItemStore< VALUE >

Simple class, which represents the local storage of N-tuple items of the given type.

Essentially it is a restricted GaudiUtils::HashMap with the ownership of the newly created entries

Author
  Vanya BELYAEV ibely.nosp@m.aev@.nosp@m.physi.nosp@m.cs.s.nosp@m.yr.ed.nosp@m.u

Date
  2007-04-08

Definition at line 37 of file TuplePut.h.

## Member Typedef Documentation

## ◆ Store

template<class VALUE>

typedef GaudiUtils::HashMap<std::string, std::unique_ptr<NTuple::Item<VALUE> > > Tuples::ItemStore< VALUE >::Store
| private

Definition at line 41 of file TuplePut.h.

## Constructor & Destructor Documentation

## ◆ ItemStore() [1/2]

template<class VALUE>

Tuples::ItemStore< VALUE >::ItemStore | ( |  | ) |
| default

constructor : create empty map

## ◆ ItemStore() [2/2]

template<class VALUE>

Tuples::ItemStore< VALUE >::ItemStore | ( | const ItemStore< VALUE > & |  | ) |
| private delete

## Member Function Documentation

## ◆ getItem()

template<class VALUE>

NTuple::Item<VALUE>* Tuples::ItemStore< VALUE >::getItem | ( | const std::string & | key,
|  | Tuples::TupleObj * | tuple
| ) |  |
| inline private

the only one method:

Definition at line 49 of file TuplePut.h.

49 {
50 // find the item by name
51 auto ifound = m_map.find( key );
52 // existing item?
53 if ( m_map.end() != ifound ) return ifound->second.get(); // RETURN
54 // check the tuple for booking:
55 if ( !tuple ) return nullptr;
56 // check the existence of the name
57 if ( !tuple->goodItem( key ) ) {
58 tuple->Error( "ItemStore::getItem('" + key + "') item name is not unique" ).ignore();
59 return nullptr; // RETURN
60 }
61 // get the underlying object
62 NTuple::Tuple* tup = tuple->tuple();
63 if ( !tup ) {
64 tuple->Error( "ItemStore::getItem('" + key + "') invalid NTuple::Tuple*" ).ignore();
65 return nullptr; // RETURN
66 }
67 // create new item:
68 // add the newly created item into the store:
69 auto stored = m_map.emplace( key, std::make_unique<NTuple::Item<VALUE>>() );
70 if ( !stored.second ) {
71 tuple->Warning( "ItemStore::getItem('" + key + "') item already exists, new one not inserted!" ).ignore();
72 return nullptr;
73 }
74 auto& item = stored.first->second;
75 // add it into N-tuple
76 StatusCode sc = tup->addItem( key, *item ); // ATTENTION!
77 if ( sc.isFailure() ) {
78 tuple->Error( "ItemStore::getItem('" + key + "') cannot addItem", sc ).ignore();
79 m_map.erase( stored.first );
80 return nullptr; // RETURN
81 }
82 // check the name again
83 if ( !tuple->addItem( key, System::typeinfoName( typeid( VALUE ) ) ) ) {
84 tuple->Warning( "ItemStore::getItem('" + key + "') the item not unique " ).ignore();
85 m_map.erase( stored.first );
86 return nullptr;
87 }
88 //
89 return item.get(); // RETURN
90 }
System::typeinfoName
GAUDI_API const std::string typeinfoName(const std::type_info &)
Get platform independent information about the class type.
Definition: System.cpp:298
Tuples::TupleObj::Warning
virtual StatusCode Warning(const std::string &msg, const StatusCode sc=StatusCode::FAILURE) const =0
Tuples::TupleObj::addItem
bool addItem(std::string name, std::string type)
add the item name into the list of known items
Definition: TupleObj.h:1886
GaudiUtils::Map::end
iterator end()
Definition: Map.h:130
StatusCode
This class is used for returning status codes from appropriate routines.
Definition: StatusCode.h:50
Tuples::ItemStore::m_map
Store m_map
the underlying map
Definition: TuplePut.h:98
GaudiUtils::Map::find
iterator find(const key_type &key)
Definition: Map.h:147
Tuples::TupleObj::tuple
const NTuple::Tuple * tuple() const
provide the access to underlying Gaudi N-tuple
Definition: TupleObj.h:1851
Tuples::TupleObj::Error
virtual StatusCode Error(const std::string &msg, const StatusCode sc=StatusCode::FAILURE) const =0
NTuple::Tuple
Abstract base class which allows the user to interact with the actual N tuple implementation.
Definition: NTuple.h:375
StatusCode::ignore
const StatusCode & ignore() const
Ignore/check StatusCode.
Definition: StatusCode.h:153
GaudiUtils::Map::erase
iterator erase(const_iterator pos)
Definition: Map.h:182
NTuple::Tuple::addItem
StatusCode addItem(const std::string &name, Item< TYPE > &itm)
Add a scalar data item a N tuple.
Definition: NTuple.h:503
StatusCode::isFailure
bool isFailure() const
Definition: StatusCode.h:130
NTuple::Item< VALUE >
Tuples::TupleObj::goodItem
bool goodItem(const std::string &name) const
check the uniqueness of the name
Definition: TupleObj.h:1894
GaudiUtils::Map::emplace
std::pair< iterator, bool > emplace(Args &&... args)
Definition: Map.h:164

## ◆ operator=()

template<class VALUE>

ItemStore& Tuples::ItemStore< VALUE >::operator= | ( | const ItemStore< VALUE > & |  | ) |
| private delete

## Friends And Related Function Documentation

## ◆ TupleObj

template<class VALUE>

friend class TupleObj
| friend

Definition at line 38 of file TuplePut.h.

## Member Data Documentation

## ◆ m_map

template<class VALUE>

Store Tuples::ItemStore< VALUE >::m_map
| private

the underlying map

the underlying map

Definition at line 98 of file TuplePut.h.

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

- GaudiAlg/GaudiAlg/TuplePut.h