Test setting default values in d3pds. More...

#include <DefaultFillerTool.h>

Inheritance diagram for D3PDTest::DefaultFillerTool:

Collaboration diagram for D3PDTest::DefaultFillerTool:

Public Member Functions
	DefaultFillerTool (const std::string &type, const std::string &name, const IInterface *parent)
	Standard Gaudi tool constructor.
virtual StatusCode	book () final
	Book variables for this block.
virtual StatusCode	fill () override
	Fill one block — type-safe version.
virtual StatusCode	configureD3PD (IAddVariable *tree, const std::type_info &ti)
	Configure during initialization: type-check.
StatusCode	configureD3PD (IAddVariable *tree)
	Configure the parent tree.
virtual StatusCode	fillUntyped (const void *p, bool again)
	Fill one block.
virtual StatusCode	fillAgain ()
	Fill one block, after `AGAIN` has been returned (type-safe).
	BlockFillerToolImpl (const std::string &type, const std::string &name, const IInterface *parent)
	Standard Gaudi tool constructor.
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.
StatusCode	addVariable (const std::string &name, void *&ptr, const std::string &docstring="")
	Make the template implementation from `IAddVariable` visible.
StatusCode	addVariable (const std::string &name, void *&ptr, const std::string &docstring, const U &defval)
	Make the template implementation from `IAddVariable` visible.
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.
StatusCode	addDimensionedVariable (const std::string &name, void *&ptr, const std::string &dim, const std::string &docstring="")
	Add a variable to the tuple.
StatusCode	addDimensionedVariable (const std::string &name, void *&ptr, const std::string &dim, const std::string &docstring, const U &defval)
	Add a variable to the tuple.

Protected Member Functions
StatusCode	configureImpl (IAddVariable *tree, const std::type_info &ti, const std::type_info &fill_ti)
	Configure during initialization: type-check.
StatusCode	configureImpl (IAddVariable tree, const std::type_info &ti, const std::vector< const std::type_info > &tis, size_t &which)
	Configure during initialization: type-check.
StatusCode	convert (void const *&p) const
	Do type conversion.

Protected Attributes
ObjectMetadata	m_metadata
	Metadata about the variables created by this object.

Private Attributes
char *	m_c1
	Variables.
char *	m_c2
unsigned char *	m_uc1
unsigned char *	m_uc2
short *	m_s1
short *	m_s2
unsigned short *	m_us1
unsigned short *	m_us2
int *	m_i1
int *	m_i2
unsigned int *	m_ui1
unsigned int *	m_ui2
float *	m_f1
float *	m_f2
double *	m_d1
double *	m_d2
bool *	m_b1
bool *	m_b2
std::string	m_prefix
	Property: the variable prefix for this block.
std::string	m_suffix
	Property: the variable prefix for this block.
std::string	m_blockName
	Property: the name of this block.
TypeConverter	m_converter
	Helper to do type conversions.
IAddVariable *	m_tree
	Reference to the block name.

Static Private Attributes
static const std::string	s_emptyString
	Used to provide a default value for blockName.

Detailed Description

Test setting default values in d3pds.

Definition at line 26 of file DefaultFillerTool.h.

Constructor & Destructor Documentation

◆ DefaultFillerTool()

