fgen.data_models.package_shared_elements

Shared elements of a package data model

PackageSharedElements

class PackageSharedElements

Bases: object

Data model of the shared elements in a package

This helps us define the shared elements across the package. For example, the names of callables that are defined in Fortran but used in Python.

property finalise_method_name: str

Name of the callables which finalise instances

property fortran_build_callable_name: str

Name of Fortran callables which build instances

property fortran_get_free_instance_number_callable_name: str

Name of Fortran callables which get the number of a free/available instance

property fortran_get_instance_callable_name: str

Name of Fortran callables which get an instance

property fortran_instance_finalise_callable_name: str

Name of Fortran callables finalise an instance

property fortran_wrapper_method_prefix: str

Prefix to use when creating the Fortran wrapper equivalent of methods

property from_build_args_name: str

Name of the Python function which creates an object from its build arguments

property n_fortran_instances_to_expose: int

Number of Fortran instances to expose

Once the user requests more instances than this, an error is raised.

property no_setters_suffix: str

Suffix to use when creating the no setters version of our wrapper classes