ChunkConsumer (CoastWatch Utilities v4.0.0)

All Known Implementing Classes:: GridChunkConsumer

public interface ChunkConsumer

The ChunkConsumer interface is implemented by all classes that consume data chunks.

Since:: 3.4.0
Author:: Peter Hollemans

Method Summary

Modifier and Type

Method

Description

ChunkingScheme

getNativeScheme()

Gets the native chunking scheme for chunks accepted by this producer.

DataChunk

getPrototypeChunk()

Gets a prototype chunk for this consumer.

void

putChunk(ChunkPosition pos, DataChunk chunk)

Consumes a data chunk.

Method Details
- putChunk
  
  void putChunk(ChunkPosition pos, DataChunk chunk)
  
  Consumes a data chunk.
  
  Parameters:
  
  pos - the position of the data chunk to consume.
  
  chunk - the data chunk to consume.
- getNativeScheme
  
  ChunkingScheme getNativeScheme()
  
  Gets the native chunking scheme for chunks accepted by this producer. Calls to putChunk(noaa.coastwatch.util.chunk.ChunkPosition, noaa.coastwatch.util.chunk.DataChunk) are optimized to use chunk positions obtained from the native scheme.
  
  Returns:
  
  the native chunking scheme used by this consumer, or null if no native chunking scheme is used.
  
  Since:
  
  3.5.0
- getPrototypeChunk
  
  DataChunk getPrototypeChunk()
  
  Gets a prototype chunk for this consumer. Chunks passed to the putChunk(noaa.coastwatch.util.chunk.ChunkPosition, noaa.coastwatch.util.chunk.DataChunk) method must conform to the prototype.
  
  Returns:
  
  a prototype chunk for chunks accepted by this consumer.
  
  Since:
  
  3.5.0