OfflineTaskGroup

java.lang.Object
- offlineProcessing.OfflineTaskGroup

All Implemented Interfaces:

PamSettings
```
public class OfflineTaskGroup
extends java.lang.Object
implements PamSettings
```
Author:

Doug Gillespie Handles a series of offline tasks which all use a common data block so that data can be loaded, a whole series of tasks completed and the data then saved in a single operation.
This will be the primary interface to OfflineTasks - even if there is only one task it will be in a group of one !

Constructor Summary

Constructors
Constructor and Description
`OfflineTaskGroup(PamControlledUnit pamControlledUnit, java.lang.String settingsName)` PamControlledunit required in constructor since some bookkeeping will be goign on in the background which will need the unit type and name.

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addTask(OfflineTask task)`
`int`	`getNTasks()`
`PamDataBlock`	`getPrimaryDataBlock()`
`int`	`getProcessTime()`
`java.io.Serializable`	`getSettingsReference()`
`long`	`getSettingsVersion()`
`OfflineTask`	`getTask(int iTask)`
`TaskGroupParams`	`getTaskGroupParams()`
`TaskMonitor`	`getTaskMonitor()`
`java.lang.String`	`getUnitName()`
`java.lang.String`	`getUnitType()`
`void`	`killTasks()`
`boolean`	`restoreSettings(PamControlledUnitSettings pamControlledUnitSettings)`
`boolean`	`runTasks()` Run all the tasks.
`void`	`setPrimaryDataBlock(PamDataBlock primaryDataBlock)`
`void`	`setSummaryLists()` Setup summary lists of required and affected datablocks based on which tasks are actually going to run .
`void`	`setTaskMonitor(TaskMonitor taskMonitor)`
`void`	`tasksDone()` some bookkeeping - write information about task completion to the database.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - OfflineTaskGroup
```
public OfflineTaskGroup(PamControlledUnit pamControlledUnit,
                java.lang.String settingsName)
```
    PamControlledunit required in constructor since some bookkeeping will be goign on in the background which will need the unit type and name.
    
    Parameters:
    pamControlledUnit - host contrlled unit.
    settingsName - Name to be used in PamSettings for storing some basic information (which tasks are selected)
- Method Detail
  - setSummaryLists
```
public void setSummaryLists()
```
    Setup summary lists of required and affected datablocks based on which tasks are actually going to run .
  - runTasks
```
public boolean runTasks()
```
    Run all the tasks.
    
    Parameters:
    offlineClassifierParams -
    
    Returns:
  - killTasks
```
public void killTasks()
```
  - addTask
```
public void addTask(OfflineTask task)
```
    Parameters:
    task - task to add to the group
  - getNTasks
```
public int getNTasks()
```
    Returns:
    the number of tasks in the group
  - getTask
```
public OfflineTask getTask(int iTask)
```
    Parameters:
    iTask - the task number
    
    Returns:
    the task.
  - getProcessTime
```
public int getProcessTime()
```
    Returns:
    the processTime
  - getPrimaryDataBlock
```
public PamDataBlock getPrimaryDataBlock()
```
    Returns:
    the primaryDataBlock
  - setPrimaryDataBlock
```
public void setPrimaryDataBlock(PamDataBlock primaryDataBlock)
```
    Parameters:
    primaryDataBlock - the primaryDataBlock to set
  - getTaskMonitor
```
public TaskMonitor getTaskMonitor()
```
    Returns:
    the taskMonitor
  - setTaskMonitor
```
public void setTaskMonitor(TaskMonitor taskMonitor)
```
    Parameters:
    taskMonitor - the taskMonitor to set
  - tasksDone
```
public void tasksDone()
```
    some bookkeeping - write information about task completion to the database.
  - getSettingsReference
```
public java.io.Serializable getSettingsReference()
```
    Specified by:
    
    getSettingsReference in interface PamSettings
    
    Returns:
    The serialisable object that will be stored
  - getSettingsVersion
```
public long getSettingsVersion()
```
    Specified by:
    
    getSettingsVersion in interface PamSettings
    
    Returns:
    An integer version number for the settings
  - getUnitName
```
public java.lang.String getUnitName()
```
    Specified by:
    
    getUnitName in interface PamSettings
    
    Returns:
    A Name specific to this instance of the particular class, e.g. Sperm whale detector, Beaked whale detector, etc.
  - getUnitType
```
public java.lang.String getUnitType()
```
    Specified by:
    
    getUnitType in interface PamSettings
    
    Returns:
    A Name specific to the type, e.g. Glick detector
  - restoreSettings
```
public boolean restoreSettings(PamControlledUnitSettings pamControlledUnitSettings)
```
    Specified by:
    
    restoreSettings in interface PamSettings
    
    Returns:
    true if successful The object performs final checks (if needed) and then casts the settings data pamcontrolledunitSettings.settings into the correct type and uses as required
  - getTaskGroupParams
```
public TaskGroupParams getTaskGroupParams()
```
    Returns:
    the taskGroupParams

Class OfflineTaskGroup

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

OfflineTaskGroup

Method Detail

setSummaryLists

runTasks

killTasks

addTask

getNTasks

getTask

getProcessTime

getPrimaryDataBlock

setPrimaryDataBlock

getTaskMonitor

setTaskMonitor

tasksDone

getSettingsReference

getSettingsVersion

getUnitName

getUnitType

restoreSettings

getTaskGroupParams