HDF5EnumerationValueMDArray (jhdf5 19.04.1 API)

java.lang.Object
- ch.systemsx.cisd.hdf5.HDF5EnumerationValueMDArray

All Implemented Interfaces:

java.lang.Iterable<ch.systemsx.cisd.base.mdarray.MDAbstractArray.ArrayEntry>
```
public class HDF5EnumerationValueMDArray
extends java.lang.Object
implements java.lang.Iterable<ch.systemsx.cisd.base.mdarray.MDAbstractArray.ArrayEntry>
```
A class that represents a multi-dimensional array of HDF enumeration values.

Constructor Summary

Constructors
Constructor and Description
`HDF5EnumerationValueMDArray(HDF5EnumerationType type, ch.systemsx.cisd.base.mdarray.MDAbstractArray<?> ordinalArray)` Creates an enumeration value array.
`HDF5EnumerationValueMDArray(HDF5EnumerationType type, ch.systemsx.cisd.base.mdarray.MDByteArray ordinalArray)` Creates an enumeration value array.
`HDF5EnumerationValueMDArray(HDF5EnumerationType type, ch.systemsx.cisd.base.mdarray.MDIntArray ordinalArray)` Creates an enumeration value array.
`HDF5EnumerationValueMDArray(HDF5EnumerationType type, ch.systemsx.cisd.base.mdarray.MDShortArray ordinalArray)` Creates an enumeration value array.
`HDF5EnumerationValueMDArray(int rank)` Creates an empty array with given `rank`.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int[]`	`dimensions()` Returns the dimensions of this enumeration array.
`boolean`	`equals(java.lang.Object obj)`
`int`	`getOrdinal(int... arrayIndices)` Returns the ordinal value for the `arrayIndex`.
`int`	`getOrdinal(int arrayIndex)` Returns the ordinal value for the `arrayIndex`.
`int`	`getOrdinal(int arrayIndexX, int arrayIndexY)` Returns the ordinal value for the `arrayIndex`.
`ch.systemsx.cisd.base.mdarray.MDAbstractArray<?>`	`getOrdinalValues()` Returns the ordinal values for all elements of this array.
`HDF5EnumerationType`	`getType()` Returns the `type` of this enumeration array.
`<T extends java.lang.Enum<T>> T`	`getValue(java.lang.Class<T> enumClass, int... arrayIndices)` Returns the value as Enum of type `enumClass`.
`java.lang.String`	`getValue(int... arrayIndices)` Returns the string value for `arrayIndex`.
`java.lang.String`	`getValue(int arrayIndex)` Returns the string value for `arrayIndex`.
`java.lang.String`	`getValue(int arrayIndexX, int arrayIndexY)` Returns the string value for `arrayIndex`.
`int`	`hashCode()`
`java.util.Iterator<ch.systemsx.cisd.base.mdarray.MDAbstractArray.ArrayEntry>`	`iterator()`
`long[]`	`longDimensions()` Returns the dimensions of this enumeration array as a long.
`int`	`rank()` Returns the rank of this multi-dimensional enumeration array.
`int`	`size()` Returns the number of elements of this enumeration array.
`int`	`size(int dim)` Returns the extent of this enum array along its `dim`-th axis.
`<T extends java.lang.Enum<T>> ch.systemsx.cisd.base.mdarray.MDArray<T>`	`toEnumArray(java.lang.Class<T> enumClass)` Returns the values for all elements of this array as an enum array with enums of type `enumClass`.
`java.lang.String`	`toString()`
`ch.systemsx.cisd.base.mdarray.MDArray<java.lang.String>`	`toStringArray()` Returns the string values for all elements of this array.

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

Methods inherited from interface java.lang.Iterable
forEach, spliterator

- Constructor Detail
  - HDF5EnumerationValueMDArray
```
public HDF5EnumerationValueMDArray(HDF5EnumerationType type,
                                   ch.systemsx.cisd.base.mdarray.MDAbstractArray<?> ordinalArray)
                            throws java.lang.IllegalArgumentException
```
    Creates an enumeration value array.
    
    Parameters:
    
    type - The enumeration type of this value.
    
    ordinalArray - The array of ordinal values in the type. Has to be one of MDByteArray, MDShortArray or MDIntArray.
    
    Throws:
    
    java.lang.IllegalArgumentException - If any of the ordinals in the ordinalArray is outside of the range of allowed values of the type.
  - HDF5EnumerationValueMDArray
```
public HDF5EnumerationValueMDArray(int rank)
```
    Creates an empty array with given rank.
  - HDF5EnumerationValueMDArray
```
public HDF5EnumerationValueMDArray(HDF5EnumerationType type,
                                   ch.systemsx.cisd.base.mdarray.MDByteArray ordinalArray)
                            throws java.lang.IllegalArgumentException
