GammaLib  1.7.0.dev
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
GInstDir.hpp
Go to the documentation of this file.
1 /***************************************************************************
2  * GInstDir.hpp - Abstract instrument direction base class *
3  * ----------------------------------------------------------------------- *
4  * copyright (C) 2010-2014 by Juergen Knoedlseder *
5  * ----------------------------------------------------------------------- *
6  * *
7  * This program is free software: you can redistribute it and/or modify *
8  * it under the terms of the GNU General Public License as published by *
9  * the Free Software Foundation, either version 3 of the License, or *
10  * (at your option) any later version. *
11  * *
12  * This program is distributed in the hope that it will be useful, *
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of *
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
15  * GNU General Public License for more details. *
16  * *
17  * You should have received a copy of the GNU General Public License *
18  * along with this program. If not, see <http://www.gnu.org/licenses/>. *
19  * *
20  ***************************************************************************/
21 /**
22  * @file GInstDir.hpp
23  * @brief Abstract instrument direction base class definition
24  * @author Juergen Knoedlseder
25  */
26 
27 #ifndef GINSTDIR_HPP
28 #define GINSTDIR_HPP
29 
30 /* __ Includes ___________________________________________________________ */
31 #include <string>
32 #include "GBase.hpp"
33 
34 
35 /***********************************************************************//**
36  * @class GInstDir
37  *
38  * @brief Abstract instrument direction base class
39  *
40  * The instrument direction of an event is the equivalent of the sky
41  * direction (implemented by GSkyDir) but in the instrument data space.
42  * The instrument direction may be any kind of position or direction
43  * information encoded in the data space, such as incident event
44  * reconstructions for imaging devices or detector numbers etc. for
45  * non-imaging devices.
46  ***************************************************************************/
47 class GInstDir : public GBase {
48 
49 public:
50  // Constructors and destructors
51  GInstDir(void);
52  GInstDir(const GInstDir& dir);
53  virtual ~GInstDir(void);
54 
55  // Operators
56  virtual GInstDir& operator=(const GInstDir& dir);
57 
58  // Pure virtual methods
59  virtual void clear(void) = 0;
60  virtual GInstDir* clone(void) const = 0;
61  virtual std::string classname(void) const = 0;
62  virtual std::string print(const GChatter& chatter = NORMAL) const = 0;
63 
64 protected:
65  // Protected methods
66  void init_members(void);
67  void copy_members(const GInstDir& dir);
68  void free_members(void);
69 };
70 
71 #endif /* GINSTDIR_HPP */
virtual void clear(void)=0
Clear object.
Definition of interface for all GammaLib classes.
virtual GInstDir & operator=(const GInstDir &dir)
Assignment operator.
Definition: GInstDir.cpp:105
void free_members(void)
Delete class members.
Definition: GInstDir.cpp:163
virtual GInstDir * clone(void) const =0
Clones object.
Abstract instrument direction base class.
Definition: GInstDir.hpp:47
Interface class for all GammaLib classes.
Definition: GBase.hpp:52
GChatter
Definition: GTypemaps.hpp:33
virtual ~GInstDir(void)
Destructor.
Definition: GInstDir.cpp:83
void init_members(void)
Initialise class members.
Definition: GInstDir.cpp:141
virtual std::string classname(void) const =0
Return class name.
GInstDir(void)
Void constructor.
Definition: GInstDir.cpp:52
virtual std::string print(const GChatter &chatter=NORMAL) const =0
Print content of object.
void copy_members(const GInstDir &dir)
Copy class members.
Definition: GInstDir.cpp:153