CesiumLanguageWriter.PacketCesiumWriter.WriteAvailability C# (CSharp) Method

PacketCesiumWriter Class Documentation Usage Examples Of CesiumLanguageWriter.PacketCesiumWriter::WriteAvailability Show file Open project: AnalyticalGraphicsInc/czml-writer

WriteAvailability() public method

Writes the value expressed as a availability, which is the set of time intervals over which data for an object is available. The property can be a single string specifying a single interval, or an array of strings representing intervals. A later Cesium packet can update this availability if it changes or is found to be incorrect. For example, an SGP4 propagator may initially report availability for all time, but then later the propagator throws an exception and the availability can be adjusted to end at that time. If this optional property is not present, the object is assumed to be available for all time. Availability is scoped to a particular CZML stream, so two different streams can list different availability for a single object. Within a single stream, the last availability stated for an object is the one in effect and any availabilities in previous packets are ignored. If an object is not available at a time, the client will not draw that object. If not specified, the default value is 0000-00-00T00:00:00Z/9999-12-31T24:00:00Z.

public WriteAvailability ( IList value ) : void
value	IList	The intervals.
return	void

        public void WriteAvailability(IList<TimeInterval> value)
        {
            const string PropertyName = AvailabilityPropertyName;
            Output.WritePropertyName(PropertyName);
            CesiumWritingHelper.WriteTimeIntervalCollection(Output, value);
        }

Same methods

PacketCesiumWriter::WriteAvailability ( JulianDate start, JulianDate stop ) : void
PacketCesiumWriter::WriteAvailability ( TimeInterval value ) : void

Usage Example

Example #1

Show file

File: Utility.cs Project: jontours/czml-writer

 /// <summary>
 /// Writes the availability intervals from either the TimeSpan or TimeStamp elements from the kml document.
 /// </summary>
 /// <param name="timePrimitiveParentElement">The parent element that contains the kml TimePrimitive element.</param>
 /// <param name="packetWriter">The packet writer.</param>
 /// <param name="docNamespace">The namespace of the kml document.</param>
 public static void WriteAvailability(XElement timePrimitiveParentElement, PacketCesiumWriter packetWriter, XNamespace docNamespace)
 {
     TimeInterval interval = GetInterval(timePrimitiveParentElement, docNamespace);
     if (interval != null)
     {
         packetWriter.WriteAvailability(interval);
     }
 }

PacketCesiumWriter

OnClose

OnOpen

OpenBillboardProperty

OpenBoxProperty

OpenClockProperty

OpenConicSensorProperty

OpenCorridorProperty

OpenCustomPatternSensorProperty

OpenCylinderProperty

OpenDescriptionProperty

OpenEllipseProperty