NTuple::TupleImp Class Reference

#include <GaudiKernel/NTupleImplementation.h>

Inheritance diagram for NTuple::TupleImp:

Collaboration diagram for NTuple::TupleImp:

Public Member Functions
INTupleItem *	i_find (const std::string &name) const override
	Internally used by abstract classes. More...
	TupleImp (std::string title)
	Standard Constructor. More...
	~TupleImp () override
	Standard Destructor. More...
ItemContainer &	items () override
	Access item container. More...
const ItemContainer &	items () const override
	Access item container (CONST) More...
const std::string &	title () const override
	Object title. More...
const INTupleItem *	find (const std::string &name) const override
	Find an item row of the Ntuple (CONST) More...
INTupleItem *	find (const std::string &name) override
	Find an item row of the Ntuple. More...
char *	buffer () override
	Access N tuple data buffer. More...
const char *	buffer () const override
	Access N tuple data buffer (CONST) More...
IConversionSvc *	conversionService () const
	Access conversion service. More...
void	setConversionService (IConversionSvc *svc)
	Access conversion service. More...
INTupleSvc *	tupleService () const
	Access conversion service. More...
void	setTupleService (INTupleSvc *svc)
	Access conversion service. More...
StatusCode	attachSelector (ISelectStatement *sel) override
	Attach selector. More...
ISelectStatement *	selector () override
	Access selector. More...
virtual char *	setBuffer (std::unique_ptr< char[]> &&buff)
	Set N tuple data buffer. More...
char *	setBuffer (char *buff) override
	Set N tuple data buffer. More...
void	reset () override
	Reset all entries to their default values. More...
StatusCode	add (INTupleItem *item) override
	Add an item row to the N tuple. More...
StatusCode	remove (INTupleItem *item) override
	Remove an item row (identified by pointer) from the N tuple. More...
StatusCode	remove (const std::string &name) override
	Remove an item row (identified by name) from the N tuple. More...
StatusCode	write () override
	Write record of the NTuple (Shortcut of writeRecord) More...
StatusCode	writeRecord () override
	Write record of the NTuple. More...
StatusCode	read () override
	Read record of the NTuple (Shortcut of readRecord) More...
StatusCode	readRecord () override
	Read record of the NTuple. More...
StatusCode	save () override
	Save the NTuple. More...
Public Member Functions inherited from NTuple::Tuple
template<class TYPE >
StatusCode	item (const std::string &name, Item< TYPE > &result)
	Locate a scalar Item of data to the N tuple type safe. More...
template<class TYPE >
StatusCode	item (const std::string &name, const Item< TYPE > &result) const
	Locate a scalar Item of data to the N tuple type safe (CONST) More...
template<class TYPE >
StatusCode	item (const std::string &name, Array< TYPE > &result)
	Locate a Array of data to the N tuple type safe. More...
template<class TYPE >
StatusCode	item (const std::string &name, const Array< TYPE > &result) const
	Locate a Array of data to the N tuple type safe (CONST) More...
template<class TYPE >
StatusCode	item (const std::string &name, Matrix< TYPE > &result)
	Locate a Matrix of data to the N tuple type safe. More...
template<class TYPE >
StatusCode	item (const std::string &name, const Matrix< TYPE > &result) const
	Locate a Matrix of data to the N tuple type safe (CONST) More...
template<class TYPE >
StatusCode	addItem (const std::string &name, Item< TYPE > &itm)
	Add a scalar data item a N tuple. More...
template<class TYPE >
StatusCode	addItem (const std::string &name, Item< TYPE * > &itm)
	Add an simple object item to an N tuple. More...
StatusCode	addItem (const std::string &name, Item< IOpaqueAddress * > &itm)
	Add an address object item to an N tuple: specialized call. More...
template<class TYPE , class RANGE >
StatusCode	addItem (const std::string &name, Item< TYPE > &itm, const RANGE low, const RANGE high)
	Add a scalar data item a N tuple with a range. More...
