to_data_file_step.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) 2015-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 TO_DATA_FILE_STEP_HPP
#define TO_DATA_FILE_STEP_HPP

#include "config_HAVE_CIRCUIT_BUILT.hpp"

#include "design_flow_step.hpp"

#include <string>

#include "refcount.hpp"

enum class ToDataFileStep_Type
{
   UNKNOWN = 0,
#if HAVE_CIRCUIT_BUILT
   GENERATE_FU_LIST,
#endif
};

class ToDataFileStep : public virtual DesignFlowStep
{
 protected:
   ToDataFileStep_Type to_data_file_step_type;

 public:
   ToDataFileStep(const DesignFlowManagerConstRef design_flow_manager,
                  const ToDataFileStep_Type _to_data_file_step_type, const ParameterConstRef parameters);

   std::string GetSignature() const override;

   static const std::string EnumToName(const ToDataFileStep_Type to_data_file_step);

   static ToDataFileStep_Type NameToEnum(const std::string& to_data_file_step);

   static const std::string ComputeSignature(const ToDataFileStep_Type to_data_file_step_type);

   std::string GetName() const override;

   void ComputeRelationships(DesignFlowStepSet& relationship,
                             const DesignFlowStep::RelationshipType relationship_type) override = 0;

   DesignFlowStepFactoryConstRef CGetDesignFlowStepFactory() const override;

   bool HasToBeExecuted() const override;
};
#endif