org.opengis.coverage.grid
Class ValueInBytePacking

Show UML class diagram

Object
  CodeList<ValueInBytePacking>
      ValueInBytePacking

All Implemented Interfaces:

Serializable, Comparable<ValueInBytePacking>

Deprecated. In favor of migrating to ISO 19123 definition for Coverage.

@UML(identifier="GC_ValueInBytePacking",
     specification=OGC_01004)
public final class ValueInBytePacking
extends CodeList<ValueInBytePacking>

Order of values packed in a byte for sample dimensions with less than 8 bits. This include UNSIGNED_1BIT, UNSIGNED_2BITS and UNSIGNED_4BITS data types.

WARNING: THIS CLASS WILL CHANGE. Current API is derived from OGC Grid Coverages Implementation specification 1.0. We plan to replace it by new interfaces derived from ISO 19123 (Schema for coverage geometry and functions). Current interfaces should be considered as legacy and are included in this distribution only because they were part of GeoAPI 1.0 release. We will try to preserve as much compatibility as possible, but no migration plan has been determined yet.

Since:

GeoAPI 1.0

See Also:

GridPacking, ByteInValuePacking, Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class CodeList

CodeList.Filter

Field Summary

static ValueInBytePacking	HI_BIT_FIRST Deprecated. High bit first (big endian order).
static ValueInBytePacking	LO_BIT_FIRST Deprecated. Low bit firts (little endian order).

Method Summary

ValueInBytePacking[]	family() Deprecated. Returns the list of codes of the same kind than this code list element.
static ValueInBytePacking	valueOf(String code) Deprecated. Returns the value in byte packing that matches the given string, or returns a new one if none match it.
static ValueInBytePacking[]	values() Deprecated. Returns the list of ValueInBytePackings.

Methods inherited from class CodeList

compareTo, equals, identifier, name, names, ordinal, readResolve, toString, valueOf, valueOf

Methods inherited from class Object

clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

LO_BIT_FIRST

@UML(identifier="GC_LoBitFirst",
     obligation=CONDITIONAL,
     specification=OGC_01004)
public static final ValueInBytePacking LO_BIT_FIRST

Deprecated.

Low bit firts (little endian order).

HI_BIT_FIRST

@UML(identifier="GC_HiBitFirst",
     obligation=CONDITIONAL,
     specification=OGC_01004)
public static final ValueInBytePacking HI_BIT_FIRST

Deprecated.

High bit first (big endian order).

Method Detail

values

public static ValueInBytePacking[] values()

Deprecated.

Returns the list of ValueInBytePackings.

Returns:

The list of codes declared in the current JVM.

family

public ValueInBytePacking[] family()

Deprecated.

Returns the list of codes of the same kind than this code list element. Invoking this method is equivalent to invoking values(), except that this method can be invoked on an instance of the parent CodeList class.

Specified by:

family in class CodeList<ValueInBytePacking>

Returns:

The codes of the same kind than this code.

valueOf

public static ValueInBytePacking valueOf(String code)

Deprecated.

Returns the value in byte packing that matches the given string, or returns a new one if none match it. More specifically, this methods returns the first instance for which name().equals(code) returns true. If no existing instance is found, then a new one is created for the given name.

Parameters:

code - The name of the code to fetch or to create.

Returns:

A code matching the given name.