CentralBodyComponent#

class ansys.stk.core.stkobjects.astrogator.CentralBodyComponent#

Bases: IComponentInfo, ICloneable

Central Body.

Overview#

Methods

`set_default_gravity_model_by_name`	Select a gravity model.
`add_gravity_model`	Add a central body gravity model type.
`remove_gravity_model_by_name`	Remove a central body gravity model type.
`set_default_shape_by_name`	Select a central body shape.
`add_shape`	Add a central body shape type from the available types.
`remove_shape_by_name`	Remove a central body shape type.
`set_default_attitude_by_name`	Select a central body attitude.
`add_attitude`	Add a central body attitude type from the available types.
`remove_attitude_by_name`	Remove a central body attitude type.
`set_default_ephemeris_by_name`	Select an ephemeris type.
`add_ephemeris`	Add an ephemeris type from the available types.
`remove_ephemeris_by_name`	Remove an ephemeris type.
`cut_gravity_model_by_name`	Copy a gravity model to the clipboard and removes it from the central body.
`copy_gravity_model_by_name`	Copy a gravity model to the clipboard.
`paste_gravity_model`	Add the gravity model in the clipboard to the central body.
`add_copy_of_gravity_model`	Add the gravity model to the central body.
`cut_shape_by_name`	Copy a central body shape to the clipboard and removes it from the central body.
`copy_shape_by_name`	Copy a central body shape to the clipboard.
`paste_shape`	Add the central body shape in the clipboard to the central body.
`add_copy_of_shape`	Add the central body shape to the central body.
`cut_attitude_by_name`	Copy a central body attitude definition to the clipboard and removes it from the central body.
`copy_attitude_by_name`	Copy a central body attitude definition to the clipboard.
`paste_attitude`	Add the central body attitude definition in the clipboard to the central body.
`add_copy_of_attitude`	Add the central body attitude definition to the central body.
`cut_ephemeris_by_name`	Copy a central body ephemeris definition to the clipboard and removes it from the central body.
`copy_ephemeris_by_name`	Copy a central body ephemeris definition to the clipboard.
`paste_ephemeris`	Add the central body ephemeris definition in the clipboard to the central body.
`add_copy_of_ephemeris`	Add the central body ephemeris definition to the central body.

Properties

`gravitational_parameter`	Get or set the gravitational parameter to be used. Uses Gravity Parameter Dimension.
`parent_name`	Get or set the parent of this central body.
`children`	Get the children of this central body.
`default_gravity_model_name`	Get the gravity model.
`default_gravity_model_data`	Get the gravity model parameters.
`default_shape_name`	Get the shape of the central body.
`default_shape_data`	Get the parameters of the central body shape.
`default_attitude_name`	Get the attitude of the central body.
`default_attitude_data`	Get the parameters of the central body attitude.
`default_ephemeris_name`	Get the ephemeris of the central body.
`default_ephemeris_data`	Get the parameters of the central body ephemeris.

Import detail#

from ansys.stk.core.stkobjects.astrogator import CentralBodyComponent

Property detail#

property CentralBodyComponent.gravitational_parameter: float#: Get or set the gravitational parameter to be used. Uses Gravity Parameter Dimension.

property CentralBodyComponent.parent_name: str#: Get or set the parent of this central body.

property CentralBodyComponent.children: CentralBodyComponentCollection#: Get the children of this central body.

property CentralBodyComponent.default_gravity_model_name: str#: Get the gravity model.

property CentralBodyComponent.default_gravity_model_data: CentralBodyComponentGravityModel#: Get the gravity model parameters.

property CentralBodyComponent.default_shape_name: str#: Get the shape of the central body.

property CentralBodyComponent.default_shape_data: ICentralBodyComponentShape#: Get the parameters of the central body shape.

property CentralBodyComponent.default_attitude_name: str#: Get the attitude of the central body.

property CentralBodyComponent.default_attitude_data: ICentralBodyComponentAttitude#: Get the parameters of the central body attitude.

property CentralBodyComponent.default_ephemeris_name: str#: Get the ephemeris of the central body.

property CentralBodyComponent.default_ephemeris_data: ICentralBodyComponentEphemeris#: Get the parameters of the central body ephemeris.

Method detail#

CentralBodyComponent.set_default_gravity_model_by_name(self, gravity_model_name: str) → None#

Select a gravity model.

Parameters:: gravity_model_name : str
Returns:: None

CentralBodyComponent.add_gravity_model(self, gravity_model: CentralBodyGravityModel, unique_name: str) → CentralBodyComponentGravityModel#

Add a central body gravity model type.

Parameters:

gravity_model : CentralBodyGravityModel

unique_name : str

Returns:

CentralBodyComponentGravityModel

CentralBodyComponent.remove_gravity_model_by_name(self, gravity_model_name: str) → None#

Remove a central body gravity model type.

Parameters:: gravity_model_name : str
Returns:: None

CentralBodyComponent.set_default_shape_by_name(self, shape_name: str) → None#

Select a central body shape.

Parameters:: shape_name : str
Returns:: None

CentralBodyComponent.add_shape(self, shape: CentralBodyShape, unique_name: str) → ICentralBodyComponentShape#

Add a central body shape type from the available types.

