CzmlDocument

java.lang.Object
- agi.foundation.cesium.CzmlDocument

All Implemented Interfaces:: ICzmlDocument

public class CzmlDocument
extends Object
implements ICzmlDocument

Generates CZML files.

Constructor Summary

Constructors
Constructor and Description

CzmlDocument()
Initializes a new instance.

Constructors
Constructor and Description
`CzmlDocument()` Initializes a new instance.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addSamplingError(EventHandler<SamplingErrorEventArgs> value)` An event that is raised when a non-fatal sampling error occurs during CZML generation.
`CzmlDocumentPacketizer`	`createStreamingDocument()` Creates a `CzmlDocumentPacketizer` that can be used to stream CZML incrementally to a client.
`CzmlDocumentPacketizer`	`createStreamingDocument(Writer writer)` Creates a `CzmlDocumentPacketizer` that can be used to stream CZML incrementally to a client.
`ArrayList<CesiumSource>`	`getCesiumSources()` Gets the collection of `CesiumSource` instances used to generate CZML.
`Clock`	`getClock()` Gets the initial clock settings to be used when loading the document.
`String`	`getDescription()` Gets the document description.
`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`	`getMaximumDataPointsPerPacket()` Gets the maximum number of data points to store in each CZML packet.
`String`	`getName()` Gets the name of the document.
`ServiceProviderCollection`	`getObjectsToWrite()` Gets the collection of instances to be written to CZML.
`boolean`	`getPrettyFormatting()` Gets a value indicating whether the resulting CZML file is formatted using whitespace for easy readability, which will produce a significantly larger file.
`TimeInterval`	`getRequestedInterval()` Gets the interval for which to write data.
`Duration`	`getStep()` Gets the step size to be used for sampling properties.
`boolean`	`getTerminateOnSamplingError()` Gets a value indicating whether CZML generation halts when a sampling error occurs; for example if a TLE fails to propagate at the desired time.
`void`	`removeSamplingError(EventHandler<SamplingErrorEventArgs> value)` An event that is raised when a non-fatal sampling error occurs during CZML generation.
`void`	`setClock(Clock value)` Sets the initial clock settings to be used when loading the document.
`void`	`setDescription(String value)` Sets the document description.
`void`	`setEnableAutomaticReferencing(boolean value)` Sets a value indicating whether to enable automatic CZML reference creation for objects with the same definition.
`void`	`setEvaluatorGroup(EvaluatorGroup value)` Sets the `EvaluatorGroup` to use when evaluating.
`void`	`setMaximumDataPointsPerPacket(Integer value)` Sets the maximum number of data points to store in each CZML packet.
`void`	`setName(String value)` Sets the name of the document.
`void`	`setPrettyFormatting(boolean value)` Sets a value indicating whether the resulting CZML file is formatted using whitespace for easy readability, which will produce a significantly larger file.
`void`	`setRequestedInterval(TimeInterval value)` Sets the interval for which to write data.
`void`	`setStep(Duration value)` Sets the step size to be used for sampling properties.
`void`	`setTerminateOnSamplingError(boolean value)` Sets a value indicating whether CZML generation halts when a sampling error occurs; for example if a TLE fails to propagate at the desired time.
`void`	`writeDocument(CesiumOutputStream outputStream)` Writes the document to the provided output stream.
`void`	`writeDocument(Writer writer)` Writes the document to the provided writer.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - CzmlDocument
```
public CzmlDocument()
```
    Initializes a new instance.
- Method Detail
  - getName
```
public final String getName()
```
    Gets the name of the document.
  - setName
```
public final void setName(String value)
```
    Sets the name of the document.
  - getDescription
```
public final String getDescription()
```
    Gets the document description.
  - setDescription
```
public final void setDescription(String value)
```
    Sets the document description.
  - getClock
```
public final Clock getClock()
```
    Gets the initial clock settings to be used when loading the document.
  - setClock
```
public final void setClock(Clock value)
```
    Sets the initial clock settings to be used when loading the document.
  - getEnableAutomaticReferencing
```
public final boolean getEnableAutomaticReferencing()
```
    Gets a value indicating whether to enable automatic CZML reference creation for objects with the same definition. By default, this is set to true.
  - setEnableAutomaticReferencing
```
public final void setEnableAutomaticReferencing(boolean value)
```
    Sets a value indicating whether to enable automatic CZML reference creation for objects with the same definition. By default, this is set to true.
  - getStep
```
@Nonnull
public final Duration getStep()
```
    Gets the step size to be used for sampling properties. Note that individual objects may override this value using ICesiumFixedStepService. By default, this is set to 60 seconds.
  - setStep
```
public final void setStep(@Nonnull
                          Duration value)