```
    Creates an enumeration value array.
    
    Parameters:
    
    type - The enumeration type of this value.
    
    ordinalArray - The array of ordinal values in the type.
    
    Throws:
    
    java.lang.IllegalArgumentException - If any of the ordinals in the ordinalArray is outside of the range of allowed values of the type.
  - HDF5EnumerationValueMDArray
```
public HDF5EnumerationValueMDArray(HDF5EnumerationType type,
                                   ch.systemsx.cisd.base.mdarray.MDShortArray ordinalArray)
                            throws java.lang.IllegalArgumentException
```
    Creates an enumeration value array.
    
    Parameters:
    
    type - The enumeration type of this value.
    
    ordinalArray - The array of ordinal values in the type.
    
    Throws:
    
    java.lang.IllegalArgumentException - If any of the ordinals in the ordinalArray is outside of the range of allowed values of the type.
  - HDF5EnumerationValueMDArray
```
public HDF5EnumerationValueMDArray(HDF5EnumerationType type,
                                   ch.systemsx.cisd.base.mdarray.MDIntArray ordinalArray)
                            throws java.lang.IllegalArgumentException
```
    Creates an enumeration value array.
    
    Parameters:
    
    type - The enumeration type of this value.
    
    ordinalArray - The array of ordinal values in the type.
    
    Throws:
    
    java.lang.IllegalArgumentException - If any of the ordinals in the ordinalArray is outside of the range of allowed values of the type.
- Method Detail
  - getType
```
public HDF5EnumerationType getType()
```
    Returns the type of this enumeration array.
  - size
```
public int size()
```
    Returns the number of elements of this enumeration array.
  - size
```
public int size(int dim)
```
    Returns the extent of this enum array along its dim-th axis.
  - rank
```
public int rank()
```
    Returns the rank of this multi-dimensional enumeration array.
  - dimensions
```
public int[] dimensions()
```
    Returns the dimensions of this enumeration array.
  - longDimensions
```
public long[] longDimensions()
```
    Returns the dimensions of this enumeration array as a long.
  - getOrdinal
```
public int getOrdinal(int arrayIndex)
```
    Returns the ordinal value for the arrayIndex.
    
    Parameters:
    
    arrayIndex - The index in the array to get the ordinal for.
  - getOrdinal
```
public int getOrdinal(int arrayIndexX,
                      int arrayIndexY)
```
    Returns the ordinal value for the arrayIndex.
    
    Parameters:
    
    arrayIndexX - The x index in the array to get the ordinal for.
    
    arrayIndexY - The y index in the array to get the ordinal for.
  - getOrdinal
```
public int getOrdinal(int... arrayIndices)
```
    Returns the ordinal value for the arrayIndex.
    
    Parameters:
    
    arrayIndices - The indices in the array to get the ordinal for.
  - getValue
```
public java.lang.String getValue(int arrayIndex)
```
    Returns the string value for arrayIndex.
    
    Parameters:
    
    arrayIndex - The index in the array to get the value for.
  - getValue
```
public java.lang.String getValue(int arrayIndexX,
                                 int arrayIndexY)
```
    Returns the string value for arrayIndex.
    
    Parameters:
    
    arrayIndexX - The x index in the array to get the value for.
    
    arrayIndexY - The y index in the array to get the value for.
  - getValue
```
public java.lang.String getValue(int... arrayIndices)
```
    Returns the string value for arrayIndex.
    
    Parameters:
    
    arrayIndices - The indices in the array to get the value for.
  - getValue
```
public <T extends java.lang.Enum<T>> T getValue(java.lang.Class<T> enumClass,
                                                int... arrayIndices)
```
    Returns the value as Enum of type enumClass.
    
    Parameters:
    
    enumClass - The class to return the value as.
    
    arrayIndices - The indices in the array to get the value for.
  - toStringArray
```
public ch.systemsx.cisd.base.mdarray.MDArray<java.lang.String> toStringArray()
```
    Returns the string values for all elements of this array.
  - toEnumArray
```
public <T extends java.lang.Enum<T>> ch.systemsx.cisd.base.mdarray.MDArray<T> toEnumArray(java.lang.Class<T> enumClass)
```
    Returns the values for all elements of this array as an enum array with enums of type enumClass.
  - getOrdinalValues
```
public ch.systemsx.cisd.base.mdarray.MDAbstractArray<?> getOrdinalValues()
```
    Returns the ordinal values for all elements of this array.
  - iterator
```
public java.util.Iterator<ch.systemsx.cisd.base.mdarray.MDAbstractArray.ArrayEntry> iterator()
```
    Specified by:
    
    iterator in interface java.lang.Iterable<ch.systemsx.cisd.base.mdarray.MDAbstractArray.ArrayEntry>
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Overrides:
    
    equals in class java.lang.Object

Class HDF5EnumerationValueMDArray

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface java.lang.Iterable

Constructor Detail

HDF5EnumerationValueMDArray

HDF5EnumerationValueMDArray

HDF5EnumerationValueMDArray

HDF5EnumerationValueMDArray

HDF5EnumerationValueMDArray

Method Detail

getType

size

size

rank

dimensions

longDimensions

getOrdinal

getOrdinal

getOrdinal

getValue

getValue

getValue

getValue

toStringArray

toEnumArray

getOrdinalValues

iterator

toString

hashCode

equals