agi.foundation.cesium.advanced

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

Class CesiumGeneratorContext

java.lang.Object

agi.foundation.cesium.advanced.CesiumGeneratorContext

public class CesiumGeneratorContext
extends Object

This class both provides contextual information regarding the CZML being written as well as allows CesiumSource instances to add CesiumGenerators to be written.

Field Summary

Fields

Modifier and Type	Field and Description
static String	Version Gets the CZML version being written.

Method Summary

Modifier and Type	Method and Description
void	addAdditionalSource(CesiumSource source, IServiceProvider serviceProvider) Adds an additional CesiumSource required for a given service provider.
void	addChildGenerator(CesiumGenerator childGenerator) Adds a Cesium generator for a property.
CesiumGeneratorContext	constrain(TimeInterval interval) Return a new instance that has RequestedInterval (get) intersected with the given interval.
CesiumGeneratorContext	getContext()
boolean	getEnableAutomaticReferencing() Gets a value indicating whether to enable automatic CZML reference creation for objects with the same definition.
EvaluatorGroup	getEvaluatorGroup() Gets the EvaluatorGroup to use when evaluating.
Integer	getMaximumDataPointsPerFragment() Gets the maximum number of data points to write at a time.
boolean	getPrettyFormatting() Gets a value indicating whether the written data should be formatted for easy human readability.
TimeInterval	getRequestedInterval() Gets the requested interval for data.
Duration	getStep() Gets the smallest step that should be taken when sampling.
void	raiseSamplingError(Object sender, RuntimeException exception) Called when an exception is encountered while sampling a property.

Methods inherited from class java.lang.Object

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

Field Detail

Version

@Nonnull
public static final String Version

Gets the CZML version being written.

See Also:

Constant Field Values

Method Detail

addChildGenerator

public final void addChildGenerator(CesiumGenerator childGenerator)

Adds a Cesium generator for a property.

Parameters:

childGenerator - The generator responsible for generating the property.

getEvaluatorGroup

@Nonnull
public final EvaluatorGroup getEvaluatorGroup()

Gets the EvaluatorGroup to use when evaluating.

getRequestedInterval

@Nonnull
public final TimeInterval getRequestedInterval()

Gets the requested interval for data. Generators may generate values outside this interval if it is equivalent in speed and compactness.

getStep

@Nonnull
public final Duration getStep()

Gets the smallest step that should be taken when sampling. Note that individual objects may override this value using ICesiumFixedStepService.

getMaximumDataPointsPerFragment

@Nullable
public final Integer getMaximumDataPointsPerFragment()

Gets the maximum number of data points to write at a time.

getPrettyFormatting

public final boolean getPrettyFormatting()

Gets a value indicating whether the written data should be formatted for easy human readability. When this property is false (the default), more compact CZML is generated.

getEnableAutomaticReferencing

public final boolean getEnableAutomaticReferencing()

Gets a value indicating whether to enable automatic CZML reference creation for objects with the same definition.

raiseSamplingError

public final void raiseSamplingError(Object sender,
                                     RuntimeException exception)

Called when an exception is encountered while sampling a property.

Parameters:

sender - The instance which generated the exception.

exception - The exception.

constrain

@Nonnull
public final CesiumGeneratorContext constrain(TimeInterval interval)

Return a new instance that has RequestedInterval (get) intersected with the given interval.

Parameters:

interval - The interval to further constrain by.

Returns:

A new instance.

addAdditionalSource

public final void addAdditionalSource(@Nonnull
                                      CesiumSource source,
                                      @Nonnull
                                      IServiceProvider serviceProvider)

Adds an additional CesiumSource required for a given service provider. This method may only be called while creating generators.

Parameters:

source - The additional source required for the item.

serviceProvider - The service provider that requires the additional source.

Throws:

IllegalStateException - This method was not called while creating generators.

getContext

public final CesiumGeneratorContext getContext()