com.luciad.fusion.engine

Tiling EngineInterface ILfnEngineSession

All Superinterfaces:

AutoCloseable, Closeable

public interface ILfnEngineSession
extends Closeable

The session groups the information needed to drive the fusion engine.

The session provides a tile set with the source data, and the ID of the coverage to be populated by the fusion engine.

Note: before the V2013.1 release, you needed an instance of this interface in order to create an ALfnEngine instance. As of V2013.1, the LuciadFusion API user should not need to create instances of this interface anymore. You can create an engine for a tile store and coverage ID (see TLfnEngineFactory#createEngine). The returned engine still contains an ILfnEngineSession.
See the migration details for more information.

Since:

10.0

See Also:

TLfnEngineFactory.createEngine(com.luciad.fusion.tilestore.ALfnTileStore, com.luciad.fusion.engine.ILfnEngineSession)

Method Summary

Modifier and Type	Method and Description
void	close() Closes the session.
long	getCheckpointInterval() Gets the checkpoint interval in milliseconds.
List<? extends ALfnAssetMetadata>	getSourceAssetMetadatas() Gets the metadata of the source assets for this session.
String	getSourceCoverageName() Gets the name of the coverage in the source tile set.
TLcdEarthTileFormat	getSourceFormat() Gets the tile format of the source data.
ILcdEarthTileSet	getSourceTileSet() Gets the tile set that produces tiles for the source data.
ALfnCoverageMetadata	getTargetCoverageMetadata() Gets the target coverage metadata for this session.
ILcdEarthTileCombiner	getTileCombiner() Gets the tile combiner for this coverage.
ILcdEarthTileDataCodec	getTileDataCodec() Gets the codec for the tile data.
ALfnTileStore	getTileStore() Returns the Tile Store that is associated with this session.

Method Detail

getSourceAssetMetadatas

List<? extends ALfnAssetMetadata> getSourceAssetMetadatas()

Gets the metadata of the source assets for this session.

Returns:

the metadata of the source assets for this session

getTargetCoverageMetadata

ALfnCoverageMetadata getTargetCoverageMetadata()

Gets the target coverage metadata for this session.

Returns:

the target coverage metadata for this session, must never be null

getSourceTileSet

ILcdEarthTileSet getSourceTileSet()
                           throws IOException

Gets the tile set that produces tiles for the source data.

Returns:

the source tile set

Throws:

IOException - when the source data cannot be accessed

getSourceCoverageName

String getSourceCoverageName()

Gets the name of the coverage in the source tile set.

Returns:

the source coverage name

getSourceFormat

TLcdEarthTileFormat getSourceFormat()

Gets the tile format of the source data.

Returns:

the tile format

getTileDataCodec

ILcdEarthTileDataCodec getTileDataCodec()

Gets the codec for the tile data.

The codec must be able to encode tiles with getSourceFormat() as the tile format.

Returns:

the data codec

getTileCombiner

ILcdEarthTileCombiner getTileCombiner()

Gets the tile combiner for this coverage.

The combiner must be able to combine tiles with getSourceFormat() as the tile format.

A return value of null from the ILcdEarthTileCombiner.combineTiles(com.luciad.earth.tileset.ALcdEarthTile[][]) method indicates that the tile should not be combined but produced from the source tile set instead.

Returns:

the tile combiner for this coverage

getCheckpointInterval

long getCheckpointInterval()

Gets the checkpoint interval in milliseconds.

Special value -1 indicates that no checkpoints should be saved, not even when the engine session is cancelled.

Returns:

an interval in milliseconds

close

void close()
    throws IOException

Closes the session. This should be called when the session is no longer needed, e.g. the fusion has finished. The session will release its internal resources.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Throws:

IOException - when resources can not be closed

getTileStore

ALfnTileStore getTileStore()

Returns the Tile Store that is associated with this session.

Returns:

The Tile Store associated with this session, never null

Since:

2013.0