class documentation

class Environment:

View In Hierarchy

Object containing all the important variables, with appropriate getters and setters. Also contains self integrity checks.

Method __getattr__ Getter for all parameters, looks for super if the parameter is prefaced with an underscore. Looks for mandatory parameters first, then secondary parameters. :param attribute: The name of the parameter to get...
Method __init__ Initialises the environment, all parameters are set to None. Set _wasInitialised to False for all parameters.
Method __setattr__ Setter for all parameters, looks for super if the parameter is prefaced with an underscore. :param attribute: The name of the parameter to set. :type attribute: str
Method integrity_check Checks if all mandatory parameters are set. :return: True if all mandatory parameters are set, False otherwise.
Instance Variable _mParams Undocumented
Instance Variable _sParams Undocumented
Instance Variable _wasInitialised Undocumented
def __getattr__(self, attribute):

Getter for all parameters, looks for super if the parameter is prefaced with an underscore. Looks for mandatory parameters first, then secondary parameters. :param attribute: The name of the parameter to get. :type attribute: str :return: The value of the parameter.

def __init__(self):

Initialises the environment, all parameters are set to None. Set _wasInitialised to False for all parameters.

def __setattr__(self, attribute, value):

Setter for all parameters, looks for super if the parameter is prefaced with an underscore. :param attribute: The name of the parameter to set. :type attribute: str

def integrity_check(self):

Checks if all mandatory parameters are set. :return: True if all mandatory parameters are set, False otherwise.

_mParams: dict =

Undocumented

_sParams: dict =

Undocumented

_wasInitialised =

Undocumented