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

#include <GObservationRegistry.hpp>

Inheritance diagram for GObservationRegistry:

Public Member Functions
	GObservationRegistry (void)
	Void constructor.

	GObservationRegistry (const GObservation *obs)
	Observation constructor.

	GObservationRegistry (const GObservationRegistry &registry)
	Copy constructor.

virtual	~GObservationRegistry (void)
	Destructor.

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

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

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

GObservation *	alloc (const std::string &name) const
	Allocate observation of given name.

std::string	name (const int &index) const
	Returns instrument name for a specific registered observation.

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 GObservationRegistry &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 GObservation * > &	obs ()

Detailed Description

Interface definition for the observation registry class.

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

const GXXXObservation      g_obs_XXX_seed;
const GObservationRegistry g_obs_XXX_registry(&g_obs_XXX_seed);

at the top of the .cpp file of the observation. Here, XXX is a unique name that describes the instrument for which the observation class is implemented.

Definition at line 54 of file GObservationRegistry.hpp.

Constructor & Destructor Documentation

◆ GObservationRegistry() [1/3]

GObservationRegistry::GObservationRegistry ( void )

Void constructor.

Definition at line 55 of file GObservationRegistry.cpp.

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

◆ GObservationRegistry() [2/3]

GObservationRegistry::GObservationRegistry ( const GObservation * obs )

Observation constructor.

Parameters

[in] obs Observation.

Definition at line 79 of file GObservationRegistry.cpp.

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

◆ GObservationRegistry() [3/3]

GObservationRegistry::GObservationRegistry ( const GObservationRegistry & registry )

Copy constructor.

Parameters

[in] registry Registry.

Definition at line 130 of file GObservationRegistry.cpp.

References copy_members(), and init_members().

◆ ~GObservationRegistry()

GObservationRegistry::~GObservationRegistry ( void )

virtual

Destructor.

Definition at line 146 of file GObservationRegistry.cpp.

References free_members().

Member Function Documentation

◆ alloc()

GObservation * GObservationRegistry::alloc ( const std::string & name ) const

Allocate observation of given name.

Parameters

[in] name Instrument name.

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

Returns a pointer to an observation instance for a specific name. If the instrument name has not been found in the registry, a NULL pointer is returned.

Definition at line 205 of file GObservationRegistry.cpp.

References GObservation::clone(), name(), names(), obs(), and size().

Referenced by GObservations::read().

◆ classname()

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

inlinevirtual

Return class name.

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

Implements GRegistry.

Definition at line 108 of file GObservationRegistry.hpp.

◆ copy_members()

void GObservationRegistry::copy_members ( const GObservationRegistry & registry )

protected

Copy class members.

Parameters

[in] registry Registry.

Definition at line 304 of file GObservationRegistry.cpp.

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

◆ free_members()

void GObservationRegistry::free_members ( void )

protected

Delete class members.

Definition at line 314 of file GObservationRegistry.cpp.

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

◆ init_members()

void GObservationRegistry::init_members ( void )

protected

Initialise class members.

Definition at line 292 of file GObservationRegistry.cpp.

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

◆ name()

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

virtual

Returns instrument name for a specific registered observation.

Parameters

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

Returns: Instrument name.

Exceptions

GException::out_of_range Observation index is out of range.

Implements GRegistry.

Definition at line 232 of file GObservationRegistry.cpp.

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

Referenced by alloc().

◆ names()

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

inlinestaticprivate

Definition at line 90 of file GObservationRegistry.hpp.

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

◆ number()

static int & GObservationRegistry::number ( )

inlinestaticprivate

Definition at line 85 of file GObservationRegistry.hpp.

Referenced by GObservationRegistry(), and size().

◆ obs()

static GRegistryPointer< const GObservation * > & GObservationRegistry::obs ( )

inlinestaticprivate

Definition at line 95 of file GObservationRegistry.hpp.

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

◆ operator=()

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

Assignment operator.

Parameters

[in] registry Registry.

Returns: Reference to registry.

Definition at line 168 of file GObservationRegistry.cpp.

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

◆ print()

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

virtual

Print registry information.

Parameters

[in] chatter Chattiness (defaults to NORMAL).

Returns: Registry content.

Implements GRegistry.

Definition at line 253 of file GObservationRegistry.cpp.

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

◆ size()

int GObservationRegistry::size ( void ) const

inlinevirtual

Return number of registered observations.

Returns: Number of registered observations.

Returns the number of registered observations.

Implements GRegistry.

Definition at line 122 of file GObservationRegistry.hpp.

References number().

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

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

include/GObservationRegistry.hpp
src/obs/GObservationRegistry.cpp

Public Member Functions

Protected Member Functions

Static Private Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ GObservationRegistry() [1/3]

◆ GObservationRegistry() [2/3]

◆ GObservationRegistry() [3/3]

◆ ~GObservationRegistry()

Member Function Documentation

◆ alloc()

◆ classname()

◆ copy_members()

◆ free_members()

◆ init_members()

◆ name()

◆ names()

◆ number()

◆ obs()

◆ operator=()

◆ print()

◆ size()