ostk.astrodynamics.trajectory.orbit.message.spacex.OPM

class OPM(self: ostk.astrodynamics.trajectory.orbit.message.spacex.OPM, header: ostk::astrodynamics::trajectory::orbit::message::spacex::OPM::Header, deployments: list[ostk::astrodynamics::trajectory::orbit::message::spacex::OPM::Deployment])

Bases: pybind11_object

The SpaceX OPM message.

See also

SpaceX OPM.

Constructor.

Parameters:
  • header (Header) -- The header of the OPM message.

  • deployments (list[Deployment]) -- The deployments of the OPM message.

Methods

dictionary

Build an OPM message from a dictionary.

get_deployment_at

Get the deployment at a given index.

get_deployment_with_name

Get the deployment with a given name.

get_deployments

Get the deployments of the OPM message.

get_header

Get the header of the OPM message.

is_defined

Check if the OPM message is defined.

load

Load an OPM message from a file.

parse

Parse an OPM message from a string.

undefined

Return an undefined OPM message.

class Deployment(
self: ostk.astrodynamics.trajectory.orbit.message.spacex.OPM.Deployment,
name: ostk.core.type.String,
sequence_number: ostk.core.type.Integer,
mission_time: ostk.physics.time.Duration,
date: ostk.physics.time.Instant,
position: ostk.physics.coordinate.Position,
velocity: ostk.physics.coordinate.Velocity,
mean_perigee_altitude: ostk.physics.unit.Length,
mean_apogee_altitude: ostk.physics.unit.Length,
mean_inclination: ostk.physics.unit.Angle,
mean_argument_of_perigee: ostk.physics.unit.Angle,
mean_longitude_ascending_node: ostk.physics.unit.Angle,
mean_mean_anomaly: ostk.physics.unit.Angle,
ballistic_coefficient: ostk.core.type.Real,
)

Bases: pybind11_object

The deployment of the SpaceX OPM message.

Constructor.

Parameters:
  • name (str) -- The name of the deployment.

  • sequence_number (int) -- The sequence number of the deployment.

  • mission_time (Duration) -- The mission time of the deployment.

  • date (Instant) -- The date of the deployment.

  • position (Position) -- The position of the deployment.

  • velocity (Velocity) -- The velocity of the deployment.

  • mean_perigee_altitude (Length) -- The mean perigee altitude of the deployment.

  • mean_apogee_altitude (Length) -- The mean apogee altitude of the deployment.

  • mean_inclination (Angle) -- The mean inclination of the deployment.

  • mean_argument_of_perigee (Angle) -- The mean argument of perigee of the deployment.

  • mean_longitude_ascending_node (Angle) -- The mean longitude of the ascending node of the deployment.

  • mean_mean_anomaly (Angle) -- The mean mean anomaly of the deployment.

  • ballistic_coefficient (float) -- The ballistic coefficient of the deployment.

property ballistic_coefficient

Get the ballistic coefficient of the deployment.

Type:

float

property date

Get the date of the deployment.

Type:

Instant

property mean_apogee_altitude

Get the mean apogee altitude of the deployment.

Type:

Length

property mean_argument_of_perigee

Get the mean argument of perigee of the deployment.

Type:

Angle

property mean_inclination

Get the mean inclination of the deployment.

Type:

Angle

property mean_longitude_ascending_node

Get the mean longitude of the ascending node of the deployment.

Type:

Angle

property mean_mean_anomaly

Get the mean mean anomaly of the deployment.

Type:

Angle

property mean_perigee_altitude

Get the mean perigee altitude of the deployment.

Type:

Length

property mission_time

Get the mission time of the deployment.

Type:

Duration

property name

Get the name of the deployment.

Type:

str

property position

Get the position of the deployment.

Type:

Position

property sequence_number

Get the sequence number of the deployment.

Type:

int

to_state(
self: ostk.astrodynamics.trajectory.orbit.message.spacex.OPM.Deployment,
) ostk.astrodynamics.trajectory.State

Convert the deployment to a state.

Returns:

The state of the deployment.

Return type:

state (State)

property velocity

Get the velocity of the deployment.

Type:

Velocity

class Header(
self: ostk.astrodynamics.trajectory.orbit.message.spacex.OPM.Header,
generation_date: ostk.physics.time.Instant,
launch_date: ostk.physics.time.Instant,
)

Bases: pybind11_object

The header of the SpaceX OPM message.

Constructor.

Parameters:
  • generation_date (Instant) -- The date at which the OPM message was generated.

  • launch_date (Instant) -- The date at which the spacecraft was launched.

property generation_date

Get the date at which the OPM message was generated.

Returns:

The date at which the OPM message was generated.

Return type:

instant (Instant)

property launch_date

Get the date at which the spacecraft was launched.

Returns:

The date at which the spacecraft was launched.

Return type:

instant (Instant)

static dictionary(
dictionary: ostk.core.container.Dictionary,
) ostk.astrodynamics.trajectory.orbit.message.spacex.OPM

Build an OPM message from a dictionary.

Parameters:

dictionary (dict) -- The dictionary containing the OPM message information.

Returns:

The OPM message.

Return type:

opm (OPM)

get_deployment_at(
self: ostk.astrodynamics.trajectory.orbit.message.spacex.OPM,
index: int,
) ostk::astrodynamics::trajectory::orbit::message::spacex::OPM::Deployment

Get the deployment at a given index.

Parameters:

index (int) -- The index of the deployment.

Returns:

The deployment at the given index.

Return type:

deployment (Deployment)

get_deployment_with_name(
self: ostk.astrodynamics.trajectory.orbit.message.spacex.OPM,
name: ostk.core.type.String,
) ostk::astrodynamics::trajectory::orbit::message::spacex::OPM::Deployment

Get the deployment with a given name.

Parameters:

name (str) -- The name of the deployment.

Returns:

The deployment with the given name.

Return type:

deployment (Deployment)

get_deployments(
self: ostk.astrodynamics.trajectory.orbit.message.spacex.OPM,
) list[ostk::astrodynamics::trajectory::orbit::message::spacex::OPM::Deployment]

Get the deployments of the OPM message.

Returns:

The deployments of the OPM message.

Return type:

deployments (list[Deployment])

get_header(
self: ostk.astrodynamics.trajectory.orbit.message.spacex.OPM,
) ostk::astrodynamics::trajectory::orbit::message::spacex::OPM::Header

Get the header of the OPM message.

Returns:

The header of the OPM message.

Return type:

header (Header)

is_defined(self: ostk.astrodynamics.trajectory.orbit.message.spacex.OPM) bool

Check if the OPM message is defined.

Returns:

True if the OPM message is defined, False otherwise.

Return type:

is_defined (bool)

static load(
file: ostk.core.filesystem.File,
) ostk.astrodynamics.trajectory.orbit.message.spacex.OPM

Load an OPM message from a file.

Parameters:

file (str) -- The path to the file containing the OPM message.

Returns:

The OPM message.

Return type:

opm (OPM)

static parse(
string: ostk.core.type.String,
) ostk.astrodynamics.trajectory.orbit.message.spacex.OPM

Parse an OPM message from a string.

Parameters:

string (str) -- The string containing the OPM message.

Returns:

The OPM message.

Return type:

opm (OPM)

static undefined() ostk.astrodynamics.trajectory.orbit.message.spacex.OPM

Return an undefined OPM message.

Returns:

An undefined OPM message.

Return type:

opm (OPM)