OpCandidate (ImageJ2 Javadocs 0-SNAPSHOT API)

java.lang.Object
- net.imagej.ops.OpCandidate

```
public class OpCandidate
extends Object
```
Container class for a possible operation match between an OpRef and an OpInfo, as computed by the OpMatchingService.

Author:

Curtis Rueden

See Also:

OpMatchingService

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class OpCandidate.StatusCode

Nested Classes
Modifier and Type	Class and Description
`static class`	`OpCandidate.StatusCode`

Constructor Summary

Constructors
Constructor and Description

OpCandidate(OpEnvironment ops, OpRef ref, OpInfo info)

Constructors
Constructor and Description
`OpCandidate(OpEnvironment ops, OpRef ref, OpInfo info)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CommandInfo`	`cInfo()` Gets the `CommandInfo` metadata describing the op to match against.
`Object[]`	`getArgs()`
`Module`	`getModule()` Gets the module instance associated with the attempted match.
`OpRef`	`getRef()` Gets the op reference describing the desired match.
`String`	`getStatus()` Gets a descriptive status message in human readable form.
`OpCandidate.StatusCode`	`getStatusCode()` Gets the matching status code.
`ModuleItem<?>`	`getStatusItem()` Gets the status item related to the matching status, if any.
`String`	`getStatusMessage()` Gets a message elaborating on the matching status, if any.
`List<ModuleItem<?>>`	`inputs()` Gets the op's input parameters.
`OpInfo`	`opInfo()` Gets the `OpInfo` metadata describing the op to match against.
`OpEnvironment`	`ops()` Gets the op execution environment of the desired match.
`List<ModuleItem<?>>`	`outputs()` Gets the op's output parameters.
`void`	`setArgs(Object[] args)`
`void`	`setModule(Module module)` Sets the module instance associated with the attempted match.
`void`	`setStatus(OpCandidate.StatusCode code)` Sets the status of the matching attempt.
`void`	`setStatus(OpCandidate.StatusCode code, String message)` Sets the status of the matching attempt.
`void`	`setStatus(OpCandidate.StatusCode code, String message, ModuleItem<?> item)` Sets the status of the matching.
`String`	`toString()`

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

- Constructor Detail
  - OpCandidate
```
public OpCandidate(OpEnvironment ops,
                   OpRef ref,
                   OpInfo info)
```
- Method Detail
  - ops
```
public OpEnvironment ops()
```
    Gets the op execution environment of the desired match.
  - getRef
```
public OpRef getRef()
```
    Gets the op reference describing the desired match.
  - opInfo
```
public OpInfo opInfo()
```
    Gets the OpInfo metadata describing the op to match against.
  - cInfo
```
public CommandInfo cInfo()
```
    Gets the CommandInfo metadata describing the op to match against.
    
    See Also:
    
    OpInfo.cInfo()
  - inputs
```
public List<ModuleItem<?>> inputs()
```
    Gets the op's input parameters.
  - outputs
```
public List<ModuleItem<?>> outputs()
```
    Gets the op's output parameters.
  - setModule
```
public void setModule(Module module)
```
    Sets the module instance associated with the attempted match.
  - getModule
```
public Module getModule()
```
    Gets the module instance associated with the attempted match.
  - setStatus
```
public void setStatus(OpCandidate.StatusCode code)
```
    Sets the status of the matching attempt.
  - setStatus
```
public void setStatus(OpCandidate.StatusCode code,
                      String message)
```
    Sets the status of the matching attempt.
  - setStatus
```
public void setStatus(OpCandidate.StatusCode code,
                      String message,
                      ModuleItem<?> item)
```
    Sets the status of the matching.
  - getStatusCode
```
public OpCandidate.StatusCode getStatusCode()
```
    Gets the matching status code.
  - getStatusMessage
```
public String getStatusMessage()
```
    Gets a message elaborating on the matching status, if any.
  - getStatusItem
```
public ModuleItem<?> getStatusItem()
```
    Gets the status item related to the matching status, if any. Typically, if set, this is the parameter for which matching failed.
  - getStatus
```
public String getStatus()
```
    Gets a descriptive status message in human readable form.
  - getArgs
```
public Object[] getArgs()
```
  - setArgs
```
public void setArgs(Object[] args)
```
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class OpCandidate

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

OpCandidate

Method Detail

ops

getRef

opInfo

cInfo

inputs

outputs

setModule

getModule

setStatus

setStatus

setStatus

getStatusCode

getStatusMessage

getStatusItem

getStatus

getArgs

setArgs

toString