Pandora
Pandora source code navigator
Loading...
Searching...
No Matches
object_creation::ObjectCreationHelper< PARAMETERS, METADATA, OBJECT > Class Template Reference

Object creation helper class. More...

#include "ObjectCreation.h"

Public Types

typedef PARAMETERS Parameters
 
typedef METADATA Metadata
 
typedef OBJECT Object
 

Static Public Member Functions

static pandora::StatusCode Create (const pandora::Pandora &pandora, const Parameters &parameters, const pandora::ObjectFactory< Parameters, Object > &factory=pandora::PandoraObjectFactory< Parameters, Object >())
 Create a new object from a user factory.
 
static pandora::StatusCode Create (const pandora::Algorithm &algorithm, const Parameters &parameters, const Object *&pObject, const pandora::ObjectFactory< Parameters, Object > &factory=pandora::PandoraObjectFactory< Parameters, Object >())
 Create a new object from a user factory, receiving the address of the object created.
 
static pandora::StatusCode AlterMetadata (const pandora::Algorithm &algorithm, const Object *const pObject, const Metadata &metadata)
 Alter the metadata information stored in an object.
 

Detailed Description

template<typename PARAMETERS, typename METADATA, typename OBJECT>
class object_creation::ObjectCreationHelper< PARAMETERS, METADATA, OBJECT >

Object creation helper class.

Parameters
PARAMETERSthe type of object parameters
METADATAthe type of object metadata
OBJECTthe type of object

Definition at line 35 of file ObjectCreation.h.

Member Typedef Documentation

◆ Metadata

template<typename PARAMETERS , typename METADATA , typename OBJECT >
typedef METADATA object_creation::ObjectCreationHelper< PARAMETERS, METADATA, OBJECT >::Metadata

Definition at line 39 of file ObjectCreation.h.

◆ Object

template<typename PARAMETERS , typename METADATA , typename OBJECT >
typedef OBJECT object_creation::ObjectCreationHelper< PARAMETERS, METADATA, OBJECT >::Object

Definition at line 40 of file ObjectCreation.h.

◆ Parameters

template<typename PARAMETERS , typename METADATA , typename OBJECT >
typedef PARAMETERS object_creation::ObjectCreationHelper< PARAMETERS, METADATA, OBJECT >::Parameters

Definition at line 38 of file ObjectCreation.h.

Member Function Documentation

◆ AlterMetadata()

template<typename PARAMETERS , typename METADATA , typename OBJECT >
StatusCode object_creation::ObjectCreationHelper< PARAMETERS, METADATA, OBJECT >::AlterMetadata ( const pandora::Algorithm algorithm,
const Object *const  pObject,
const Metadata metadata 
)
static

Alter the metadata information stored in an object.

Parameters
algorithmthe algorithm calling this function
pObjectaddress of the object to modify
metaDatathe metadata (only populated metadata fields will be propagated to the object)

Definition at line 43 of file ObjectCreation.cc.

Here is the call graph for this function:

◆ Create() [1/2]

template<typename PARAMETERS , typename METADATA , typename OBJECT >
static pandora::StatusCode object_creation::ObjectCreationHelper< PARAMETERS, METADATA, OBJECT >::Create ( const pandora::Algorithm algorithm,
const Parameters parameters,
const Object *&  pObject,
const pandora::ObjectFactory< Parameters, Object > &  factory = pandora::PandoraObjectFactoryParametersObject >() 
)
static

Create a new object from a user factory, receiving the address of the object created.

Parameters
algorithmthe algorithm calling this function
parametersthe object parameters
pObjectto receive the address of the object created
factorythe factory that performs the object allocation

◆ Create() [2/2]

template<typename PARAMETERS , typename METADATA , typename OBJECT >
static pandora::StatusCode object_creation::ObjectCreationHelper< PARAMETERS, METADATA, OBJECT >::Create ( const pandora::Pandora pandora,
const Parameters parameters,
const pandora::ObjectFactory< Parameters, Object > &  factory = pandora::PandoraObjectFactoryParametersObject >() 
)
static

Create a new object from a user factory.

Parameters
pandorathe pandora instance to create the new object
parametersthe object parameters
factorythe factory that performs the object allocation
Here is the caller graph for this function:

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