ATLAS Offline Software
Public Member Functions | Protected Attributes | Private Attributes | Static Private Attributes | List of all members
D3PD::ContainedMultiAssociationFillerTool Class Reference

Represent a multiple association by containment. More...

#include <ContainedMultiAssociationFillerTool.h>

Inheritance diagram for D3PD::ContainedMultiAssociationFillerTool:
Collaboration diagram for D3PD::ContainedMultiAssociationFillerTool:

Public Member Functions

 ContainedMultiAssociationFillerTool (const std::string &type, const std::string &name, const IInterface *parent)
 Standard Gaudi tool constructor. More...
 
virtual StatusCode initialize ()
 Standard Gaudi initialize method. More...
 
virtual StatusCode finalize ()
 Standard Gaudi finalize method. More...
 
virtual StatusCode configureD3PD (IAddVariable *tree, const std::type_info &ti)
 Configure during initialization: type-check. More...
 
virtual StatusCode book ()
 Declare tuple variables. More...
 
virtual StatusCode fillUntyped (const void *p, bool again=false)
 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...
 

Protected Attributes

ObjectMetadata m_metadata
 Metadata about the variables created by this object. More...
 

Private Attributes

ToolHandle< IMultiAssociationToolm_associator
 Property: The association tool instance. More...
 
ToolHandleArray< IBlockFillerToolm_blockFillers
 Property: The list of block filler tools. More...
 
std::string m_prefix
 Property: The variable name prefix. More...
 
std::string m_blockName
 Property: the name of this block. More...
 
const void * m_next
 Next object to process. More...
 
const std::string & m_suffix
 Reference to the variable suffix. More...
 
IAddVariablem_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...
 

Detailed Description

Represent a multiple association by containment.

This is a block filler tool which represents a multiple association by containment. It uses the AGAIN feature of a block filler tool. The effect is that for each source object, there will be multiple entries made, one for each target object. Other variables will generally just be copied.

It takes as a property an IMultiAssociationTool. For each input object, it asks the association tool which objects are associated with it; the result is a collection of 0 or more objects. This tool also has a list of block filler tools; these tools are called for the result of the association.

The tool in addition creates a counter variable to count the of target objects for each source object. If this is -1, then the target object variables are not filled in.

Properties: Associator - The ISingleAssociationTool. BlockFillers - List of contained block filler tools. Prefix - Variable name prefix for the contained blocks. Counter - Variable name to use for the target object counter. Omitted if empty.

Definition at line 56 of file ContainedMultiAssociationFillerTool.h.

Constructor & Destructor Documentation

◆ ContainedMultiAssociationFillerTool()

D3PD::ContainedMultiAssociationFillerTool::ContainedMultiAssociationFillerTool ( const std::string &  type,
const std::string &  name,
const IInterface *  parent 
)

Standard Gaudi tool constructor.

Parameters
typeThe name of the tool type.
nameThe tool name.
parentThe tool's Gaudi parent.

Definition at line 27 of file ContainedMultiAssociationFillerTool.cxx.

31  : base_class (type, name, parent),
33  m_associator (this),
34  m_blockFillers (this),
35  m_next (0)
36 {
37  declareProperty ("Associator", m_associator,
38  "The IMultiAssociationTool instance.");
39  declareProperty ("BlockFillers", m_blockFillers,
40  "List of contained block filler tools.");
41  declareProperty ("BlockName", m_blockName = this->name(),
42  "The name of this block.");
43  declareProperty ("Prefix", m_prefix = "",
44  "Variable name prefix for the contained blocks.");
45 }

Member Function Documentation

◆ 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
nameThe name of the variable.
typeThe type of the variable.
ptrPointer to the type of the variable. The pointer need not be initialized; the D3PD software will set the pointer prior to calling fill().
dimDimension for the variable. (Presently unimplemented!)
docstringDocumentation string for this variable.
defvalPointer 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.

129 {
130  if (!m_tree) {
131  // Called from constructor --- just initialize pointer.
132  ptr = 0;
133  return StatusCode::SUCCESS;
134  }
135 
137  ti, ptr, dim,
138  docstring, defval ) );
140  ti, ptr, dim,
141  docstring, defval);
142 }

◆ addDimensionedVariable() [2/6]

virtual StatusCode D3PD::IAddVariable::addDimensionedVariable
inherited

Add a variable to the tuple.

