public class TaskArguments extends Object
Constructor and Description |
---|
TaskArguments()
Creates with no initial size.
|
TaskArguments(Optional<ImageSizeSuggestion> size)
Creates with a specific initial size-suggestion.
|
Modifier and Type | Method and Description |
---|---|
void |
assignGroup(String groupRange)
Assigns an index-range to use to form groups, by subsetting components from each input's
identifier.
|
void |
assignMaxNumberProcessors(String numberProcessors)
Assigns a suggested maximum number of processors (CPUs) for a task.
|
void |
assignSize(String size)
Assign dimensions or scaling factor or size for an image, as may be used by a task.
|
void |
assignTaskName(Optional<String> taskName)
Assigns a name for the task.
|
Optional<IndexRangeNegative> |
getGroupIndexRange()
An index-range to use for grouping, by subsetting components from each input's identifier.
|
Optional<Integer> |
getMaxNumberProcessors()
Suggests a maximum number of processors (CPUs) for a task.
|
Optional<ImageSizeSuggestion> |
getSize()
Suggests dimensions or a scaling-factor to resize an image to.
|
Optional<String> |
getTaskName()
A name to describe the ongoing task.
|
public TaskArguments()
public TaskArguments(Optional<ImageSizeSuggestion> size)
size
- the size-suggestion.public void assignTaskName(Optional<String> taskName)
taskName
- the name to assign.public void assignSize(String size) throws ExperimentExecutionException
size
- a string describing the size in a format compatible with ImageSizeSuggestionFactory.create(String)
.ExperimentExecutionException
- if the format of size is invalid.public void assignGroup(String groupRange) throws ExperimentExecutionException
groupRange
- a string in the format expected by IndexRangeNegativeFactory.parse(java.lang.String)
,
or an empty-string which is considered as "0".ExperimentExecutionException
- if groupRange
does have the expected format.public void assignMaxNumberProcessors(String numberProcessors) throws ExperimentExecutionException
numberProcessors
- the maximum number of processors.ExperimentExecutionException
- if the string doesn't describe a positive integer.public Optional<ImageSizeSuggestion> getSize()
public Optional<Integer> getMaxNumberProcessors()
public Optional<IndexRangeNegative> getGroupIndexRange()
Copyright © 2010–2023 Owen Feehan, ETH Zurich, University of Zurich, Hoffmann-La Roche. All rights reserved.