ostk.astrodynamics.trajectory.orbit.model.Propagated

class Propagated(*args, **kwargs)

Bases: OrbitModel

A Propagated orbit model.

Provides the interface for orbit models.

Overloaded function.

1. __init__(self: ostk.astrodynamics.trajectory.orbit.model.Propagated, propagator: ostk::astrodynamics::trajectory::Propagator, state: ostk.astrodynamics.trajectory.State, initial_revolution_number: ostk.core.type.Integer = 1) -> None

   Constructor.

   Args:

   propagator (Propagator): The propagator. state (State): The initial state. initial_revolution_number (int, optional): The initial revolution number. Defaults to 1.

2. __init__(self: ostk.astrodynamics.trajectory.orbit.model.Propagated, propagator: ostk::astrodynamics::trajectory::Propagator, state_array: list[ostk.astrodynamics.trajectory.State], initial_revolution_number: ostk.core.type.Integer = 1) -> None

   Constructor.

   Args:

   propagator (Propagator): The propagator. state_array (list[State]): The initial state array. initial_revolution_number (int, optional): The initial revolution number. Defaults to 1.

Methods

access_cached_state_array	Access the cached state array of the Propagated model.
access_propagator	Access the propagator of the Propagated model.
as_kepler	Cast the orbit model to a Kepler model.
as_propagated	Cast the orbit model to a propagated model.
as_sgp4	Cast the orbit model to an SGP4 model.
calculate_revolution_number_at	Calculate the revolution number of the Propagated model at a given instant.
calculate_state_at	Calculate the state of the Propagated model at a given instant.
calculate_states_at	Calculate the states of the Propagated model at given instants.
get_epoch	Get the epoch of the Propagated model.
get_revolution_number_at_epoch	Get the revolution number at the epoch of the Propagated model.
is_defined	Check if the Propagated model is defined.
is_kepler	Check if the orbit model is a Kepler model.
is_propagated	Check if the orbit model is a propagated model.
is_sgp4	Check if the orbit model is an SGP4 model.
set_cached_state_array	Set the cached state array of the Propagated model.

access_cached_state_array(

self: ostk.astrodynamics.trajectory.orbit.model.Propagated,

) → list[ostk.astrodynamics.trajectory.State]

Access the cached state array of the Propagated model.

Returns:

The cached state array.

Return type:

list[State]

access_propagator(

self: ostk.astrodynamics.trajectory.orbit.model.Propagated,

) → ostk::astrodynamics::trajectory::Propagator

Access the propagator of the Propagated model.

Returns:

The propagator.

Return type:

Propagator

as_kepler(

self: ostk.astrodynamics.trajectory.orbit.OrbitModel,

) → ostk::astrodynamics::trajectory::orbit::model::Kepler

Cast the orbit model to a Kepler model.

Returns:

The Kepler model.

Return type:

Kepler

as_propagated(

self: ostk.astrodynamics.trajectory.orbit.OrbitModel,

) → ostk::astrodynamics::trajectory::orbit::model::Propagated

Cast the orbit model to a propagated model.

Returns:

The propagated model.

Return type:

Propagated

as_sgp4(

self: ostk.astrodynamics.trajectory.orbit.OrbitModel,

) → ostk::astrodynamics::trajectory::orbit::model::SGP4

Cast the orbit model to an SGP4 model.

Returns:

The SGP4 model.

Return type:

SGP4

calculate_revolution_number_at(

self: ostk.astrodynamics.trajectory.orbit.model.Propagated,

instant: ostk.physics.time.Instant,

) → ostk.core.type.Integer

Calculate the revolution number of the Propagated model at a given instant.

Parameters:

instant (Instant) -- The instant.

Returns:

The revolution number.

Return type:

int

calculate_state_at(

self: ostk.astrodynamics.trajectory.orbit.model.Propagated,

instant: ostk.physics.time.Instant,

) → ostk.astrodynamics.trajectory.State

Calculate the state of the Propagated model at a given instant.

Parameters:

instant (Instant) -- The instant.

Returns:

The state.

Return type:

State

calculate_states_at(

self: ostk.astrodynamics.trajectory.orbit.model.Propagated,

instants: list[ostk.physics.time.Instant],

) → list[ostk.astrodynamics.trajectory.State]

Calculate the states of the Propagated model at given instants.

Parameters:

instants (list[Instant]) -- The instants.

Returns:

The states.

Return type:

list[State]

get_epoch(

self: ostk.astrodynamics.trajectory.orbit.model.Propagated,

) → ostk.physics.time.Instant

Get the epoch of the Propagated model.

Returns:

The epoch.

Return type:

Instant

get_revolution_number_at_epoch(

self: ostk.astrodynamics.trajectory.orbit.model.Propagated,

) → ostk.core.type.Integer

Get the revolution number at the epoch of the Propagated model.

Returns:

The revolution number.

Return type:

int

is_defined(

self: ostk.astrodynamics.trajectory.orbit.model.Propagated,

) → bool

Check if the Propagated model is defined.

Returns:

True if the Propagated model is defined, False otherwise.

Return type:

bool

is_kepler(self: ostk.astrodynamics.trajectory.orbit.OrbitModel) → bool

Check if the orbit model is a Kepler model.

Returns:

True if the orbit model is a Kepler model, False otherwise.

Return type:

bool

is_propagated(self: ostk.astrodynamics.trajectory.orbit.OrbitModel) → bool

Check if the orbit model is a propagated model.

Returns:

True if the orbit model is a propagated model, False otherwise.

Return type:

bool

is_sgp4(self: ostk.astrodynamics.trajectory.orbit.OrbitModel) → bool

Check if the orbit model is an SGP4 model.

Returns:

True if the orbit model is an SGP4 model, False otherwise.

Return type:

bool

set_cached_state_array(

self: ostk.astrodynamics.trajectory.orbit.model.Propagated,

state_array: list[ostk.astrodynamics.trajectory.State],

) → None

Set the cached state array of the Propagated model.

Parameters:

state_array (list[State]) -- The state array.