psyclone.parse.algorithm.FileInfo Class Reference

Public Member Functions
def	__init__ (self, name, calls)
def	name (self)
def	calls (self)

Detailed Description

Captures information about the algorithm file and the invoke calls
found within the contents of the file.

:param str name: the name of the algorithm program unit (program, \
module, subroutine or function)
:param calls: information about the invoke calls in the algorithm code.
:type calls: list of :py:class:`psyclone.parse.algorithm.InvokeCall`

Definition at line 860 of file algorithm.py.

Member Function Documentation

calls()

def psyclone.parse.algorithm.FileInfo.calls

(

self

)

:returns: information about invoke calls
:rtype: list of :py:class:`psyclone.parse.algorithm.InvokeCall`

Definition at line 885 of file algorithm.py.

    def calls(self):
        '''
        :returns: information about invoke calls
        :rtype: list of :py:class:`psyclone.parse.algorithm.InvokeCall`
 
        '''
        return self._calls
 
 

References psyclone.domain.lfric.lfric_collection.LFRicCollection._calls, and psyclone.parse.algorithm.FileInfo._calls.

name()

def psyclone.parse.algorithm.FileInfo.name

(

self

)

:returns: the name of the algorithm program unit
:rtype: str

Definition at line 876 of file algorithm.py.

    def name(self):
        '''
        :returns: the name of the algorithm program unit
        :rtype: str
 
        '''
        return self._name
 

References psyclone.domain.common.algorithm.psyir.AlgorithmInvokeCall._name, psyclone.domain.gocean.kernel.psyir.GOceanKernelMetadata._name, psyclone.domain.gocean.kernel.psyir.GOceanKernelMetadata.GridArg._name, psyclone.domain.lfric.kernel.lfric_kernel_metadata.LFRicKernelMetadata._name, psyclone.dynamo0p3.DynFuncDescriptor03._name, psyclone.expression.NamedArg._name, psyclone.gocean1p0.GOKernelGridArgument._name, psyclone.gocean1p0.GOStencil._name, psyclone.nemo.NemoInvoke._name, psyclone.nemo.NemoPSy._name, psyclone.parse.algorithm.FileInfo._name, psyclone.parse.algorithm.InvokeCall._name, psyclone.parse.kernel.KernelProcedure._name, psyclone.parse.kernel.KernelType._name, psyclone.parse.module_info.ModuleInfo._name, psyclone.psyGen.PSy._name, psyclone.psyGen.Invoke._name, psyclone.psyGen.Kern._name, psyclone.psyGen.Argument._name, psyclone.psyir.nodes.container.Container._name, psyclone.psyir.nodes.routine.Routine._name, and psyclone.psyir.symbols.symbol.Symbol._name.

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/parse/algorithm.py