Interface definition for the temporal model registry class. More...

#include <GModelTemporalRegistry.hpp>

Inheritance diagram for GModelTemporalRegistry:

Public Member Functions
	GModelTemporalRegistry (void)
	Void constructor. More...

	GModelTemporalRegistry (const GModelTemporal *model)
	Model constructor. More...

	GModelTemporalRegistry (const GModelTemporalRegistry &registry)
	Copy constructor. More...

virtual	~GModelTemporalRegistry (void)
	Destructor. More...

GModelTemporalRegistry &	operator= (const GModelTemporalRegistry &registry)
	Assignment operator. More...

std::string	classname (void) const
	Return class name. More...

int	size (void) const
	Return number of registered models. More...

GModelTemporal *	alloc (const GXmlElement &xml) const
	Allocate temporal model that is found in XML element. More...

std::string	name (const int &index) const
	Returns model name. More...

std::string	print (const GChatter &chatter=NORMAL) const
	Print registry information. More...

Public Member Functions inherited from GRegistry
virtual	~GRegistry (void)
	Destructor. More...

std::string	content (void) const
	Return list of names in registry. More...

Protected Member Functions
void	init_members (void)
	Initialise class members. More...

void	copy_members (const GModelTemporalRegistry &registry)
	Copy class members. More...

void	free_members (void)
	Delete class members. More...

Static Private Member Functions
static int &	number ()

static GRegistryPointer< const GModelTemporal * > &	models ()

Detailed Description

Interface definition for the temporal model registry class.

The registry class allows the registration of temporal models that are not necessarily compiled into the GammaLib. It uses the static members m_number and m_models which are allocated globally to keep track of temporal models that are available throughout all linked libraries. To register a temporal model it is sufficient to add

const GModelTemporalXXX      g_temporal_XXX_seed;
const GModelTemporalRegistry g_temporal_XXX_registry(&g_spectral_XXX_seed);

at the top of the .cpp file of the temporal model. Here, XXX is a unique name that describes the model.

Definition at line 56 of file GModelTemporalRegistry.hpp.

Constructor & Destructor Documentation

GModelTemporalRegistry::GModelTemporalRegistry ( void )

Void constructor.

Definition at line 58 of file GModelTemporalRegistry.cpp.

References init_members(), models(), and size().

GModelTemporalRegistry::GModelTemporalRegistry ( const GModelTemporal * model )

Model constructor.

Parameters

[in] model Model.

Construct registry by adding a model to the registry. This is the standard constructor that is used to register a new model to GammaLib.

Definition at line 85 of file GModelTemporalRegistry.cpp.

References init_members(), models(), number(), size(), and GModelTemporal::type().

GModelTemporalRegistry::GModelTemporalRegistry ( const GModelTemporalRegistry & registry )

Copy constructor.

Parameters

[in] registry Registry.

Definition at line 132 of file GModelTemporalRegistry.cpp.

References copy_members(), and init_members().

GModelTemporalRegistry::~GModelTemporalRegistry ( void )

virtual

Destructor.

Definition at line 148 of file GModelTemporalRegistry.cpp.

References free_members().

Member Function Documentation

GModelTemporal * GModelTemporalRegistry::alloc ( const GXmlElement & xml ) const

Allocate temporal model that is found in XML element.

Parameters

[in] xml XML element.

Returns: Pointer to temporal model.

Exceptions

GException::invalid_value No appropriate temporal model found in XML element.

Returns a pointer to a temporal model instance that corresponds to the type found in an XML element. If no appropriate model is found the method will throw an exception.

Definition at line 210 of file GModelTemporalRegistry.cpp.

References GXmlElement::attribute(), G_ALLOC, models(), GModelTemporal::read(), and size().

Referenced by GCTAModelIrfBackground::xml_temporal(), GCTAModelAeffBackground::xml_temporal(), GCTAModelCubeBackground::xml_temporal(), GCTAModelRadialAcceptance::xml_temporal(), GCTAModelBackground::xml_temporal(), GCTAModelSkyCube::xml_temporal(), and GModelSky::xml_temporal().