Class describing a Vertex. More...

#include <Vertex_v1.h>

Inheritance diagram for xAOD::Vertex_v1:

Collaboration diagram for xAOD::Vertex_v1:

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>

Public Member Functions
	Vertex_v1 ()
	Default constructor.
	Vertex_v1 (const Vertex_v1 &other)
	Copy constructor.
Vertex_v1 &	operator= (const Vertex_v1 &tp)
	Assignment operator. This can involve creating and copying an Auxilary store, and so should be used sparingly.
Type::ObjectType	type () const
	A little helper function for identifying the type in template code.
float	x () const
	Returns the x position.
void	setX (float value)
	Sets the x position.
float	y () const
	Returns the y position.
void	setY (float value)
	Sets the y position.
float	z () const
	Returns the z position.
void	setZ (float value)
	Sets the z position.
float	time () const
	Returns the time.
void	setTime (float value)
	Sets the time.
float	timeResolution () const
	Returns the time resolution.
void	setTimeResolution (float value)
	Sets the time resolution.
uint8_t	hasValidTime () const
	Returns whether or not the vertex has a valid time.
void	setHasValidTime (uint8_t value)
	Sets whether or not the vertex has a valid time.
const std::vector< float > &	covariance () const
	Returns the covariance matrix as a simple vector of values.
void	setCovariance (const std::vector< float > &value)
	Sets the covariance matrix as a simple vector of values.
const Amg::Vector3D &	position () const
	Returns the 3-pos.
void	setPosition (const Amg::Vector3D &position)
	Sets the 3-position.
const	AmgSymMatrix (3) &covariancePosition() const
	Returns the vertex covariance matrix.
void	setCovariancePosition (const AmgSymMatrix(3)&covariancePosition)
	Sets the vertex covariance matrix.
VxType::VertexType	vertexType () const
	The type of the vertex.
void	setVertexType (VxType::VertexType vType)
	Set the type of the vertex.
std::vector< Trk::VxTrackAtVertex > &	vxTrackAtVertex ()
	Non-const access to the VxTrackAtVertex vector.
const std::vector< Trk::VxTrackAtVertex > &	vxTrackAtVertex () const
	Const access to the vector of tracks fitted to the vertex (may not exist!)
bool	vxTrackAtVertexAvailable () const
	Check if VxTrackAtVertices are attached to the object.
void	resetCache ()
	Reset the internal cache of the object.
void	assign (const AuxElement &other, bool warnUnlocked=false)
	Assignment.
const SG::AuxVectorData *	container () const
	Return the container holding this element.
SG::AuxVectorData *	container ()
	Return the container holding this element.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
void	makePrivateStore ()
	Create a new (empty) private store for this object.
template<class U1>
void	makePrivateStore (const U1 &other, bool warnUnlocked=false)
	Create a new private store for this object and copy aux data.
template<class U1>
void	makePrivateStore (const U1 *other, bool warnUnlocked=false)
	Create a new private store for this object and copy aux data.
void	releasePrivateStore ()
	Release and free any private store associated with this object.
void	setStore (const SG::IConstAuxStore *store)
	Set the store associated with this object.
void	setStore (SG::IAuxStore *store)
	Set the store associated with this object.
void	setStore (const DataLink< SG::IConstAuxStore > &store)
	Set the store associated with this object.
void	setConstStore (const SG::IConstAuxStore *store)
	Synonym for `setStore` with `IConstAuxStore`.
void	setNonConstStore (SG::IAuxStore *store)
	Synonym for `setStore` with `IAuxStore`.
bool	usingPrivateStore () const
	Test to see if this object is currently using a private store.
bool	usingStandaloneStore () const
	Test to see if this object is currently using a standalone store.
const SG::IConstAuxStore *	getConstStore () const
	Return the current store, as a const interface.
SG::IAuxStore *	getStore () const
	Return the current store, as a non-const interface.
void	clearCache ()
	Clear the cached aux data pointers.
const SG::auxid_set_t &	getAuxIDs () const
	Return a set of identifiers for existing data items for this object.
const SG::auxid_set_t &	getDecorIDs () const
	Return a set of identifiers for decorations for this object.
bool	hasStore () const
	Return true if this object has an associated store.
bool	hasNonConstStore () const
	Return true if this object has an associated non-const store.
bool	clearDecorations () const
	Clear all decorations.
bool	trackIndices () const
	Return true if index tracking is enabled for this object.
size_t	index () const
	Return the index of this element within its container.

Static Public Attributes
static constexpr bool	supportsThinning = true
	Mark that this type supports thinning operations.

Protected Member Functions
bool	noPrivateData () const
	True if this element has no private data.
bool	havePrivateData () const
	True if this element currently has private data.
bool	hadPrivateData () const
	True if this element had private data before it was added to its current container.

Private Types
enum class	PrivateStoreState : uint8_t { NO_PRIVATE = 0 , HAVE_PRIVATE = 1 , HAD_PRIVATE = 2 }
	The current private data state. More...

Private Member Functions
void	releasePrivateStoreForDtor ()
	Out-of-line portion of destructor.
void	setIndex (size_t index, SG::AuxVectorData *container)
	Set the index/container for this element.
bool	setIndexPrivate (size_t index, SG::AuxVectorData *container)
	Set the index/container for this element.
void	makePrivateStore1 (const void *other, bool warnUnlocked)
	Create a new private store for this object and copy aux data.
void	makePrivateStore1 (const AuxElement *other, bool warnUnlocked)
	Create a new private store for this object and copy aux data.
AuxElementStandaloneData *	setStore1 (const SG::IConstAuxStore *store)
	Set the store associated with this object.
void	clearAux ()
	Clear all aux data associated with this element.
