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

#include <GModelSpectralRegistry.hpp>

Inheritance diagram for GModelSpectralRegistry:

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

	GModelSpectralRegistry (const GModelSpectral *model)
	Model constructor. More...

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

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

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

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

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

GModelSpectral *	alloc (const GXmlElement &xml) const
	Allocate spectral 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 GModelSpectralRegistry &registry)
	Copy class members. More...

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

Static Private Member Functions
static int &	number ()

static GRegistryPointer< const GModelSpectral * > &	models ()

Detailed Description

Interface definition for the spectral model registry class.

The registry class allows the registration of spectral 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 spectral models that are available throughout all linked libraries. To register a spectral model it is sufficient to add

const GModelSpectralXXX      g_spectral_XXX_seed;
const GModelSpectralRegistry g_spectral_XXX_registry(&g_spectral_XXX_seed);

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

Definition at line 56 of file GModelSpectralRegistry.hpp.

Constructor & Destructor Documentation

GModelSpectralRegistry::GModelSpectralRegistry ( void )

Void constructor.

Definition at line 58 of file GModelSpectralRegistry.cpp.

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

GModelSpectralRegistry::GModelSpectralRegistry ( const GModelSpectral * 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 GModelSpectralRegistry.cpp.

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

GModelSpectralRegistry::GModelSpectralRegistry ( const GModelSpectralRegistry & registry )

Copy constructor.

Parameters

[in] registry Registry.

Definition at line 132 of file GModelSpectralRegistry.cpp.

References copy_members(), and init_members().

GModelSpectralRegistry::~GModelSpectralRegistry ( void )

virtual

Destructor.

Definition at line 148 of file GModelSpectralRegistry.cpp.

References free_members().

Member Function Documentation

GModelSpectral * GModelSpectralRegistry::alloc ( const GXmlElement & xml ) const

Allocate spectral model that is found in XML element.

Parameters

[in] xml XML element.

Returns: Pointer to spectral model.

Exceptions

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

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

Definition at line 210 of file GModelSpectralRegistry.cpp.

References GXmlElement::attribute(), G_ALLOC, models(), name(), GModelSpectral::read(), size(), and gammalib::xml_has_par().

Referenced by GCTAModelSpatialGaussSpectrum::read(), GModelSpectralComposite::read(), GModelSpectralMultiplicative::read(), GModelSpectralExponential::read(), GCTAModelIrfBackground::xml_spectral(), GCTAModelAeffBackground::xml_spectral(), GCTAModelCubeBackground::xml_spectral(), GCTAModelRadialAcceptance::xml_spectral(), GCTAModelBackground::xml_spectral(), GCTAModelSkyCube::xml_spectral(), and GModelSky::xml_spectral().