![]() |
ATLAS Offline Software
|
A specialization of SingleAssociationTool that can accept one of several types. More...
#include <SingleAssociationToolMulti.h>
Public Member Functions | |
SingleAssociationTool (const std::string &type, const std::string &name, const IInterface *parent) | |
Standard Gaudi tool constructor. More... | |
virtual StatusCode | configureD3PD (IAddVariable *tree, const std::type_info &ti) override |
Configure during initialization: type-check. More... | |
virtual const void * | getUntyped (const void *p) override |
Return the target object. More... | |
virtual const std::type_info & | fromTypeinfo () const override |
Return the std::type_info for the source of the association. More... | |
virtual const SelectType< TO_T, 0 >::type * | get (const T0 &p)=0 |
Return the target object. More... | |
virtual const std::type_info & | typeinfo () const override |
Return the type of object retrieved by this tool. More... | |
virtual void | releaseObject (const typename SelectType< TO_T, 0 >::type *) override |
Release an object retrieved from the association. More... | |
virtual void | releaseObjectUntyped (const void *p) override |
Release an object retrieved from the association. More... | |
StatusCode | configureD3PD (IAddVariable *tree) |
Configure the parent tree. More... | |
virtual StatusCode | book () |
Create any needed tuple variables. More... | |
virtual StatusCode | addVariable (const std::string &name, const std::type_info &ti, void *&ptr, const std::string &docstring="", const void *defval=0) |
Add a variable to the tuple. More... | |
template<class T > | |
StatusCode | addVariable (const std::string &name, T *&ptr, const std::string &docstring="") |
Make the template implementation from IAddVariable visible. More... | |
template<class T , class U > | |
StatusCode | addVariable (const std::string &name, T *&ptr, const std::string &docstring, const U &defval) |
Make the template implementation from IAddVariable visible. More... | |
virtual StatusCode | addVariable (const std::string &name, const std::type_info &ti, void *&ptr, const std::string &docstring="", const void *defval=0)=0 |
Make the template implementation from IAddVariable visible. More... | |
template<class T > | |
StatusCode | addVariable (const std::string &name, T *&ptr, const std::string &docstring="") |
Add a variable to the tuple. More... | |
template<class T , class U > | |
StatusCode | addVariable (const std::string &name, T *&ptr, const std::string &docstring, const U &defval) |
Add a variable to the tuple. More... | |
virtual StatusCode | addDimensionedVariable (const std::string &name, const std::type_info &ti, void *&ptr, const std::string &dim, const std::string &docstring="", const void *defval=0) |
Add a variable to the tuple. More... | |
template<class T > | |
StatusCode | addDimensionedVariable (const std::string &name, T *&ptr, const std::string &dim, const std::string &docstring="") |
Add a variable to the tuple. More... | |
template<class T , class U > | |
StatusCode | addDimensionedVariable (const std::string &name, T *&ptr, const std::string &dim, const std::string &docstring, const U &defval) |
Add a variable to the tuple. More... | |
virtual StatusCode | addDimensionedVariable (const std::string &name, const std::type_info &ti, void *&ptr, const std::string &dim, const std::string &docstring="", const void *defval=0)=0 |
Add a variable to the tuple. More... | |
template<class T > | |
StatusCode | addDimensionedVariable (const std::string &name, T *&ptr, const std::string &dim, const std::string &docstring="") |
Add a variable to the tuple. More... | |
template<class T , class U > | |
StatusCode | addDimensionedVariable (const std::string &name, T *&ptr, const std::string &dim, const std::string &docstring, const U &defval) |
Add a variable to the tuple. More... | |
Protected Member Functions | |
virtual const void * | doGetUntyped (const void *p, size_t count) |
Helper to decide which which get method to call. More... | |
virtual void | doReleaseObjectUntyped (const void *p, size_t count) |
virtual void | push_ti (std::vector< const std::type_info * > &tis) |
Helper to collect the list of type_info's that we accept. More... | |
virtual const std::type_info & | doTypeinfo (size_t count) const |
const void * | doConversion (const void *p) |
Helper to convert pointers to source objects. More... | |
StatusCode | configureMulti (D3PD::IAddVariable *tree, const std::type_info &ti, const std::vector< const std::type_info * > &tis, size_t &which) |
Configure during initialization: type-check. More... | |
Protected Attributes | |
size_t | m_which |
Index of which type we're expecting. More... | |
ObjectMetadata | m_metadata |
Metadata about the variables created by this object. More... | |
Private Attributes | |
const std::type_info * | m_fromTypeinfo |
type_info for the selected type. More... | |
std::string | m_prefix |
Parameter: source object prefix. More... | |
std::string | m_blockName |
Property: the name of this block. More... | |
TypeConverter | m_inputConverter |
Helper to convert source object pointers. More... | |
const std::string & | m_suffix |
Reference to the variable suffix. More... | |
IAddVariable * | m_tree |
Reference to the block name. More... | |
Static Private Attributes | |
static const std::string | s_emptyString |
Used to provide a default value for blockName. More... | |
A specialization of SingleAssociationTool that can accept one of several types.
The input for this tool can either be of type T1
... T5
. The first one that yields a valid conversion is used, and the appropriate get
method is called.
If the output type is also a Types
construct, then the corresponding type within that is used as the output type.
Note that this is all done at configuration time: this doesn't allow the type to change dynamically. Rather, this gives a tool that can be configured with more than one type.
This specialization is for the 1-argument case.
Definition at line 49 of file SingleAssociationToolMulti.h.
D3PD::SingleAssociationTool< Types< T0 >, TO_T >::SingleAssociationTool | ( | const std::string & | type, |
const std::string & | name, | ||
const IInterface * | parent | ||
) |
|
virtualinherited |
Add a variable to the tuple.
name | The name of the variable. |
type | The type of the variable. |
ptr | Pointer to the type of the variable. The pointer need not be initialized; the D3PD software will set the pointer prior to calling fill() . |
dim | Dimension for the variable. (Presently unimplemented!) |
docstring | Documentation string for this variable. |
defval | Pointer to the default value to use for this variable. Null for no default (generally means to fill with zeros). Of the type given by ti . Only works for basic types. |
If called from the constructor, the only effect is to clear ptr
.
Implements D3PD::IAddVariable.
Definition at line 123 of file AddVariable.cxx.
|
inherited |
Add a variable to the tuple.
name | The name of the variable. |
type | The type of the variable. |
ptr | Pointer to the type of the variable. The pointer need not be initialized; the D3PD software will set the pointer prior to calling fill() . |
dim | Dimension for the variable. (Presently unimplemented!) |
docstring | Documentation string for this variable. |
defval | Pointer to the default value to use for this variable. Null for no default (generally means to fill with zeros). Of the type given by ti . Only works for basic types. |
If called from the constructor, the only effect is to clear ptr
.
|
inherited |
Add a variable to the tuple.
name | The name of the variable. |
ptr | Pointer to the type of the variable. The pointer need not be initialized; the D3PD software will set the pointer prior to calling fill() . |
dim | Dimension for the variable. (Presently unimplemented!) |
docstring | Documentation string for this variable. |
defval | Pointer to the default value to use for this variable. Only works for basic types. |
If called from the constructor, the only effect is to clear ptr
.
|
inherited |
Add a variable to the tuple.
name | The name of the variable. |
ptr | Pointer to the type of the variable. The pointer need not be initialized; the D3PD software will set the pointer prior to calling fill() . |
dim | Dimension for the variable. (Presently unimplemented!) |
docstring | Documentation string for this variable. |
defval | Pointer to the default value to use for this variable. Only works for basic types. |
If called from the constructor, the only effect is to clear ptr
.
|
inherited |
Add a variable to the tuple.
name | The name of the variable. |
ptr | Pointer to the type of the variable. The pointer need not be initialized; the D3PD software will set the pointer prior to calling fill() . |
dim | Dimension for the variable. (Presently unimplemented!) |
docstring | Documentation string for this variable. |
If called from the constructor, the only effect is to clear ptr
.
|
inherited |
Add a variable to the tuple.
name | The name of the variable. |
ptr | Pointer to the type of the variable. The pointer need not be initialized; the D3PD software will set the pointer prior to calling fill() . |
dim | Dimension for the variable. (Presently unimplemented!) |
docstring | Documentation string for this variable. |
If called from the constructor, the only effect is to clear ptr
.
|
virtualinherited |
Add a variable to the tuple.
name | The name of the variable. |
type | The type of the variable. |
ptr | Pointer to the type of the variable. The pointer need not be initialized; the D3PD software will set the pointer prior to calling fill() . |
docstring | Documentation string for this variable. |
defval | Pointer to the default value to use for this variable. Null for no default (generally means to fill with zeros). Of the type given by ti . Only works for basic types. |
If called from the constructor, the only effect is to clear ptr
.
Implements D3PD::IAddVariable.
Definition at line 85 of file AddVariable.cxx.
|
inherited |
Make the template implementation from IAddVariable
visible.
|
inherited |
Make the template implementation from IAddVariable
visible.
|
inherited |
Add a variable to the tuple.
name | The name of the variable. |
ptr | Pointer to the type of the variable. The pointer need not be initialized; the D3PD software will set the pointer prior to calling fill() . |
docstring | Documentation string for this variable. |
defval | Pointer to the default value to use for this variable. Only works for basic types. |
If called from the constructor, the only effect is to clear ptr
.
|
inherited |
Make the template implementation from IAddVariable
visible.
|
inherited |
Add a variable to the tuple.
name | The name of the variable. |
ptr | Pointer to the type of the variable. The pointer need not be initialized; the D3PD software will set the pointer prior to calling fill() . |
docstring | Documentation string for this variable. |
If called from the constructor, the only effect is to clear ptr
.
|
virtualinherited |
Create any needed tuple variables.
This is called at the start of the first event. The default implementation is a no-op.
Reimplemented in D3PD::DRAssociationTool, D3PD::TrackParticleVertexAssociationTool, D3PD::egammaGenParticleAssociationTool, and D3PD::MuonGenParticleAssociationTool.
Definition at line 92 of file SingleAssociationToolImpl.cxx.
|
inherited |
Configure the parent tree.
tree | The parent IAddVariable instance. |
Definition at line 61 of file AddVariable.cxx.
|
overridevirtual |
Configure during initialization: type-check.
tree | Our parent for tuple making. |
ti | Gives the type of the object being passed to fillUntyped . |
configureD3PD
should check that the type of the object coming as input is compatible with what it expects, and raise an error otherwise.
Reimplemented from D3PD::SingleAssociationToolImpl.
|
protectedinherited |
Configure during initialization: type-check.
Alternate implementation for the case where we have to choose among multiple possible input types.
tree | Our parent for tuple making. | |
ti | Gives the type of the object being passed to getUntyped . | |
tis | List of possible input types that we can accept. | |
[out] | which | Index of the accepted type. |
configureMulti
should check that the type of the object coming as input (to getUntyped
) is compatible with what it expects, and raise an error otherwise.
Definition at line 74 of file SingleAssociationToolImpl.cxx.
Helper to convert pointers to source objects.
p | Source object, as a pointer to the type passed to configureD3PD . return Source object, as a pointer to the type given by fromTypeinfo . |
p | Source object, as a pointer to the type passed to configureD3PD . return Source object, as a pointer to the type given by typeinfoFrom . |
Definition at line 103 of file SingleAssociationToolImpl.cxx.
|
protectedvirtual |
Helper to decide which which get
method to call.
This either calls get
using the last type in our template argument list, or chains to the base class.
It's virtual so that we can call the most-derived one from getUntyped
in the base class, but we also declare it as inline so that the base class chaining can be inlined.
|
protectedvirtual |
|
protectedvirtual |
|
overridevirtual |
Return the std::type_info
for the source of the association.
Implements D3PD::SingleAssociationToolImpl.
|
pure virtual |
Return the target object.
p | The source object for the association. |
Return the target of the association, or 0.
|
overridevirtual |
Return the target object.
p | The source object for the association. |
Return the target of the association, or 0. Should be of the type given by typeinfo
.
|
protectedvirtual |
Helper to collect the list of type_info's
that we accept.
This first chains to the base class to pick up its list. Then we add the type_info
corresponding to the last type in the template argument list.
|
overridevirtual |
Release an object retrieved from the association.
p | The object to release. |
Call this when you are done with the object returned by get()
. The default implementation is a no-op, but if the association dynamically allocated the object which it returned, this gives it a chance to free it.
Reimplemented from D3PD::SingleAssociationToolTo< TO_T >.
|
overridevirtual |
Release an object retrieved from the association.
p | The object to release. |
Call this when you are done with the object returned by getUntyped()
. The default implementation is a no-op, but if the association dynamically allocated the object which it returned, this gives it a chance to free it.
Reimplemented from D3PD::SingleAssociationToolTo< TO_T >.
|
overridevirtual |
Return the type of object retrieved by this tool.
Reimplemented from D3PD::SingleAssociationToolTo< TO_T >.
|
privateinherited |
Property: the name of this block.
Definition at line 121 of file SingleAssociationToolImpl.h.
|
private |
type_info
for the selected type.
Definition at line 170 of file SingleAssociationToolMulti.h.
|
privateinherited |
Helper to convert source object pointers.
Definition at line 124 of file SingleAssociationToolImpl.h.
|
protectedinherited |
Metadata about the variables created by this object.
Definition at line 129 of file AddVariable.h.
|
privateinherited |
Parameter: source object prefix.
Definition at line 118 of file SingleAssociationToolImpl.h.
|
privateinherited |
Reference to the variable suffix.
Definition at line 137 of file AddVariable.h.
|
privateinherited |
Reference to the block name.
The parent IAddVariable
instance.
Definition at line 143 of file AddVariable.h.
|
protected |
Index of which type we're expecting.
Definition at line 136 of file SingleAssociationToolMulti.h.
|
staticprivateinherited |
Used to provide a default value for blockName.
Definition at line 41 of file AddVariable.h.