org.g_node.nix

Class SetDimension<T extends SetDimension>

java.lang.Object

org.bytedeco.javacpp.Pointer

org.g_node.nix.base.ImplContainer

org.g_node.nix.SetDimension<T>

All Implemented Interfaces:

Comparable<T>

@Platform(include="<nix/Dimensions.hpp>") @Platform(value="linux",link="nix@.1",preload="hdf5@.7") @Platform(value="windows",link="nix",preload={"hdf5","msvcp120","msvcr120","szip","zlib"})
 @Namespace(value="nix")
public class SetDimension<T extends SetDimension>
extends ImplContainer
implements Comparable<T>

SetDimension

Dimension descriptor for a dimension that represents just a list or set of values.

The SetDimension is used in cases where data is given as a set or list. This can be just a collection of values but also a list of recorded signals or a stack of images. Optionally an array of labels, one for each index of this dimension, can be specified.

See Also:

Dimension, RangeDimension, SampledDimension

Constructor Summary

Constructors

Constructor and Description
SetDimension() Constructor that creates an uninitialized SetDimension.

Method Summary

Modifier and Type	Method and Description
int	compareTo(T dimension)
int	getDimensionType() The type of the dimension.
long	getIndex() The actual dimension that is described by the dimension descriptor.
List<String>	getLabels() Get the labels of the range dimension.
boolean	isNone() Check if entity is null
void	setLabels(List<String> labels) Set the labels for the dimension.

Methods inherited from class org.g_node.nix.base.ImplContainer

isInitialized

Methods inherited from class org.bytedeco.javacpp.Pointer

address, asBuffer, asByteBuffer, capacity, capacity, deallocate, deallocate, deallocateReferences, equals, fill, hashCode, isNull, limit, limit, memchr, memcmp, memcpy, memmove, memset, offsetof, position, position, put, setNull, sizeof, toString, zero

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

SetDimension

public SetDimension()

Constructor that creates an uninitialized SetDimension.

Calling any method on an uninitialized dimension will throw a RuntimeException.

Method Detail

isNone

@Cast(value="bool")
public boolean isNone()

Description copied from class: ImplContainer

Check if entity is null

Specified by:

isNone in class ImplContainer

Returns:

true if initialized else false

getIndex

@Name(value="index")
 @Cast(value="size_t")
public long getIndex()

The actual dimension that is described by the dimension descriptor.

The index of the dimension entity representing the dimension of the actual data that is defined by this descriptor.

Returns:

The dimension index of the dimension.

getDimensionType

@Name(value="dimensionType")
 @ByVal
 @Cast(value="nix::DimensionType")
public int getDimensionType()

The type of the dimension.

This field indicates whether the dimension is a SampledDimension, SetDimension or RangeDimension.

Returns:

The dimension type. Constants specified in DataType

See Also:

DataType

getLabels

public List<String> getLabels()

Get the labels of the range dimension.

The labels serve as names for each index of the data at the respective dimension.

Returns:

The labels of the dimension as a list of strings.

setLabels

public void setLabels(List<String> labels)

Set the labels for the dimension.

Parameters:

labels - A list containing all new labels. If null removes the labels from the dimension.

compareTo

public int compareTo(T dimension)

Specified by:

compareTo in interface Comparable<T extends SetDimension>