|
ATLAS Offline Software
|
Represent a single association by index.
More...
#include <IndexAssociationFillerTool.h>
|
| IndexAssociationFillerTool (const std::string &type, const std::string &name, const IInterface *parent) |
| Standard Gaudi tool constructor. More...
|
|
virtual StatusCode | initialize () override |
| Standard Gaudi initialize method. More...
|
|
virtual StatusCode | configureD3PD (IAddVariable *tree, const std::type_info &ti) override |
| Configure during initialization: type-check. More...
|
|
virtual StatusCode | book () override |
| Declare tuple variables. More...
|
|
virtual StatusCode | fillUntyped (const void *p, bool again=false) override |
| Fill one block. More...
|
|
StatusCode | configureD3PD (IAddVariable *tree) |
| Configure the parent tree. 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...
|
|
Represent a single association by index.
This is a block filler tool which represents a single association by index.
It takes as a property an ISingleAssociationTool
. For each input object, it asks the association tool which object is associated with it. It also takes as a property a collection getter label. This defines an ‘index’ collection. The tool searches this collection for the target of the association and finds the index of that object within that collection. That index is then booked as a variable.
The index is set to -1 if the association fails or if the object isn't found in the index container.
Properties: Associator - The ISingleAssociationTool instance. Target - Label of the collection getter defining the collection within which to index. Prefix - Variable name prefix for the contained blocks. CollectionGetterRegistry - The ICollectionGetterRegistryTool instance.
Definition at line 61 of file IndexAssociationFillerTool.h.
◆ IndexAssociationFillerTool()
D3PD::IndexAssociationFillerTool::IndexAssociationFillerTool |
( |
const std::string & |
type, |
|
|
const std::string & |
name, |
|
|
const IInterface * |
parent |
|
) |
| |
Standard Gaudi tool constructor.
- Parameters
-
type | The name of the tool type. |
name | The tool name. |
parent | The tool's Gaudi parent. |
Definition at line 28 of file IndexAssociationFillerTool.cxx.
39 "The ISingleAssociationTool instance.");
41 "Label of the collection getter defining the collection "
42 "within which to index.");
44 "Variable name prefix for the index variable.");
46 "The name of this block.");
47 declareProperty (
"CollectionGetterRegistry",
m_registry,
48 "The ICollectionGetterRegistryTool instance.");
50 "If true, then it is not considered an error for the "
51 "target getter to fail to find the input objects.");
◆ addDimensionedVariable() [1/6]
StatusCode D3PD::AddVariable::addDimensionedVariable |
( |
const std::string & |
name, |
|
|
const std::type_info & |
ti, |
|
|
void *& |
ptr, |
|
|
const std::string & |
dim, |
|
|
const std::string & |
docstring = "" , |
|
|
const void * |
defval = 0 |
|
) |
| |
|
virtualinherited |
Add a variable to the tuple.
- Parameters
-
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.
133 return StatusCode::SUCCESS;
138 docstring, defval ) );
◆ addDimensionedVariable() [2/6]
virtual StatusCode D3PD::IAddVariable::addDimensionedVariable |
|
inherited |
Add a variable to the tuple.
- Parameters
-
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
.
◆ addDimensionedVariable() [3/6]
template<class T , class U >
StatusCode D3PD::IAddVariable::addDimensionedVariable |
( |
class T |
, |
|
|
class U |
|
|
) |
| |
|
inherited |
Add a variable to the tuple.
- Parameters
-
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
.
◆ addDimensionedVariable() [4/6]
template<class T , class U >
StatusCode D3PD::IAddVariable::addDimensionedVariable |
( |
const std::string & |
name, |
|
|
T *& |
ptr, |
|
|
const std::string & |
dim, |
|
|
const std::string & |
docstring, |
|
|
const U & |
defval |
|
) |
| |
|
inherited |
Add a variable to the tuple.
- Parameters
-
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
.
◆ addDimensionedVariable() [5/6]
template<class T >
StatusCode D3PD::IAddVariable::addDimensionedVariable |
( |
class T |
| ) |
|
|
inherited |
Add a variable to the tuple.
- Parameters
-
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
.
◆ addDimensionedVariable() [6/6]
template<class T >
StatusCode D3PD::IAddVariable::addDimensionedVariable |
( |
const std::string & |
name, |
|
|
T *& |
ptr, |
|
|
const std::string & |
dim, |
|
|
const std::string & |
docstring = "" |
|
) |
| |
|
inherited |
Add a variable to the tuple.
- Parameters
-
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
.
◆ addVariable() [1/6]
StatusCode D3PD::AddVariable::addVariable |
( |
const std::string & |
name, |
|
|
const std::type_info & |
ti, |
|
|
void *& |
ptr, |
|
|
const std::string & |
docstring = "" , |
|
|
const void * |
defval = 0 |
|
) |
| |
|
virtualinherited |
Add a variable to the tuple.
- Parameters
-
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.
94 return StatusCode::SUCCESS;
98 ti,
ptr, docstring, defval ) );
100 ti,
ptr, docstring, defval);
◆ addVariable() [2/6]
virtual StatusCode D3PD::IAddVariable::addVariable |
|
inherited |
◆ addVariable() [3/6]
template<class T , class U >
StatusCode D3PD::IAddVariable::addVariable |
( |
class T |
, |
|
|
class U |
|
|
) |
| |
|
inherited |
◆ addVariable() [4/6]
template<class T , class U >
StatusCode D3PD::IAddVariable::addVariable |
( |
const std::string & |
name, |
|
|
T *& |
ptr, |
|
|
const std::string & |
docstring, |
|
|
const U & |
defval |
|
) |
| |
|
inherited |
Add a variable to the tuple.
- Parameters
-
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
.
◆ addVariable() [5/6]
template<class T >
StatusCode D3PD::IAddVariable::addVariable |
( |
class T |
| ) |
|
|
inherited |
◆ addVariable() [6/6]
template<class T >
StatusCode D3PD::IAddVariable::addVariable |
( |
const std::string & |
name, |
|
|
T *& |
ptr, |
|
|
const std::string & |
docstring = "" |
|
) |
| |
|
inherited |
Add a variable to the tuple.
- Parameters
-
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
.
◆ book()
StatusCode D3PD::IndexAssociationFillerTool::book |
( |
| ) |
|
|
overridevirtual |
Declare tuple variables.
This is called at the start of the first event.
Definition at line 111 of file IndexAssociationFillerTool.cxx.
119 return StatusCode::SUCCESS;
◆ configureD3PD() [1/2]
StatusCode D3PD::AddVariable::configureD3PD |
( |
IAddVariable * |
tree | ) |
|
|
inherited |
Configure the parent tree.
- Parameters
-
Definition at line 61 of file AddVariable.cxx.
65 return StatusCode::SUCCESS;
◆ configureD3PD() [2/2]
StatusCode D3PD::IndexAssociationFillerTool::configureD3PD |
( |
IAddVariable * |
tree, |
|
|
const std::type_info & |
ti |
|
) |
| |
|
overridevirtual |
Configure during initialization: type-check.
- Parameters
-
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.
Definition at line 85 of file IndexAssociationFillerTool.cxx.
98 "D3PD::IndexAssociationFillerTool")
99 <<
"Not booking index variable because association target does not exist.";
102 return StatusCode::SUCCESS;
◆ fillUntyped()
StatusCode D3PD::IndexAssociationFillerTool::fillUntyped |
( |
const void * |
p, |
|
|
bool |
again = false |
|
) |
| |
|
overridevirtual |
Fill one block.
- Parameters
-
p | The input object. |
again | Set if this is a subsequent call requested by an AGAIN return |
This is called once per object. The type of the object at which p
points is given by the ti
argument to configureD3PD
. The caller is responsible for arranging that all the pointers for booked variables are set appropriately upon entry.
If the return status is the special code AGAIN
(defined above), then this filler tool wants to make multiple entries. The parent should set up to capture a new ‘row’ and run through the list of block filler tools again, but for this tool call fillAgainUntyped
instead of fillUntyped
. This should be repeated as long as fillAgainUntyped
returns AGAIN
.
Once fillUntyped
returns AGAIN
, the parent should call fillUntyped
with the same p argument and again
set to true
. This continues until fillUntyped
returns something other than AGAIN
.
Not all parents may support this. In that case, returning AGAIN
will be treated as an error.
Definition at line 150 of file IndexAssociationFillerTool.cxx.
181 return StatusCode::SUCCESS;
◆ initialize()
StatusCode D3PD::IndexAssociationFillerTool::initialize |
( |
| ) |
|
|
overridevirtual |
Standard Gaudi initialize
method.
Definition at line 59 of file IndexAssociationFillerTool.cxx.
62 <<
"IndexAssociationFillerTool is deprecated; use instead "
63 <<
"ContainedAssociationFillerTool with IndexFillerTool. "
64 <<
"IndexAssociation.py should do that for you.";
72 return StatusCode::SUCCESS;
◆ m_allowMissing
bool D3PD::IndexAssociationFillerTool::m_allowMissing |
|
private |
◆ m_associator
◆ m_blockName
std::string D3PD::IndexAssociationFillerTool::m_blockName |
|
private |
◆ m_converter
Helper to convert from pointer returned by the associator to pointer into the index container.
Definition at line 156 of file IndexAssociationFillerTool.h.
◆ m_index
int* D3PD::IndexAssociationFillerTool::m_index |
|
private |
◆ m_map
IndexMap D3PD::IndexAssociationFillerTool::m_map |
|
private |
◆ m_metadata
Metadata about the variables created by this object.
Definition at line 129 of file AddVariable.h.
◆ m_prefix
std::string D3PD::IndexAssociationFillerTool::m_prefix |
|
private |
◆ m_registry
◆ m_suffix
const std::string& D3PD::AddVariable::m_suffix |
|
privateinherited |
◆ m_targetLabel
std::string D3PD::IndexAssociationFillerTool::m_targetLabel |
|
private |
◆ m_tree
◆ s_emptyString
const std::string D3PD::AddVariable::s_emptyString |
|
staticprivateinherited |
Used to provide a default value for blockName.
Definition at line 41 of file AddVariable.h.
The documentation for this class was generated from the following files:
ICollectionGetterTool * target()
Return the getter defining the first collection within which to index.
def pout(output, newline=True)
virtual const std::type_info & elementTypeinfo() const =0
Return the element type of the collection.
int findIndex(const void *p)
Find the index corresponding to an element.
std::string dstName() const
Return the name of the destination type, or an empty string.
StatusCode configureD3PD(IAddVariable *tree)
Configure the parent tree.
AddVariable(const std::string &prefix, const std::string &blockName=s_emptyString)
Constructor.
const std::string & m_suffix
Reference to the variable suffix.
const std::string & m_prefix
Reference to the variable prefix.
StatusCode reset()
Call before asking for an index. Rebuilds cache if needed.
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.
IAddVariable * m_tree
Reference to the block name.
StatusCode init(const std::type_info &src_ti, const std::type_info &dst_ti)
Initialize the converter.
std::string srcName() const
Return the name of the source type, or an empty string.
ObjectMetadata m_metadata
Metadata about the variables created by this object.
const void * convertUntyped(const void *p) const
Convert pointer.
#define CHECK(...)
Evaluate an expression and check for errors.
#define REPORT_MESSAGE_WITH_CONTEXT(LVL, CONTEXT_NAME)
Report a message, with an explicitly specified context name.
StatusCode configureD3PD()
Configure during initialization: type-check.
#define REPORT_MESSAGE(LVL)
Report a message.
StatusCode addVariable(const std::string &name, T *&ptr, const std::string &docstring="")
Add a variable to the tuple.
StatusCode addDimensionedVariable(const std::string &name, T *&ptr, const std::string &dim, const std::string &docstring="")
Add a variable to the tuple.