D3PDTest::DefaultFillerTool::DefaultFillerTool	(	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 27 of file DefaultFillerTool.cxx.

  : D3PD::BlockFillerTool<void> (type, name, parent)
{
  book().ignore(); // Avoid coverity warnings
}

Member Function Documentation

◆ addDimensionedVariable() [1/3]

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.

Definition at line 119 of file AddVariable.cxx.

{
  if (!m_tree) {
    // Called from constructor --- just initialize pointer.
    ptr = 0;
    return StatusCode::SUCCESS;
  }
 
  CHECK( m_metadata.addDimensionedVariable( m_prefix + name + m_suffix,
                                            ti, ptr, dim,
                                            docstring, defval ) );
  return m_tree->addDimensionedVariable (m_prefix + name + m_suffix,
                                         ti, ptr, dim,
                                         docstring, defval);
}

◆ addDimensionedVariable() [2/3]

StatusCode D3PD::IAddVariable::addDimensionedVariable	(	const std::string &	name,
		void *&	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() [3/3]

StatusCode D3PD::IAddVariable::addDimensionedVariable	(	const std::string &	name,
		void *&	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/3]

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.

Definition at line 93 of file AddVariable.cxx.

{
  if (!m_tree) {
    // Called from constructor --- just initialize pointer.
    ptr = 0;
    return StatusCode::SUCCESS;
  }
 
  CHECK( m_metadata.addVariable( m_prefix + name + m_suffix,
                                 ti, ptr, docstring, defval ) );
  return m_tree->addVariable (m_prefix + name + m_suffix,
                              ti, ptr, docstring, defval);
}

◆ addVariable() [2/3]

StatusCode D3PD::IAddVariable::addVariable	(	const std::string &	name,
		void *&	ptr,
		const std::string &	docstring,
		const U &	defval )

inherited

Make the template implementation from IAddVariable visible.

◆ addVariable() [3/3]

StatusCode D3PD::IAddVariable::addVariable	(	const std::string &	name,
		void *&	ptr,
		const std::string &	docstring = "" )

inherited

Make the template implementation from IAddVariable visible.

◆ BlockFillerToolImpl()

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

inherited

Standard Gaudi tool constructor.

Parameters

type	The name of the tool type.
name	The tool name.
parent	The tool's Gaudi parent.

◆ book()

StatusCode D3PDTest::DefaultFillerTool::book ( )

finalvirtual

Book variables for this block.

Implements D3PD::BlockFillerTool< void >.

Definition at line 39 of file DefaultFillerTool.cxx.

{
  CHECK( addVariable ("c1",   m_c1) );
  CHECK( addVariable ("c2",   m_c2, "", 1) );
  CHECK( addVariable ("uc1",  m_uc1) );
  CHECK( addVariable ("uc2",  m_uc2, "", 2) );
  CHECK( addVariable ("s1",   m_s1) );
  CHECK( addVariable ("s2",   m_s2, "", -3) );
  CHECK( addVariable ("us1",  m_us1) );
  CHECK( addVariable ("us2",  m_us2, "", 4) );
  CHECK( addVariable ("i1",   m_i1) );
  CHECK( addVariable ("i2",   m_i2, "", -5) );
  CHECK( addVariable ("ui1",  m_ui1) );
  CHECK( addVariable ("ui2",  m_ui2, "", 6) );
  CHECK( addVariable ("f1",   m_f1) );
  CHECK( addVariable ("f2",   m_f2, "", -7.5) );
  CHECK( addVariable ("d1",   m_d1) );
  CHECK( addVariable ("d2",   m_d2, "", 8.5) );
  CHECK( addVariable ("b1",   m_b1) );
  CHECK( addVariable ("b2",   m_b2, "", true) );
 
  return StatusCode::SUCCESS;
}

◆ configureD3PD() [1/2]

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

inherited

Configure the parent tree.

Parameters

tree	The parent `IAddVariable` instance.

Definition at line 69 of file AddVariable.cxx.

{
  m_tree = tree;
  m_metadata.clear();
  return StatusCode::SUCCESS;
}

◆ configureD3PD() [2/2]

StatusCode D3PD::BlockFillerTool< void >::configureD3PD	(	IAddVariable *	tree,
		const std::type_info &	ti )

virtualinherited

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 43 of file VoidBlockFillerTool.cxx.

{
  return configureImpl (tree, ti, typeid(void) );
}

◆ 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 70 of file BlockFillerToolImpl.cxx.

{
  CHECK( AddVariable::configureD3PD (tree) );
  CHECK( m_converter.init (ti, fill_ti) );
 
  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 91 of file BlockFillerToolImpl.cxx.

{
  CHECK( AddVariable::configureD3PD (tree) );
  CHECK( m_converter.init (ti, tis, which) );
  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 107 of file BlockFillerToolImpl.cxx.

{
  p = m_converter.convertUntyped (p);
  if (!p) {
    REPORT_MESSAGE (MSG::ERROR)
      << "Pointer conversion from " << m_converter.srcName() << " to "
      << m_converter.dstName() << "failed.";
    return StatusCode::FAILURE;
  }
  return StatusCode::SUCCESS;
}

◆ fill()

StatusCode D3PDTest::DefaultFillerTool::fill ( )

overridevirtual

Fill one block — type-safe version.

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< void >.

Definition at line 71 of file DefaultFillerTool.cxx.

{
  return StatusCode::SUCCESS;
}

◆ fillAgain()

StatusCode D3PD::BlockFillerTool< void >::fillAgain ( )

virtualinherited

Fill one block, after AGAIN has been returned (type-safe).

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().

Definition at line 97 of file VoidBlockFillerTool.cxx.

{
  return fill();
}

◆ fillUntyped()

StatusCode D3PD::BlockFillerTool< void >::fillUntyped	(	const void *	p,
		bool	again )

virtualinherited

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 77 of file VoidBlockFillerTool.cxx.

{
  if (again)
    return fillAgain();
  return fill() ;
}

Member Data Documentation

◆ m_b1

bool* D3PDTest::DefaultFillerTool::m_b1

private

Definition at line 73 of file DefaultFillerTool.h.

◆ m_b2

bool* D3PDTest::DefaultFillerTool::m_b2

private

Definition at line 74 of file DefaultFillerTool.h.

◆ m_blockName

std::string D3PD::BlockFillerToolImpl::m_blockName

privateinherited

Property: the name of this block.

Definition at line 118 of file BlockFillerToolImpl.h.

◆ m_c1

char* D3PDTest::DefaultFillerTool::m_c1

private

Variables.

Definition at line 57 of file DefaultFillerTool.h.

◆ m_c2

char* D3PDTest::DefaultFillerTool::m_c2

private

Definition at line 58 of file DefaultFillerTool.h.

◆ m_converter

TypeConverter D3PD::BlockFillerToolImpl::m_converter

privateinherited

Helper to do type conversions.

Definition at line 121 of file BlockFillerToolImpl.h.

◆ m_d1

double* D3PDTest::DefaultFillerTool::m_d1

private

Definition at line 71 of file DefaultFillerTool.h.

◆ m_d2

double* D3PDTest::DefaultFillerTool::m_d2

private

Definition at line 72 of file DefaultFillerTool.h.

◆ m_f1

float* D3PDTest::DefaultFillerTool::m_f1

private

Definition at line 69 of file DefaultFillerTool.h.

◆ m_f2

float* D3PDTest::DefaultFillerTool::m_f2

private

Definition at line 70 of file DefaultFillerTool.h.

◆ m_i1

int* D3PDTest::DefaultFillerTool::m_i1

private

Definition at line 65 of file DefaultFillerTool.h.

◆ m_i2

int* D3PDTest::DefaultFillerTool::m_i2

private

Definition at line 66 of file DefaultFillerTool.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_prefix

std::string D3PD::BlockFillerToolImpl::m_prefix

privateinherited

Property: the variable prefix for this block.

Definition at line 112 of file BlockFillerToolImpl.h.

◆ m_s1

short* D3PDTest::DefaultFillerTool::m_s1

private

Definition at line 61 of file DefaultFillerTool.h.

◆ m_s2

short* D3PDTest::DefaultFillerTool::m_s2

private

Definition at line 62 of file DefaultFillerTool.h.

◆ m_suffix

std::string D3PD::BlockFillerToolImpl::m_suffix

privateinherited

Property: the variable prefix for this block.

Definition at line 115 of file BlockFillerToolImpl.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.

◆ m_uc1

unsigned char* D3PDTest::DefaultFillerTool::m_uc1

private

Definition at line 59 of file DefaultFillerTool.h.

◆ m_uc2

unsigned char* D3PDTest::DefaultFillerTool::m_uc2

private

Definition at line 60 of file DefaultFillerTool.h.

◆ m_ui1

unsigned int* D3PDTest::DefaultFillerTool::m_ui1

private

Definition at line 67 of file DefaultFillerTool.h.

◆ m_ui2

unsigned int* D3PDTest::DefaultFillerTool::m_ui2

private

Definition at line 68 of file DefaultFillerTool.h.

◆ m_us1

unsigned short* D3PDTest::DefaultFillerTool::m_us1

private

Definition at line 63 of file DefaultFillerTool.h.

◆ m_us2

unsigned short* D3PDTest::DefaultFillerTool::m_us2

private

Definition at line 64 of file DefaultFillerTool.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:

Public Member Functions

Protected Member Functions

Protected Attributes

Private Attributes

Static Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ DefaultFillerTool()

Member Function Documentation

◆ addDimensionedVariable() [1/3]

◆ addDimensionedVariable() [2/3]

◆ addDimensionedVariable() [3/3]

◆ addVariable() [1/3]

◆ addVariable() [2/3]

◆ addVariable() [3/3]

◆ BlockFillerToolImpl()

◆ book()

◆ configureD3PD() [1/2]

◆ configureD3PD() [2/2]

◆ configureImpl() [1/2]

◆ configureImpl() [2/2]

◆ convert()

◆ fill()

◆ fillAgain()

◆ fillUntyped()

Member Data Documentation

◆ m_b1

◆ m_b2

◆ m_blockName

◆ m_c1

◆ m_c2

◆ m_converter

◆ m_d1

◆ m_d2

◆ m_f1

◆ m_f2

◆ m_i1

◆ m_i2

◆ m_metadata

◆ m_prefix

◆ m_s1

◆ m_s2

◆ m_suffix

◆ m_tree

◆ m_uc1

◆ m_uc2

◆ m_ui1

◆ m_ui2

◆ m_us1

◆ m_us2

◆ s_emptyString