org.g_node.nix

Class Dimension<T extends Dimension>

java.lang.Object

org.bytedeco.javacpp.Pointer

org.g_node.nix.base.ImplContainer

org.g_node.nix.Dimension<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 Dimension<T extends Dimension>
extends ImplContainer
implements Comparable<T>

Dimension

Instances of the Dimension subclasses are used to define the different dimensions of data in a DataArray.

The real dimension descriptor are defined in three subclasses: RangeDimension, SampledDimension and SetDimension .

See Also:

RangeDimension, SampledDimension, SetDimension

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
RangeDimension	asRangeDimension() Returns as RangeDimension.
SampledDimension	asSampledDimension() Returns as SampledDimension.
SetDimension	asSetDimension() Returns as SetDimension.
int	compareTo(T dimension)
int	getDimensionType() The type of the dimension.
long	getIndex() The actual dimension that is described by the dimension descriptor.
boolean	isNone() Check if entity is null

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

Dimension

public Dimension()

Constructor that creates an uninitialized Dimension.

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. Constant specified in DimensionType

See Also:

DimensionType, RangeDimension, SampledDimension, *

asSetDimension

@ByVal
public SetDimension asSetDimension()

Returns as SetDimension.

Returns:

SetDimension object

asSampledDimension

@ByVal
public SampledDimension asSampledDimension()

Returns as SampledDimension.

Returns:

SampledDimension object

asRangeDimension

@ByVal
public RangeDimension asRangeDimension()

Returns as RangeDimension.

Returns:

RangeDimension object

compareTo

public int compareTo(T dimension)

Specified by:

compareTo in interface Comparable<T extends Dimension>