#include <VarHandleKeyArray.h>

Inheritance diagram for SG::VarHandleKeyArrayCommon< Base >:

Collaboration diagram for SG::VarHandleKeyArrayCommon< Base >:

Public Member Functions
	VarHandleKeyArrayCommon ()
	default base Constructor of mixin More...

	VarHandleKeyArrayCommon (const std::vector< Base > &v)
	base Constructor that takes a vector More...

	VarHandleKeyArrayCommon (std::initializer_list< Base > l)
	base Constructor that takes an initializer list of VarHandleKeys More...

	VarHandleKeyArrayCommon (std::initializer_list< std::string > l)
	base Constructor that takes an initializer list of std::strings. More...

template<class T = Base>
requires T::isDecorHandleKey	VarHandleKeyArrayCommon (VarHandleKey &contKey, std::initializer_list< std::string > l)
	base Constructor that takes an associated container and an initializer list of std::strings. More...

StatusCode	initialize (bool used=true)
	forward the initialization to the member VarHandleKeys More...

virtual StatusCode	assign (const std::vector< std::string > &vs) override
	Set the contents of the VarHandleKeyArray from a vector of std::strings. More...

virtual void	push_back (const std::string &key) override
	Add a new key to the VarHandleKeyArray. More...

virtual std::string	toString () const override
	string representation of the VarHandleKeyArray More...

virtual std::vector< SG::VarHandleKey * >	keys () const override
	create array of all base VarHandleKeys in the Array More...

virtual void	renounce () override
	if called, handles will not be declared in the algorithm I/O More...

virtual bool	renounced () const override
	query renounced state More...

virtual void	declare (IDataHandleHolder *) override

virtual void	setOwner (IDataHandleHolder *o) override

virtual const IDataHandleHolder *	owner () const override

virtual IDataHandleHolder *	owner () override

virtual Gaudi::DataHandle::Mode	mode () const =0

Public Attributes
T	elements
	STL member. More...

Private Attributes
bool	m_isRenounced { false }

IDataHandleHolder *	m_owner { nullptr }

Detailed Description

template<class Base>
class SG::VarHandleKeyArrayCommon< Base >

Definition at line 62 of file StoreGate/StoreGate/VarHandleKeyArray.h.

Constructor & Destructor Documentation

◆ VarHandleKeyArrayCommon() [1/5]

template<class Base >

SG::VarHandleKeyArrayCommon< Base >::VarHandleKeyArrayCommon ( )

inline

default base Constructor of mixin

Definition at line 69 of file StoreGate/StoreGate/VarHandleKeyArray.h.

69 : std::vector<Base>() {};

◆ VarHandleKeyArrayCommon() [2/5]

template<class Base >

SG::VarHandleKeyArrayCommon< Base >::VarHandleKeyArrayCommon ( const std::vector< Base > & v )

inline

base Constructor that takes a vector

Parameters

v	vector of Read/Write/UpdateHandleKey

Definition at line 75 of file StoreGate/StoreGate/VarHandleKeyArray.h.

75 :

76 std::vector<Base>(v) {};

◆ VarHandleKeyArrayCommon() [3/5]

template<class Base >

SG::VarHandleKeyArrayCommon< Base >::VarHandleKeyArrayCommon ( std::initializer_list< Base > l )

inline

base Constructor that takes an initializer list of VarHandleKeys

Parameters

l	initializer list of Read/Write/UpdateHandleKey

Definition at line 82 of file StoreGate/StoreGate/VarHandleKeyArray.h.

82 :

83 std::vector<Base>{l} {};

◆ VarHandleKeyArrayCommon() [4/5]

template<class Base >

SG::VarHandleKeyArrayCommon< Base >::VarHandleKeyArrayCommon ( std::initializer_list< std::string > l )

inline

base Constructor that takes an initializer list of std::strings.

Parameters

l	initializer list of std::strings used to create the VarHandleKeys

Definition at line 90 of file StoreGate/StoreGate/VarHandleKeyArray.h.

                                                                 {
       for (const auto &e : l) {
         std::vector<Base>::emplace_back( e );
       }
     }

◆ VarHandleKeyArrayCommon() [5/5]

template<class Base >

template<class T = Base>

requires T::isDecorHandleKey SG::VarHandleKeyArrayCommon< Base >::VarHandleKeyArrayCommon	(	VarHandleKey &	contKey,
		std::initializer_list< std::string >	l
	)

inline

base Constructor that takes an associated container and an initializer list of std::strings.

Parameters

contKey	VarHandleKey of the associated container
l	initializer list of std::strings used to create the VarHandleKeys

All decorations will be read from the container referenced by @contKey.

Definition at line 108 of file StoreGate/StoreGate/VarHandleKeyArray.h.

                                                                 {
       for (const auto &e : l) {
         std::vector<Base>::emplace_back( contKey, e );
       }
     }    

Member Function Documentation

◆ assign()

template<class Base >

virtual StatusCode SG::VarHandleKeyArrayCommon< Base >::assign ( const std::vector< std::string > & vs )

overridevirtual