template<class TYPE >
StatusCode	addItem (const std::string &name, long dim, Array< TYPE > &array)
	Add an fixed-size Array of data to a column wise N tuple. More...
template<class TYPE , class RANGE >
StatusCode	addItem (const std::string &name, long dim, Array< TYPE > &array, const RANGE low, const RANGE high)
	Add an fixed-size Array of data to a column wise N tuple with a range. More...
template<class TYPE , class INDEX , class RANGE >
StatusCode	addItem (const std::string &name, Item< INDEX > &index, Array< TYPE > &array, const RANGE low, const RANGE high)
	Add an indexed Array of data to a column wise N tuple with a range. More...
template<class TYPE , class INDEX , class RANGE >
StatusCode	addIndexedItem (const std::string &name, Item< INDEX > &index, Array< TYPE > &array, const RANGE low, const RANGE high)
	Add an indexed Array of data to a column wise N tuple with a range. More...
template<class TYPE , class INDEX >
StatusCode	addItem (const std::string &name, Item< INDEX > &index, Array< TYPE > &array)
	Add an indexed Array of data to a column wise N tuple. More...
template<class TYPE , class INDEX >
StatusCode	addIndexedItem (const std::string &name, Item< INDEX > &index, Array< TYPE > &array)
	Add an indexed Array of data to a column wise N tuple. More...
template<class TYPE >
StatusCode	addItem (const std::string &name, long cols, long rows, Matrix< TYPE > &matrix)
	Add an fixed size Matrix of data to a column wise N tuple. More...
template<class TYPE , class RANGE >
StatusCode	addItem (const std::string &name, long cols, long rows, Matrix< TYPE > &result, const RANGE low, const RANGE high)
	Add an fixed size Matrix of data to a column wise N tuple. More...
template<class TYPE , class INDEX >
StatusCode	addItem (const std::string &name, Item< INDEX > &index, Matrix< TYPE > &matrix, long rows)
	Add an variable size Matrix of data to a column wise N tuple. More...
template<class TYPE , class INDEX >
StatusCode	addIndexedItem (const std::string &name, Item< INDEX > &col_index, long rows, Matrix< TYPE > &matrix)
	Add an variable size Matrix of data to a column wise N tuple. More...
template<class TYPE , class INDEX , class RANGE >
StatusCode	addItem (const std::string &name, Item< INDEX > &index, Matrix< TYPE > &matrix, long rows, const RANGE low, const RANGE high)
	Add an variable size Matrix of data to a column wise N tuple. More...
template<class TYPE , class INDEX , class RANGE >
StatusCode	addIndexedItem (const std::string &name, Item< INDEX > &index, long rows, Matrix< TYPE > &matrix, const RANGE low, const RANGE high)
	Add an variable size Matrix of data to a column wise N tuple. More...
Public Member Functions inherited from DataObject
	DataObject ()
	Standard Constructor. More...
	DataObject (const DataObject &rhs)
	Copy Constructor. More...
DataObject &	operator= (const DataObject &rhs)
	Assignment Operator. More...
	DataObject (DataObject &&rhs)
	Move Constructor. More...
DataObject &	operator= (DataObject &&rhs)
	Move Assignment Operator. More...
virtual	~DataObject ()
	Standard Destructor. More...
virtual unsigned long	addRef ()
	Add reference to object. More...
virtual unsigned long	release ()
	release reference to object More...
virtual const CLID &	clID () const
	Retrieve reference to class definition structure. More...
const std::string &	name () const
	Retreive DataObject name. It is the name when registered in the store. More...
virtual StatusCode	update ()
	Provide empty placeholder for internal object reconfiguration callback. More...
void	setRegistry (IRegistry *pRegistry)
	Set pointer to Registry. More...
IRegistry *	registry () const
	Get pointer to Registry. More...
LinkManager *	linkMgr () const
	Retrieve Link manager. More...
unsigned char	version () const
	Retrieve version number of this object representation. More...
