iLinearModelTemplate.hh

Go to the documentation of this file.

/*
This file is part of CASToR.

    CASToR 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 3 of the License, or (at your option) any later
    version.

    CASToR 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
    CASToR (in file GNU_GPL.TXT). If not, see <http://www.gnu.org/licenses/>.

Copyright 2017-2019 all CASToR contributors listed below:

    --> Didier BENOIT, Claude COMTAT, Marina FILIPOVIC, Thibaut MERLIN, Mael MILLARDET, Simon STUTE, Valentin VIELZEUF

This is CASToR version 3.0.
*/

#ifndef IDYNAMICMODELTEMPLATE_HH
#define IDYNAMICMODELTEMPLATE_HH 1

// Mother class of dynamic model
#include "vDynamicModel.hh"
// Required to automatically add the class in the CASToR code
#include "sAddonManager.hh"

// Inherit from Generic Linear Model
#include "iLinearModel.hh"

// This class inherits from iLinearModel,
// which  itself inherits from the virtual vDynamicModel
//  vDynamicModel
//  |
//  |-->> iLinearModel
//        |
//        |-->> iLinearModelTemplate

class iLinearModelTemplate : public iLinearModel
{
  // -----------------------------------------------------------------------------------------
  // Constructor & Destructor
  public:
    iLinearModelTemplate();
    ~iLinearModelTemplate();


  // -----------------------------------------------------------------------------------------
  // Public member functions related to the initialization of the model
  public:
    // Function for automatic insertion (put the class name as the parameters and do not add semi-colon at the end of the line)
    FUNCTION_DYNAMICMODEL(iLinearModelTemplate)
    int CheckSpecificParameters();
    int ReadAndCheckConfigurationFileSpecific();
    int ReadAndCheckOptionsList(string a_listOptions);
    int InitializeSpecific();
    void ShowHelp();


  // -----------------------------------------------------------------------------------------
  // Public member functions called by the main iterative algorithm class


  // -----------------------------------------------------------------------------------------
  // Data members
  protected:

};

// Class for automatic insertion (set here the visible dynamic model's name, put the class name as the parameters and do not add semi-colon at the end of the line)
CLASS_DYNAMICMODEL(template,iLinearModelTemplate)

#endif