## org.das2.util.monitor.SubTaskMonitor

creates a ProgressMonitor that maps its progress to a parent's progress. For example, if a process takes a progress monitor, but is implemented in two steps that each take a progress monitor, then two subtask monitors can be created to monitor each step, and the client who passed in the monitor will see the whole deal as one process. Note we would often abuse monitors, handing them off to several processes that would each take the monitor through its lifecycle. Now we require the lifecycle be performed once, so that machines can use the monitors to monitor processes. In this case, SubTaskMonitors should be used, and getSubtaskMonitor was added. Note too that this class should not be called directly, because getSubtaskMonitor allows the source class to return a monitor of its own design.

## canBeCancelled

canBeCancelled( ) → boolean

### Returns:

boolean
[search for examples] [view on GitHub] [view on old javadoc] [view source]

## cancel

cancel( ) → void

### Returns:

void (returns nothing)
[search for examples] [view on GitHub] [view on old javadoc] [view source]

## create

create( ProgressMonitor parent, long min, long max ) → org.das2.util.monitor.SubTaskMonitor

create the subtask monitor.

### Parameters

parent - parent monitor
min - minium
max - maximum

### Returns:

SubTaskMonitor
[search for examples] [view on GitHub] [view on old javadoc] [view source]

## create

create( ProgressMonitor parent, long min, long max, boolean cancelChecked ) → org.das2.util.monitor.SubTaskMonitor

create the subtask monitor.

### Parameters

parent - parent monitor
min - minium
max - maximum
cancelChecked - true if we should check the parent's cancel status

### Returns:

SubTaskMonitor
[search for examples] [view on GitHub] [view on old javadoc] [view source]

## create

create( ProgressMonitor parent, boolean cancelChecked ) → org.das2.util.monitor.SubTaskMonitor

mode for when parent is indeterminate

### Parameters

parent - a ProgressMonitor
cancelChecked - a boolean

### Returns:

an org.das2.util.monitor.SubTaskMonitor
[search for examples] [view on GitHub] [view on old javadoc] [view source]

## finished

finished( ) → void

### Returns:

void (returns nothing)
[search for examples] [view on GitHub] [view on old javadoc] [view source]

## getLabel

getLabel( ) → String

### Returns:

java.lang.String
[search for examples] [view on GitHub] [view on old javadoc] [view source]

## getSubtaskMonitor

getSubtaskMonitor( int start, int end, String label ) → ProgressMonitor

### Parameters

start - an int
end - an int
label - a String

### Returns:

org.das2.util.monitor.ProgressMonitor
[search for examples] [view on GitHub] [view on old javadoc] [view source]
getSubtaskMonitor( String label ) → ProgressMonitor [view source]

## getTaskProgress

getTaskProgress( ) → long

### Returns:

long
[search for examples] [view on GitHub] [view on old javadoc] [view source]

## getTaskSize

getTaskSize( ) → long

### Returns:

long
[search for examples] [view on GitHub] [view on old javadoc] [view source]

## isCancelled

isCancelled( ) → boolean

### Returns:

boolean
[search for examples] [view on GitHub] [view on old javadoc] [view source]

## isFinished

isFinished( ) → boolean

### Returns:

boolean
[search for examples] [view on GitHub] [view on old javadoc] [view source]

## isStarted

isStarted( ) → boolean

### Returns:

boolean
[search for examples] [view on GitHub] [view on old javadoc] [view source]

## setAdditionalInfo

setAdditionalInfo( String s ) → void

### Parameters

s - a String

### Returns:

void (returns nothing)
[search for examples] [view on GitHub] [view on old javadoc] [view source]

## setLabel

setLabel( String label ) → void

### Parameters

label - a String

### Returns:

void (returns nothing)
[search for examples] [view on GitHub] [view on old javadoc] [view source]

## setProgressMessage

setProgressMessage( String message ) → void

these messages are lost, unless doEchoToParent is set.

### Parameters

message - a String

### Returns:

void (returns nothing)
[search for examples] [view on GitHub] [view on old javadoc] [view source]

## setTaskProgress

setTaskProgress( long position ) → void

### Parameters

position - a long

### Returns:

void (returns nothing)
[search for examples] [view on GitHub] [view on old javadoc] [view source]

## setTaskSize

setTaskSize( long taskSize ) → void

### Parameters

taskSize - a long

### Returns:

void (returns nothing)
[search for examples] [view on GitHub] [view on old javadoc] [view source]

## started

started( ) → void

### Returns:

void (returns nothing)
[search for examples] [view on GitHub] [view on old javadoc] [view source]

## toString

toString( ) → String

### Returns:

java.lang.String
[search for examples] [view on GitHub] [view on old javadoc] [view source]