void	copyAux (const ConstAuxElement &other, bool warnUnlocked=false)
	Copy aux data from another object.
void	setNoPrivateData ()
	Record that this element does not have private data.
void	setHavePrivateData ()
	Record that this element currently has private data.
void	setHadPrivateData ()
	Record that this element used to have private data.

Static Private Member Functions
static void	clearAuxHelper (AuxVectorData &container, size_t index)
	Clear all aux data associated with an element.
static void	copyAuxHelper (AuxVectorData &container, size_t index, const ConstAuxElement &other, bool warnUnlocked)
	Copy aux data from another object.

Private Attributes
CxxUtils::CachedValue< Amg::Vector3D >	m_position
	Cached position of the vertex.
CxxUtils::CachedValue< AmgSymMatrix(3)>	m_covariance
	Cached covariance of the vertex.
const SG::AuxVectorData *	m_container
	The container of which this object is an element.
size_t	m_index
	The index of this element within its container.
PrivateStoreState	m_privateStoreState

Track particle contents operations
typedef std::vector< ElementLink< xAOD::TrackParticleContainer > >	TrackParticleLinks_t
	Type for the associated track particles.
typedef std::vector< ElementLink< xAOD::NeutralParticleContainer > >	NeutralParticleLinks_t
	Type for the associated neutral particles.
const TrackParticleLinks_t &	trackParticleLinks () const
	Get all the particles associated with the vertex.
void	setTrackParticleLinks (const TrackParticleLinks_t &trackParticles)
	Set all track particle links at once.
const std::vector< float > &	trackWeights () const
	Get all the track weights.
void	setTrackWeights (const std::vector< float > &weights)
	Set all the track weights.
const NeutralParticleLinks_t &	neutralParticleLinks () const
	Get all the particles associated with the vertex.
void	setNeutralParticleLinks (const NeutralParticleLinks_t &neutralParticles)
	Set all neutral particle links at once.
const std::vector< float > &	neutralWeights () const
	Get all the neutral weights.
void	setNeutralWeights (const std::vector< float > &weights)
	Set all the neutral weights.
const TrackParticle *	trackParticle (size_t i) const
	Get the pointer to a given track that was used in vertex reco.
float	trackWeight (size_t i) const
	Get the weight of a given track in the vertex reconstruction.
size_t	nTrackParticles () const
	Get the number of tracks associated with this vertex.
const NeutralParticle *	neutralParticle (size_t i) const
	Get the pointer to a given neutral that was used in vertex reco.
float	neutralWeight (size_t i) const
	Get the weight of a given neutral in the vertex reconstruction.
size_t	nNeutralParticles () const
	Get the number of neutrals associated with this vertex.
void	addTrackAtVertex (const ElementLink< TrackParticleContainer > &tr, float weight=1.0)
	Add a new track to the vertex.
void	addNeutralAtVertex (const ElementLink< NeutralParticleContainer > &tr, float weight=1.0)
	Add a new neutral to the vertex.
void	clearTracks ()
	Remove all tracks from the vertex.
void	clearNeutrals ()
	Remove all neutrals from the vertex.

Fit quality functions
float	chiSquared () const
	Returns the \( \chi^2 \) of the vertex fit as float.
float	numberDoF () const
	Returns the number of degrees of freedom of the vertex fit as float.
void	setFitQuality (float chiSquared, float numberDoF)
	Set the 'Fit Quality' information.

Detailed Description

Class describing a Vertex.

Author: Kirill Prokofiev Kiril.nosp@m.l.Pr.nosp@m.okofe.nosp@m.v@ce.nosp@m.rn.ch; Attila Krasznahorkay Attil.nosp@m.a.Kr.nosp@m.aszna.nosp@m.hork.nosp@m.ay@ce.nosp@m.rn.c.nosp@m.h; Ruslan Mashinistov Rusla.nosp@m.n.Ma.nosp@m.shini.nosp@m.stov.nosp@m.@cern.nosp@m..ch

Definition at line 42 of file Vertex_v1.h.

Member Typedef Documentation

◆ Accessor

template<class T, class ALLOC = AuxAllocator_t<T>>

using SG::AuxElement::Accessor = SG::Accessor<T, ALLOC>

inherited

Definition at line 572 of file AuxElement.h.

◆ ConstAccessor

template<class T, class ALLOC = AuxAllocator_t<T>>

using SG::AuxElement::ConstAccessor = SG::ConstAccessor<T, ALLOC>

inherited

Definition at line 569 of file AuxElement.h.

◆ Decorator

template<class T, class ALLOC = AuxAllocator_t<T>>

using SG::AuxElement::Decorator = SG::Decorator<T, ALLOC>

inherited

Definition at line 575 of file AuxElement.h.

◆ NeutralParticleLinks_t

typedef std::vector< ElementLink< xAOD::NeutralParticleContainer > > xAOD::Vertex_v1::NeutralParticleLinks_t

Type for the associated neutral particles.

Definition at line 141 of file Vertex_v1.h.

◆ TrackParticleLinks_t

typedef std::vector< ElementLink< xAOD::TrackParticleContainer > > xAOD::Vertex_v1::TrackParticleLinks_t

Type for the associated track particles.

Definition at line 128 of file Vertex_v1.h.

◆ TypelessConstAccessor

using SG::AuxElement::TypelessConstAccessor = ConstAuxElement::TypelessConstAccessor

inherited

Definition at line 566 of file AuxElement.h.

Member Enumeration Documentation

◆ PrivateStoreState

enum class SG::IAuxElement::PrivateStoreState : uint8_t

strongprivateinherited

The current private data state.

Enumerator
NO_PRIVATE
HAVE_PRIVATE
HAD_PRIVATE

