GammaLib  1.7.0.dev
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
GCTACubeSource Class Referenceabstract

CTA source cube base class. More...

#include <GCTACubeSource.hpp>

Inheritance diagram for GCTACubeSource:
GBase

Public Member Functions

 GCTACubeSource (void)
 Void constructor. More...
 
 GCTACubeSource (const GCTACubeSource &source)
 Copy constructor. More...
 
virtual ~GCTACubeSource (void)
 Destructor. More...
 
virtual GCTACubeSourceoperator= (const GCTACubeSource &source)
 Assignment operator. More...
 
virtual void clear (void)=0
 Clear object. More...
 
virtual GCTACubeSourceclone (void) const =0
 Clones object. More...
 
virtual std::string classname (void) const =0
 Return class name. More...
 
virtual GCTAClassCode code (void) const =0
 
virtual void set (const std::string &name, const GModelSpatial &model, const GObservation &obs)=0
 
virtual std::string print (const GChatter &chatter=NORMAL) const =0
 Print content of object. More...
 
virtual const std::string & name (void) const
 Return the source name. More...
 
virtual void name (const std::string &name)
 Set the source name. More...
 
- Public Member Functions inherited from GBase
virtual ~GBase (void)
 Destructor. More...
 

Protected Member Functions

void init_members (void)
 Initialise class members. More...
 
void copy_members (const GCTACubeSource &source)
 Copy class members. More...
 
void free_members (void)
 Delete class members. More...
 

Protected Attributes

std::string m_name
 Unique source name. More...
 

Detailed Description

CTA source cube base class.

This class provides an abstract base class for handling of pre-computed response information in a cube-style analysis.

Definition at line 50 of file GCTACubeSource.hpp.

Constructor & Destructor Documentation

GCTACubeSource::GCTACubeSource ( void  )

Void constructor.

Definition at line 53 of file GCTACubeSource.cpp.

References init_members().

GCTACubeSource::GCTACubeSource ( const GCTACubeSource source)

Copy constructor.

Parameters
[in]sourceCube analysis source.

Definition at line 68 of file GCTACubeSource.cpp.

References copy_members(), and init_members().

GCTACubeSource::~GCTACubeSource ( void  )
virtual

Destructor.

Definition at line 84 of file GCTACubeSource.cpp.

References free_members().

Member Function Documentation

virtual std::string GCTACubeSource::classname ( void  ) const
pure virtual

Return class name.

Returns
String containing the class name.

Returns the class name for non-abstract classes in a human readable way.

Implements GBase.

virtual void GCTACubeSource::clear ( void  )
pure virtual

Clear object.

Sets the object to a clean initial state. After calling the method the object will be in the same state as it were if an empty instance of the object would have been created.

Implements GBase.

virtual GCTACubeSource* GCTACubeSource::clone ( void  ) const
pure virtual

Clones object.

Returns
Pointer to deep copy of object.

Creates a deep copy of the object and returns a pointer to the object.

Implements GBase.

virtual GCTAClassCode GCTACubeSource::code ( void  ) const
pure virtual
void GCTACubeSource::copy_members ( const GCTACubeSource source)
protected

Copy class members.

Parameters
[in]sourceCube analysis source.

Definition at line 158 of file GCTACubeSource.cpp.

References m_name.

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

void GCTACubeSource::free_members ( void  )
protected

Delete class members.

Definition at line 170 of file GCTACubeSource.cpp.

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

void GCTACubeSource::init_members ( void  )
protected

Initialise class members.

Definition at line 143 of file GCTACubeSource.cpp.

References m_name.

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

const std::string & GCTACubeSource::name ( void  ) const
inlinevirtual

Return the source name.

Returns
Source name.

Definition at line 93 of file GCTACubeSource.hpp.

References m_name.

Referenced by name().

void GCTACubeSource::name ( const std::string &  name)
inlinevirtual

Set the source name.

Parameters
[in]nameSource name.

Definition at line 105 of file GCTACubeSource.hpp.

References m_name, and name().

GCTACubeSource & GCTACubeSource::operator= ( const GCTACubeSource source)
virtual

Assignment operator.

Parameters
[in]sourceCube analysis source.
Returns
Cube analysis source.

Definition at line 106 of file GCTACubeSource.cpp.

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

virtual std::string GCTACubeSource::print ( const GChatter chatter = NORMAL) const
pure virtual

Print content of object.

Parameters
[in]chatterChattiness (defaults to NORMAL).
Returns
String containing the content of the object.

Formats the content in a standard way and puts this content in a C++ string that is returned.

Implements GBase.

virtual void GCTACubeSource::set ( const std::string &  name,
const GModelSpatial model,
const GObservation obs 
)
pure virtual

Member Data Documentation

std::string GCTACubeSource::m_name
protected

Unique source name.

Definition at line 82 of file GCTACubeSource.hpp.

Referenced by copy_members(), init_members(), and name().


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