Package Ganga :: Package Lib :: Package Mergers :: Module Merger :: Class AbstractMerger
[hide private]
[frames] | no frames]

Class AbstractMerger

source code

                 object --+            
                          |            
   GPIDev.Base.Objects.Node --+        
                              |        
GPIDev.Base.Objects.GangaObject --+    
                                  |    
    GPIDev.Adapters.IMerger.IMerger --+
                                      |
                                     AbstractMerger
Known Subclasses:

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

Nested Classes [hide private]
  _proxyClass
The idea behind this class is to put all of the checking and user interaction in this class, and then use a very simple stateless merge_tool to actually do the relevant merge.

Inherited from GPIDev.Base.Objects.GangaObject: __metaclass__

Instance Methods [hide private]
 
__init__(self, merge_tool)
x.__init__(...) initializes x; see help(type(x)) for signature
source code
 
merge(self, jobs, outputdir=None, ignorefailed=None, overwrite=None)
Method to merge the output of jobs.
source code

Inherited from GPIDev.Adapters.IMerger.IMerger: validatedMerge

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

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

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

Class Methods [hide private]
Class Variables [hide private]
  _schema = Schema(Version(1, 0), {'files': SimpleItem(defvalue=...
  _category = 'mergers'
  _name = 'AbstractMerger'
  _hidden = 1
  _GUIPrefs = [{'attribute': 'ignorefailed', 'widget': 'Bool'}, ...
  success = True
  failure = False
  files = <Ganga.GPIDev.Base.Objects.Descriptor object at 0x17f7...
  ignorefailed = <Ganga.GPIDev.Base.Objects.Descriptor object at...
  merge_tool = <Ganga.GPIDev.Base.Objects.Descriptor object at 0...
  overwrite = <Ganga.GPIDev.Base.Objects.Descriptor object at 0x...

Inherited from GPIDev.Adapters.IMerger.IMerger: set_outputdir_for_automerge

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

Properties [hide private]

Inherited from object: __class__

Method Details [hide private]

__init__(self, merge_tool)
(Constructor)

source code 

x.__init__(...) initializes x; see help(type(x)) for signature

Overrides: object.__init__
(inherited documentation)

merge(self, jobs, outputdir=None, ignorefailed=None, overwrite=None)

source code 

Method to merge the output of jobs.

jobs may be a single job instance or a sequence of Jobs outputdir is the name of the directry to put the merge results in. It will be created if needed. ignorefailed and overwrite have the same meaning as in the schema, but override the schema values.

returns whether the merge was successful or not as a boolean

Overrides: GPIDev.Adapters.IMerger.IMerger.merge

Class Variable Details [hide private]

_schema

Value:
Schema(Version(1, 0), {'files': SimpleItem(defvalue= [], typelist= ['s\
tr'], sequence= 1, doc= 'A list of files to merge.'), 'merge_tool': Co\
mponentItem('merge_tools', defvalue= None, doc= 'The merge tool to use\
.', hidden= 1), 'ignorefailed': SimpleItem(defvalue= False, doc= 'Jobs\
 that are in the failed or killed states will be excluded from the mer\
ge when this flag is set to True.'), 'overwrite': SimpleItem(defvalue=\
 False, doc= 'The default behaviour for this Merger object. Will overw\
rite output files.')})

_GUIPrefs

Value:
[{'attribute': 'ignorefailed', 'widget': 'Bool'},
 {'attribute': 'overwrite', 'widget': 'Bool'}]

files

Value:
<Ganga.GPIDev.Base.Objects.Descriptor object at 0x17f7190>

ignorefailed

Value:
<Ganga.GPIDev.Base.Objects.Descriptor object at 0x17f7250>

merge_tool

Value:
<Ganga.GPIDev.Base.Objects.Descriptor object at 0x17f7210>

overwrite

Value:
<Ganga.GPIDev.Base.Objects.Descriptor object at 0x17f72d0>