Definition at line 131 of file IAuxElement.h.

  {
    NO_PRIVATE = 0,
    HAVE_PRIVATE = 1,
    HAD_PRIVATE = 2,
  };

Constructor & Destructor Documentation

◆ Vertex_v1() [1/2]

xAOD::Vertex_v1::Vertex_v1 ( )

Default constructor.

Definition at line 19 of file Vertex_v1.cxx.

      : SG::AuxElement(),
        m_position(),
        m_covariance() {
 
   }

◆ Vertex_v1() [2/2]

xAOD::Vertex_v1::Vertex_v1 ( const Vertex_v1 & other )

Copy constructor.

Definition at line 26 of file Vertex_v1.cxx.

      : SG::AuxElement(other),
        m_position( other.m_position ),
        m_covariance( other.m_covariance ){
      //copy aux store content (only the stuffs already loaded in memory!)
      this->makePrivateStore( other );
   }

Member Function Documentation

◆ addNeutralAtVertex()

void xAOD::Vertex_v1::addNeutralAtVertex	(	const ElementLink< NeutralParticleContainer > &	tr,
		float	weight = 1.0 )

Add a new neutral to the vertex.

Definition at line 323 of file Vertex_v1.cxx.

                                               {
 
      neutralAcc( *this ).push_back( tr );
      weightNeutralAcc( *this ).push_back( weight );
      return;
   }

◆ addTrackAtVertex()

void xAOD::Vertex_v1::addTrackAtVertex	(	const ElementLink< TrackParticleContainer > &	tr,
		float	weight = 1.0 )

Add a new track to the vertex.

Definition at line 314 of file Vertex_v1.cxx.

                                               {
 
      trackAcc( *this ).push_back( tr );
      weightTrackAcc( *this ).push_back( weight );
      return;
   }

◆ AmgSymMatrix()

const xAOD::Vertex_v1::AmgSymMatrix ( 3 ) const &

Returns the vertex covariance matrix.

◆ assign()

void SG::AuxElement::assign	(	const AuxElement &	other,
		bool	warnUnlocked = false )

inherited

Assignment.

Parameters

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.

◆ auxdata() [1/4]

template<class T, class ALLOC = AuxAllocator_t<T>>

XAOD_AUXDATA_DEPRECATED Accessor< T, ALLOC >::reference_type SG::AuxElement::auxdata ( const std::string & name )

inherited

Fetch an aux data variable, as a non-const reference.

Parameters

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.

◆ auxdata() [2/4]

template<class T, class ALLOC = AuxAllocator_t<T>>

XAOD_AUXDATA_DEPRECATED Accessor< T, ALLOC >::const_reference_type SG::AuxElement::auxdata ( const std::string & name ) const

inherited

Fetch an aux data variable, as a const reference.

Parameters

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.

◆ auxdata() [3/4]

template<class T, class ALLOC = AuxAllocator_t<T>>

XAOD_AUXDATA_DEPRECATED Accessor< T, ALLOC >::reference_type SG::AuxElement::auxdata	(	const std::string &	name,
		const std::string &	clsname )

inherited

Fetch an aux data variable, as a non-const reference.

Parameters

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.

◆ auxdata() [4/4]

template<class T, class ALLOC = AuxAllocator_t<T>>

XAOD_AUXDATA_DEPRECATED Accessor< T, ALLOC >::const_reference_type SG::AuxElement::auxdata	(	const std::string &	name,
		const std::string &	clsname ) const

inherited

Fetch an aux data variable, as a const reference.

Parameters

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.

◆ auxdataConst() [1/2]

template<class T, class ALLOC = AuxAllocator_t<T>>

XAOD_AUXDATA_DEPRECATED Accessor< T, ALLOC >::const_reference_type SG::AuxElement::auxdataConst ( const std::string & name ) const

inherited

Fetch an aux data variable, as a const reference.

Parameters

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.

◆ auxdataConst() [2/2]

template<class T, class ALLOC = AuxAllocator_t<T>>

XAOD_AUXDATA_DEPRECATED Accessor< T, ALLOC >::const_reference_type SG::AuxElement::auxdataConst	(	const std::string &	name,
		const std::string &	clsname ) const

inherited

Fetch an aux data variable, as a const reference.

Parameters

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.

◆ auxdecor() [1/2]

template<class T, class ALLOC = AuxAllocator_t<T>>

XAOD_AUXDATA_DEPRECATED Decorator< T, ALLOC >::reference_type SG::AuxElement::auxdecor ( const std::string & name ) const

inherited

Fetch an aux decoration, as a non-const reference.

Parameters

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.

◆ auxdecor() [2/2]

template<class T, class ALLOC = AuxAllocator_t<T>>

XAOD_AUXDATA_DEPRECATED Decorator< T, ALLOC >::reference_type SG::AuxElement::auxdecor	(	const std::string &	name,
		const std::string &	clsname ) const

inherited

Fetch an aux decoration, as a non-const reference.

Parameters

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.

◆ chiSquared()

float xAOD::Vertex_v1::chiSquared ( ) const

Returns the \( \chi^2 \) of the vertex fit as float.

◆ clearAux()

void SG::AuxElement::clearAux ( )

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.

{
  if (!m_container) return;
  clearAuxHelper (*container(), index());
}

◆ clearAuxHelper()

void SG::AuxElement::clearAuxHelper	(	AuxVectorData &	container,
		size_t	index )

staticprivateinherited

Clear all aux data associated with an element.

Parameters

container	Container of the element.
index	Index of this element within the container.

If the associated aux data is const, this throws ExcConstAuxData.

Definition at line 639 of file AuxElement.cxx.

