stfinvidentity.h 2.87 KB
Newer Older
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
/*! \file stfinvidentity.h
 * \brief just find a scaling factor (prototypes)
 * 
 * ----------------------------------------------------------------------------
 * 
 * $Id$
 * \author Thomas Forbriger
 * \date 07/05/2011
 * 
 * just find a scaling factor (prototypes)
 * 
 * Copyright (c) 2011 by Thomas Forbriger (BFO Schiltach) 
 *
 * ----
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version. 
 * 
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 * 
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
 * ----
 *
 * 
 * REVISIONS and CHANGES 
 *  - 07/05/2011   V1.0   Thomas Forbriger
 * 
 * ============================================================================
 */

// include guard
#ifndef STFINV_STFINVIDENTITY_H_VERSION

#define STFINV_STFINVIDENTITY_H_VERSION \
  "STFINV_STFINVIDENTITY_H   V1.0   "
#define STFINV_STFINVIDENTITY_H_CVSID \
  "$Id$"

45
46
#include<stfinv/stfinvbase.h>

47
48
namespace stfinv {

thomas.forbriger's avatar
thomas.forbriger committed
49
50
51
  /*! \brief Engine to apply a scalar factor
   * \ingroup engines
   */
52
  class STFEngineIdentity: public stfinv::STFBaseEngine {
thomas.forbriger's avatar
thomas.forbriger committed
53
    public:
54
      //! \brief typedef to refer to base class
thomas.forbriger's avatar
thomas.forbriger committed
55
      typedef stfinv::STFBaseEngine Tbase;
56
57
58
59
      //! \brief ID used to select thsi engine
      static const char* const ID;
      //! \brief short description of this engine
      static const char* const description;
thomas.forbriger's avatar
thomas.forbriger committed
60
61
      /*! \brief Constructor.
       */
62
      STFEngineIdentity(const stfinv::Tvectoroftriples& triples,
thomas.forbriger's avatar
thomas.forbriger committed
63
64
65
66
67
68
69
                        const stfinv::Waveform& stf,
                        const std::string& parameters)
        :Tbase(triples, stf, parameters) { }
      //! \brief abstract base requires virtual destructor
      virtual ~STFEngineIdentity() { }
      //! \brief Start engine and return source time function.
      virtual stfinv::Waveform run();
70
71
72
73
      //! \brief print online help
      virtual void help(std::ostream& os=std::cout) const;
      //! \brief print online help
      static void classhelp(std::ostream& os=std::cout);
74
75
76
77
78
79
80
      //! \brief return name of engine
      virtual const char* name() const;
    protected:
      //! \brief set default values in Mparamap
      virtual void setdefaults() { }
      //! \brief initialize work space
      virtual void initialize() { }
thomas.forbriger's avatar
thomas.forbriger committed
81
82
  }; // class STFEngineIdentity

83
84
85
86
87
} // namespace stfinv

#endif // STFINV_STFINVIDENTITY_H_VERSION (includeguard)

/* ----- END OF stfinvidentity.h ----- */