Set the contents of the VarHandleKeyArray from a vector of std::strings.

Parameters

vs	vector of initializer strings

Implements SG::VarHandleKeyArray.

◆ declare()

template<class Base >

virtual void SG::VarHandleKeyArrayCommon< Base >::declare ( IDataHandleHolder * )

overridevirtual

Implements SG::VarHandleKeyArray.

◆ initialize()

template<class Base >

StatusCode SG::VarHandleKeyArrayCommon< Base >::initialize ( bool used = true )

forward the initialization to the member VarHandleKeys

Parameters

used	If false, then this handle is not to be used. Instead of normal initialization, the key will be cleared.

◆ keys()

template<class Base >

virtual std::vector<SG::VarHandleKey*> SG::VarHandleKeyArrayCommon< Base >::keys ( ) const

overridevirtual

create array of all base VarHandleKeys in the Array

Implements SG::VarHandleKeyArray.

◆ mode()

virtual Gaudi::DataHandle::Mode SG::VarHandleKeyArray::mode ( ) const

pure virtualinherited

Implemented in SG::HandleKeyArray< T_Handle, T_HandleKey, MODE >.

◆ owner() [1/2]

template<class Base >

virtual const IDataHandleHolder* SG::VarHandleKeyArrayCommon< Base >::owner ( ) const

inlineoverridevirtual

Implements SG::VarHandleKeyArray.

Definition at line 161 of file StoreGate/StoreGate/VarHandleKeyArray.h.

161 { return m_owner; }

◆ owner() [2/2]

template<class Base >

virtual IDataHandleHolder* SG::VarHandleKeyArrayCommon< Base >::owner ( )

inlineoverridevirtual

Implements SG::VarHandleKeyArray.

Definition at line 162 of file StoreGate/StoreGate/VarHandleKeyArray.h.

162 { return m_owner; }

◆ push_back()

template<class Base >

virtual void SG::VarHandleKeyArrayCommon< Base >::push_back ( const std::string & key )

inlineoverridevirtual

Add a new key to the VarHandleKeyArray.

Parameters

key	name of the key

Implements SG::VarHandleKeyArray.

Definition at line 133 of file StoreGate/StoreGate/VarHandleKeyArray.h.

                                                           {
       std::vector<Base>::emplace_back( key );
     }

◆ renounce()

template<class Base >

virtual void SG::VarHandleKeyArrayCommon< Base >::renounce ( )

inlineoverridevirtual

if called, handles will not be declared in the algorithm I/O

Implements SG::VarHandleKeyArray.

Definition at line 151 of file StoreGate/StoreGate/VarHandleKeyArray.h.

151 { m_isRenounced = true; }

◆ renounced()

template<class Base >

virtual bool SG::VarHandleKeyArrayCommon< Base >::renounced ( ) const

inlineoverridevirtual

query renounced state

Implements SG::VarHandleKeyArray.

Definition at line 156 of file StoreGate/StoreGate/VarHandleKeyArray.h.

156 { return m_isRenounced; }

◆ setOwner()

template<class Base >

virtual void SG::VarHandleKeyArrayCommon< Base >::setOwner ( IDataHandleHolder * o )

inlineoverridevirtual

Implements SG::VarHandleKeyArray.

Definition at line 160 of file StoreGate/StoreGate/VarHandleKeyArray.h.

160 { m_owner = o; }

◆ toString()

template<class Base >

virtual std::string SG::VarHandleKeyArrayCommon< Base >::toString ( ) const

overridevirtual

string representation of the VarHandleKeyArray

Implements SG::VarHandleKeyArray.

Member Data Documentation

◆ elements

T std::vector< T >::elements

inherited

STL member.

◆ m_isRenounced

template<class Base >

bool SG::VarHandleKeyArrayCommon< Base >::m_isRenounced { false }

private

Definition at line 166 of file StoreGate/StoreGate/VarHandleKeyArray.h.

◆ m_owner

template<class Base >

IDataHandleHolder* SG::VarHandleKeyArrayCommon< Base >::m_owner { nullptr }

private

Definition at line 167 of file StoreGate/StoreGate/VarHandleKeyArray.h.

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

StoreGate/StoreGate/VarHandleKeyArray.h

Public Member Functions

Public Attributes

Private Attributes

Detailed Description

template<class Base> class SG::VarHandleKeyArrayCommon< Base >

Constructor & Destructor Documentation

◆ VarHandleKeyArrayCommon() [1/5]

◆ VarHandleKeyArrayCommon() [2/5]

◆ VarHandleKeyArrayCommon() [3/5]

◆ VarHandleKeyArrayCommon() [4/5]

◆ VarHandleKeyArrayCommon() [5/5]

Member Function Documentation

◆ assign()

◆ declare()

◆ initialize()

◆ keys()

◆ mode()

◆ owner() [1/2]

◆ owner() [2/2]

◆ push_back()

◆ renounce()

◆ renounced()

◆ setOwner()

◆ toString()

Member Data Documentation

◆ elements

◆ m_isRenounced

◆ m_owner

template<class Base>
class SG::VarHandleKeyArrayCommon< Base >