Base class for all ROOT-based code generators. More...

#include <RootReaderD3PDBase.h>

Inheritance diagram for D3PD::RootReaderD3PDBase:

Collaboration diagram for D3PD::RootReaderD3PDBase:

Public Types
typedef unsigned int	Dim_t
	Currently unimplemented — see design note. More...

Public Member Functions
	RootReaderD3PDBase ()
	Quite empty constructor. More...

virtual StatusCode	addVariable (const std::string &name, const std::type_info &ti, void &ptr, const std::string &docstring="", const void defval=0)
	Main function for adding a variable to the D3PD. 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)
	Function currently not used by the D3PDMaker code. More...

virtual StatusCode	addMetadata (const std::string &key, const void *obj, const std::type_info &ti)
	Function adding metadata to the D3PD. Not implemented here! More...

virtual StatusCode	capture ()
	Function capturing the current value of the D3PD variables. Not implemented here! More...

virtual StatusCode	clear ()
	Function clearing the D3PD variables. Not implemented here! More...

virtual StatusCode	redim (const Dim_t *ptr)
	Function currently not used by the D3PDMaker code. More...

virtual void	setIsContainer (bool isContainer)
	Set the "isCollection" parameter of the object. More...

virtual bool	isContainer () const
	Get the "isCollection" parameter of the object. More...

virtual void	setPrefix (const std::string &prefix)
	Set the common prefix of the variables. More...

virtual const std::string &	prefix () const
	Get the common prefix of the variables. More...

virtual StatusCode	createReader (const std::string &classname, const std::string &dir="./") const =0
	Function creating the D3PDReader code. More...

template<class T >
StatusCode	addMetadata (const std::string &key, const T *obj)
	Add a new piece of metadata to the tuple. 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...

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
void	addSTLHeader (std::ostream &out, const char *name) const
	Function adding STL include statements to the header when needed. More...

Protected Attributes
ObjectMetadata	m_metadata
	Object holding the information about the variables. More...

Detailed Description

