psyclone.psyir.symbols.interfaces.ArgumentInterface Class Reference

Inheritance diagram for psyclone.psyir.symbols.interfaces.ArgumentInterface:

Collaboration diagram for psyclone.psyir.symbols.interfaces.ArgumentInterface:

Classes
class	Access

Public Member Functions
def	__init__ (self, access=None)
def	access (self)
def	access (self, value)
def	__str__ (self)
def	copy (self)

Public Attributes
	access

Detailed Description

Captures the interface to a Symbol that is accessed as a routine
argument.

:param access: specifies how the argument is used in the Schedule
:type access: :py:class:`psyclone.psyir.symbols.ArgumentInterface.Access`

Definition at line 198 of file interfaces.py.

Member Function Documentation

access() [1/2]

def psyclone.psyir.symbols.interfaces.ArgumentInterface.access

(

self

)

:returns: the access-type for this argument.
:rtype: :py:class:`psyclone.psyir.symbols.ArgumentInterface.Access`

Definition at line 235 of file interfaces.py.

    def access(self):
        '''
        :returns: the access-type for this argument.
        :rtype: :py:class:`psyclone.psyir.symbols.ArgumentInterface.Access`
        '''
        return self._access
 

References psyclone.domain.gocean.kernel.psyir.GOceanKernelMetadata.GridArg._access, psyclone.domain.gocean.kernel.psyir.GOceanKernelMetadata.FieldArg._access, psyclone.domain.gocean.kernel.psyir.GOceanKernelMetadata.ScalarArg._access, psyclone.domain.lfric.kernel.common_meta_arg_metadata.CommonMetaArgMetadata._access, psyclone.parse.kernel.Descriptor._access, psyclone.psyGen.Argument._access, and psyclone.psyir.symbols.interfaces.ArgumentInterface._access.

Here is the caller graph for this function:

access() [2/2]

def psyclone.psyir.symbols.interfaces.ArgumentInterface.access	(		self,
			value
	)

:param value: the new access type.
:type value: :py:class:`psyclon.psyir.symbols.ArgumentInterface.Access`

:raises TypeError: if the supplied value is not an \
    ArgumentInterface.Access

Definition at line 243 of file interfaces.py.

    def access(self, value):
        '''
        :param value: the new access type.
        :type value: :py:class:`psyclon.psyir.symbols.ArgumentInterface.Access`
 
        :raises TypeError: if the supplied value is not an \
            ArgumentInterface.Access
        '''
        if not isinstance(value, ArgumentInterface.Access):
            raise TypeError(
                f"SymbolInterface.access must be an 'ArgumentInterface.Access'"
                f" but got '{type(value).__name__}'.")
        self._access = value
 

References psyclone.domain.gocean.kernel.psyir.GOceanKernelMetadata.GridArg._access, psyclone.domain.gocean.kernel.psyir.GOceanKernelMetadata.FieldArg._access, psyclone.domain.gocean.kernel.psyir.GOceanKernelMetadata.ScalarArg._access, psyclone.domain.lfric.kernel.common_meta_arg_metadata.CommonMetaArgMetadata._access, psyclone.parse.kernel.Descriptor._access, psyclone.psyGen.Argument._access, and psyclone.psyir.symbols.interfaces.ArgumentInterface._access.

Here is the caller graph for this function:

copy()

def psyclone.psyir.symbols.interfaces.ArgumentInterface.copy

(

self

)

:returns: a copy of this object.
:rtype: :py:class:`psyclone.psyir.symbol.SymbolInterface`

Reimplemented from psyclone.psyir.symbols.interfaces.SymbolInterface.

Definition at line 260 of file interfaces.py.

    def copy(self):
        '''
        :returns: a copy of this object.
        :rtype: :py:class:`psyclone.psyir.symbol.SymbolInterface`
        '''
        return self.__class__(access=self.access)
 
 

References psyclone.psyir.symbols.symbol.Symbol.__class__, psyclone.domain.gocean.kernel.psyir.GOceanKernelMetadata.GridArg.access, psyclone.domain.gocean.kernel.psyir.GOceanKernelMetadata.FieldArg.access, psyclone.domain.gocean.kernel.psyir.GOceanKernelMetadata.ScalarArg.access(), psyclone.domain.lfric.kernel.common_meta_arg_metadata.CommonMetaArgMetadata.access, psyclone.dynamo0p3.DynKernelArgument.access, psyclone.parse.kernel.Descriptor.access(), psyclone.psyGen.Argument.access(), and psyclone.psyir.symbols.interfaces.ArgumentInterface.access.

Here is the call 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/psyir/symbols/interfaces.py