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

Abstract event atom container class. More...

#include <GEventList.hpp>

Inheritance diagram for GEventList:
GEvents GBase GCOMEventList GCTAEventList GLATEventList

Public Member Functions

 GEventList (void)
 Void constructor. More...
 
 GEventList (const GEventList &list)
 Copy constructor. More...
 
virtual ~GEventList (void)
 Destructor. More...
 
virtual GEventListoperator= (const GEventList &list)
 Assignment operator. More...
 
virtual GEventAtomoperator[] (const int &index)=0
 
virtual const GEventAtomoperator[] (const int &index) const =0
 
virtual void clear (void)=0
 Clear object. More...
 
virtual GEventListclone (void) const =0
 Clones object. More...
 
virtual std::string classname (void) const =0
 Return class name. More...
 
virtual int size (void) 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 void roi (const GRoi &roi)=0
 
virtual const GRoiroi (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 GEventList &list)
 Copy class members. More...
 
void free_members (void)
 Delete class members. More...
 
virtual void set_energies (void)=0
 
virtual void set_times (void)=0
 
- 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 atom container class.

This class is an abstract container class for event atoms.

In addition to the base class methods, it defines also an interface to the region of interest (ROI) that is covered by the data space. The ROI can be accessed by the roi() methods.

Definition at line 49 of file GEventList.hpp.

Constructor & Destructor Documentation

GEventList::GEventList ( void  )

Void constructor.

Definition at line 51 of file GEventList.cpp.

References init_members().

GEventList::GEventList ( const GEventList list)

Copy constructor.

Parameters
[in]listEvent list.

Definition at line 66 of file GEventList.cpp.

References copy_members(), and init_members().

GEventList::~GEventList ( void  )
virtual

Destructor.

Definition at line 82 of file GEventList.cpp.

References free_members().

Member Function Documentation

virtual std::string GEventList::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 GCTAEventList, GLATEventList, and GCOMEventList.

virtual void GEventList::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 GCTAEventList, GLATEventList, and GCOMEventList.

virtual GEventList* GEventList::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 GCTAEventList, GLATEventList, and GCOMEventList.

void GEventList::copy_members ( const GEventList list)
protected

Copy class members.

Parameters
[in]listEvent list.

Definition at line 155 of file GEventList.cpp.

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

void GEventList::free_members ( void  )
protected

Delete class members.

Definition at line 165 of file GEventList.cpp.

Referenced by GCOMEventList::clear(), GLATEventList::clear(), GCTAEventList::clear(), operator=(), and ~GEventList().

void GEventList::init_members ( void  )
protected

Initialise class members.

Definition at line 143 of file GEventList.cpp.

Referenced by GCOMEventList::clear(), GLATEventList::clear(), GCTAEventList::clear(), GEventList(), and operator=().

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

Implements GEvents.

Implemented in GCTAEventList, GLATEventList, and GCOMEventList.

virtual int GEventList::number ( void  ) const
pure virtual

Implements GEvents.

Implemented in GCTAEventList, GLATEventList, and GCOMEventList.

GEventList & GEventList::operator= ( const GEventList list)
virtual

Assignment operator.

Parameters
[in]listEvent list.
Returns
Event list.

Definition at line 104 of file GEventList.cpp.

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

Referenced by GCOMEventList::operator=(), GLATEventList::operator=(), and GCTAEventList::operator=().

virtual GEventAtom* GEventList::operator[] ( const int &  index)
pure virtual

Implements GEvents.

Implemented in GCTAEventList, GLATEventList, and GCOMEventList.

virtual const GEventAtom* GEventList::operator[] ( const int &  index) const
pure virtual

Implements GEvents.

Implemented in GCTAEventList, GLATEventList, and GCOMEventList.

virtual std::string GEventList::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 GCTAEventList, GLATEventList, and GCOMEventList.

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

Implements GEvents.

Implemented in GCTAEventList, GLATEventList, and GCOMEventList.

virtual void GEventList::roi ( const GRoi roi)
pure virtual

Implemented in GCTAEventList, GLATEventList, and GCOMEventList.

virtual const GRoi& GEventList::roi ( void  ) const
pure virtual

Implemented in GCTAEventList, GLATEventList, and GCOMEventList.

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

Implements GEvents.

Implemented in GCTAEventList, GLATEventList, and GCOMEventList.

virtual void GEventList::set_energies ( void  )
protectedpure virtual

Implements GEvents.

Implemented in GCTAEventList, GLATEventList, and GCOMEventList.

virtual void GEventList::set_times ( void  )
protectedpure virtual

Implements GEvents.

Implemented in GCTAEventList, GLATEventList, and GCOMEventList.

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

Implements GEvents.

Implemented in GCTAEventList, GLATEventList, and GCOMEventList.

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

Implements GEvents.

Implemented in GCTAEventList, GLATEventList, and GCOMEventList.


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