CLFFTPlan.CLFFTDirection (MIPAV API Documentation)

java.lang.Object
- java.lang.Enum<CLFFTPlan.CLFFTDirection>
- - gov.nih.mipav.model.algorithms.filters.OpenCL.filters.CLFFTPlan.CLFFTDirection

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<CLFFTPlan.CLFFTDirection>

Enclosing class:

CLFFTPlan
```
public static enum CLFFTPlan.CLFFTDirection
extends java.lang.Enum<CLFFTPlan.CLFFTDirection>
```

Enum Constant Summary

Enum Constants
Enum Constant Description

Forward

Inverse

Constructor Summary

Constructors
Modifier Constructor Description

private CLFFTDirection()

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method	Description
`(package private) abstract int`	`value()`
`static CLFFTPlan.CLFFTDirection`	`valueOf(java.lang.String name)`	Returns the enum constant of this type with the specified name.
`static CLFFTPlan.CLFFTDirection[]`	`values()`	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

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

- Enum Constant Detail
  - Forward
```
public static final CLFFTPlan.CLFFTDirection Forward
```
  - Inverse
```
public static final CLFFTPlan.CLFFTDirection Inverse
```
- Constructor Detail
  - CLFFTDirection
```
private CLFFTDirection()
```
- Method Detail
  - values
```
public static CLFFTPlan.CLFFTDirection[] values()
```
    Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
    for (CLFFTPlan.CLFFTDirection c : CLFFTPlan.CLFFTDirection.values()) System.out.println(c);
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static CLFFTPlan.CLFFTDirection valueOf(java.lang.String name)
```
    Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
    
    Parameters:
    
    name - the name of the enum constant to be returned.
    
    Returns:
    
    the enum constant with the specified name
    
    Throws:
    
    java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
    
    java.lang.NullPointerException - if the argument is null
  - value
```
abstract int value()
```