void	setVersion (unsigned char vsn)
	Set version number of this object representation. More...
unsigned long	refCount () const
	Return the refcount. More...
virtual std::ostream &	fillStream (std::ostream &s) const
	Fill the output stream (ASCII) More...
Public Member Functions inherited from INTuple
virtual	~INTuple ()=default

Protected Attributes
ItemContainer	m_items
	Container with N tuple _Columns. More...
bool	m_isBooked = false
	Flag wether N tuple is booked. More...
std::string	m_title
	N tuple title. More...
SmartIF< ISelectStatement >	m_pSelector
	Possibly hanging selector. More...
std::unique_ptr< char[]>	m_buffer
	Buffer. More...
INTupleSvc *	m_ntupleSvc = nullptr
	Reference to N-tuple service used. More...
IConversionSvc *	m_cnvSvc = nullptr
	Reference to the conversion service used. More...

Private Member Functions
	TupleImp (const TupleImp &)=delete
	Standard Copy Constructor. More...

Additional Inherited Members
Public Types inherited from INTuple
typedef std::vector< INTupleItem * >	ItemContainer
Static Public Member Functions inherited from DataObject
static const CLID &	classID ()
	Retrieve reference to class definition structure (static access) More...
Protected Member Functions inherited from NTuple::Tuple
template<class TYPE >
StatusCode	i_item (const std::string &name, _Item< TYPE > *&result) const
	Locate a _Column of data to the N tuple type safe. More...
template<class TYPE >
StatusCode	i_item (const std::string &name, _Item< TYPE * > *&result) const
	Locate a _Column of data to the N tuple type unsafe for objects. More...
StatusCode	i_item (const std::string &name, _Item< IOpaqueAddress * > *&result) const
	Locate a _Column of data to the N tuple type safe. More...
template<class TYPE >
StatusCode	i_item (const std::string &name, _Array< TYPE > *&result) const
	Locate a _Array of data to the N tuple type safe. More...
template<class TYPE >
StatusCode	i_item (const std::string &name, _Matrix< TYPE > *&result) const
	Locate a _Matrix of data to the N tuple type safe. More...
template<class TYPE >
StatusCode	i_addItem (const std::string &name, long, const std::string &, TYPE low, TYPE high, _Item< TYPE > *&result)
	Add a _Item of data to the N tuple. More...
template<class TYPE >
StatusCode	i_addItem (const std::string &name, long dim, const std::string &index, TYPE low, TYPE high, _Array< TYPE > *&result)
	Add a _Item of data to the N tuple. More...
template<class TYPE >
StatusCode	i_addItem (const std::string &name, long dim1, long dim2, const std::string &index, TYPE low, TYPE high, _Matrix< TYPE > *&result)
	Add a _Item of data to the N tuple. More...
template<class TYPE >
StatusCode	i_addObject (const std::string &name, _Item< TYPE * > *&result, const std::type_info &)

Detailed Description

Definition at line 16 of file NTupleImplementation.h.

Constructor & Destructor Documentation

NTuple::TupleImp::TupleImp ( const TupleImp &  )

privatedelete

Standard Copy Constructor.

NTuple::TupleImp::TupleImp

(

std::string

title

)

Standard Constructor.

Definition at line 26 of file NTupleImplementation.cpp.

: m_title( std::move( title ) ) {}

NTuple::TupleImp::~TupleImp ( )

override

Standard Destructor.

Definition at line 29 of file NTupleImplementation.cpp.

                      {
    for ( auto& i : m_items ) i->release();
  }

Member Function Documentation

StatusCode NTuple::TupleImp::add ( INTupleItem *  item )

overridevirtual

Add an item row to the N tuple.

Implements INTuple.

Definition at line 55 of file NTupleImplementation.cpp.

                                              {
    if ( item ) {
      INTupleItem* i = i_find( item->name() );
      if ( !i ) {
        m_items.push_back( item );
        return StatusCode::SUCCESS;
      }
    }
    return StatusCode::FAILURE;
  }

