VehicleEclipsingBodies

class ansys.stk.core.stkobjects.VehicleEclipsingBodies

Eclipsing bodies.

Overview

Methods

is_eclipsing_body_assigned	Return true if the eclipsing body is assigned.
assign_eclipsing_body	Add an eclipsing body.
remove_eclipsing_body	Remove an eclipsing body.
remove_all_eclipsing_bodies	Remove all eclipsing bodies.

Properties

available_eclipsing_bodies	Get the available eclipsing bodies.
assigned_eclipsing_bodies	Get the assigned eclipsing bodies.

Import detail

from ansys.stk.core.stkobjects import VehicleEclipsingBodies

Property detail

property VehicleEclipsingBodies.available_eclipsing_bodies: list

Get the available eclipsing bodies.

property VehicleEclipsingBodies.assigned_eclipsing_bodies: list

Get the assigned eclipsing bodies.

Method detail

VehicleEclipsingBodies.is_eclipsing_body_assigned(self, eclipsing_body: str) → bool

Return true if the eclipsing body is assigned.

Parameters:

eclipsing_body : str

Returns:

bool

VehicleEclipsingBodies.assign_eclipsing_body(self, eclipsing_body: str) → None

Add an eclipsing body.

Parameters:

eclipsing_body : str

Returns:

None

VehicleEclipsingBodies.remove_eclipsing_body(self, eclipsing_body: str) → None

Remove an eclipsing body.

Parameters:

eclipsing_body : str

Returns:

None

VehicleEclipsingBodies.remove_all_eclipsing_bodies(self) → None

Remove all eclipsing bodies.

Returns:

None