CeaTask (Starjava TTOOLS API)

Skip navigation links

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

java.lang.Object
- uk.ac.starlink.ttools.cea.CeaTask

```
public class CeaTask
extends java.lang.Object
```
Represents a task suitable for use in the CEA interface of STILTS. Corresponds, but perhaps not exactly, to a STILTS task.

Since:

17 Mar 2006

Author:

Mark Taylor

Constructor Summary

Constructors
Constructor and Description

CeaTask(uk.ac.starlink.task.Task task, java.lang.String name)
Constructs a CeaTask.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.String`	`getName()` Returns public task name.
`CeaParameter`	`getParameter(java.lang.String name)` Returns a named parameter of this task.
`CeaParameter[]`	`getParameters()` Returns a list of the parameters associated with this task for the purposes of CEA use.
`java.lang.String`	`getPurpose()` Returns task purpose.
`void`	`removeParameter(java.lang.String name)` Removes a named parameter from this task's parameter list.

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

- Constructor Detail
  - CeaTask
```
public CeaTask(uk.ac.starlink.task.Task task,
               java.lang.String name)
```
    Constructs a CeaTask.
    
    Parameters:
    
    task - ttools task object
    
    name - public name of the task
- Method Detail
  - getName
```
public java.lang.String getName()
```
    Returns public task name.
    
    Returns:
    
    task name
  - getPurpose
```
public java.lang.String getPurpose()
```
    Returns task purpose.
    
    Returns:
    
    task purpose
  - removeParameter
```
public void removeParameter(java.lang.String name)
```
    Removes a named parameter from this task's parameter list.
    
    Parameters:
    
    name - name of the parameter to remove
  - getParameter
```
public CeaParameter getParameter(java.lang.String name)
```
    Returns a named parameter of this task.
    
    Parameters:
    
    name - of the parameter
    
    Returns:
    
    parameter
  - getParameters
```
public CeaParameter[] getParameters()
```
    Returns a list of the parameters associated with this task for the purposes of CEA use.
    
    Returns:
    
    parameter list

Skip navigation links

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

Copyright © 2017 Central Laboratory of the Research Councils. All Rights Reserved.