agi.foundation.cesium

(agi.foundation.cesium-2024r3.jar)

Interface ICzmlDocumentPacketizer

All Known Implementing Classes:

CzmlDocumentPacketizer, CzmlUpdateDocumentPacketizer

public interface ICzmlDocumentPacketizer

Generates a CZML document one packet at a time to allow for incremental processing by client applications.

Method Summary

Modifier and Type	Method and Description
CesiumGenerationStatus	generateNextPacket() Writes a single CZML packet to the writer that was provided to this packetizer when it was created.
CesiumGenerationStatus	generateNextPacket(Writer writer) Writes a single CZML packet to the provided writer.

Method Detail

generateNextPacket

@Nonnull
CesiumGenerationStatus generateNextPacket()

Writes a single CZML packet to the writer that was provided to this packetizer when it was created.

Returns:

CesiumGenerationStatus.DONE if all packets have been generated; otherwise CesiumGenerationStatus.MORE_TO_GENERATE.

Throws:

IllegalStateException - Thrown when this object was not created with a writer.

DataUnavailableException - Thrown when all CZML has been generated.

generateNextPacket

@Nonnull
CesiumGenerationStatus generateNextPacket(@Nonnull
                                                    Writer writer)

Writes a single CZML packet to the provided writer.

Parameters:

writer - The writer to write to.

Returns:

CesiumGenerationStatus.DONE if all packets have been generated; otherwise CesiumGenerationStatus.MORE_TO_GENERATE.

Throws:

ArgumentNullException - Thrown when writer is null.

DataUnavailableException - Thrown when all CZML has been generated.