StatusCode NTuple::TupleImp::attachSelector ( ISelectStatement *  sel )

overridevirtual

Attach selector.

Implements INTuple.

Definition at line 34 of file NTupleImplementation.cpp.

                                                             {
    m_pSelector = sel;
    return StatusCode::SUCCESS;
  }

char* NTuple::TupleImp::buffer ( )

inlineoverridevirtual

Access N tuple data buffer.

Implements INTuple.

Definition at line 57 of file NTupleImplementation.h.

{ return m_buffer.get(); }

const char* NTuple::TupleImp::buffer ( ) const

inlineoverridevirtual

Access N tuple data buffer (CONST)

Implements INTuple.

Definition at line 59 of file NTupleImplementation.h.

{ return m_buffer.get(); }

IConversionSvc* NTuple::TupleImp::conversionService ( ) const

inline

Access conversion service.

Definition at line 61 of file NTupleImplementation.h.

{ return m_cnvSvc; }

const INTupleItem* NTuple::TupleImp::find ( const std::string &  name ) const

inlineoverridevirtual

Find an item row of the Ntuple (CONST)

Implements INTuple.

Definition at line 53 of file NTupleImplementation.h.

{ return i_find( name ); }

INTupleItem* NTuple::TupleImp::find ( const std::string &  name )

inlineoverridevirtual

Find an item row of the Ntuple.

Implements INTuple.

Definition at line 55 of file NTupleImplementation.h.

{ return i_find( name ); }

INTupleItem * NTuple::TupleImp::i_find ( const std::string &  name ) const

overridevirtual

Internally used by abstract classes.

Locate a column of data to the N tuple (not type safe)

Implements INTuple.

Definition at line 48 of file NTupleImplementation.cpp.

                                                             {
    auto i = std::find_if( std::begin( m_items ), std::end( m_items ),
                           [&]( ItemContainer::const_reference j ) { return j->name() == name; } );
    return i != std::end( m_items ) ? const_cast<INTupleItem*>( *i ) : nullptr;
  }

ItemContainer& NTuple::TupleImp::items ( )

inlineoverridevirtual

Access item container.

Implements INTuple.

Definition at line 47 of file NTupleImplementation.h.

{ return m_items; }

const ItemContainer& NTuple::TupleImp::items ( ) const

inlineoverridevirtual

Access item container (CONST)

Implements INTuple.

Definition at line 49 of file NTupleImplementation.h.

{ return m_items; }

StatusCode NTuple::TupleImp::read ( )

overridevirtual

Read record of the NTuple (Shortcut of readRecord)

Read record of the NTuple.

Implements INTuple.

Definition at line 95 of file NTupleImplementation.cpp.

{ return m_ntupleSvc->readRecord( this ); }

StatusCode NTuple::TupleImp::readRecord ( )

overridevirtual

Read record of the NTuple.

Implements INTuple.

Definition at line 97 of file NTupleImplementation.cpp.

{ return m_ntupleSvc->readRecord( this ); }

StatusCode NTuple::TupleImp::remove ( INTupleItem *  item )

overridevirtual

Remove an item row (identified by pointer) from the N tuple.

Remove a column from the N-tuple.

Implements INTuple.

Definition at line 73 of file NTupleImplementation.cpp.

                                                 {
    auto i = std::find( std::begin( m_items ), std::end( m_items ), item );
    if ( i == std::end( m_items ) ) return StatusCode::FAILURE;
    m_items.erase( i );
    item->release();
    return StatusCode::SUCCESS;
  }

StatusCode NTuple::TupleImp::remove ( const std::string &  name )

overridevirtual

Remove an item row (identified by name) from the N tuple.

Remove a column from the N-tuple.

Implements INTuple.

Definition at line 67 of file NTupleImplementation.cpp.

                                                     {
    INTupleItem* i = i_find( name );
    return i ? remove( i ) : StatusCode::FAILURE;
  }