Parameters
nameThe name of the variable.
typeThe type of the variable.
ptrPointer to the type of the variable. The pointer need not be initialized; the D3PD software will set the pointer prior to calling fill().
dimDimension for the variable. (Presently unimplemented!)
docstringDocumentation string for this variable.
defvalPointer 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
nameThe name of the variable.
ptrPointer to the type of the variable. The pointer need not be initialized; the D3PD software will set the pointer prior to calling fill().
dimDimension for the variable. (Presently unimplemented!)
docstringDocumentation string for this variable.
defvalPointer 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
nameThe name of the variable.
ptrPointer to the type of the variable. The pointer need not be initialized; the D3PD software will set the pointer prior to calling fill().
dimDimension for the variable. (Presently unimplemented!)
docstringDocumentation string for this variable.
defvalPointer 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
nameThe name of the variable.
ptrPointer to the type of the variable. The pointer need not be initialized; the D3PD software will set the pointer prior to calling fill().
dimDimension for the variable. (Presently unimplemented!)
docstringDocumentation 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
nameThe name of the variable.
ptrPointer to the type of the variable. The pointer need not be initialized; the D3PD software will set the pointer prior to calling fill().
dimDimension for the variable. (Presently unimplemented!)
docstringDocumentation 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
nameThe name of the variable.
typeThe type of the variable.
ptrPointer to the type of the variable. The pointer need not be initialized; the D3PD software will set the pointer prior to calling fill().
docstringDocumentation string for this variable.
defvalPointer 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.

90 {
91  if (!m_tree) {
92  // Called from constructor --- just initialize pointer.
93  ptr = 0;
94  return StatusCode::SUCCESS;
95  }
96 
98  ti, ptr, docstring, defval ) );
100  ti, ptr, docstring, defval);
101 }

◆ addVariable() [2/6]

virtual StatusCode D3PD::IAddVariable::addVariable
inherited

Make the template implementation from IAddVariable visible.

◆ addVariable() [3/6]

template<class T , class U >
StatusCode D3PD::IAddVariable::addVariable ( class T  ,
class U   
)
inherited

Make the template implementation from IAddVariable visible.

◆ 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
nameThe name of the variable.
ptrPointer to the type of the variable. The pointer need not be initialized; the D3PD software will set the pointer prior to calling fill().
docstringDocumentation string for this variable.
defvalPointer 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

Make the template implementation from IAddVariable visible.

◆ 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
nameThe name of the variable.
ptrPointer to the type of the variable. The pointer need not be initialized; the D3PD software will set the pointer prior to calling fill().
docstringDocumentation string for this variable.

If called from the constructor, the only effect is to clear ptr.

◆ book()

StatusCode D3PD::ContainedMultiAssociationFillerTool::book ( )
virtual

Declare tuple variables.

This is called at the start of the first event.

Definition at line 103 of file ContainedMultiAssociationFillerTool.cxx.

104 {
105  CHECK( m_associator->book () );
106  for (size_t i = 0; i < m_blockFillers.size(); i++)
107  CHECK( m_blockFillers[i]->book ( ) );
108 
109  return StatusCode::SUCCESS;
110 }

◆ configureD3PD() [1/2]

StatusCode D3PD::AddVariable::configureD3PD ( IAddVariable tree)
inherited

Configure the parent tree.

Parameters
treeThe parent IAddVariable instance.

Definition at line 61 of file AddVariable.cxx.

62 {
63  m_tree = tree;
64  m_metadata.clear();
65  return StatusCode::SUCCESS;
66 }

◆ configureD3PD() [2/2]

StatusCode D3PD::ContainedMultiAssociationFillerTool::configureD3PD ( IAddVariable tree,
const std::type_info &  ti 
)
virtual

Configure during initialization: type-check.

Parameters
treeOur parent for tuple making.
tiGives 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 ContainedMultiAssociationFillerTool.cxx.

87 {
89  CHECK( m_associator->configureD3PD (this, ti) );
90  const std::type_info& ati = m_associator->elementTypeinfo();
91  for (size_t i = 0; i < m_blockFillers.size(); i++)
92  CHECK( m_blockFillers[i]->configureD3PD (this, ati ) );
93 
94  return StatusCode::SUCCESS;
95 }

◆ fillUntyped()

StatusCode D3PD::ContainedMultiAssociationFillerTool::fillUntyped ( const void *  p,
bool  again = false 
)
virtual

Fill one block.

Parameters
pThe input object.
againSet 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.

The return code may also be EMPTY if this tool did not fill in anything. If all tools return empty, the parent may omit the row.

Definition at line 143 of file ContainedMultiAssociationFillerTool.cxx.

