ToDataFileStep Class Reference

#include <to_data_file_step.hpp>

Inheritance diagram for ToDataFileStep:

Collaboration diagram for ToDataFileStep:

Public Member Functions
	ToDataFileStep (const DesignFlowManagerConstRef design_flow_manager, const ToDataFileStep_Type _to_data_file_step_type, const ParameterConstRef parameters)
	Constructor. More...
std::string	GetSignature () const override
	Return a unified identifier of this design step. More...
std::string	GetName () const override
	Return the name of this design step. More...
void	ComputeRelationships (DesignFlowStepSet &relationship, const DesignFlowStep::RelationshipType relationship_type) override=0
	Compute the relationships of a step with other steps. More...
DesignFlowStepFactoryConstRef	CGetDesignFlowStepFactory () const override
	Return the factory to create this type of steps. More...
bool	HasToBeExecuted () const override
	Check if this step has actually to be executed. More...
Public Member Functions inherited from DesignFlowStep
	DesignFlowStep (const DesignFlowManagerConstRef design_flow_manager, const ParameterConstRef parameters)
	Constructor. More...
virtual	~DesignFlowStep ()
	Destructor. More...
virtual DesignFlowStep_Status	Exec ()=0
	Execute the step. More...
virtual void	Initialize ()
	Initialize the step (i.e., like a constructor, but executed just before exec. More...
DesignFlowStep_Status	GetStatus () const
	Return the status of this design step. More...
virtual void	WriteDot (std::ostream &out) const
	Write the label for a dot graph. More...
bool	IsComposed () const
	Returns if this step is composed. More...
int	CGetDebugLevel () const
	Return the debug level of the step. More...
virtual void	PrintInitialIR () const
	Dump the initial intermediate representation. More...
virtual void	PrintFinalIR () const
	Dump the final intermediate representation. More...

Static Public Member Functions
static const std::string	EnumToName (const ToDataFileStep_Type to_data_file_step)
	Given a to data file step type, return the name of the type. More...
static ToDataFileStep_Type	NameToEnum (const std::string &to_data_file_step)
	Given the name of data file step type, return the enum. More...
static const std::string	ComputeSignature (const ToDataFileStep_Type to_data_file_step_type)
	Compute the signature of a to data file step. More...

Protected Attributes
ToDataFileStep_Type	to_data_file_step_type
	The type of step. More...
Protected Attributes inherited from DesignFlowStep
bool	composed
	True if this step represents a composition of design flow steps (e.g., a flow); must be set by specialized constructors. More...
const Wrefcount< const DesignFlowManager >	design_flow_manager
	The design flow manager. More...
const ParameterConstRef	parameters
	Set of input parameters. More...
int	debug_level
	The debug level. More...
const int	output_level
	The output level. More...

Additional Inherited Members
Public Types inherited from DesignFlowStep
enum	RelationshipType { DEPENDENCE_RELATIONSHIP, INVALIDATION_RELATIONSHIP, PRECEDENCE_RELATIONSHIP }
	The relationship type. More...

Detailed Description

Definition at line 63 of file to_data_file_step.hpp.

Constructor & Destructor Documentation

ToDataFileStep()

ToDataFileStep::ToDataFileStep	(	const DesignFlowManagerConstRef	_design_flow_manager,
		const ToDataFileStep_Type	_to_data_file_step_type,
		const ParameterConstRef	_parameters
	)

Constructor.

Header include.

Parameters

design_flow_manager	is the design flow manager
to_data_file_step	is the type of this step
parameters	is the set of input parameters

design_flows include

Definition at line 46 of file to_data_file_step.cpp.

Member Function Documentation

CGetDesignFlowStepFactory()

DesignFlowStepFactoryConstRef ToDataFileStep::CGetDesignFlowStepFactory ( ) const

overridevirtual

Return the factory to create this type of steps.

Implements DesignFlowStep.

Definition at line 109 of file to_data_file_step.cpp.

References DesignFlowStep::design_flow_manager, and Wrefcount< T >::lock().

Referenced by GenerateFuList::CGetDesignFlowStepFactory().

Here is the call graph for this function:

Here is the caller graph for this function:

ComputeRelationships()

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

overridepure virtual

Compute the relationships of a step with other steps.

Parameters

dependencies	is where relationships will be stored
relationship_type	is the type of relationship to be computed

Implements DesignFlowStep.

Implemented in GenerateFuList.

ComputeSignature()

const std::string ToDataFileStep::ComputeSignature ( const ToDataFileStep_Type  to_data_file_step_type )

static

Compute the signature of a to data file step.

Parameters

to_data_file_step_type

is the type of the step

Returns

the corresponding signature

Definition at line 52 of file to_data_file_step.cpp.

References EnumToName().

Referenced by GetSignature(), and main().

Here is the call graph for this function:

Here is the caller graph for this function:

EnumToName()

const std::string ToDataFileStep::EnumToName ( const ToDataFileStep_Type  to_data_file_step )

static

Given a to data file step type, return the name of the type.

Parameters

to_data_file_step

is the type to be considered

Returns

the name of the type

Definition at line 57 of file to_data_file_step.cpp.

References THROW_UNREACHABLE, and UNKNOWN.

Referenced by ComputeSignature(), and GetName().

Here is the caller graph for this function:

GetName()

std::string ToDataFileStep::GetName ( ) const

overridevirtual

Return the name of this design step.

Returns

the name of the pass (for debug purpose)

Implements DesignFlowStep.

Definition at line 104 of file to_data_file_step.cpp.

References EnumToName(), and to_data_file_step_type.

Referenced by GenerateFuList::GetName().

Here is the call graph for this function:

Here is the caller graph for this function:

GetSignature()

std::string ToDataFileStep::GetSignature ( ) const

overridevirtual

Return a unified identifier of this design step.

Returns

the signature of the design step

Implements DesignFlowStep.

Definition at line 99 of file to_data_file_step.cpp.

References ComputeSignature(), and to_data_file_step_type.

Referenced by GenerateFuList::GetSignature().

Here is the call graph for this function:

Here is the caller graph for this function:

HasToBeExecuted()

bool ToDataFileStep::HasToBeExecuted ( ) const

overridevirtual

Check if this step has actually to be executed.

Returns

true if the step has to be executed

Implements DesignFlowStep.

Definition at line 94 of file to_data_file_step.cpp.

Referenced by GenerateFuList::HasToBeExecuted().

Here is the caller graph for this function:

NameToEnum()

ToDataFileStep_Type ToDataFileStep::NameToEnum ( const std::string &  to_data_file_step )

static

Given the name of data file step type, return the enum.

Parameters

to_data_file_step_type

is the type to be considered

Returns

the name of the type

Definition at line 78 of file to_data_file_step.cpp.

References THROW_UNREACHABLE, and UNKNOWN.

Referenced by ToDataFileStepFactory::CreateStep().

Here is the caller graph for this function:

Field Documentation

to_data_file_step_type

ToDataFileStep_Type ToDataFileStep::to_data_file_step_type

protected

The type of step.

Definition at line 67 of file to_data_file_step.hpp.

Referenced by GetName(), and GetSignature().

---

The documentation for this class was generated from the following files:

• /workspace/src/design_flows/backend/ToDataFile/to_data_file_step.hpp
• /workspace/src/design_flows/backend/ToDataFile/to_data_file_step.cpp