Parameters:

shape : CentralBodyShape

unique_name : str

Returns:

ICentralBodyComponentShape

CentralBodyComponent.remove_shape_by_name(self, shape_name: str) → None#

Remove a central body shape type.

Parameters:: shape_name : str
Returns:: None

CentralBodyComponent.set_default_attitude_by_name(self, attitude_name: str) → None#

Select a central body attitude.

Parameters:: attitude_name : str
Returns:: None

CentralBodyComponent.add_attitude(self, attitude: CentralBodyAttitude, unique_name: str) → ICentralBodyComponentAttitude#

Add a central body attitude type from the available types.

Parameters:

attitude : CentralBodyAttitude

unique_name : str

Returns:

ICentralBodyComponentAttitude

CentralBodyComponent.remove_attitude_by_name(self, attitude_name: str) → None#

Remove a central body attitude type.

Parameters:: attitude_name : str
Returns:: None

CentralBodyComponent.set_default_ephemeris_by_name(self, ephemeris_name: str) → None#

Select an ephemeris type.

Parameters:: ephemeris_name : str
Returns:: None

CentralBodyComponent.add_ephemeris(self, ephemeris: CentralBodyEphemeris, unique_name: str) → ICentralBodyComponentEphemeris#

Add an ephemeris type from the available types.

Parameters:

ephemeris : CentralBodyEphemeris

unique_name : str

Returns:

ICentralBodyComponentEphemeris

CentralBodyComponent.remove_ephemeris_by_name(self, ephemeris_name: str) → None#

Remove an ephemeris type.

Parameters:: ephemeris_name : str
Returns:: None

CentralBodyComponent.cut_gravity_model_by_name(self, gravity_model_name: str) → None#

Copy a gravity model to the clipboard and removes it from the central body.

Parameters:: gravity_model_name : str
Returns:: None

CentralBodyComponent.copy_gravity_model_by_name(self, gravity_model_name: str) → None#

Copy a gravity model to the clipboard.

Parameters:: gravity_model_name : str
Returns:: None

CentralBodyComponent.paste_gravity_model(self) → CentralBodyComponentGravityModel#

Add the gravity model in the clipboard to the central body.

Returns:: CentralBodyComponentGravityModel

CentralBodyComponent.add_copy_of_gravity_model(self, gravity_model: CentralBodyComponentGravityModel) → CentralBodyComponentGravityModel#

Add the gravity model to the central body.

Parameters:: gravity_model : CentralBodyComponentGravityModel
Returns:: CentralBodyComponentGravityModel

CentralBodyComponent.cut_shape_by_name(self, shape_name: str) → None#

Copy a central body shape to the clipboard and removes it from the central body.

Parameters:: shape_name : str
Returns:: None

CentralBodyComponent.copy_shape_by_name(self, shape_name: str) → None#

Copy a central body shape to the clipboard.

Parameters:: shape_name : str
Returns:: None

CentralBodyComponent.paste_shape(self) → ICentralBodyComponentShape#

Add the central body shape in the clipboard to the central body.

Returns:: ICentralBodyComponentShape

CentralBodyComponent.add_copy_of_shape(self, shape: ICentralBodyComponentShape) → ICentralBodyComponentShape#

Add the central body shape to the central body.

Parameters:: shape : ICentralBodyComponentShape
Returns:: ICentralBodyComponentShape

CentralBodyComponent.cut_attitude_by_name(self, attitude_name: str) → None#

Copy a central body attitude definition to the clipboard and removes it from the central body.

Parameters:: attitude_name : str
Returns:: None

CentralBodyComponent.copy_attitude_by_name(self, attitude_name: str) → None#

Copy a central body attitude definition to the clipboard.

Parameters:: attitude_name : str
Returns:: None

CentralBodyComponent.paste_attitude(self) → ICentralBodyComponentAttitude#

Add the central body attitude definition in the clipboard to the central body.

Returns:: ICentralBodyComponentAttitude

CentralBodyComponent.add_copy_of_attitude(self, attitude: ICentralBodyComponentAttitude) → ICentralBodyComponentAttitude#

Add the central body attitude definition to the central body.

Parameters:: attitude : ICentralBodyComponentAttitude
Returns:: ICentralBodyComponentAttitude

CentralBodyComponent.cut_ephemeris_by_name(self, ephemeris_name: str) → None#

Copy a central body ephemeris definition to the clipboard and removes it from the central body.

Parameters:: ephemeris_name : str
Returns:: None

CentralBodyComponent.copy_ephemeris_by_name(self, ephemeris_name: str) → None#

Copy a central body ephemeris definition to the clipboard.

Parameters:: ephemeris_name : str
Returns:: None

CentralBodyComponent.paste_ephemeris(self) → ICentralBodyComponentEphemeris#

Add the central body ephemeris definition in the clipboard to the central body.

Returns:: ICentralBodyComponentEphemeris

CentralBodyComponent.add_copy_of_ephemeris(self, ephemeris: ICentralBodyComponentEphemeris) → ICentralBodyComponentEphemeris#

Add the central body ephemeris definition to the central body.

Parameters:: ephemeris : ICentralBodyComponentEphemeris
Returns:: ICentralBodyComponentEphemeris