{
  if (!container.hasStore()) return;
  if (!container.hasNonConstStore()) {
    throw SG::ExcConstAuxData ("clearAux", SG::null_auxid);
  }
 
  SG::AuxTypeRegistry& r = SG::AuxTypeRegistry::instance();
  for (SG::auxid_t auxid : container.getWritableAuxIDs()) {
    r.clear (auxid, container, index, 1);
  }
}

◆ clearCache()

void SG::AuxElement::clearCache ( )

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.

{
  if (container())
    container()->clearCache();
}

◆ clearDecorations()

bool SG::AuxElement::clearDecorations ( ) const

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.

{
  if (havePrivateData())
    return m_container->clearDecorations();
  return false;
}

◆ clearNeutrals()

void xAOD::Vertex_v1::clearNeutrals ( )

Remove all neutrals from the vertex.

Definition at line 338 of file Vertex_v1.cxx.

                                 {
 
      neutralAcc( *this ).clear();
      weightNeutralAcc( *this ).clear();
      return;
   }

◆ clearTracks()

void xAOD::Vertex_v1::clearTracks ( )

Remove all tracks from the vertex.

Definition at line 331 of file Vertex_v1.cxx.

                               {
 
      trackAcc( *this ).clear();
      weightTrackAcc( *this ).clear();
      return;
   }

◆ container() [1/2]

SG::AuxVectorData * SG::AuxElement::container ( )

inherited

Return the container holding this element.

◆ container() [2/2]

const SG::AuxVectorData * SG::AuxElement::container ( ) const

inherited

Return the container holding this element.

◆ copyAux()

void SG::AuxElement::copyAux	(	const ConstAuxElement &	other,
		bool	warnUnlocked = false )

privateinherited

Copy aux data from another object.

Parameters

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 600 of file AuxElement.cxx.

{
  if (!m_container) return;
  copyAuxHelper (*container(), index(), other, warnUnlocked);
}

◆ copyAuxHelper()

void SG::AuxElement::copyAuxHelper	(	AuxVectorData &	container,
		size_t	index,
		const ConstAuxElement &	other,
		bool	warnUnlocked )

staticprivateinherited

Copy aux data from another object.

Parameters

container	Container of the element.
index	Index of this element within the container.
other	The object from which to copy.
warnUnlocked	If true, then warn when we skip unlocked decorations.

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 667 of file AuxElement.cxx.

{
  if (!container.hasStore()) return;
  if (!container.hasNonConstStore())
    throw SG::ExcConstAuxData ("copyAux");
 
  const SG::AuxVectorData* ocont = other.container();
 
  if (!ocont || !ocont->hasStore()) {
    AuxElement::clearAuxHelper (container, index);
    return;
  }
 
#ifndef XAOD_STANDALONE
  const SG::auxid_set_t& other_decors = ocont->getDecorIDs();
#endif
  SG::auxid_set_t other_ids = ocont->getAuxIDs();
 
  size_t oindex = other.index();
  SG::AuxTypeRegistry& r = SG::AuxTypeRegistry::instance();
 
  for (SG::auxid_t auxid : other_ids) {
#ifndef XAOD_STANDALONE
    if (other_decors.test (auxid)) {
      // Don't copy decorations --- another thread may be modifying them.
      other_ids.reset (auxid);
      // Warn if we skip a decoration (except for mcEventWeights,
      // for which this is expected).
      if (warnUnlocked && r.getName(auxid) != "mcEventWeights") {
        std::ostringstream ss;
        ss << "skipped unlocked decoration " << r.getName(auxid)
           << " (" << auxid << ")";
        ATHCONTAINERS_WARNING("copyAux", ss.str());
      }
    }
    else
#endif
    if (!r.isLinked (auxid)) {
      r.copy (auxid, container, index, *ocont, oindex, 1);
    }
  }
 
  for (SG::auxid_t auxid : container.getWritableAuxIDs()) {
    if (!other_ids.test (auxid)) {
      r.clear (auxid, container, index, 1);
    }
  }
}

◆ covariance()

const std::vector< float > & xAOD::Vertex_v1::covariance ( ) const

Returns the covariance matrix as a simple vector of values.

◆ getAuxIDs()

const SG::auxid_set_t & SG::AuxElement::getAuxIDs ( ) 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.

{
#ifdef ATHCONTAINERS_R21_COMPAT
  if (havePrivateData())
    return m_container->getConstStore()->getAuxIDs();
  if (container())
    return container()->getAuxIDs();
  static const SG::auxid_set_t null_set;
  return null_set;
#else
  return ConstAuxElement::getAuxIDs();
#endif
}

◆ getConstStore()

const SG::IConstAuxStore * SG::AuxElement::getConstStore ( ) const

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.

{
  if (havePrivateData()) {
    return m_container->getConstStore();
  }
  return 0;
}

◆ getDecorIDs()

const SG::auxid_set_t & SG::AuxElement::getDecorIDs ( ) const

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.

{
#ifdef ATHCONTAINERS_R21_COMPAT
  if (havePrivateData())
    return m_container->getConstStore()->getDecorIDs();
  if (container())
    return container()->getDecorIDs();
  static const SG::auxid_set_t null_set;
  return null_set;
#else
  return ConstAuxElement::getDecorIDs();
#endif
}

◆ getStore()

SG::IAuxStore * SG::AuxElement::getStore ( ) const

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.

{
  if (havePrivateData()) {
#ifdef ATHCONTAINERS_R21_COMPAT
    SG::AuxVectorData* container_nc ATLAS_THREAD_SAFE = m_container;
#else
    SG::AuxVectorData* container_nc ATLAS_THREAD_SAFE = const_cast<SG::AuxVectorData*>(container());
#endif
    return container_nc->getStore();
  }
  return 0;
}

