VehicleEphemerisCCSDSv3ExportTool#

class ansys.stk.core.stkobjects.VehicleEphemerisCCSDSv3ExportTool#

The Ephemeris/Attitude Export Tool for CCSDSv3 Ephemeris type.

Overview#

export

Export the ephemeris file.

central_body_name

Get or set the central body of the satellite.

classification

A string that specifies the classification/caveats of the data file.

date_format

Get or set the desired date format.

ephemeris_format

Get or set the desired format to be used for representing the position and velocity information as either scientific notation or floating point notation. Scientific notation is recommended when possible.

file_format

Get or set the file format that will be generated by the export tool.

has_covariance_data

Return true if the object has covariance data.

include_acceleration

Include acceleration data in the exported file.

include_covariance

Include covariance data in the exported file. If covariance data is not available, this property becomes read-only.

message_id

A string defining the message ID which should uniquely identify the message.

object_id

A string defining the Object ID - to be specified as the international spacecraft designator, also known as an NSSDC identifier.

object_name

A name for the Object. By recommendation of the CCSDS standard, the name from the SPACEWARN Bulletin should be used.

originator

A string that specifies an identifier of the organization producing the data file.

reference_frame

Get or set the reference frame of the ephemeris.

reference_frames_supported

Return an array of valid choices.

step_size

If the Use Ephemeris Steps option is not selected, enter a Step Size to be used for the vehicle.

time_period

Set the time period. Options are Use Entire Ephemeris - STK creates a data file using the Start and Stop Time specified in the vehicle’s Orbit tab or Specify Time Period - STK creates a data file using the Start and Stop Time specified here.

time_precision

If selected, STK uses the Step Size specified in the vehicle’s Basic properties. If not selected, specify a Step Size. Dimensionless.

time_system

Get or set the time system of the ephemeris.

use_satellite_center_and_frame

Use the satellite center and frame. Setting the property to β€˜True’ will cause CentralBody and ReferenceFrame properties become read-only.

Import detail#

from ansys.stk.core.stkobjects import VehicleEphemerisCCSDSv3ExportTool

Property detail#

property VehicleEphemerisCCSDSv3ExportTool.central_body_name: str#

Get or set the central body of the satellite.

property VehicleEphemerisCCSDSv3ExportTool.classification: str#

A string that specifies the classification/caveats of the data file.

property VehicleEphemerisCCSDSv3ExportTool.date_format: CCSDSDateFormat#

Get or set the desired date format.

property VehicleEphemerisCCSDSv3ExportTool.ephemeris_format: CCSDSEphemerisFormatType#

Get or set the desired format to be used for representing the position and velocity information as either scientific notation or floating point notation. Scientific notation is recommended when possible.

property VehicleEphemerisCCSDSv3ExportTool.file_format: EphemExportToolFileFormat#

Get or set the file format that will be generated by the export tool.

property VehicleEphemerisCCSDSv3ExportTool.has_covariance_data: bool#

Return true if the object has covariance data.

property VehicleEphemerisCCSDSv3ExportTool.include_acceleration: bool#

Include acceleration data in the exported file.

property VehicleEphemerisCCSDSv3ExportTool.include_covariance: bool#

Include covariance data in the exported file. If covariance data is not available, this property becomes read-only.

property VehicleEphemerisCCSDSv3ExportTool.message_id: str#

A string defining the message ID which should uniquely identify the message.

property VehicleEphemerisCCSDSv3ExportTool.object_id: str#

A string defining the Object ID - to be specified as the international spacecraft designator, also known as an NSSDC identifier.

property VehicleEphemerisCCSDSv3ExportTool.object_name: str#

A name for the Object. By recommendation of the CCSDS standard, the name from the SPACEWARN Bulletin should be used.

property VehicleEphemerisCCSDSv3ExportTool.originator: str#

A string that specifies an identifier of the organization producing the data file.

property VehicleEphemerisCCSDSv3ExportTool.reference_frame: CCSDSReferenceFrame#

Get or set the reference frame of the ephemeris.

property VehicleEphemerisCCSDSv3ExportTool.reference_frames_supported: list#

Return an array of valid choices.

property VehicleEphemerisCCSDSv3ExportTool.step_size: ExportToolStepSize#

If the Use Ephemeris Steps option is not selected, enter a Step Size to be used for the vehicle.

property VehicleEphemerisCCSDSv3ExportTool.time_period: ExportToolTimePeriod#

Set the time period. Options are Use Entire Ephemeris - STK creates a data file using the Start and Stop Time specified in the vehicle’s Orbit tab or Specify Time Period - STK creates a data file using the Start and Stop Time specified here.

property VehicleEphemerisCCSDSv3ExportTool.time_precision: int#

If selected, STK uses the Step Size specified in the vehicle’s Basic properties. If not selected, specify a Step Size. Dimensionless.

property VehicleEphemerisCCSDSv3ExportTool.time_system: CCSDSTimeSystem#

Get or set the time system of the ephemeris.

property VehicleEphemerisCCSDSv3ExportTool.use_satellite_center_and_frame: bool#

Use the satellite center and frame. Setting the property to β€˜True’ will cause CentralBody and ReferenceFrame properties become read-only.

Method detail#

VehicleEphemerisCCSDSv3ExportTool.export(self, file_name: str) None#

Export the ephemeris file.

Parameters:

file_name : str

Returns:

None