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

#include <GModelRegistry.hpp>

Inheritance diagram for GModelRegistry:

Public Member Functions
	GModelRegistry (void)
	Void constructor.

	GModelRegistry (const GModel *model)
	Model constructor.

	GModelRegistry (const GModelRegistry &registry)
	Copy constructor.

virtual	~GModelRegistry (void)
	Destructor.

GModelRegistry &	operator= (const GModelRegistry &registry)
	Assignment operator.

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

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

GModel *	alloc (const std::string &name) const
	Allocate model of given name.

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

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

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

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

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

void	copy_members (const GModelRegistry &registry)
	Copy class members.

void	free_members (void)
	Delete class members.

Static Private Member Functions
static int &	number ()

static GRegistryPointer< std::string > &	names ()

static GRegistryPointer< const GModel * > &	models ()

Detailed Description

Interface definition for the model registry class.

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

const GModelXXX      g_XXX_seed;
const GModelRegistry g_XXX_registry(&g_XXX_seed);

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

Definition at line 53 of file GModelRegistry.hpp.

Constructor & Destructor Documentation

◆ GModelRegistry() [1/3]

GModelRegistry::GModelRegistry ( void )

Void constructor.

Definition at line 55 of file GModelRegistry.cpp.

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

◆ GModelRegistry() [2/3]

GModelRegistry::GModelRegistry ( const GModel * 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 82 of file GModelRegistry.cpp.

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

◆ GModelRegistry() [3/3]

GModelRegistry::GModelRegistry ( const GModelRegistry & registry )

Copy constructor.

Parameters

[in] registry Registry.

Definition at line 133 of file GModelRegistry.cpp.

References copy_members(), and init_members().

◆ ~GModelRegistry()

GModelRegistry::~GModelRegistry ( void )

virtual

Destructor.

Definition at line 149 of file GModelRegistry.cpp.

References free_members().

Member Function Documentation

◆ alloc()

GModel * GModelRegistry::alloc ( const std::string & name ) const

Allocate model of given name.

Parameters

[in] name Model name.

Returns: Pointer to model (NULL if name is not registered).

Returns a pointer to a void model instance of the specified name. If the name has not been found in the registry, a NULL pointer is returned.

Definition at line 207 of file GModelRegistry.cpp.

References GModel::clone(), models(), name(), names(), and size().

Referenced by GModelDataMultiplicative::read(), and GModels::read().

◆ classname()

std::string GModelRegistry::classname ( void ) const

inlinevirtual

Return class name.

Returns: String containing the class name ("GModelRegistry").

Implements GRegistry.

Definition at line 107 of file GModelRegistry.hpp.

◆ copy_members()

void GModelRegistry::copy_members ( const GModelRegistry & registry )

protected

Copy class members.

Parameters

[in] registry Registry.

Definition at line 304 of file GModelRegistry.cpp.

Referenced by GModelRegistry(), and operator=().

◆ free_members()

void GModelRegistry::free_members ( void )

protected

Delete class members.

Definition at line 314 of file GModelRegistry.cpp.

Referenced by operator=(), and ~GModelRegistry().

◆ init_members()

void GModelRegistry::init_members ( void )

protected

Initialise class members.

Definition at line 292 of file GModelRegistry.cpp.

Referenced by GModelRegistry(), GModelRegistry(), GModelRegistry(), and operator=().

◆ models()

static GRegistryPointer< const GModel * > & GModelRegistry::models ( )

inlinestaticprivate

Definition at line 94 of file GModelRegistry.hpp.

Referenced by alloc(), GModelRegistry(), and print().

◆ name()

std::string GModelRegistry::name ( const int & index ) const

virtual

Returns model name.

Parameters

[in] index Model index [0,...,size()[.

Returns: Model name.

Exceptions

GException::out_of_range Model index is out of range.

Implements GRegistry.

Definition at line 234 of file GModelRegistry.cpp.

References G_NAME, names(), and size().

Referenced by alloc().

◆ names()

static GRegistryPointer< std::string > & GModelRegistry::names ( )

inlinestaticprivate

Definition at line 89 of file GModelRegistry.hpp.

Referenced by alloc(), GModelRegistry(), GModelRegistry(), name(), and print().

◆ number()

static int & GModelRegistry::number ( )

inlinestaticprivate

Definition at line 84 of file GModelRegistry.hpp.

Referenced by GModelRegistry(), and size().

◆ operator=()

GModelRegistry & GModelRegistry::operator= ( const GModelRegistry & registry )

Assignment operator.

Parameters

[in] registry Registry.

Returns: Reference to registry.

Definition at line 171 of file GModelRegistry.cpp.

References copy_members(), free_members(), and init_members().

◆ print()

std::string GModelRegistry::print ( const GChatter & chatter = NORMAL ) const

virtual

Print registry information.

Parameters

[in] chatter Chattiness.

Returns: Registry content.

Implements GRegistry.

Definition at line 254 of file GModelRegistry.cpp.

References models(), names(), NORMAL, gammalib::parformat(), SILENT, size(), and gammalib::str().

◆ size()

int GModelRegistry::size ( void ) const

inlinevirtual

Return number of registered models.

Returns: Number of registered models.

Returns the number of registered model.

Implements GRegistry.

Definition at line 121 of file GModelRegistry.hpp.

References number().

Referenced by alloc(), GModelRegistry(), GModelRegistry(), name(), and print().

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

include/GModelRegistry.hpp
src/model/GModelRegistry.cpp

Public Member Functions

Protected Member Functions

Static Private Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ GModelRegistry() [1/3]

◆ GModelRegistry() [2/3]

◆ GModelRegistry() [3/3]

◆ ~GModelRegistry()

Member Function Documentation

◆ alloc()

◆ classname()

◆ copy_members()

◆ free_members()

◆ init_members()

◆ models()

◆ name()

◆ names()

◆ number()

◆ operator=()

◆ print()

◆ size()