design_flow_aux_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) 2004-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 DESIGN_FLOW_AUX_STEP_HPP
#define DESIGN_FLOW_AUX_STEP_HPP
#include "design_flow_step.hpp" // for DesignFlowStep, DesignFlowManagerCon...
#include <iosfwd>               // for ostream
#include <string>               // for string

using AuxDesignFlowStepType = enum AuxDesignFlowStepType {
   DESIGN_FLOW_ENTRY, 
   DESIGN_FLOW_EXIT   
};

class AuxDesignFlowStep : public DesignFlowStep
{
 private:
   const AuxDesignFlowStepType type;

   const std::string name;

 public:
   AuxDesignFlowStep(std::string name, const AuxDesignFlowStepType type,
                     const DesignFlowManagerConstRef design_flow_manager, const ParameterConstRef parameters);

   ~AuxDesignFlowStep() override;

   DesignFlowStep_Status Exec() override;

   bool HasToBeExecuted() const override;

   std::string GetSignature() const override;

   std::string GetName() const override;

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

   static const std::string ComputeSignature(const std::string& name, const AuxDesignFlowStepType type);

   void WriteDot(std::ostream& out) const override;

   DesignFlowStepFactoryConstRef CGetDesignFlowStepFactory() const override;
};
#endif