psyclone.psyGen.DummyTransformation Class Reference

Inheritance diagram for psyclone.psyGen.DummyTransformation:

Collaboration diagram for psyclone.psyGen.DummyTransformation:

Public Member Functions
def	name (self)
def	apply (self, node, options=None)
Public Member Functions inherited from psyclone.psyGen.Transformation
def	validate (self, node, options=None)

Detailed Description

Dummy transformation use elsewhere to keep pyreverse happy.

Definition at line 2814 of file psyGen.py.

Member Function Documentation

apply()

def psyclone.psyGen.DummyTransformation.apply	(		self,
			node,
			options = None
	)

Abstract method that applies the transformation. This function
must be implemented by each transform. As a minimum each apply
function must take a node to which the transform is applied, and
a dictionary of additional options, which will also be passed on
to the validate functions. This dictionary is used to provide
optional parameters, and also to modify the behaviour of
validation of transformations: for example, if the user knows that
a transformation can correctly be applied in a specific case, but
the more generic code validation would not allow this. Validation
functions should check for a key in the options dictionary to
disable certain tests. Those keys will be documented in each
apply() and validate() function.

Note that some apply() functions might take a slightly different
set of parameters.

:param node: The node (or list of nodes) for the transformation \
        - specific to the actual transform used.
:type node: depends on actual transformation
:param options: a dictionary with options for transformations.
:type options: Optional[Dict[str, Any]]

Reimplemented from psyclone.psyGen.Transformation.

Definition at line 2821 of file psyGen.py.

    def apply(self, node, options=None):
        pass
 
 
# For Sphinx AutoAPI documentation generation

name()

def psyclone.psyGen.DummyTransformation.name

(

self

)

Dummy transformation use elsewhere to keep pyreverse happy.

Reimplemented from psyclone.psyGen.Transformation.

Definition at line 2818 of file psyGen.py.

    def name(self):
        return
 

Here is the caller graph for this function:

---

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

• /home/docs/checkouts/readthedocs.org/user_builds/psyclone-ref/checkouts/latest/src/psyclone/psyGen.py