ATLAS Offline Software
Public Member Functions | List of all members
SG::IAuxStoreIO Class Referenceabstract

Interface providing I/O for a generic auxiliary store. More...

#include <IAuxStoreIO.h>

Inheritance diagram for SG::IAuxStoreIO:
Collaboration diagram for SG::IAuxStoreIO:

Public Member Functions

virtual ~IAuxStoreIO ()
 Destructor. More...
 
virtual const void * getIOData (SG::auxid_t auxid) const =0
 Return a pointer to the data to be stored for one aux data item. More...
 
virtual const std::type_info * getIOType (SG::auxid_t auxid) const =0
 Return the type of the data to be stored for one aux data item. More...
 
virtual const SG::auxid_set_tgetDynamicAuxIDs () const =0
 Get the list of all dynamically created variables. More...
 
virtual SG::auxid_set_t getSelectedAuxIDs () const
 Get a list of dynamic variables that need to be written out. More...
 

Detailed Description

Interface providing I/O for a generic auxiliary store.

   In order to read/write the properties stored in a generic
   auxiliary store object, this interface needs to be used.
   It allows the infrastructure code to inspect the contents
   of the object, and access it in a way that allows the
   information to be passed to the persistency system.
Author
Attila Krasznahorkay Attil.nosp@m.a.Kr.nosp@m.aszna.nosp@m.hork.nosp@m.ay@ce.nosp@m.rn.c.nosp@m.h
Marcin Nowak Marci.nosp@m.n.No.nosp@m.wak@c.nosp@m.ern..nosp@m.ch
Revision
584348
Date
2014-02-20 10:21:15 +0100 (Thu, 20 Feb 2014)

Definition at line 43 of file IAuxStoreIO.h.

Constructor & Destructor Documentation

◆ ~IAuxStoreIO()

virtual SG::IAuxStoreIO::~IAuxStoreIO ( )
inlinevirtual

Destructor.

Definition at line 47 of file IAuxStoreIO.h.

47 {}

Member Function Documentation

◆ getDynamicAuxIDs()

virtual const SG::auxid_set_t& SG::IAuxStoreIO::getDynamicAuxIDs ( ) const
pure virtual

Get the list of all dynamically created variables.

Implemented in SG::AuxStoreInternal, xAOD::TAuxStore, xAOD::AuxContainerBase, xAOD::ShallowAuxContainer, xAOD::AuxInfoBase, and xAOD::RAuxStore.

◆ getIOData()

virtual const void* SG::IAuxStoreIO::getIOData ( SG::auxid_t  auxid) const
pure virtual

Return a pointer to the data to be stored for one aux data item.

Parameters
auxidThe identifier of the desired aux data item.

This will usually be a pointer to a std::vector; however, it may be something different for a standalone object.

Returns 0 and reports an error if the requested aux data item does not exist.

Implemented in SG::AuxStoreInternal, RootAuxDynStore, xAOD::TAuxStore, xAOD::AuxContainerBase, xAOD::ShallowAuxContainer, xAOD::AuxInfoBase, and xAOD::RAuxStore.

◆ getIOType()

virtual const std::type_info* SG::IAuxStoreIO::getIOType ( SG::auxid_t  auxid) const
pure virtual

Return the type of the data to be stored for one aux data item.

Parameters
auxidThe identifier of the desired aux data item.

For an aux data item of type T, this will usually be std::vector<T>. For standalone objects, however, it will usually be T; and std::vector<char> will be used instead of std::vector<bool>.

Returns 0 if the requested aux data item does not exist.

Implemented in SG::AuxStoreInternal, xAOD::TAuxStore, xAOD::AuxContainerBase, xAOD::ShallowAuxContainer, xAOD::AuxInfoBase, and xAOD::RAuxStore.

◆ getSelectedAuxIDs()

virtual SG::auxid_set_t SG::IAuxStoreIO::getSelectedAuxIDs ( ) const
inlinevirtual

Get a list of dynamic variables that need to be written out.

Reimplemented in xAOD::TAuxStore, xAOD::AuxContainerBase, xAOD::ShallowAuxContainer, xAOD::AuxInfoBase, and xAOD::RAuxStore.

Definition at line 86 of file IAuxStoreIO.h.

86  {
87  // default all are selected
88  return getDynamicAuxIDs();
89  }

The documentation for this class was generated from the following file:
SG::IAuxStoreIO::getDynamicAuxIDs
virtual const SG::auxid_set_t & getDynamicAuxIDs() const =0
Get the list of all dynamically created variables.