◆ hadPrivateData()

bool SG::IAuxElement::hadPrivateData ( ) const

protectedinherited

True if this element had private data before it was added to its current container.

◆ hasNonConstStore()

bool SG::AuxElement::hasNonConstStore ( ) const

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.

{
  if (havePrivateData())
    return m_container->hasNonConstStore();
  return false;
}

◆ hasStore()

bool SG::AuxElement::hasStore ( ) const

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.

{
  if (havePrivateData())
    return m_container->hasStore();
  return false;
}

◆ hasValidTime()

uint8_t xAOD::Vertex_v1::hasValidTime ( ) const

Returns whether or not the vertex has a valid time.

◆ havePrivateData()

bool SG::IAuxElement::havePrivateData ( ) const

protectedinherited

True if this element currently has private data.

◆ index()

size_t SG::IAuxElement::index ( ) const

inherited

Return the index of this element within its container.

Inherited from IAuxElement.

◆ isAvailable()

template<class T, class ALLOC = AuxAllocator_t<T>>

XAOD_AUXDATA_DEPRECATED bool SG::AuxElement::isAvailable	(	const std::string &	name,
		const std::string &	clsname = "" ) const

inherited

Check if an aux variable is available for reading.

Parameters

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.

◆ isAvailableWritable()

template<class T, class ALLOC = AuxAllocator_t<T>>

XAOD_AUXDATA_DEPRECATED bool SG::AuxElement::isAvailableWritable	(	const std::string &	name,
		const std::string &	clsname = "" )

inherited

Check if an aux variable is available for writing.

Parameters

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.

◆ isAvailableWritableAsDecoration()

template<class T, class ALLOC = AuxAllocator_t<T>>

XAOD_AUXDATA_DEPRECATED bool SG::AuxElement::isAvailableWritableAsDecoration	(	const std::string &	name,
		const std::string &	clsname = "" ) const

inherited

Check if an aux variable is available for writing as a decoration.

Parameters

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.

◆ makePrivateStore() [1/3]

void SG::AuxElement::makePrivateStore ( )

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.

{
  if (m_container) {
    throw SG::ExcBadPrivateStore ("store already exists");
  }
 
  m_container = new SG::AuxElementPrivateData;
  IAuxElement::setIndex (0);
  IAuxElement::setHavePrivateData();
}

◆ makePrivateStore() [2/3]

template<class U1>

void SG::AuxElement::makePrivateStore	(	const U1 &	other,
		bool	warnUnlocked = false )

inherited

Create a new private store for this object and copy aux data.

Parameters

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.

◆ makePrivateStore() [3/3]

template<class U1>

void SG::AuxElement::makePrivateStore	(	const U1 *	other,
		bool	warnUnlocked = false )

inherited

Create a new private store for this object and copy aux data.

Parameters

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.

◆ makePrivateStore1() [1/2]

void SG::AuxElement::makePrivateStore1	(	const AuxElement *	other,
		bool	warnUnlocked )

privateinherited

Create a new private store for this object and copy aux data.

Parameters

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.

{
  makePrivateStore();
  if (other)
    this->copyAux (*other, warnUnlocked);
}

◆ makePrivateStore1() [2/2]

void SG::AuxElement::makePrivateStore1	(	const void *	other,
		bool	warnUnlocked )

privateinherited

Create a new private store for this object and copy aux data.

Parameters

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.

◆ neutralParticle()

const NeutralParticle * xAOD::Vertex_v1::neutralParticle ( size_t i ) const

Get the pointer to a given neutral that was used in vertex reco.

Definition at line 280 of file Vertex_v1.cxx.

                                                                     {
 
      if( ! neutralAcc.isAvailable( *this ) ) {
         return nullptr;
      }
      if( ( neutralAcc( *this ).size() <= i ) ||
          ( ! neutralAcc( *this )[ i ].isValid() ) ) {
         return nullptr;
      }
 
      return ( *( neutralAcc( *this )[ i ] ) );
   }

◆ neutralParticleLinks()

const NeutralParticleLinks_t & xAOD::Vertex_v1::neutralParticleLinks ( ) const

Get all the particles associated with the vertex.

◆ neutralWeight()

float xAOD::Vertex_v1::neutralWeight ( size_t i ) const

Get the weight of a given neutral in the vertex reconstruction.

Definition at line 293 of file Vertex_v1.cxx.

                                                  {
 
      if( weightNeutralAcc( *this ).size() <= i ) {
         return -1.0;
      }
      return weightNeutralAcc( *this )[ i ];
   }

◆ neutralWeights()

const std::vector< float > & xAOD::Vertex_v1::neutralWeights ( ) const

Get all the neutral weights.

◆ nNeutralParticles()

size_t xAOD::Vertex_v1::nNeutralParticles ( ) const

Get the number of neutrals associated with this vertex.

Definition at line 301 of file Vertex_v1.cxx.

                                             {
 
      if( ! neutralAcc.isAvailable( *this ) ) {
         return 0;
      }
 
      return neutralAcc( *this ).size();
   }

◆ noPrivateData()

bool SG::IAuxElement::noPrivateData ( ) const

protectedinherited

True if this element has no private data.

◆ nTrackParticles()

size_t xAOD::Vertex_v1::nTrackParticles ( ) const

Get the number of tracks associated with this vertex.

Definition at line 270 of file Vertex_v1.cxx.

                                           {
 
      if( ! trackAcc.isAvailable( *this ) ) {
         return 0;
      }
 
      return trackAcc( *this ).size();
   }

◆ numberDoF()

float xAOD::Vertex_v1::numberDoF ( ) const

Returns the number of degrees of freedom of the vertex fit as float.

