|
ATLAS Offline Software
|
Copy aux data to D3PD.
More...
#include <AuxDataFillerTool.h>
|
| AuxDataFillerTool (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 | book () |
| Book variables for this block. More...
|
|
virtual StatusCode | fill (const SG::AuxElement &p) |
| Fill one block — type-safe version. More...
|
|
virtual StatusCode | configureD3PD (IAddVariable *tree, const std::type_info &ti) |
| Configure during initialization: type-check. More...
|
|
StatusCode | configureD3PD (IAddVariable *tree) |
| Configure the parent tree. More...
|
|
virtual StatusCode | fillUntyped (const void *p, bool again=false) |
| Fill one block. More...
|
|
virtual StatusCode | fillAgain (const SG::AuxElement &p) |
| Fill one block, after AGAIN has been returned (type-safe). 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...
|
|
Copy aux data to D3PD.
Definition at line 33 of file AuxDataFillerTool.h.
◆ AuxDataFillerTool()
D3PD::AuxDataFillerTool::AuxDataFillerTool |
( |
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 110 of file AuxDataFillerTool.cxx.
116 "Prefix to add to aux data names.");
119 "Specify variables to fill. "
120 "Each is of the form VAR[=AUXVAR][<DEF][#DOCSTRING].\n"
121 "VAR is the D3PD variable name. "
122 "AUXVAR is the aux data item name. It may contain a class "
123 "name before a ::. If omitted, it defaults to VAR. "
124 "It may also be a comma-separated string of variable "
125 "names; the first one found to be present will be used. "
126 "If the < is present, then it is not an error for this "
127 "variable to be missing. If not empty, DEF specifies the "
128 "default value to use (works only for basic types). "
129 "DEF may be preceded with a type name: `TYPE: DEF' to "
130 "specify a type in the case the type of this aux variable "
132 "An optional documentation string may be given after a #.");
◆ 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::AuxDataFillerTool::book |
( |
| ) |
|
|
virtual |
◆ 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]
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.
◆ configureImpl() [1/2]
StatusCode D3PD::BlockFillerToolImpl::configureImpl |
( |
IAddVariable * |
tree, |
|
|
const std::type_info & |
ti, |
|
|
const std::type_info & |
fill_ti |
|
) |
| |
|
protectedinherited |
Configure during initialization: type-check.
- Parameters
-
tree | Our parent for tuple making. |
ti | Gives the type of the object being passed to fillUntyped . |
fill_ti | is the type of object that the user code will expect. |
This is the common implementation for the configureD3PD
method of IBlockFillerTool
. It checks that the type of the object coming as input is compatible with what the user code is expecting, and raises an error otherwise.
Definition at line 55 of file BlockFillerToolImpl.cxx.
62 return StatusCode::SUCCESS;
◆ configureImpl() [2/2]
StatusCode D3PD::BlockFillerToolImpl::configureImpl |
( |
IAddVariable * |
tree, |
|
|
const std::type_info & |
ti, |
|
|
const std::vector< const std::type_info * > & |
tis, |
|
|
size_t & |
which |
|
) |
| |
|
protectedinherited |
Configure during initialization: type-check.
- Parameters
-
| tree | Our parent for tuple making. |
| ti | Gives the type of the object being passed to fillUntyped . |
| tis | List of possible input types that we can accept. |
[out] | which | Index of the accepted type. |
This is the common implementation for the configureD3PD
method of IBlockFillerTool
. It checks that the type of the object coming as input is compatible with what the user code is expecting, and raises an error otherwise.
This version allows for one of a set of types to match. If successful, WHICH is set to the index (0-based) of the matching type.
Definition at line 83 of file BlockFillerToolImpl.cxx.
90 return StatusCode::SUCCESS;
◆ convert()
StatusCode D3PD::BlockFillerToolImpl::convert |
( |
void const *& |
p | ) |
const |
|
protectedinherited |
Do type conversion.
- Parameters
-
p[in,out] | Pointer to convert. |
On entry, p is a pointer to an object of the type that was passed into configureImpl
as ti
. Convert the pointer to point to an object of the type that was given as fill_ti
. If the conversion fails, the pointer is set to 0 (and FAILURE
is returned).
Definition at line 105 of file BlockFillerToolImpl.cxx.
112 return StatusCode::FAILURE;
114 return StatusCode::SUCCESS;
◆ fill()
Fill one block — type-safe version.
- Parameters
-
This is called once per object. The caller is responsible for arranging that all the pointers for booked variables are set appropriately upon entry.
Implements D3PD::BlockFillerTool< SG::AuxElement >.
Definition at line 170 of file AuxDataFillerTool.cxx.
173 const void* aux =
v->access(
p);
175 v->type.assign (
v->ptr, aux);
176 else if (!
v->has_default) {
182 return StatusCode::SUCCESS;
◆ fillAgain()
Fill one block, after AGAIN
has been returned (type-safe).
- Parameters
-
Once fill
returns AGAIN
, the parent should call fillAgain
with the same arguments. This continues until fillAgain
returns something other than AGAIN
.
By default, this just calls fill()
.
◆ fillUntyped()
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.
◆ initialize()
StatusCode D3PD::AuxDataFillerTool::initialize |
( |
| ) |
|
|
virtual |
◆ parseVars()
StatusCode D3PD::AuxDataFillerTool::parseVars |
( |
| ) |
|
|
private |
Parse the variables property and fill m_vars
.
Definition at line 189 of file AuxDataFillerTool.cxx.
192 std::string docstring;
193 std::string::size_type ipos =
name.find (
'#');
194 if (ipos != std::string::npos) {
195 docstring =
name.substr (ipos+1, std::string::npos);
199 std::string defstring;
200 bool has_default =
false;
201 ipos =
name.find (
'<');
202 if (ipos != std::string::npos) {
203 defstring =
name.substr (ipos+1, std::string::npos);
204 name.erase (ipos, std::string::npos);
209 ipos =
name.find (
'=');
210 if (ipos != std::string::npos) {
211 name.erase (ipos, std::string::npos);
212 label.erase (0, ipos+1);
215 std::vector<std::string>
labels;
217 std::vector<std::string> label_classes;
218 for (std::string&
l :
labels) {
219 std::string label_class;
220 ipos =
l.find (
"::");
221 if (ipos != std::string::npos) {
222 label_class =
l.substr (0, ipos);
228 label_classes.push_back (label_class);
237 if (!defstring.empty()) {
238 ipos = defstring.find (
':');
239 if (ipos != std::string::npos) {
240 std::string typname = defstring.substr (0, ipos);
242 defstring.erase (0, ipos+1);
246 const std::type_info* ti = typ.getTypeInfo();
248 for (
size_t i = 0;
i <
labels.size();
i++)
255 m_vars.push_back (std::make_unique<Var>
257 defstring, has_default));
259 catch (
const std::runtime_error&
e) {
261 <<
"Can't find aux data item(s) " <<
label
262 <<
" [" <<
e.what() <<
"]";
263 return StatusCode::FAILURE;
266 if (
m_vars.back()->accessors.empty()) {
268 <<
"Can't find aux data item(s) " <<
label;
269 return StatusCode::FAILURE;
272 return StatusCode::SUCCESS;
◆ m_auxprefix
std::string D3PD::AuxDataFillerTool::m_auxprefix |
|
private |
◆ m_blockName
std::string D3PD::BlockFillerToolImpl::m_blockName |
|
privateinherited |
◆ m_converter
◆ m_metadata
Metadata about the variables created by this object.
Definition at line 129 of file AddVariable.h.
◆ m_prefix
std::string D3PD::BlockFillerToolImpl::m_prefix |
|
privateinherited |
◆ m_suffix
std::string D3PD::BlockFillerToolImpl::m_suffix |
|
privateinherited |
◆ m_tree
◆ m_vars
std::vector<std::unique_ptr<Var> > D3PD::AuxDataFillerTool::m_vars |
|
private |
◆ m_varString
std::vector<std::string> D3PD::AuxDataFillerTool::m_varString |
|
private |
◆ 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:
static AuxTypeRegistry & instance()
Return the singleton registry instance.
std::string dstName() const
Return the name of the destination type, or an empty string.
StatusCode configureD3PD(IAddVariable *tree)
Configure the parent tree.
const std::string & m_suffix
Reference to the variable suffix.
const std::string & m_prefix
Reference to the variable prefix.
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.
Handle mappings between names and auxid_t.
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(LVL)
Report a message.
void trim(std::string &input)
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.
SG::auxid_t getAuxID(const std::string &name, const std::string &clsname="", const Flags flags=Flags::None, const SG::auxid_t linkedVariable=SG::null_auxid)
Look up a name -> auxid_t mapping.