void NTuple::TupleImp::reset ( )

overridevirtual

Reset all entries to their default values.

Reset N tuple to default values.

Implements INTuple.

Definition at line 43 of file NTupleImplementation.cpp.

                       {
    for ( auto& i : m_items ) i->reset();
  }

StatusCode NTuple::TupleImp::save ( )

overridevirtual

Save the NTuple.

Implements INTuple.

Definition at line 99 of file NTupleImplementation.cpp.

{ return m_ntupleSvc->save( this ); }

ISelectStatement * NTuple::TupleImp::selector ( )

overridevirtual

Access selector.

Implements INTuple.

Definition at line 40 of file NTupleImplementation.cpp.

{ return m_pSelector.get(); }

char * NTuple::TupleImp::setBuffer ( std::unique_ptr< char[]> &&  buff )

virtual

Set N tuple data buffer.

Definition at line 81 of file NTupleImplementation.cpp.

                                                          {
    m_buffer = std::move( buff );
    return m_buffer.get();
  }

char * NTuple::TupleImp::setBuffer ( char *  buff )

overridevirtual

Set N tuple data buffer.

Implements INTuple.

Definition at line 86 of file NTupleImplementation.cpp.

                                        {
    m_buffer.reset( buff );
    return m_buffer.get();
  }

void NTuple::TupleImp::setConversionService ( IConversionSvc *  svc )

inline

Access conversion service.

Definition at line 63 of file NTupleImplementation.h.

{ m_cnvSvc = svc; }

void NTuple::TupleImp::setTupleService ( INTupleSvc *  svc )

inline

Access conversion service.

Definition at line 67 of file NTupleImplementation.h.

{ m_ntupleSvc = svc; }

const std::string& NTuple::TupleImp::title ( ) const

inlineoverridevirtual

Object title.

Implements INTuple.

Definition at line 51 of file NTupleImplementation.h.

{ return m_title; }

INTupleSvc* NTuple::TupleImp::tupleService ( ) const

inline

Access conversion service.

Definition at line 65 of file NTupleImplementation.h.

{ return m_ntupleSvc; }

StatusCode NTuple::TupleImp::write ( )

overridevirtual

Write record of the NTuple (Shortcut of writeRecord)

Write record of the NTuple.

Implements INTuple.

Definition at line 91 of file NTupleImplementation.cpp.

{ return m_ntupleSvc->writeRecord( this ); }

StatusCode NTuple::TupleImp::writeRecord ( )

overridevirtual

Write record of the NTuple.

Implements INTuple.

Definition at line 93 of file NTupleImplementation.cpp.

{ return m_ntupleSvc->writeRecord( this ); }

Member Data Documentation

std::unique_ptr<char[]> NTuple::TupleImp::m_buffer

protected

Buffer.

Definition at line 27 of file NTupleImplementation.h.

IConversionSvc* NTuple::TupleImp::m_cnvSvc = nullptr

protected

Reference to the conversion service used.

Definition at line 31 of file NTupleImplementation.h.

bool NTuple::TupleImp::m_isBooked = false

protected

Flag wether N tuple is booked.

Definition at line 21 of file NTupleImplementation.h.

ItemContainer NTuple::TupleImp::m_items

protected

Container with N tuple _Columns.

Definition at line 19 of file NTupleImplementation.h.

INTupleSvc* NTuple::TupleImp::m_ntupleSvc = nullptr

protected

Reference to N-tuple service used.

Definition at line 29 of file NTupleImplementation.h.

SmartIF<ISelectStatement> NTuple::TupleImp::m_pSelector

protected

Possibly hanging selector.

Definition at line 25 of file NTupleImplementation.h.

std::string NTuple::TupleImp::m_title

protected

N tuple title.

Definition at line 23 of file NTupleImplementation.h.

---

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

• GaudiKernel/GaudiKernel/NTupleImplementation.h
• GaudiKernel/src/Lib/NTupleImplementation.cpp