◆ operator=()

Vertex_v1 & xAOD::Vertex_v1::operator= ( const Vertex_v1 & tp )

Assignment operator. This can involve creating and copying an Auxilary store, and so should be used sparingly.

Definition at line 34 of file Vertex_v1.cxx.

                                                        {
 
      // Check if anything needs to be done:
      if( this == &tp ) {
         return *this;
      }
 
      // If the object doesn't have an auxiliary store yet, make a private
      // one for it:
      if( ( ! hasStore() ) && ( ! container() ) ) {
         makePrivateStore();
      }
 
      // copy the cache
      m_position = tp.m_position;
      m_covariance = tp.m_covariance;
 
      // Now let the base class copy the auxiliary contents:
      SG::AuxElement::operator=( tp );
 
      // Return the object:
      return *this;
   }

◆ position()

const Amg::Vector3D & xAOD::Vertex_v1::position ( ) const

Returns the 3-pos.

◆ releasePrivateStore()

void SG::AuxElement::releasePrivateStore ( )

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.

{
  if (hadPrivateData()) {
    // We had a private store, but it was released because this object
    // was added to a container.  Just forget about it.
    IAuxElement::setNoPrivateData();
    return;
  }
 
  if (!havePrivateData() ||
      !m_container ||
      typeid(*m_container) != typeid(AuxElementPrivateData))
  {
    throw SG::ExcBadPrivateStore ("no private store exists");
  }
 
  IAuxElement::setIndex (0);
  IAuxElement::setNoPrivateData();
  delete m_container;
  m_container = 0;
}

◆ releasePrivateStoreForDtor()

void SG::AuxElement::releasePrivateStoreForDtor ( )

privateinherited

Out-of-line portion of destructor.

Delete a private store if we have one.

Definition at line 441 of file AuxElement.cxx.

{
#ifdef ATHCONTAINERS_R21_COMPAT
  if (havePrivateData()) {
    delete m_container;
  }
#else
  ConstAuxElement::releasePrivateStoreForDtor();
#endif
}

◆ resetCache()

void xAOD::Vertex_v1::resetCache ( )

Reset the internal cache of the object.

Definition at line 348 of file Vertex_v1.cxx.

                              {
      m_position.reset();
      m_covariance.reset();
      return;
   }

◆ setConstStore()

void SG::AuxElement::setConstStore ( const SG::IConstAuxStore * store )

inherited

Synonym for setStore with IConstAuxStore.

Parameters

store The new store.

◆ setCovariance()

void xAOD::Vertex_v1::setCovariance ( const std::vector< float > & value )

Sets the covariance matrix as a simple vector of values.

◆ setCovariancePosition()

void xAOD::Vertex_v1::setCovariancePosition ( const AmgSymMatrix(3)& covariancePosition )

Sets the vertex covariance matrix.

◆ setFitQuality()

void xAOD::Vertex_v1::setFitQuality	(	float	chiSquared,
		float	numberDoF )

Set the 'Fit Quality' information.

Definition at line 150 of file Vertex_v1.cxx.

                                                                    {
 
      static const Accessor< float > acc1( "chiSquared" );
      static const Accessor< float > acc2( "numberDoF" );
      acc1( *this ) = chiSquared;
      acc2( *this ) = numberDoF;
 
      return;
   }

◆ setHadPrivateData()

void SG::IAuxElement::setHadPrivateData ( )

privateinherited

Record that this element used to have private data.

◆ setHasValidTime()

void xAOD::Vertex_v1::setHasValidTime ( uint8_t value )

Sets whether or not the vertex has a valid time.

◆ setHavePrivateData()

void SG::IAuxElement::setHavePrivateData ( )

privateinherited

Record that this element currently has private data.

◆ setIndex()

void SG::AuxElement::setIndex	(	size_t	index,
		SG::AuxVectorData *	container )

privateinherited

Set the index/container for this element.

Parameters

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.

◆ setIndexPrivate()

bool SG::AuxElement::setIndexPrivate	(	size_t	index,
		SG::AuxVectorData *	container )

privateinherited

Set the index/container for this element.

Parameters

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.

{
#ifdef ATHCONTAINERS_R21_COMPAT
  if (hadPrivateData()) {
    // We had a private store, but it was released because we were added
    // to a container.
 
    if (container == 0) {
      // We're being moved out of the container.  Make a new private
      // store, copy the data, and switch to it.
      auto privateData = new SG::AuxElementPrivateData;
      AuxElement to (privateData, 0);
      to.copyAux (*this);
      IAuxElement::setIndex (0);
      IAuxElement::setHavePrivateData();
      m_container = privateData;
      return true;
    }
  }
  else if (havePrivateData() &&
           typeid(*m_container) == typeid(AuxElementPrivateData))
  {
    // We currently have a private store.
 
    if (container != 0 && container != m_container) {
      // We're being added to a container.
      // Aux data has already been copied.
      // Release private store.
      IAuxElement::setIndex (index);
      IAuxElement::setHadPrivateData();
      delete m_container;
      m_container = container;
      return false;
    }
  }
  else {
    // We have a standalone store.
    throw SG::ExcBadPrivateStore ("Attempt to add/remove a standalone object "
                                  "from a container.");
  }
 
  IAuxElement::setIndex (index);
  m_container = container;
  return false;
#else
  return ConstAuxElement::setIndexPrivate (index, container);
#endif
}

◆ setNeutralParticleLinks()

void xAOD::Vertex_v1::setNeutralParticleLinks ( const NeutralParticleLinks_t & neutralParticles )

Set all neutral particle links at once.

◆ setNeutralWeights()

void xAOD::Vertex_v1::setNeutralWeights ( const std::vector< float > & weights )

