centralBodyOptions

Modify central body options used in satellite scenario

Since R2025a

collapse all in page

    Syntax

    options = centralBodyOptions(scenario)
    options = centralBodyOptions(___,Name=Value)

    Description

    options = centralBodyOptions(scenario) returns the Aero.satellitescenario.CentralBodyOptions object options stored in the CentralBodyOptions property of the satellite scenario scenario.

    options = centralBodyOptions(___,Name=Value) updates the Aero.satellitescenario.CentralBodyOptions object stored in the CentralBodyOptions property of the satellite scenario scenario using additional parameters specified by one or more name-value arguments and returns the object in options. When AutoSimulate of scenario is false, you can specify the optional name-value arguments only if SimulationStatus is set to NotStarted.

    Input Arguments

    collapse all

    Satellite scenario, specified as a scalar satelliteScenario object.

    Name-Value Arguments

    collapse all

    Specify optional pairs of arguments as Name1=Value1,...,NameN=ValueN, where Name is the argument name and Value is the corresponding value. Name-value arguments must appear after other arguments, but the order of the pairs does not matter.

    Example: UseEarthOrientationParameters = 1 uses earth orientation parameters.

    Option to use Earth orientation parameters for the transformation between the Geocentric Celestial Reference Frame (GCRF) and International Terrestrial Reference Frame (ITRF), specified as a logical scalar.

    Default Value

    The default value is the currently used value of the UseEarthOrientationParameters property of Aero.satellitescenario.CentralBodyOptions property returned by CentralBodyOptions property of the satellite scenario scenario.

    Data Types: logical

    Custom list of Earth orientation data, specified in a MAT-file. To create the file, use the aeroReadIERSData function.

    Default Value

    The default value is the currently used value of the EarthOrientationParameterFile property of Aero.satellitescenario.CentralBodyOptions property returned by CentralBodyOptions property of the satellite scenario scenario.

    Data Types: string

    Output Arguments

    collapse all

    Currently used options for the central body, returned as a scalar Aero.satellitescenario.CentralBodyOptions object.

    Version History

    Introduced in R2025a

    See Also

    Objects

    Functions

    Topics