145 {
146  // ??? Doesn't handle nested AGAIN.
147 
148  if (!again) {
149  if (m_next) {
150  m_associator->releaseElementUntyped (m_next);
151  m_next = 0;
152  }
153 
154  // Start the association.
155  CHECK( m_associator->resetUntyped (p) );
156 
157  // Get the first result.
158  m_next = m_associator->nextUntyped();
159  }
160 
161  if (!m_next)
162  return StatusCode(EMPTY);
163 
164  for (size_t i = 0; i < m_blockFillers.size(); i++) {
165  StatusCode sc = m_blockFillers[i]->fillUntyped (m_next);
167  if (!sc.isSuccess()) {
168  REPORT_MESSAGE (MSG::WARNING)
169  << "Got AGAIN/EMPTY: "
170  << "Nested ContainedMultiAssociationFillerTool not supported.";
171  }
172  }
173 
174  m_associator->releaseElementUntyped (m_next);
175  m_next = m_associator->nextUntyped();
176 
177  // Always return AGAIN for the first object, even if it's the last one.
178  // We'll return EMPTY on the next call.
179  // If we don't do this, then we can have problems if multiple
180  // ContainedMultiAssociationFillerTools are used; any that return
181  // a list of size 1 will have that object duplicated in all rows.
182  if (m_next || !again)
183  return StatusCode(AGAIN);
184 
185  return StatusCode::SUCCESS;
186 }

◆ finalize()

StatusCode D3PD::ContainedMultiAssociationFillerTool::finalize ( )
virtual

Standard Gaudi finalize method.

Definition at line 65 of file ContainedMultiAssociationFillerTool.cxx.

66 {
68  if (m_next) {
69  m_associator->releaseElementUntyped (m_next);
70  m_next = 0;
71  }
72  return StatusCode::SUCCESS;
73 }

◆ initialize()

StatusCode D3PD::ContainedMultiAssociationFillerTool::initialize ( )
virtual

Standard Gaudi initialize method.

Definition at line 52 of file ContainedMultiAssociationFillerTool.cxx.

53 {
55  CHECK( m_associator.retrieve() );
56  CHECK( m_blockFillers.retrieve() );
57  return StatusCode::SUCCESS;
58 }

Member Data Documentation

◆ m_associator

ToolHandle<IMultiAssociationTool> D3PD::ContainedMultiAssociationFillerTool::m_associator
private

Property: The association tool instance.

Definition at line 135 of file ContainedMultiAssociationFillerTool.h.

◆ m_blockFillers

ToolHandleArray<IBlockFillerTool> D3PD::ContainedMultiAssociationFillerTool::m_blockFillers
private

Property: The list of block filler tools.

Definition at line 138 of file ContainedMultiAssociationFillerTool.h.

◆ m_blockName

std::string D3PD::ContainedMultiAssociationFillerTool::m_blockName
private

Property: the name of this block.

Definition at line 144 of file ContainedMultiAssociationFillerTool.h.

◆ m_metadata

ObjectMetadata D3PD::AddVariable::m_metadata
protectedinherited

Metadata about the variables created by this object.

Definition at line 129 of file AddVariable.h.

◆ m_next

const void* D3PD::ContainedMultiAssociationFillerTool::m_next
private

Next object to process.

Definition at line 147 of file ContainedMultiAssociationFillerTool.h.

◆ m_prefix

std::string D3PD::ContainedMultiAssociationFillerTool::m_prefix
private

Property: The variable name prefix.

Definition at line 141 of file ContainedMultiAssociationFillerTool.h.

◆ m_suffix

const std::string& D3PD::AddVariable::m_suffix
privateinherited

Reference to the variable suffix.

Definition at line 137 of file AddVariable.h.

◆ m_tree

IAddVariable* D3PD::AddVariable::m_tree
privateinherited

Reference to the block name.

The parent IAddVariable instance.

Definition at line 143 of file AddVariable.h.

