FMTSaSchedule.h

Go to the documentation of this file.

/*
Copyright (c) 2019 Gouvernement du Québec
 
SPDX-License-Identifier: LiLiQ-R-1.1
License-Filename: LICENSES/EN/LiLiQ-R11unicode.txt
*/
 
#ifndef FMTSASCHEDULE_H
#define FMTSASCHEDULE_H
 
#include <memory>
#include <string>
#include <vector>
 
 
namespace Spatial
{
 
// DocString: FMTSaSchedule
class FMTSaSchedule
    {
    public:
        // DocString: FMTSaSchedule(const std::string&)
        FMTSaSchedule(const std::string& typesc);
        // DocString: FMTSaSchedule()
        FMTSaSchedule()=default;
        // DocString: FMTSaSchedule::getScheduleType
        std::string getScheduleType()const;
        // DocString: FMTSaSchedule::getLevel
        size_t getLevel()const;
        // DocString: FMTSaSchedule::setInitialTemperature
        void setInitialTemperature(const double& Temp);
        // DocString: ~FMTSaSchedule()
        virtual~FMTSaSchedule();
        // DocString: FMTSaSchedule::reduceTemp
        virtual void reduceTemp();
        // DocString: FMTSaSchedule::getTemp
        double getTemp() const;
        // DocString: FMTSaSchedule::setTemp
        void setTemp( double p_Temp);
        // DocString: FMTSaSchedule::getInitialTemp
        double getInitialTemp() const;
        // DocString: FMTSaSchedule::clone
        virtual std::unique_ptr<FMTSaSchedule> clone()const;
    protected:
        std::string m_ScheduleType;
        size_t m_Level;
        double m_Temperature;
        double m_InitialTemperature;
    };
}
#endif // FMTSASCHEDULE_H