Voro.c_loop_subset_mode (MIPAV API Documentation)

java.lang.Object
- java.lang.Enum<Voro.c_loop_subset_mode>
- - gov.nih.mipav.model.structures.Voro.c_loop_subset_mode

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<Voro.c_loop_subset_mode>

Enclosing class:

Voro
```
static enum Voro.c_loop_subset_mode
extends java.lang.Enum<Voro.c_loop_subset_mode>
```
A type associated with a c_loop_subset class, determining what type of geometrical region to loop over.

Enum Constant Summary

Enum Constants
Enum Constant Description

box

no_check

sphere

Constructor Summary

Constructors
Modifier Constructor Description

private c_loop_subset_mode()

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method	Description
`static Voro.c_loop_subset_mode`	`valueOf(java.lang.String name)`	Returns the enum constant of this type with the specified name.
`static Voro.c_loop_subset_mode[]`	`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
  - sphere
```
public static final Voro.c_loop_subset_mode sphere
```
  - box
```
public static final Voro.c_loop_subset_mode box
```
  - no_check
```
public static final Voro.c_loop_subset_mode no_check
```
- Constructor Detail
  - c_loop_subset_mode
```
private c_loop_subset_mode()
```
- Method Detail
  - values
```
public static Voro.c_loop_subset_mode[] 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 (Voro.c_loop_subset_mode c : Voro.c_loop_subset_mode.values()) System.out.println(c);
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static Voro.c_loop_subset_mode 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