Set all the neutral weights.

◆ setNonConstStore()

void SG::AuxElement::setNonConstStore ( SG::IAuxStore * store )

inherited

Synonym for setStore with IAuxStore.

Parameters

store The new store.

◆ setNoPrivateData()

void SG::IAuxElement::setNoPrivateData ( )

privateinherited

Record that this element does not have private data.

◆ setPosition()

void xAOD::Vertex_v1::setPosition ( const Amg::Vector3D & position )

Sets the 3-position.

◆ setStore() [1/3]

void SG::AuxElement::setStore ( const DataLink< SG::IConstAuxStore > & store )

inherited

Set the store associated with this object.

Parameters

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.

Parameters

store Link to the new store.

Definition at line 269 of file AuxElement.cxx.

{
  AuxElementStandaloneData* data = setStore1 (store);
  if (store)
    data->setStore (store);
}

◆ setStore() [2/3]

void SG::AuxElement::setStore ( const SG::IConstAuxStore * store )

inherited

Set the store associated with this object.

Parameters

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.

{
  AuxElementStandaloneData* data = setStore1 (store);
  if (store)
    data->setStore (store);
}

◆ setStore() [3/3]

void SG::AuxElement::setStore ( SG::IAuxStore * store )

inherited

Set the store associated with this object.

Parameters

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.

{
  AuxElementStandaloneData* data = setStore1 (store);
  if (store)
    data->setStore (store);
}

◆ setStore1()

AuxElementStandaloneData * SG::AuxElement::setStore1 ( const SG::IConstAuxStore * store )

privateinherited

Set the store associated with this object.

Parameters

store The new store.

Helper for setStore. Creates the AuxElementStandaloneData object if needed and returns it.

Parameters

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.

{
  if (store) {
    // Want this object be standalone.
    if (!m_container) {
      // Not in a container (and no private store).  Make a new object.
      AuxElementStandaloneData* data = new AuxElementStandaloneData;
      IAuxElement::setHavePrivateData();
      m_container = data;
      return data;
    }
    if (usingStandaloneStore()) {
      // Standalone --- return existing object.
      return static_cast<AuxElementStandaloneData*> (container());
    }
    // Otherwise, it's an error.
    throw ExcBadPrivateStore ("Attempt to attach a standalone store to an "
                              "object in a container or with a private store.");
  }
 
  else {
    // Getting rid of a standalone store.
    if (usingStandaloneStore()) {
      IAuxElement::setNoPrivateData();
      delete m_container;
      m_container = 0;
    }
    else if (m_container != 0)
      throw ExcBadPrivateStore ("Attempt to remove a standalone store from an "
                                "object in a container or with a private store.");
    return 0;
  }
}

◆ setTime()

void xAOD::Vertex_v1::setTime ( float value )

Sets the time.

◆ setTimeResolution()

void xAOD::Vertex_v1::setTimeResolution ( float value )

Sets the time resolution.

◆ setTrackParticleLinks()

void xAOD::Vertex_v1::setTrackParticleLinks ( const TrackParticleLinks_t & trackParticles )

Set all track particle links at once.

◆ setTrackWeights()

void xAOD::Vertex_v1::setTrackWeights ( const std::vector< float > & weights )

Set all the track weights.

◆ setVertexType()

void xAOD::Vertex_v1::setVertexType ( VxType::VertexType vType )

Set the type of the vertex.

◆ setX()

void xAOD::Vertex_v1::setX ( float value )

Sets the x position.

◆ setY()

void xAOD::Vertex_v1::setY ( float value )

Sets the y position.

◆ setZ()

void xAOD::Vertex_v1::setZ ( float value )

Sets the z position.

◆ time()

float xAOD::Vertex_v1::time ( ) const

Returns the time.

◆ timeResolution()

float xAOD::Vertex_v1::timeResolution ( ) const

Returns the time resolution.

◆ trackIndices()

bool SG::AuxElement::trackIndices ( ) const

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.

◆ trackParticle()

setTrackWeights setNeutralWeights const TrackParticle * xAOD::Vertex_v1::trackParticle ( size_t i ) const

Get the pointer to a given track that was used in vertex reco.

Definition at line 249 of file Vertex_v1.cxx.

                                                                 {
 
      if( ! trackAcc.isAvailable( *this ) ) {
         return nullptr;
      }
      if( ( trackAcc( *this ).size() <= i ) ||
          ( ! trackAcc( *this )[ i ].isValid() ) ) {
         return nullptr;
      }
 
      return ( *( trackAcc( *this )[ i ] ) );
   }

◆ trackParticleLinks()

const TrackParticleLinks_t & xAOD::Vertex_v1::trackParticleLinks ( ) const

Get all the particles associated with the vertex.

◆ trackWeight()

float xAOD::Vertex_v1::trackWeight ( size_t i ) const

Get the weight of a given track in the vertex reconstruction.

Definition at line 262 of file Vertex_v1.cxx.

                                                {
 
      if( weightTrackAcc( *this ).size() <= i ) {
         return -1.0;
      }
      return weightTrackAcc( *this )[ i ];
   }

◆ trackWeights()

const std::vector< float > & xAOD::Vertex_v1::trackWeights ( ) const

Get all the track weights.

◆ type()

Type::ObjectType xAOD::Vertex_v1::type ( ) const

A little helper function for identifying the type in template code.

Definition at line 58 of file Vertex_v1.cxx.

                                        {
 
      return Type::Vertex;
   }

◆ usingPrivateStore()

bool SG::AuxElement::usingPrivateStore ( ) const

inherited

Test to see if this object is currently using a private store.

Definition at line 280 of file AuxElement.cxx.

