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

Abstract event bin container class. More...

#include <GEventCube.hpp>

Inheritance diagram for GEventCube:
GEvents GBase GCOMEventCube GCTAEventCube GLATEventCube GMWLSpectrum

Public Member Functions

 GEventCube (void)
 Void constructor. More...
 
 GEventCube (const GEventCube &cube)
 Copy constructor. More...
 
virtual ~GEventCube (void)
 Destructor. More...
 
virtual GEventCubeoperator= (const GEventCube &cube)
 Assignment operator. More...
 
virtual GEventBinoperator[] (const int &index)=0
 
virtual const GEventBinoperator[] (const int &index) const =0
 
virtual void clear (void)=0
 Clear object. More...
 
virtual GEventCubeclone (void) const =0
 Clones object. More...
 
virtual std::string classname (void) const =0
 Return class name. More...
 
virtual int size (void) const =0
 
virtual int dim (void) const =0
 
virtual int naxis (const int &axis) const =0
 
virtual void load (const GFilename &filename)=0
 
virtual void save (const GFilename &filename, const bool &clobber=false) const =0
 
virtual void read (const GFits &file)=0
 
virtual void write (GFits &file) const =0
 
virtual int number (void) const =0
 
virtual std::string print (const GChatter &chatter=NORMAL) const =0
 Print content of object. More...
 
- Public Member Functions inherited from GEvents
 GEvents (void)
 Void constructor. More...
 
 GEvents (const GEvents &events)
 Copy constructor. More...
 
virtual ~GEvents (void)
 Destructor. More...
 
virtual GEventsoperator= (const GEvents &events)
 Assignment operator. More...
 
void ebounds (const GEbounds &ebounds)
 Set energy boundaries. More...
 
void gti (const GGti &gti)
 Set Good Time Intervals. More...
 
const GEboundsebounds (void) const
 Return energy boundaries. More...
 
const GGtigti (void) const
 Return Good Time Intervals. More...
 
const GTimetstart (void) const
 Return start time. More...
 
const GTimetstop (void) const
 Return stop time. More...
 
const GEnergyemin (void) const
 Return minimum energy. More...
 
const GEnergyemax (void) const
 Return maximum energy. 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 GEventCube &cube)
 Copy class members. More...
 
void free_members (void)
 Delete class members. More...
 
virtual void set_energies (void)
 Set energies (dummy method) More...
 
virtual void set_times (void)
 Set times (dummy method) More...
 
- Protected Member Functions inherited from GEvents
void init_members (void)
 Initialise class members. More...
 
void copy_members (const GEvents &events)
 Copy class members. More...
 
void free_members (void)
 Delete class members. More...
 

Additional Inherited Members

- Protected Attributes inherited from GEvents
GEbounds m_ebounds
 Energy boundaries covered by events. More...
 
GGti m_gti
 Good time intervals covered by events. More...
 

Detailed Description

Abstract event bin container class.

This class is an abstract container class for event bins.

Definition at line 46 of file GEventCube.hpp.

Constructor & Destructor Documentation

GEventCube::GEventCube ( void  )

Void constructor.

Definition at line 51 of file GEventCube.cpp.

References init_members().

GEventCube::GEventCube ( const GEventCube cube)

Copy constructor.

Parameters
[in]cubeEvent cube.

Definition at line 66 of file GEventCube.cpp.

References copy_members(), and init_members().

GEventCube::~GEventCube ( void  )
virtual

Destructor.

Definition at line 82 of file GEventCube.cpp.

References free_members().

Member Function Documentation

virtual std::string GEventCube::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 GEvents.

Implemented in GCTAEventCube, GCOMEventCube, GLATEventCube, and GMWLSpectrum.

virtual void GEventCube::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 GEvents.

Implemented in GCTAEventCube, GCOMEventCube, GLATEventCube, and GMWLSpectrum.

virtual GEventCube* GEventCube::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 GEvents.

Implemented in GCTAEventCube, GCOMEventCube, GLATEventCube, and GMWLSpectrum.

void GEventCube::copy_members ( const GEventCube cube)
protected

Copy class members.

Parameters
[in]cubeEvent cube.

Definition at line 155 of file GEventCube.cpp.

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

virtual int GEventCube::dim ( void  ) const
pure virtual
void GEventCube::free_members ( void  )
protected
void GEventCube::init_members ( void  )
protected

Initialise class members.

Definition at line 143 of file GEventCube.cpp.

Referenced by GMWLSpectrum::clear(), GLATEventCube::clear(), GCOMEventCube::clear(), GCTAEventCube::clear(), GEventCube(), and operator=().

virtual void GEventCube::load ( const GFilename filename)
pure virtual

Implements GEvents.

Implemented in GCTAEventCube, GCOMEventCube, GLATEventCube, and GMWLSpectrum.

virtual int GEventCube::naxis ( const int &  axis) const
pure virtual
virtual int GEventCube::number ( void  ) const
pure virtual

Implements GEvents.

Implemented in GCTAEventCube, GCOMEventCube, GLATEventCube, and GMWLSpectrum.

GEventCube & GEventCube::operator= ( const GEventCube cube)
virtual

Assignment operator.

Parameters
[in]cubeEvent cube.
Returns
Event cube.

Definition at line 104 of file GEventCube.cpp.

References copy_members(), free_members(), init_members(), and GEvents::operator=().

Referenced by GMWLSpectrum::operator=(), GLATEventCube::operator=(), GCOMEventCube::operator=(), and GCTAEventCube::operator=().

virtual GEventBin* GEventCube::operator[] ( const int &  index)
pure virtual

Implements GEvents.

Implemented in GCTAEventCube, GCOMEventCube, GLATEventCube, and GMWLSpectrum.

virtual const GEventBin* GEventCube::operator[] ( const int &  index) const
pure virtual

Implements GEvents.

Implemented in GCTAEventCube, GCOMEventCube, GLATEventCube, and GMWLSpectrum.

virtual std::string GEventCube::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 GEvents.

Implemented in GCTAEventCube, GCOMEventCube, GLATEventCube, and GMWLSpectrum.

virtual void GEventCube::read ( const GFits file)
pure virtual

Implements GEvents.

Implemented in GCTAEventCube, GCOMEventCube, GLATEventCube, and GMWLSpectrum.

virtual void GEventCube::save ( const GFilename filename,
const bool &  clobber = false 
) const
pure virtual

Implements GEvents.

Implemented in GCTAEventCube, GCOMEventCube, GLATEventCube, and GMWLSpectrum.

void GEventCube::set_energies ( void  )
inlineprotectedvirtual

Set energies (dummy method)

Implements GEvents.

Reimplemented in GCTAEventCube, GLATEventCube, and GCOMEventCube.

Definition at line 88 of file GEventCube.hpp.

void GEventCube::set_times ( void  )
inlineprotectedvirtual

Set times (dummy method)

Implements GEvents.

Reimplemented in GCTAEventCube, GLATEventCube, and GCOMEventCube.

Definition at line 98 of file GEventCube.hpp.

virtual int GEventCube::size ( void  ) const
pure virtual

Implements GEvents.

Implemented in GCTAEventCube, GCOMEventCube, GLATEventCube, and GMWLSpectrum.

virtual void GEventCube::write ( GFits file) const
pure virtual

Implements GEvents.

Implemented in GCTAEventCube, GCOMEventCube, GLATEventCube, and GMWLSpectrum.


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