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

Abstract instrument direction base class. More...

#include <GInstDir.hpp>

Inheritance diagram for GInstDir:
GBase GCOMInstDir GCTAInstDir GLATInstDir GMWLInstDir

Public Member Functions

 GInstDir (void)
 Void constructor. More...
 
 GInstDir (const GInstDir &dir)
 Copy constructor. More...
 
virtual ~GInstDir (void)
 Destructor. More...
 
virtual GInstDiroperator= (const GInstDir &dir)
 Assignment operator. More...
 
virtual void clear (void)=0
 Clear object. More...
 
virtual GInstDirclone (void) const =0
 Clones object. More...
 
virtual std::string classname (void) const =0
 Return class name. More...
 
virtual std::string print (const GChatter &chatter=NORMAL) const =0
 Print content of object. 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 GInstDir &dir)
 Copy class members. More...
 
void free_members (void)
 Delete class members. More...
 

Detailed Description

Abstract instrument direction base class.

The instrument direction of an event is the equivalent of the sky direction (implemented by GSkyDir) but in the instrument data space. The instrument direction may be any kind of position or direction information encoded in the data space, such as incident event reconstructions for imaging devices or detector numbers etc. for non-imaging devices.

Definition at line 47 of file GInstDir.hpp.

Constructor & Destructor Documentation

GInstDir::GInstDir ( void  )

Void constructor.

Definition at line 52 of file GInstDir.cpp.

References init_members().

GInstDir::GInstDir ( const GInstDir dir)

Copy constructor.

Parameters
[in]dirInstrument direction.

Definition at line 67 of file GInstDir.cpp.

References copy_members(), and init_members().

GInstDir::~GInstDir ( void  )
virtual

Destructor.

Definition at line 83 of file GInstDir.cpp.

References free_members().

Member Function Documentation

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

Implemented in GCTAInstDir, GLATInstDir, GMWLInstDir, and GCOMInstDir.

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

Implemented in GCTAInstDir, GLATInstDir, GMWLInstDir, and GCOMInstDir.

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

Implemented in GCTAInstDir, GLATInstDir, GMWLInstDir, and GCOMInstDir.

void GInstDir::copy_members ( const GInstDir dir)
protected

Copy class members.

Parameters
[in]dirInstrument direction.

Definition at line 153 of file GInstDir.cpp.

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

void GInstDir::free_members ( void  )
protected

Delete class members.

Definition at line 163 of file GInstDir.cpp.

Referenced by GCOMInstDir::clear(), GMWLInstDir::clear(), GLATInstDir::clear(), GCTAInstDir::clear(), operator=(), and ~GInstDir().

void GInstDir::init_members ( void  )
protected

Initialise class members.

Definition at line 141 of file GInstDir.cpp.

Referenced by GCOMInstDir::clear(), GMWLInstDir::clear(), GLATInstDir::clear(), GCTAInstDir::clear(), GInstDir(), and operator=().

GInstDir & GInstDir::operator= ( const GInstDir dir)
virtual

Assignment operator.

Parameters
[in]dirInstrument direction.
Returns
Instrument direction.

Definition at line 105 of file GInstDir.cpp.

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

Referenced by GCOMInstDir::operator=(), GMWLInstDir::operator=(), GLATInstDir::operator=(), and GCTAInstDir::operator=().

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

Implemented in GCTAInstDir, GLATInstDir, GMWLInstDir, and GCOMInstDir.


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