Base class for all ROOT-based code generators.

   To be able to simply create multiple different code generators, this
   class collects the functionality that all classes need to implement in
   the same way. Classes inheriting from this one only need to implement
   the <code>createReader(...)</code> function. (With as complicated
   code as they'd like...)

Author: Attila Krasznahorkay Attil.nosp@m.a.Kr.nosp@m.aszna.nosp@m.hork.nosp@m.ay@ce.nosp@m.rn.c.nosp@m.h

Revision: 462802

Date: 2011-10-12 18:06:24 +0200 (Wed, 12 Oct 2011)

Definition at line 38 of file RootReaderD3PDBase.h.

Member Typedef Documentation

◆ Dim_t

typedef unsigned int D3PD::ID3PD::Dim_t

inherited

Currently unimplemented — see design note.

Definition at line 52 of file ID3PD.h.

Constructor & Destructor Documentation

◆ RootReaderD3PDBase()

D3PD::RootReaderD3PDBase::RootReaderD3PDBase ( )

Quite empty constructor.

Definition at line 80 of file RootReaderD3PDBase.cxx.

       : m_metadata() {
  
    }

Member Function Documentation

◆ addDimensionedVariable() [1/3]

StatusCode D3PD::RootReaderD3PDBase::addDimensionedVariable	(	const std::string &	name,
		const std::type_info &	ti,
		void *&	ptr,
		const std::string &	dim,
		const std::string &	docstring = `""`,
		const void *	defval = `0`
	)

virtual

Function currently not used by the D3PDMaker code.

Implements D3PD::IAddVariable.

Definition at line 95 of file RootReaderD3PDBase.cxx.

                                                                                {
  
       CHECK( m_metadata.addDimensionedVariable( name, ti, ptr, dim, docstring,
                                                 defval ) );
       return StatusCode::SUCCESS;
    }

◆ addDimensionedVariable() [2/3]

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() [3/3]

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.

◆ addMetadata() [1/2]

template<class T >

StatusCode D3PD::ID3PD::addMetadata	(	const std::string &	key,
		const T *	obj
	)

inherited

Add a new piece of metadata to the tuple.

Parameters

key	- The key for this object. Any existing object will be overwritten.
obj	- Pointer to the object to write.

The interpretation of the key parameter is up to the concrete D3PD implementation. However, a key name with a trailing slash NAME/ indicates that all metadata items with this name should be grouped together in a collection called NAME (for example, in a Root directory with that name).

◆ addMetadata() [2/2]

StatusCode D3PD::RootReaderD3PDBase::addMetadata	(	const std::string &	key,
		const void *	obj,
		const std::type_info &	ti
	)

virtual

Function adding metadata to the D3PD. Not implemented here!

Implements D3PD::ID3PD.

Definition at line 107 of file RootReaderD3PDBase.cxx.

                                                                      {
  
       REPORT_MESSAGE_WITH_CONTEXT( MSG::ERROR, "RootReaderD3PDBase" )
          << "addMetadata(...) not implemented";
       return StatusCode::FAILURE;
    }

◆ addSTLHeader()

void D3PD::RootReaderD3PDBase::addSTLHeader	(	std::ostream &	out,
		const char *	name
	)		const

protected

Function adding STL include statements to the header when needed.

This function is used internally to decide if specific STL headers are needed for the generated code or not.

The code just checks if the header name appears in the variable types somewhere, and if it does, it adds the requested header.

Parameters

out	Output stream where the include statement has to be written
name	Name of the STL header that the code should process

Definition at line 167 of file RootReaderD3PDBase.cxx.

                                                                                   {
  
       // Check if the STL name appears in the variable type names:
       bool header_needed = false;
       std::set< D3PD::ObjectMetadata::Variable >::const_iterator itr =
          m_metadata.variables().begin();
       std::set< D3PD::ObjectMetadata::Variable >::const_iterator end =
          m_metadata.variables().end();
       for( ; itr != end; ++itr ) {
          if( itr->type().find( name ) != std::string::npos ) {
             header_needed = true;
             break;
          }
       }
  
       // If it does, let's include it:
       if( header_needed ) {
          out << "#include <" << name << ">" << std::endl;
       }
  
       return;
    }

◆ addVariable() [1/3]

StatusCode D3PD::RootReaderD3PDBase::addVariable	(	const std::string &	name,
		const std::type_info &	ti,
		void *&	ptr,
		const std::string &	docstring = `""`,
		const void *	defval = `0`
	)

virtual

Main function for adding a variable to the D3PD.

Implements D3PD::IAddVariable.

Definition at line 85 of file RootReaderD3PDBase.cxx.

                                                                     {
  
       CHECK( m_metadata.addVariable( name, ti, ptr, docstring, defval ) );
       return StatusCode::SUCCESS;
    }

◆ addVariable() [2/3]

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() [3/3]

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.

◆ capture()

StatusCode D3PD::RootReaderD3PDBase::capture ( )

virtual

Function capturing the current value of the D3PD variables. Not implemented here!

Implements D3PD::ID3PD.

Definition at line 116 of file RootReaderD3PDBase.cxx.

                                           {
  
       REPORT_MESSAGE_WITH_CONTEXT( MSG::ERROR, "RootReaderD3PDBase" )
          << "capture() not implemented";
       return StatusCode::FAILURE;
    }

◆ clear()

StatusCode D3PD::RootReaderD3PDBase::clear ( )

virtual

Function clearing the D3PD variables. Not implemented here!

Implements D3PD::ID3PD.

Definition at line 123 of file RootReaderD3PDBase.cxx.

                                         {
  
       REPORT_MESSAGE_WITH_CONTEXT( MSG::ERROR, "RootReaderD3PDBase" )
          << "clear() not implemented";
       return StatusCode::FAILURE;
    }

◆ createReader()

virtual StatusCode D3PD::IReaderD3PD::createReader	(	const std::string &	classname,
		const std::string &	dir = `"./"`
	)		const

pure virtualinherited

Function creating the D3PDReader code.

This function should be implemented in the child classes to generate the D3PDReader source files. It's quite a bit influenced by the currently only implementation (D3PD::RootReaderD3PD), but I believe it could be used for other backends later on as well.

Parameters

classname	Name of the class to be generated
dir	Directory where the source(s) should be put
prefix	Common prefix to the declared variables

Implemented in D3PD::RootReaderD3PD_v1, and D3PD::RootReaderD3PD_v2.

◆ isContainer()

bool D3PD::RootReaderD3PDBase::isContainer ( ) const

virtual

Get the "isCollection" parameter of the object.

Implements D3PD::IReaderD3PD.

Definition at line 143 of file RootReaderD3PDBase.cxx.

                                               {
  
       return m_metadata.container();
    }

◆ prefix()

const std::string & D3PD::RootReaderD3PDBase::prefix ( ) const

virtual

Get the common prefix of the variables.

Implements D3PD::IReaderD3PD.

Definition at line 154 of file RootReaderD3PDBase.cxx.

                                                      {
  
       return m_metadata.prefix();
    }

◆ redim()

StatusCode D3PD::RootReaderD3PDBase::redim ( const Dim_t * ptr )

virtual

Function currently not used by the D3PDMaker code.

Implements D3PD::ID3PD.

Definition at line 130 of file RootReaderD3PDBase.cxx.

                                                       {
  
       REPORT_MESSAGE_WITH_CONTEXT( MSG::ERROR, "RootReaderD3PDBase" )
          << "redim(...) not implemented";
       return StatusCode::FAILURE;
    }

◆ setIsContainer()

void D3PD::RootReaderD3PDBase::setIsContainer ( bool isContainer )

virtual

Set the "isCollection" parameter of the object.

Implements D3PD::IReaderD3PD.

Definition at line 137 of file RootReaderD3PDBase.cxx.

                                                              {
  
       m_metadata.setContainer( isContainer );
       return;
    }

◆ setPrefix()

void D3PD::RootReaderD3PDBase::setPrefix ( const std::string & prefix )

virtual

Set the common prefix of the variables.

Implements D3PD::IReaderD3PD.

Definition at line 148 of file RootReaderD3PDBase.cxx.

                                                                {
  
       m_metadata.setPrefix( prefix );
       return;
    }

Member Data Documentation

◆ m_metadata

ObjectMetadata D3PD::RootReaderD3PDBase::m_metadata

protected

Object holding the information about the variables.

Definition at line 84 of file RootReaderD3PDBase.h.

The documentation for this class was generated from the following files:

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

◆ Dim_t

Constructor & Destructor Documentation

◆ RootReaderD3PDBase()

Member Function Documentation

◆ addDimensionedVariable() [1/3]

◆ addDimensionedVariable() [2/3]

◆ addDimensionedVariable() [3/3]

◆ addMetadata() [1/2]

◆ addMetadata() [2/2]

◆ addSTLHeader()

◆ addVariable() [1/3]

◆ addVariable() [2/3]

◆ addVariable() [3/3]

◆ capture()

◆ clear()

◆ createReader()

◆ isContainer()

◆ prefix()

◆ redim()

◆ setIsContainer()

◆ setPrefix()

Member Data Documentation

◆ m_metadata