Spacecraft.OrbitWizardCircularSetup(Variable, Variable) Method

Top 

Description

Initializes the state of a spacecraft with a circular orbit around its central body. The user specifies the desired orbit Altitude or Radius. The Spacecraft's previous Inclination and RAAN are maintained.

 

Timing Precision Mode

This page describes functionality in nanosecond timing precision mode.

Click here to see the documentation for this object in millisecond timing precision mode.

 

Method Signature

Spacecraft.OrbitWizardCircularSetup(

Variable setupOption,


Variable altitudeOrRadius)

 

 

Arguments

setupOption


Description:

Specify whether to define Altitude or Radius

Valid Values:

Value

Label

1

Specify Altitude

2

Specify Radius

 

 

 

altitudeOrRadius


Description:

Altitude or Radius of the spacecraft orbit referenced from the Earth.

Valid Range:

altitudeOrRadius ≥ 0

 

 

 

Return Value

Type:

number

 

 

Returns a 1 if the circular orbit was initialized successfully. Returns a 0 if orbit initialization failed.

 

Syntax

myVariable1 = mySpacecraft1.OrbitWizardCircularSetup(myVariable2, myVariable3);

 

 

See also

Spacecraft Object

Spacecraft Propagation Guide

Coverage and Contact Analysis Guide