Description
Returns a formatted string representing an epoch in time. The format string formatSpecificationcan include the date and time formats shown in the "Parsing Dates and Times" reference in the Help File, including month, day, year, hours, minutes, and seconds. The calling Spacecraft Epoch is assumed to be in TAI, the String is returned in UTC.
This method has been Deprecated. Please use Spacecraft.Epoch.EpochFormat instead.
Timing Precision Mode
This page describes functionality in millisecond timing precision mode.
Method Signature
Spacecraft.EpochFormat(
|
String formatSpecification)
|
Arguments
formatSpecification
|
|
Description:
|
Specifies the format of the output String. The format specification can include the date and time formats shown in the "Parsing Dates and Times" reference in the Help File, including month, day, year, hours, minutes, and seconds. The user can also include custom characters by surrounding them with **asterisks**. If a format string is not specified, the format "Mmm DD YYYY hh:mm:ss.fs" will be used.
|
Return Value
Returns a formatted string representing an epoch in time.
Syntax
myString1 = mySpacecraft1.EpochFormat(myString2);
|
For a Spacecraft at epoch 09 January 2007, 15:06, UTC:
Spacecraft1.Epoch = "09 January 2007, 15:06".EpochScan("DD Mmmm YYYY, hh:mm");
Report Spacecraft1.EpochFormat("**Date is: **D Mmmm YY **at time** h12:mm am/pm");
|
Output Report:
Date is: 9 January 07 at time 3:06 pm
|
Note: EpochFormat allows you to embed text within the date and time format using **asterisks**
|
See also
Spacecraft Object
Spacecraft.EpochFormat
Parsing Dates and Times
Spacecraft Propagation Guide
Coverage and Contact Analysis Guide
|