◆ 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:
D3PD::ContainedMultiAssociationFillerTool::m_prefix
std::string m_prefix
Property: The variable name prefix.
Definition: ContainedMultiAssociationFillerTool.h:141
D3PD::ContainedMultiAssociationFillerTool::configureD3PD
virtual StatusCode configureD3PD(IAddVariable *tree, const std::type_info &ti)
Configure during initialization: type-check.
Definition: ContainedMultiAssociationFillerTool.cxx:85
python.tests.PyTestsLib.finalize
def finalize(self)
_info( "content of StoreGate..." ) self.sg.dump()
Definition: PyTestsLib.py:50
D3PD::ObjectMetadata::addDimensionedVariable
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)
The object doesn't support dimensioned variables at the moment, like most of the D3PDMaker code doesn...
Definition: ObjectMetadata.cxx:157
yodamerge_tmp.dim
dim
Definition: yodamerge_tmp.py:239
D3PD::ContainedMultiAssociationFillerTool::book
virtual StatusCode book()
Declare tuple variables.
Definition: ContainedMultiAssociationFillerTool.cxx:103
D3PD::AddVariable::configureD3PD
StatusCode configureD3PD(IAddVariable *tree)
Configure the parent tree.
Definition: AddVariable.cxx:61
D3PD::AddVariable::AddVariable
AddVariable(const std::string &prefix, const std::string &blockName=s_emptyString)
Constructor.
Definition: AddVariable.cxx:29
D3PD::AddVariable::m_suffix
const std::string & m_suffix
Reference to the variable suffix.
Definition: AddVariable.h:137
D3PD::ContainedMultiAssociationFillerTool::m_blockName
std::string m_blockName
Property: the name of this block.
Definition: ContainedMultiAssociationFillerTool.h:144
initialize
void initialize()
Definition: run_EoverP.cxx:894
tree
TChain * tree
Definition: tile_monitor.h:30
D3PD::AddVariable::m_prefix
const std::string & m_prefix
Reference to the variable prefix.
Definition: AddVariable.h:134
D3PD::ContainedMultiAssociationFillerTool::m_associator
ToolHandle< IMultiAssociationTool > m_associator
Property: The association tool instance.
Definition: ContainedMultiAssociationFillerTool.h:135
D3PD::ContainedMultiAssociationFillerTool::m_blockFillers
ToolHandleArray< IBlockFillerTool > m_blockFillers
Property: The list of block filler tools.
Definition: ContainedMultiAssociationFillerTool.h:138
dbg::ptr
void * ptr(T *p)
Definition: SGImplSvc.cxx:74
D3PD::AddVariable::m_tree
IAddVariable * m_tree
Reference to the block name.
Definition: AddVariable.h:143
AthenaPoolTestRead.sc
sc
Definition: AthenaPoolTestRead.py:27
D3PD::AddVariable::m_metadata
ObjectMetadata m_metadata
Metadata about the variables created by this object.
Definition: AddVariable.h:129
python.utils.AtlRunQueryDQUtils.p
p
Definition: AtlRunQueryDQUtils.py:210
D3PD::IBlockFillerTool::againok
static StatusCode againok(StatusCode sc)
StatusCode check helper: change AGAIN or EMPTY to SUCCESS.
lumiFormat.i
int i
Definition: lumiFormat.py:85
EL::StatusCode
::StatusCode StatusCode
StatusCode definition for legacy code.
Definition: PhysicsAnalysis/D3PDTools/EventLoop/EventLoop/StatusCode.h:22
test_pyathena.parent
parent
Definition: test_pyathena.py:15
CHECK
#define CHECK(...)
Evaluate an expression and check for errors.
Definition: Control/AthenaKernel/AthenaKernel/errorcheck.h:422
D3PD::ObjectMetadata::clear
void clear()
Function clearing the object.
Definition: ObjectMetadata.cxx:352
name
std::string name
Definition: Control/AthContainers/Root/debug.cxx:228
D3PD::ObjectMetadata::addVariable
virtual StatusCode addVariable(const std::string &name, const std::type_info &ti, void *&ptr, const std::string &docstring="", const void *defval=0)
This function can be used to save the metadata about a D3PD variable.
Definition: ObjectMetadata.cxx:109
REPORT_MESSAGE
#define REPORT_MESSAGE(LVL)
Report a message.
Definition: Control/AthenaKernel/AthenaKernel/errorcheck.h:365
python.CaloScaleNoiseConfig.type
type
Definition: CaloScaleNoiseConfig.py:78
D3PD::IAddVariable::addVariable
StatusCode addVariable(const std::string &name, T *&ptr, const std::string &docstring="")
Add a variable to the tuple.
D3PD::IAddVariable::addDimensionedVariable
StatusCode addDimensionedVariable(const std::string &name, T *&ptr, const std::string &dim, const std::string &docstring="")
Add a variable to the tuple.
D3PD::ContainedMultiAssociationFillerTool::m_next
const void * m_next
Next object to process.
Definition: ContainedMultiAssociationFillerTool.h:147