time_info.hpp

Go to the documentation of this file.

/*
 *
 *                   _/_/_/    _/_/   _/    _/ _/_/_/    _/_/
 *                  _/   _/ _/    _/ _/_/  _/ _/   _/ _/    _/
 *                 _/_/_/  _/_/_/_/ _/  _/_/ _/   _/ _/_/_/_/
 *                _/      _/    _/ _/    _/ _/   _/ _/    _/
 *               _/      _/    _/ _/    _/ _/_/_/  _/    _/
 *
 *             ***********************************************
 *                              PandA Project
 *                     URL: http://panda.dei.polimi.it
 *                       Politecnico di Milano - DEIB
 *                        System Architectures Group
 *             ***********************************************
 *              Copyright (C) 2023-2024 Politecnico di Milano
 *
 *   This file is part of the PandA framework.
 *
 *   The PandA framework 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.
 *
 *   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, see <http://www.gnu.org/licenses/>.
 *
 */
#ifndef TIME_INFO_HPP
#define TIME_INFO_HPP

#include "refcount.hpp"
#include "schedule.hpp"

CONSTREF_FORWARD_DECL(Parameter);
UINT_STRONG_TYPEDEF_FORWARD_DECL(ControlStep);
REF_FORWARD_DECL(time_info);
class xml_element;

class time_info
{
   const ParameterConstRef Param;
   ControlStep initiation_time;
   unsigned int cycles;
   bool synthesis_dependent;
   double stage_period;
   double execution_time;

 public:
   explicit time_info(const ParameterConstRef _Param);

   ~time_info();

   static time_infoRef factory(const ParameterConstRef Param);

   void set_initiation_time(const ControlStep _initiation_time);

   ControlStep get_initiation_time() const;

   unsigned int get_cycles() const;

   double get_stage_period() const;

   void set_stage_period(double st_per);

   void set_execution_time(double execution_time, unsigned int cycles = time_info::cycles_time_DEFAULT);

   void set_synthesis_dependent(bool value);

   bool get_synthesis_dependent() const;

   double get_execution_time() const;

 public:
   static const double execution_time_DEFAULT /*= 0.0*/;
   static const ControlStep initiation_time_DEFAULT /*= 0*/;
   static const unsigned int cycles_time_DEFAULT /*=0*/;
   static const double stage_period_DEFAULT /*= 0.0*/;
};
using time_infoRef = refcount<time_info>;

#endif