psyclone.domain.gocean.gocean_constants.GOceanConstants Class Reference

Public Member Functions
def	__init__ (self)

Static Public Member Functions
def	get_valid_access_types ()

Static Public Attributes
bool	HAS_BEEN_INITIALISED = False

Detailed Description

This class stores all GOcean constants. It stores all values in
class variables (to avoid re-evaluating them).

Definition at line 46 of file gocean_constants.py.

Member Function Documentation

get_valid_access_types()

def psyclone.domain.gocean.gocean_constants.GOceanConstants.get_valid_access_types ( )

static

Return the valid access types for the GOcean API. Reads the values
from the config file the first time the method is called.

:returns: valid access types for the GOcean API.
:rtype: list[str]

Definition at line 54 of file gocean_constants.py.

    def get_valid_access_types():
        '''Return the valid access types for the GOcean API. Reads the values
        from the config file the first time the method is called.
 
        :returns: valid access types for the GOcean API.
        :rtype: list[str]
 
        '''
        if not GOceanConstants._VALID_ACCESS_TYPES:
            conf = Config.get().api_conf("gocean1.0")
            GOceanConstants._VALID_ACCESS_TYPES = \
                list(conf.get_access_mapping().keys())
        return GOceanConstants._VALID_ACCESS_TYPES
 

---

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

• /home/docs/checkouts/readthedocs.org/user_builds/psyclone-ref/checkouts/latest/src/psyclone/domain/gocean/gocean_constants.py