ScanMode (Groovy Documentation)

Summary:
Enum constants
Field
Method

life.qbic.datamodel.dtos.imaging.properties.ScanMode

Enumeration of different microscopy scan modes. This enum class should be used, whenever a imaging scan modes needs to be described. Every scan mode needs to have a meaningful and descriptive label. Abbreviations are discouraged. @since: 1.10.0 @author: Jennifer Bödker

Enum Constants Summary

Enum constants classes
Enum constant	Description
`POINT`
`XY`
`XZ`
`YZ`

Field Summary

Fields
Modifiers	Name	Description
`private java.lang.String`	`value`	Contains the String representation of a image plane item.

Constructor Summary

Constructors
Constructor and description
`private ScanMode (java.lang.String value)` Enumeration of different microscopy scan modes.

Methods Summary

Methods
Type Params	Return Type	Name and description
	`java.lang.String`	`getValue()` The string representation of the image plane item.
	`java.lang.String`	`toString()` The `toString()` method is overridden to return the String representation of a image plane item.
`null`	`ScanMode`	`valueOf(java.lang.String name)` Returns the enum constant of this type with the specified name.
`null`	`ScanMode[]`	`values()` Returns an array containing the constants of this enum type, in the order they are declared.

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class java.lang.Object`	`java.lang.Object#wait(long), java.lang.Object#wait(long, int), java.lang.Object#wait(), java.lang.Object#equals(java.lang.Object), java.lang.Object#toString(), java.lang.Object#hashCode(), java.lang.Object#getClass(), java.lang.Object#notify(), java.lang.Object#notifyAll()`

- Enum Constant Detail
  - ScanMode POINT
  - ScanMode XY
  - ScanMode XZ
  - ScanMode YZ
- Field Detail
  - private final java.lang.String value
    
    Contains the String representation of a image plane item.
- Constructor Detail
  - private ScanMode(java.lang.String value)
    
    Enumeration of different microscopy scan modes.
    Parameters:
    value - ScanMode.value
- Method Detail
  - java.lang.String getValue()
    
    The string representation of the image plane item.
    Returns:
    The value of the image plane item, which is its declarative String representation.
  - @java.lang.Override java.lang.String toString()
    
    The toString() method is overridden to return the String representation of a image plane item. This is equivalent to the getValue() return value.
    See Also:
    getValue()
    Returns:
    The String representation of the image plane item
  - ScanMode valueOf(java.lang.String name)
    
    Returns the enum constant of this type with the specified name.
  - ScanMode[] values()
    
    Returns an array containing the constants of this enum type, in the order they are declared.

Summary:
Enum constants
Field
Method

Groovy Documentation