ctools  2.0.0
 All Classes Namespaces Files Functions Variables Macros Pages
ctool_like.hpp
Go to the documentation of this file.
1 /***************************************************************************
2  * ctool_like - [WHAT] tool *
3  * ----------------------------------------------------------------------- *
4  * copyright (C) [YEAR] by [AUTHOR] *
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 ctool_like.hpp
23  * @brief [WHAT] tool definition
24  * @author [AUTHOR]
25  */
26 
27 #ifndef CTOOL_LIKE_HPP
28 #define CTOOL_LIKE_HPP
29 
30 /* __ Includes ___________________________________________________________ */
31 #include "ctlikelihood.hpp"
32 
33 /* __Definitions _________________________________________________________ */
34 #define CTOOL_LIKE_NAME "ctool_like"
35 
36 
37 /***********************************************************************//**
38  * @class ctool_like
39  *
40  * @brief [WHAT] tool
41  *
42  * @todo Add tool description.
43  ***************************************************************************/
44 class ctool_like : public ctlikelihood {
45 public:
46  // Constructors and destructors
47  ctool_like(void);
48  explicit ctool_like(const GObservations& obs);
49  ctool_like(int argc, char *argv[]);
50  ctool_like(const ctool_like& app);
51  virtual ~ctool_like(void);
52 
53  // Operators
54  ctool_like& operator=(const ctool_like& app);
55 
56  // Methods
57  void clear(void);
58  void process(void);
59  void save(void);
60 
61 protected:
62  // Protected methods
63  void init_members(void);
64  void copy_members(const ctool_like& app);
65  void free_members(void);
66  void get_parameters(void);
67 
68  // Protected members
69  // TODO: Add any data members that are necessary
70 };
71 
72 #endif /* CTOOL_LIKE_HPP */
[WHAT] tool
Definition: ctool_like.hpp:44
void get_parameters(void)
Get application parameters.
Definition: ctool_like.cpp:297
virtual ~ctool_like(void)
Destructor.
Definition: ctool_like.cpp:131
void free_members(void)
Delete class members.
Definition: ctool_like.cpp:285
const GObservations & obs(void) const
Return observation container.
Likelihood tool base class interface definition.
void clear(void)
Clear [WHAT] tool.
Definition: ctool_like.cpp:190
ctool_like & operator=(const ctool_like &app)
Assignment operator.
Definition: ctool_like.cpp:155
void copy_members(const ctool_like &app)
Copy class members.
Definition: ctool_like.cpp:272
void init_members(void)
Initialise class members.
Definition: ctool_like.cpp:257
void process(void)
Process [what] tool.
Definition: ctool_like.cpp:216
ctool_like(void)
Void constructor.
Definition: ctool_like.cpp:60
void save(void)
Save something.
Definition: ctool_like.cpp:236
Base class for likelihood tools.