Click or drag to resize

CzmlDocument Class

Generates CZML files.
Inheritance Hierarchy
SystemObject
  AGI.Foundation.CesiumCzmlDocument

Namespace:  AGI.Foundation.Cesium
Assembly:  AGI.Foundation.Cesium (in AGI.Foundation.Cesium.dll) Version: 19.1.398.0 (19.1.398.0)
Syntax
public class CzmlDocument

The CzmlDocument type exposes the following members.

Constructors
  NameDescription
Public methodCzmlDocument
Creates a new instance.
Top
Properties
  NameDescription
Public propertyCesiumSources
Gets the collection of CesiumSource instances used to generate CZML.
Public propertyClock
Gets or sets the initial clock settings to be used when loading the document.
Public propertyDescription
Gets or sets the document description.
Public propertyEnableAutomaticReferencing
Gets or sets whether to enable automatic CZML reference creation for objects with the same definition. By default, this is set to .
Public propertyEvaluatorGroup
Gets or sets the EvaluatorGroup to use when evaluating. By default, a new group is created for each document.
Public propertyMaximumDataPointsPerPacket
Gets or sets the maximum number of data points to store in each CZML packet. By default, this value is , meaning that there is no limit on how many data points will be written in each packet.
Public propertyName
Gets or sets the name of the document.
Public propertyObjectsToWrite
Gets the collection of instances to be written to CZML.
Public propertyPrettyFormatting
Gets or sets 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 .
Public propertyRequestedInterval
Gets or sets the interval for which to write data. This value must be set before writing the document.
Public propertyStep
Gets or 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.
Public propertyTerminateOnSamplingError
Gets or sets whether or not CZML generation halts when a sampling error occurs; for example if a TLE fails to propagate at the desired time. When , exceptions are thrown immediately and no further CZML will be written. When , CZML generation will continue until finished and any exceptions are raised via the SamplingError event. By default, this is set to .
Top
Methods
  NameDescription
Public methodCreateStreamingDocument

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 GenerateNextPacket(TextWriter).

Public methodCreateStreamingDocument(TextWriter)
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.
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Public methodWriteDocument
Writes the document to the provided writer.
Top
Events
  NameDescription
Public eventSamplingError
An event that is raised when a non-fatal sampling error occurs during CZML generation. This event is only raised when TerminateOnSamplingError is .
Top
See Also