```
    Sets the step size to be used for sampling properties. Note that individual objects may override this value using ICesiumFixedStepService. By default, this is set to 60 seconds.
  - getRequestedInterval
```
public final TimeInterval getRequestedInterval()
```
    Gets the interval for which to write data. This value must be set before writing the document.
  - setRequestedInterval
```
public final void setRequestedInterval(TimeInterval value)
```
    Sets the interval for which to write data. This value must be set before writing the document.
  - getPrettyFormatting
```
public final boolean getPrettyFormatting()
```
    Gets a value indicating whether the resulting CZML file is formatted using whitespace for easy readability, which will produce a significantly larger file. By default, this is set to false.
  - setPrettyFormatting
```
public final void setPrettyFormatting(boolean value)
```
    Sets a value indicating whether the resulting CZML file is formatted using whitespace for easy readability, which will produce a significantly larger file. By default, this is set to false.
  - getMaximumDataPointsPerPacket
```
@Nullable
public final Integer getMaximumDataPointsPerPacket()
```
    Gets the maximum number of data points to store in each CZML packet. By default, this value is null, meaning that there is no limit on how many data points will be written in each packet.
  - setMaximumDataPointsPerPacket
```
public final void setMaximumDataPointsPerPacket(@Nullable
                                                Integer value)
```
    Sets the maximum number of data points to store in each CZML packet. By default, this value is null, meaning that there is no limit on how many data points will be written in each packet.
  - getTerminateOnSamplingError
```
public final boolean getTerminateOnSamplingError()
```
    Gets a value indicating whether CZML generation halts when a sampling error occurs; for example if a TLE fails to propagate at the desired time. When true, exceptions are thrown immediately and no further CZML will be written. When false, CZML generation will continue until finished and any exceptions are raised via the SamplingError (add / remove) event. By default, this is set to true.
  - setTerminateOnSamplingError
```
public final void setTerminateOnSamplingError(boolean value)
```
    Sets a value indicating whether CZML generation halts when a sampling error occurs; for example if a TLE fails to propagate at the desired time. When true, exceptions are thrown immediately and no further CZML will be written. When false, CZML generation will continue until finished and any exceptions are raised via the SamplingError (add / remove) event. By default, this is set to true.
  - addSamplingError
```
public final void addSamplingError(EventHandler<SamplingErrorEventArgs> value)
```
    An event that is raised when a non-fatal sampling error occurs during CZML generation. This event is only raised when TerminateOnSamplingError (get / set) is true.
  - removeSamplingError
```
public final void removeSamplingError(EventHandler<SamplingErrorEventArgs> value)
```
    An event that is raised when a non-fatal sampling error occurs during CZML generation. This event is only raised when TerminateOnSamplingError (get / set) is true.
  - getEvaluatorGroup
```
public final EvaluatorGroup getEvaluatorGroup()
```
    Gets the EvaluatorGroup to use when evaluating. By default, a new group is created for each document.
  - setEvaluatorGroup
```
public final void setEvaluatorGroup(EvaluatorGroup value)
```
    Sets the EvaluatorGroup to use when evaluating. By default, a new group is created for each document.
  - getCesiumSources
```
@Nonnull
public final ArrayList<CesiumSource> getCesiumSources()
```
    Gets the collection of CesiumSource instances used to generate CZML.
  - getObjectsToWrite
```
@Nonnull
public final ServiceProviderCollection getObjectsToWrite()
```
    Gets the collection of instances to be written to CZML.
  - createStreamingDocument
```
@Nonnull
public final CzmlDocumentPacketizer createStreamingDocument(@Nonnull
                                                                      Writer writer)
```
    Creates a CzmlDocumentPacketizer that can be used to stream CZML incrementally to a client. The returned instance is immutable and any further changes to this class will not affect the resulting CZML.
    
    Parameters:
    
    writer - The writer to use.
    
    Returns:
    
    A new CzmlDocumentPacketizer for this document.
  - createStreamingDocument
```
@Nonnull
public final CzmlDocumentPacketizer createStreamingDocument()
```
    Creates a CzmlDocumentPacketizer that can be used to stream CZML incrementally to a client. The returned instance is immutable and any further changes to this class will not affect the resulting CZML.
    
    The resulting CzmlDocumentPacketizer must be given a writer to write each packet to by calling CzmlDocumentPacketizer.generateNextPacket(Writer).
    
    Returns:
    
    A new CzmlDocumentPacketizer for this document.
  - writeDocument
```
public final void writeDocument(Writer writer)
```
    Writes the document to the provided writer.
    
    Specified by:
    
    writeDocument in interface ICzmlDocument
    
    Parameters:
    
    writer - The writer to use.
  - writeDocument
```
public final void writeDocument(CesiumOutputStream outputStream)
```
    Writes the document to the provided output stream.
    
    Specified by:
    
    writeDocument in interface ICzmlDocument
    
    Parameters:
    
    outputStream - The output stream to use.

Class CzmlDocument

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Method Detail

getName

setName

getDescription

setDescription

getClock

setClock

getEnableAutomaticReferencing

setEnableAutomaticReferencing

getStep

setStep

getRequestedInterval

setRequestedInterval

getPrettyFormatting

setPrettyFormatting

getMaximumDataPointsPerPacket

setMaximumDataPointsPerPacket

getTerminateOnSamplingError

setTerminateOnSamplingError

addSamplingError

removeSamplingError

getEvaluatorGroup

setEvaluatorGroup

getCesiumSources

getObjectsToWrite

createStreamingDocument

createStreamingDocument

writeDocument

writeDocument