SubjobSplitter Class Reference

Inheritance diagram for SubjobSplitter:

Collaboration diagram for SubjobSplitter:

Public Member Functions
def	__init__ (self, *arguments_generator=None)
def	create_subjobs (self, job)
def	assign_arguments (self, job)
def	__repr__ (self)

Public Attributes
	arguments_generator
	The ArgumentsGenerator used when creating subjobs.

Detailed Description

Abstract base class. This class handles the logic of creating subjobs for a `Job` object.
The `create_subjobs` function should be implemented and used to construct
the subjobs of the parent job object.

Parameters:
    arguments_generator (ArgumentsGenerator): Used to construct the generator function that will yield the argument
        tuple for each `SubJob`. The splitter will iterate through the generator each time `create_subjobs` is
        called. The `SubJob` will be sent into the generator with ``send(subjob)`` so that the generator can decide what
        arguments to return.

Definition at line 143 of file backends.py.

Constructor & Destructor Documentation

__init__()

def __init__	(		self,
		*	arguments_generator = None
	)

Derived classes should call `super` to run this.

Definition at line 156 of file backends.py.

Member Function Documentation

assign_arguments()

def assign_arguments	(		self,
			job
	)

Use the `arguments_generator` (if one exists) to assign the argument tuples to the
subjobs.

Definition at line 169 of file backends.py.

create_subjobs()

def create_subjobs	(		self,
			job
	)

Implement this method in derived classes to generate the `SubJob` objects.

Reimplemented in ArgumentsSplitter, MaxSubjobsSplitter, and MaxFilesSplitter.

Definition at line 164 of file backends.py.

---

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

• calibration/scripts/caf/backends.py