ATLAS Offline Software
|
Class holding a set of rings. More...
#include <RingSet_v1.h>
Public Types | |
using | TypelessConstAccessor = ConstAuxElement::TypelessConstAccessor |
template<class T , class ALLOC = AuxAllocator_t<T>> | |
using | ConstAccessor = SG::ConstAccessor< T, ALLOC > |
template<class T , class ALLOC = AuxAllocator_t<T>> | |
using | Accessor = SG::Accessor< T, ALLOC > |
template<class T , class ALLOC = AuxAllocator_t<T>> | |
using | Decorator = SG::Decorator< T, ALLOC > |
RingSet_v1 ctors: | |
typedef std::vector< float >::iterator | iterator |
typedef std::vector< float >::const_iterator | const_iterator |
const Iterator to rings Et More... | |
Public Member Functions | |
void | assign (const AuxElement &other, bool warnUnlocked=false) |
Assignment. More... | |
const SG::AuxVectorData * | container () const |
Return the container holding this element. More... | |
SG::AuxVectorData * | container () |
Return the container holding this element. More... | |
template<class T , class ALLOC = AuxAllocator_t<T>> | |
XAOD_AUXDATA_DEPRECATED Accessor< T, ALLOC >::reference_type | auxdata (const std::string &name) |
Fetch an aux data variable, as a non-const reference. More... | |
template<class T , class ALLOC = AuxAllocator_t<T>> | |
XAOD_AUXDATA_DEPRECATED Accessor< T, ALLOC >::reference_type | auxdata (const std::string &name, const std::string &clsname) |
Fetch an aux data variable, as a non-const reference. More... | |
template<class T , class ALLOC = AuxAllocator_t<T>> | |
XAOD_AUXDATA_DEPRECATED Accessor< T, ALLOC >::const_reference_type | auxdata (const std::string &name) const |
Fetch an aux data variable, as a const reference. More... | |
template<class T , class ALLOC = AuxAllocator_t<T>> | |
XAOD_AUXDATA_DEPRECATED Accessor< T, ALLOC >::const_reference_type | auxdata (const std::string &name, const std::string &clsname) const |
Fetch an aux data variable, as a const reference. More... | |
template<class T , class ALLOC = AuxAllocator_t<T>> | |
XAOD_AUXDATA_DEPRECATED Accessor< T, ALLOC >::const_reference_type | auxdataConst (const std::string &name) const |
Fetch an aux data variable, as a const reference. More... | |
template<class T , class ALLOC = AuxAllocator_t<T>> | |
XAOD_AUXDATA_DEPRECATED Accessor< T, ALLOC >::const_reference_type | auxdataConst (const std::string &name, const std::string &clsname) const |
Fetch an aux data variable, as a const reference. More... | |
template<class T , class ALLOC = AuxAllocator_t<T>> | |
XAOD_AUXDATA_DEPRECATED bool | isAvailable (const std::string &name, const std::string &clsname="") const |
Check if an aux variable is available for reading. More... | |
template<class T , class ALLOC = AuxAllocator_t<T>> | |
XAOD_AUXDATA_DEPRECATED bool | isAvailableWritable (const std::string &name, const std::string &clsname="") |
Check if an aux variable is available for writing. More... | |
template<class T , class ALLOC = AuxAllocator_t<T>> | |
XAOD_AUXDATA_DEPRECATED bool | isAvailableWritableAsDecoration (const std::string &name, const std::string &clsname="") const |
Check if an aux variable is available for writing as a decoration. More... | |
template<class T , class ALLOC = AuxAllocator_t<T>> | |
XAOD_AUXDATA_DEPRECATED Decorator< T, ALLOC >::reference_type | auxdecor (const std::string &name) const |
Fetch an aux decoration, as a non-const reference. More... | |
template<class T , class ALLOC = AuxAllocator_t<T>> | |
XAOD_AUXDATA_DEPRECATED Decorator< T, ALLOC >::reference_type | auxdecor (const std::string &name, const std::string &clsname) const |
Fetch an aux decoration, as a non-const reference. More... | |
void | makePrivateStore () |
Create a new (empty) private store for this object. More... | |
template<class U1 > | |
void | makePrivateStore (const U1 &other, bool warnUnlocked=false) |
Create a new private store for this object and copy aux data. More... | |
template<class U1 > | |
void | makePrivateStore (const U1 *other, bool warnUnlocked=false) |
Create a new private store for this object and copy aux data. More... | |
void | releasePrivateStore () |
Release and free any private store associated with this object. More... | |
void | setStore (const SG::IConstAuxStore *store) |
Set the store associated with this object. More... | |
void | setStore (SG::IAuxStore *store) |
Set the store associated with this object. More... | |
void | setStore (const DataLink< SG::IConstAuxStore > &store) |
Set the store associated with this object. More... | |
void | setConstStore (const SG::IConstAuxStore *store) |
Synonym for setStore with IConstAuxStore . More... | |
void | setNonConstStore (SG::IAuxStore *store) |
Synonym for setStore with IAuxStore . More... | |
bool | usingPrivateStore () const |
Test to see if this object is currently using a private store. More... | |
bool | usingStandaloneStore () const |
Test to see if this object is currently using a standalone store. More... | |
const SG::IConstAuxStore * | getConstStore () const |
Return the current store, as a const interface. More... | |
SG::IAuxStore * | getStore () const |
Return the current store, as a non-const interface. More... | |
void | clearCache () |
Clear the cached aux data pointers. More... | |
const SG::auxid_set_t & | getAuxIDs () const |
Return a set of identifiers for existing data items for this object. More... | |
const SG::auxid_set_t & | getDecorIDs () const |
Return a set of identifiers for decorations for this object. More... | |
bool | hasStore () const |
Return true if this object has an associated store. More... | |
bool | hasNonConstStore () const |
Return true if this object has an associated non-const store. More... | |
bool | clearDecorations () const |
Clear all decorations. More... | |
bool | trackIndices () const |
Return true if index tracking is enabled for this object. More... | |
size_t | index () const |
Return the index of this element within its container. More... | |
size_t | index () const |
Return the index of this element within its container. More... | |
RingSet_v1 ctors | |
RingSet_v1 () | |
Default empty constructor. More... | |
RingSet_v1 (const RingSet_v1 &ringset) | |
Copy constructor. More... | |
RingSet_v1 (const size_t size, const float value=0) | |
Initialize RingSet with rings std::vector assignment. More... | |
RingSet_v1 accessors: | |
float & | at (const unsigned int i) |
Get/set ring Et at ith position. More... | |
float & | operator[] (const unsigned int i) |
Get/set ring Et at ith position. More... | |
float | at (const unsigned int i) const |
Get/set ring Et at ith position. More... | |
float | operator[] (const unsigned int i) const |
Get/set ring Et at ith position. More... | |
const std::vector< float > & | ringsE () const |
Get rings holden by RingSet. More... | |
void | setRingsE (const std::vector< float > &) |
Get/set rings holden by RingSet. More... | |
RingSet_v1 rings interation: | |
unsigned | size () const |
Get rings size. More... | |
void | clear () |
clear rings More... | |
void | addRing (float r) |
add ring to RingSet More... | |
iterator | begin () |
ring begin() iterator More... | |
iterator | end () |
ring end() iterator More... | |
const_iterator | begin () const |
ring begin() const_iterator More... | |
const_iterator | end () const |
ring end() const_iterator More... | |
void | copyTo (std::vector< float > &vec) const |
Copy ringset to std::vector end: More... | |
RingSet_v1 operators overload: | |
RingSet_v1 & | operator= (const RingSet_v1 &clrings) |
Assignment Operator. More... | |
RingSet_v1 using ostream: | |
void | print (std::ostream &stream) const |
Static Public Attributes | |
static constexpr bool | supportsThinning = true |
Mark that this type supports thinning operations. More... | |
Protected Member Functions | |
bool | noPrivateData () const |
True if this element has no private data. More... | |
bool | havePrivateData () const |
True if this element currently has private data. More... | |
bool | hadPrivateData () const |
True if this element had private data before it was added to its current container. More... | |
Private Types | |
enum | PrivateStoreState : uint8_t { PrivateStoreState::NO_PRIVATE = 0, PrivateStoreState::HAVE_PRIVATE = 1, PrivateStoreState::HAD_PRIVATE = 2 } |
The current private data state. More... | |
Private Member Functions | |
void | releasePrivateStoreForDtor () |
Out-of-line portion of destructor. More... | |
void | setIndex (size_t index, SG::AuxVectorData *container) |
Set the index/container for this element. More... | |
bool | setIndexPrivate (size_t index, SG::AuxVectorData *container) |
Set the index/container for this element. More... | |
void | makePrivateStore1 (const void *other, bool warnUnlocked) |
Create a new private store for this object and copy aux data. More... | |
void | makePrivateStore1 (const AuxElement *other, bool warnUnlocked) |
Create a new private store for this object and copy aux data. More... | |
AuxElementStandaloneData * | setStore1 (const SG::IConstAuxStore *store) |
Set the store associated with this object. More... | |
void | clearAux () |
Clear all aux data associated with this element. More... | |
void | copyAux (const ConstAuxElement &other, bool warnUnlocked=false) |
Copy aux data from another object. More... | |
void | setNoPrivateData () |
Record that this element does not have private data. More... | |
void | setHavePrivateData () |
Record that this element currently has private data. More... | |
void | setHadPrivateData () |
Record that this element used to have private data. More... | |
Private Attributes | |
const SG::AuxVectorData * | m_container |
The container of which this object is an element. More... | |
size_t | m_index |
The index of this element within its container. More... | |
PrivateStoreState | m_privateStoreState |
Class holding a set of rings.
Definition at line 31 of file RingSet_v1.h.
|
inherited |
Definition at line 572 of file AuxElement.h.
typedef std::vector<float>::const_iterator xAOD::RingSet_v1::const_iterator |
const Iterator to rings Et
Definition at line 39 of file RingSet_v1.h.
|
inherited |
Definition at line 569 of file AuxElement.h.
|
inherited |
Definition at line 575 of file AuxElement.h.
typedef std::vector<float>::iterator xAOD::RingSet_v1::iterator |
Iterator to rings Et
Definition at line 37 of file RingSet_v1.h.
|
inherited |
Definition at line 566 of file AuxElement.h.
|
strongprivateinherited |
The current private data state.
Enumerator | |
---|---|
NO_PRIVATE | |
HAVE_PRIVATE | |
HAD_PRIVATE |
Definition at line 131 of file IAuxElement.h.
|
inline |
|
inline |
Copy constructor.
Definition at line 152 of file RingSet_v1.h.
Initialize RingSet with rings std::vector assignment.
Definition at line 160 of file RingSet_v1.h.
void xAOD::RingSet_v1::addRing | ( | float | r | ) |
add ring to RingSet
Definition at line 79 of file RingSet_v1.cxx.
|
inherited |
Assignment.
other | The object from which we're assigning. |
warnUnlocked | If true, then warn when we skip unlocked decorations. |
We don't copy container/index, as assignment doesn't change where this object is. However, if we have aux data, then we copy aux data if we're copying from an object that also has it; otherwise, if we're copying from an object with no aux data, then we clear ours.
Get/set ring Et at ith position.
Definition at line 42 of file RingSet_v1.cxx.
Get/set ring Et at ith position.
Definition at line 51 of file RingSet_v1.cxx.
|
inherited |
Fetch an aux data variable, as a non-const reference.
name | Name of the aux variable. |
This method has to translate from the aux data name to the internal representation each time it is called. Using this method inside of loops is discouraged; instead use the Accessor
class.
|
inherited |
Fetch an aux data variable, as a const reference.
name | Name of the aux variable. |
This method has to translate from the aux data name to the internal representation each time it is called. Using this method inside of loops is discouraged; instead use the Accessor
or ConstAccessor
classes.
|
inherited |
Fetch an aux data variable, as a non-const reference.
name | Name of the aux variable. |
clsname | The name of the associated class. May be blank. |
This method has to translate from the aux data name to the internal representation each time it is called. Using this method inside of loops is discouraged; instead use the Accessor
class.
|
inherited |
Fetch an aux data variable, as a const reference.
name | Name of the aux variable. |
clsname | The name of the associated class. May be blank. |
This method has to translate from the aux data name to the internal representation each time it is called. Using this method inside of loops is discouraged; instead use the Accessor
or ConstAccessor
classes.
|
inherited |
Fetch an aux data variable, as a const reference.
name | Name of the aux variable. |
This method has to translate from the aux data name to the internal representation each time it is called. Using this method inside of loops is discouraged; instead use the ConstAccessor
class.
|
inherited |
Fetch an aux data variable, as a const reference.
name | Name of the aux variable. |
clsname | The name of the associated class. May be blank. |
This method has to translate from the aux data name to the internal representation each time it is called. Using this method inside of loops is discouraged; instead use the ConstAccessor
class.
|
inherited |
Fetch an aux decoration, as a non-const reference.
name | Name of the aux variable. |
This method has to translate from the aux data name to the internal representation each time it is called. Using this method inside of loops is discouraged; instead use the Accessor
class.
If the container is locked, this will allow fetching only variables that do not yet exist (in which case they will be marked as decorations) or variables already marked as decorations.
|
inherited |
Fetch an aux decoration, as a non-const reference.
name | Name of the aux variable. |
clsname | The name of the associated class. May be blank. |
This method has to translate from the aux data name to the internal representation each time it is called. Using this method inside of loops is discouraged; instead use the Accessor
class.
If the container is locked, this will allow fetching only variables that do not yet exist (in which case they will be marked as decorations) or variables already marked as decorations.
RingSet_v1::iterator xAOD::RingSet_v1::begin | ( | ) |
RingSet_v1::const_iterator xAOD::RingSet_v1::begin | ( | ) | const |
void xAOD::RingSet_v1::clear | ( | ) |
clear rings
|
privateinherited |
Clear all aux data associated with this element.
If this object has no associated store, this does nothing. If the associated aux data is const, this throws ExcConstAuxData
.
Definition at line 580 of file AuxElement.cxx.
|
inherited |
Clear the cached aux data pointers.
You should call this any time something changes in the aux store that could invalidate the vector pointers.
Definition at line 339 of file AuxElement.cxx.
|
inherited |
Clear all decorations.
Erase all decorations from an associated store, restoring the state to when lock
was called.
Returns true if there were any decorations that were cleared, false if the store did not contain any decorations.
Definition at line 428 of file AuxElement.cxx.
|
inherited |
Return the container holding this element.
|
inherited |
Return the container holding this element.
|
privateinherited |
Copy aux data from another object.
other | The object from which to copy. |
warnUnlocked | If true, then warn when we skip unlocked decorations. |
If this object has no associated store, this does nothing. If the associated aux data is const, this throws ExcConstAuxData
.
All aux data items from other
are copied to this object. Any aux data items associated with this object that are not present in other
are cleared. (If other
has no aux data, then all aux data items for this object are cleared.)
Definition at line 607 of file AuxElement.cxx.
void xAOD::RingSet_v1::copyTo | ( | std::vector< float > & | vec | ) | const |
RingSet_v1::iterator xAOD::RingSet_v1::end | ( | ) |
RingSet_v1::const_iterator xAOD::RingSet_v1::end | ( | ) | const |
|
inherited |
Return a set of identifiers for existing data items for this object.
If this object has a private or standalone store, then information from that will be returned. Otherwise, if this element is part of a container, then information for the container will be returned. Otherwise, return an empty set.
Definition at line 355 of file AuxElement.cxx.
|
inherited |
Return the current store, as a const interface.
This will be non-zero if either a const or non-const store is associated with this object. This will fetch either a private or standalone store.
Definition at line 304 of file AuxElement.cxx.
|
inherited |
Return a set of identifiers for decorations for this object.
If this object has a private or standalone store, then information from that will be returned. Otherwise, if this element is part of a container, then information for the container will be returned. Otherwise, return an empty set.
Definition at line 378 of file AuxElement.cxx.
|
inherited |
Return the current store, as a non-const interface.
This will be non-zero if a non-const store is associated with this object. This will fetch either a private or standalone store.
Definition at line 319 of file AuxElement.cxx.
|
protectedinherited |
True if this element had private data before it was added to its current container.
|
inherited |
Return true if this object has an associated non-const store.
This will be true for either a private or standalone store.
Definition at line 411 of file AuxElement.cxx.
|
inherited |
Return true if this object has an associated store.
This will be true for either a private or standalone store.
Definition at line 398 of file AuxElement.cxx.
|
protectedinherited |
True if this element currently has private data.
|
inherited |
Return the index of this element within its container.
|
inherited |
Return the index of this element within its container.
Inherited from IAuxElement.
|
inherited |
Check if an aux variable is available for reading.
name | Name of the aux variable. |
clsname | The name of the associated class. May be blank. |
This method has to translate from the aux data name to the internal representation each time it is called. Using this method inside of loops is discouraged; instead use the Accessor
class.
|
inherited |
Check if an aux variable is available for writing.
name | Name of the aux variable. |
clsname | The name of the associated class. May be blank. |
This method has to translate from the aux data name to the internal representation each time it is called. Using this method inside of loops is discouraged; instead use the Accessor
class.
|
inherited |
Check if an aux variable is available for writing as a decoration.
name | Name of the aux variable. |
clsname | The name of the associated class. May be blank. |
This method has to translate from the aux data name to the internal representation each time it is called. Using this method inside of loops is discouraged; instead use the Accessor
class.
|
inherited |
Create a new (empty) private store for this object.
ExcBadPrivateStore
will be thrown if this object is already associated with a store.
Definition at line 192 of file AuxElement.cxx.
|
inherited |
Create a new private store for this object and copy aux data.
other | The object from which aux data should be copied. |
warnUnlocked | If true, then warn when we skip unlocked decorations. |
ExcBadPrivateStore
will be thrown if this object is already associated with a store.
If other
is an object that has aux data, then those data will be copied; otherwise, nothing will be done.
|
inherited |
Create a new private store for this object and copy aux data.
other | The object from which aux data should be copied. |
warnUnlocked | If true, then warn when we skip unlocked decorations. |
ExcBadPrivateStore
will be thrown if this object is already associated with a store.
If other
is an object that has aux data, then those data will be copied; otherwise, nothing will be done.
|
privateinherited |
Create a new private store for this object and copy aux data.
other | The object from which aux data should be copied. |
warnUnlocked | If true, then warn when we skip unlocked decorations. |
ExcBadPrivateStore
will be thrown if this object is already associated with a store.
This overload handles the case where other
does have aux data.
Definition at line 565 of file AuxElement.cxx.
|
privateinherited |
Create a new private store for this object and copy aux data.
other | The object from which aux data should be copied. |
warnUnlocked | If true, then warn when we skip unlocked decorations. |
ExcBadPrivateStore
will be thrown if this object is already associated with a store.
This overload handles the case where other
does not have aux data.
|
protectedinherited |
True if this element has no private data.
RingSet_v1 & xAOD::RingSet_v1::operator= | ( | const RingSet_v1 & | clrings | ) |
Assignment Operator.
Using the assignment of SG::AuxElement.
Definition at line 121 of file RingSet_v1.cxx.
Get/set ring Et at ith position.
Definition at line 47 of file RingSet_v1.cxx.
Get/set ring Et at ith position.
Definition at line 56 of file RingSet_v1.cxx.
void xAOD::RingSet_v1::print | ( | std::ostream & | stream | ) | const |
Definition at line 115 of file RingSet_v1.cxx.
|
inherited |
Release and free any private store associated with this object.
ExcBadPrivateStore
will be thrown if this object does not have a private store.
Definition at line 210 of file AuxElement.cxx.
|
privateinherited |
Out-of-line portion of destructor.
Delete a private store if we have one.
Definition at line 441 of file AuxElement.cxx.
|
inherited |
Synonym for setStore
with IConstAuxStore
.
store | The new store. |
|
privateinherited |
Record that this element used to have private data.
|
privateinherited |
Record that this element currently has private data.
|
privateinherited |
Set the index/container for this element.
index | The index of this object within the container. |
container | The container holding this object. May be null if this object is being removed from a container. |
Usually this simply sets the index and container members of this object. However, in the case where this object has an associated private store, then we need to deal with releasing the store if the object is being added to a container, or making a new store if the object is being removed from a container.
|
privateinherited |
Set the index/container for this element.
index | The index of this object within the container. |
container | The container holding this object. May be null if this object is being removed from a container. |
This is called from setIndex
when we have a private store to deal with.
Definition at line 505 of file AuxElement.cxx.
|
inherited |
Synonym for setStore
with IAuxStore
.
store | The new store. |
|
privateinherited |
Record that this element does not have private data.
|
inherited |
Set the store associated with this object.
store | The new store. |
If store is nonzero, this adds a standalone store to the object. The object must not be in a container and must not have a private store. If store is zero, this removes a standalone store.
store | Link to the new store. |
Definition at line 269 of file AuxElement.cxx.
|
inherited |
Set the store associated with this object.
store | The new store. |
If store is nonzero, this adds a standalone store to the object. The object must not be in a container and must not have a private store. If store is zero, this removes a standalone store.
Definition at line 241 of file AuxElement.cxx.
|
inherited |
Set the store associated with this object.
store | The new store. |
If store is nonzero, this adds a standalone store to the object. The object must not be in a container and must not have a private store. If store is zero, this removes a standalone store.
Definition at line 257 of file AuxElement.cxx.
|
privateinherited |
Set the store associated with this object.
store | The new store. |
Helper for setStore
. Creates the AuxElementStandaloneData
object if needed and returns it.
store | The new store. |
Helper for setStore
. Creates the @x AuxElementStandaloneData object if needed and returns it.
Definition at line 461 of file AuxElement.cxx.
unsigned xAOD::RingSet_v1::size | ( | ) | const |
Get rings size.
|
inherited |
Return true if index tracking is enabled for this object.
Always returns true. Included here to be consistent with AuxVectorBase when standalone objects may be used as template parameters.
|
inherited |
Test to see if this object is currently using a private store.
Definition at line 280 of file AuxElement.cxx.
|
inherited |
Test to see if this object is currently using a standalone store.
Test to see if this object is currently using a private store.
Definition at line 290 of file AuxElement.cxx.
|
privateinherited |
The container of which this object is an element.
Should be null if this object is not within a container, except that it may also point at a private store.
Definition at line 335 of file AuxElement.h.
|
privateinherited |
The index of this element within its container.
Should be 0 if this object is not within a container.
Definition at line 128 of file IAuxElement.h.
|
privateinherited |
Definition at line 137 of file IAuxElement.h.
|
staticconstexprinherited |
Mark that this type supports thinning operations.
See AthContainers/supportsThinning.h and AthenaPoolCnvSvc/T_AthenaPoolCnv.h. Helps guide which pool converter template will be used. If false, the default pool converter will be used rather than the aux store-specific one. Ordinary xAOD type should not touch this, but may be overridden in a derived class to handle certain special cases.
Definition at line 959 of file AuxElement.h.