CzmlDocument Class |
Generates CZML files.
Inheritance HierarchyNamespace: AGI.Foundation.Cesium
Assembly: AGI.Foundation.Cesium (in AGI.Foundation.Cesium.dll) Version: 24.2.419.0 (24.2.419.0)
SyntaxThe CzmlDocument type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | CzmlDocument | Initializes a new instance. |
Properties| Name | Description | |
|---|---|---|
 | CesiumSources |
Gets the collection of CesiumSource instances used to generate CZML.
|
| Clock |
Gets or sets the initial clock settings to be used when loading the document.
|
| Description |
Gets or sets the document description.
|
| EnableAutomaticReferencing |
Gets or sets a value indicating whether to enable automatic CZML reference creation for objects with the same definition.
By default, this is set to .
|
| EvaluatorGroup |
Gets or sets the EvaluatorGroup to use when evaluating.
By default, a new group is created for each document.
|
| MaximumDataPointsPerPacket |
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.
|
| Name |
Gets or sets the name of the document.
|
| ObjectsToWrite |
Gets the collection of instances to be written to CZML.
|
| PrettyFormatting |
Gets or 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 .
|
| RequestedInterval |
Gets or sets the interval for which to write data.
This value must be set before writing the document.
|
| Step |
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.
|
| TerminateOnSamplingError |
Gets or 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 ,
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 .
|
Methods| Name | Description | |
|---|---|---|
| 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 GenerateNextPacket(TextWriter). |
| CreateStreamingDocument(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.
|
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
 | Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
| WriteDocument(CesiumOutputStream) |
Writes the document to the provided output stream.
|
| WriteDocument(TextWriter) |
Writes the document to the provided writer.
|
Events| Name | Description | |
|---|---|---|
 | SamplingError |
An event that is raised when a non-fatal sampling error occurs during CZML generation.
This event is only raised when TerminateOnSamplingError is .
|
See Also