{
  return havePrivateData() && 
    typeid(*m_container) == typeid(AuxElementPrivateData);
}

◆ usingStandaloneStore()

bool SG::AuxElement::usingStandaloneStore ( ) const

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.

{
  return havePrivateData() &&
    typeid(*m_container) == typeid(AuxElementStandaloneData);
}

◆ vertexType()

VxType::VertexType xAOD::Vertex_v1::vertexType ( ) const

The type of the vertex.

◆ vxTrackAtVertex() [1/2]

std::vector< Trk::VxTrackAtVertex > & xAOD::Vertex_v1::vxTrackAtVertex ( )

Non-const access to the VxTrackAtVertex vector.

This function can be used to attach an Athena-only, reconstruction specific information to the object.

The data is attached as a dynamic auxiliary property. And it needs to be explicitly disabled for writing out, as we don't have a valid dictionary for it. Not to mention that these objects are very large.

Returns: A modifiable object, creating it if necessary

Definition at line 181 of file Vertex_v1.cxx.

                                                               {
 
      return vxVertAcc( *this );
   }

◆ vxTrackAtVertex() [2/2]

const std::vector< Trk::VxTrackAtVertex > & xAOD::Vertex_v1::vxTrackAtVertex ( ) const

Const access to the vector of tracks fitted to the vertex (may not exist!)

This function can be used to access the Athena-only, reconstruction specific decoration on the object.

Keep in mind that this decoration is not available for most of the vertices. When calling this function on an object that doesn't have this decoration, an exception will be thrown. Use the vxTrackAtVertexAvailable() function to check if this function will succeed or not.

Returns: A constant reference to the decoration

Definition at line 198 of file Vertex_v1.cxx.

                                    {
 
      return vxVertAcc( *this );
   }

◆ vxTrackAtVertexAvailable()

bool xAOD::Vertex_v1::vxTrackAtVertexAvailable ( ) const

Check if VxTrackAtVertices are attached to the object.

This function can be used to check whether this Athena-only, reconstruction-specific decoration is available on the object.

In most cases it isn't.

Returns: The availablility of the decoration

Definition at line 209 of file Vertex_v1.cxx.

                                                  {
 
      return vxVertAcc.isAvailable( *this );
   }

◆ x()

float xAOD::Vertex_v1::x ( ) const

Returns the x position.

◆ y()

float xAOD::Vertex_v1::y ( ) const

Returns the y position.

◆ z()

float xAOD::Vertex_v1::z ( ) const

Returns the z position.

Member Data Documentation

◆ m_container

const SG::AuxVectorData* SG::ConstAuxElement::m_container

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.

◆ m_covariance

CxxUtils::CachedValue<AmgSymMatrix(3)> xAOD::Vertex_v1::m_covariance

private

Cached covariance of the vertex.

Definition at line 193 of file Vertex_v1.h.

◆ m_index

size_t SG::IAuxElement::m_index

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.

◆ m_position

CxxUtils::CachedValue<Amg::Vector3D> xAOD::Vertex_v1::m_position

private

Cached position of the vertex.

Definition at line 191 of file Vertex_v1.h.

◆ m_privateStoreState

PrivateStoreState SG::IAuxElement::m_privateStoreState

privateinherited

Definition at line 137 of file IAuxElement.h.

◆ supportsThinning

bool SG::AuxElement::supportsThinning = true

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.

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

Public Types

Public Member Functions

Static Public Attributes

Protected Member Functions

Private Types

Private Member Functions

Static Private Member Functions

Private Attributes

Track particle contents operations

Fit quality functions

Detailed Description

Member Typedef Documentation

◆ Accessor

◆ ConstAccessor

◆ Decorator

◆ NeutralParticleLinks_t

◆ TrackParticleLinks_t

◆ TypelessConstAccessor

Member Enumeration Documentation

◆ PrivateStoreState

Constructor & Destructor Documentation

◆ Vertex_v1() [1/2]

◆ Vertex_v1() [2/2]

Member Function Documentation

◆ addNeutralAtVertex()

◆ addTrackAtVertex()

◆ AmgSymMatrix()

◆ assign()

◆ auxdata() [1/4]

◆ auxdata() [2/4]

◆ auxdata() [3/4]

◆ auxdata() [4/4]

◆ auxdataConst() [1/2]

◆ auxdataConst() [2/2]

◆ auxdecor() [1/2]

◆ auxdecor() [2/2]

◆ chiSquared()

◆ clearAux()

◆ clearAuxHelper()

◆ clearCache()

◆ clearDecorations()

◆ clearNeutrals()

◆ clearTracks()

◆ container() [1/2]

◆ container() [2/2]

◆ copyAux()

◆ copyAuxHelper()

◆ covariance()

◆ getAuxIDs()

◆ getConstStore()

◆ getDecorIDs()

◆ getStore()

◆ hadPrivateData()

◆ hasNonConstStore()

◆ hasStore()

◆ hasValidTime()

◆ havePrivateData()

◆ index()

◆ isAvailable()

◆ isAvailableWritable()

◆ isAvailableWritableAsDecoration()

◆ makePrivateStore() [1/3]

◆ makePrivateStore() [2/3]

◆ makePrivateStore() [3/3]

◆ makePrivateStore1() [1/2]

◆ makePrivateStore1() [2/2]

◆ neutralParticle()

◆ neutralParticleLinks()

◆ neutralWeight()

◆ neutralWeights()

◆ nNeutralParticles()

◆ noPrivateData()

◆ nTrackParticles()

◆ numberDoF()

◆ operator=()

◆ position()

◆ releasePrivateStore()

◆ releasePrivateStoreForDtor()

◆ resetCache()

◆ setConstStore()