Package Ganga :: Package GPIDev :: Package Adapters :: Module IApplication :: Class IApplication

Class IApplication

          object --+        
                   |        
   Base.Objects.Node --+    
                       |    
Base.Objects.GangaObject --+
                           |
                          IApplication

Known Subclasses:

This is a Ganga.GPI.IApplication implementation class. Refer to Ganga.GPI.IApplication.__doc__ for documentation.

Nested Classes

[hide private]

_proxyClass
Base class for all application objects.

Inherited from Base.Objects.GangaObject: __metaclass__

Instance Methods

[hide private]

master_configure(self)
Configure the shared/master aspect of the application.

source code

configure(self, master_appconfig)
Configure the specific aspect of the application .

source code

postprocess(self)
Postprocessing after the job was reported as completed.

source code

postprocess_failed(self)
Postprocessing after the job was reported as failed.

source code

transition_update(self, new_status)
This method will be called just before the status of the parent Job changes to new_status.

source code

Inherited from Base.Objects.GangaObject: __construct__, __deepcopy__, __getstate__, __init__, __setstate__, _attribute_filter__set__, _auto__init__, accept, getJobObject

Inherited from Base.Objects.GangaObject (private): _getReadAccess, _getRegistry, _getRegistryID, _getWriteAccess, _readonly, _releaseWriteAccess, _setDirty, _setFlushed, _setRegistry

Inherited from Base.Objects.Node: __copy__, __eq__, __ne__, clone, copyFrom, printSummaryTree, printTree

Inherited from Base.Objects.Node (private): _getParent, _getRoot, _setParent

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __sizeof__, __str__, __subclasshook__

Class Methods

[hide private]

Inherited from Base.Objects.GangaObject (private): _declared_property

Class Variables

[hide private]

_schema = Schema(Version(0, 0), {})

_category = 'applications'

_hidden = 1

Inherited from Base.Objects.GangaObject (private): _exportmethods, _registry

Inherited from Base.Objects.Node (private): _index_cache, _parent

Properties

[hide private]

Inherited from object: __class__

Method Details

[hide private]

master_configure(self)

source code

Configure the shared/master aspect of the application. Return a tuple (modified_flag, appconfig).

This method is always called exactly once, also in the case of splitting.

Return tuple:

appconfig (also known as appextra) is an arbitrary structure which will be processed by application-specific runtime handler as the next step of job submission.
modified_flag is True if application object (self) has been modified during configure()

If this method is not implemented in the derived class then it is ignored.

configure(self, master_appconfig)

source code

Configure the specific aspect of the application . This method has a similar meaning as master_configure() method and it should return a tuple (modified_flag,appconfig).

This method must be implemented in a derived class. Otherwise the submission will fail.

Arguments:

master_appconfig is a result of the master job master_configure() method.

In case of splitting this method will be called for each subjob object exactly once which means that it will be executed as many times as there are subjobs.

If there is no splitting this method will be called exactly once, after master_configure().

Transition from Ganga 4.0.x:

master_appconfig should be ignored (it is None anyway)

postprocess(self)

source code

Postprocessing after the job was reported as completed. By default do nothing. This method may raise an exception PostprocessStatusUpdate('failed'). In this case the job status will be 'failed'. The postprocess_failed() hook will NOT be called.

postprocess_failed(self)

source code

Postprocessing after the job was reported as failed. By default do nothing.

transition_update(self, new_status)

source code

This method will be called just before the status of the parent Job changes to new_status. The default it to do nothing.