Base class for all processors, which are used to modify the specification before it is passed to Accelergy/Timeloop. More...

Inheritance diagram for timeloopfe.common.processor.Processor:

[legend]

Collaboration diagram for timeloopfe.common.processor.Processor:

[legend]

Public Member Functions
	__init__ (self, Optional["Specification"] spec=None)

	pre_parse_process (self, "Specification" spec)
	Process the specification before parsing.

	process (self, "Specification" spec)
	Process the specification.

	declare_attrs (self)
	Initialize the attributes that the processor is responsible for.

	get_index (self, type processor_type, "Specification" spec)
	Get the index of the processor in the list of processors.

	must_run_after (self, type other, "Specification" spec, bool ok_if_not_found=False)
	Ensure that this processor runs after another processor.

	add_attr (self, Node target, args, *kwargs)

Public Attributes
	logger = logging.getLogger(self.__class__.__name__)

	spec = spec

Protected Attributes
bool	_initialized = True

Detailed Description

Base class for all processors, which are used to modify the specification before it is passed to Accelergy/Timeloop.

Attributes: spec: The specification to process. logger: The logger for this processor.

Constructor & Destructor Documentation

◆ init()

timeloopfe.common.processor.Processor.__init__	(		self,
		Optional["Specification"]	spec = None )

Reimplemented in timeloopfe.common.processor.References2CopiesProcessor, timeloopfe.common.processor.SimpleProcessor, timeloopfe.v4.processors.constraint_attacher.ConstraintAttacherProcessor, timeloopfe.v4.processors.constraint_macro.ConstraintMacroProcessor, timeloopfe.v4.processors.enable_dummy_table.EnableDummyTableProcessor, timeloopfe.v4.processors.permutation_optimizer.PermutationOptimizerProcessor, timeloopfe.v4.processors.required_actions.RequiredActionsProcessor, timeloopfe.v4.processors.sparse_opt_attacher.SparseOptAttacherProcessor, and timeloopfe.v4.processors.to_diagram_processor.ToDiagramProcessor.

Member Function Documentation

◆ add_attr()

timeloopfe.common.processor.Processor.add_attr	(		self,
		Node	target,
		*	args,
		**	kwargs )

◆ declare_attrs()

timeloopfe.common.processor.Processor.declare_attrs ( self )

Initialize the attributes that the processor is responsible for.

!

Note: This method is called before process() is called. See the SimpleProcessor for an example.

Reimplemented in timeloopfe.common.processor.SimpleProcessor, timeloopfe.v4.processors.constraint_attacher.ConstraintAttacherProcessor, and timeloopfe.v4.processors.constraint_macro.ConstraintMacroProcessor.

◆ get_index()

timeloopfe.common.processor.Processor.get_index	(		self,
		type	processor_type,
		"Specification"	spec )

Get the index of the processor in the list of processors.

◆ must_run_after()

timeloopfe.common.processor.Processor.must_run_after	(		self,
		type	other,
		"Specification"	spec,
		bool	ok_if_not_found = False )

Ensure that this processor runs after another processor.

!

Parameters

other The processor that this processor must run after.

!

Parameters

ok_if_not_found If False, OK if the other processor is not found. If True, raise an exception if the other processor is not found.

◆ pre_parse_process()

timeloopfe.common.processor.Processor.pre_parse_process	(		self,
		"Specification"	spec )

Process the specification before parsing.

◆ process()

timeloopfe.common.processor.Processor.process	(		self,
		"Specification"	spec )

Process the specification.

Member Data Documentation

◆ _initialized

bool timeloopfe.common.processor.Processor._initialized = True

protected

◆ logger

timeloopfe.common.processor.Processor.logger = logging.getLogger(self.__class__.__name__)

◆ spec

timeloopfe.common.processor.Processor.spec = spec

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

timeloopfe/common/processor.py

Public Member Functions

Public Attributes

Protected Attributes