ostk.astrodynamics.Access

class Access(
self: ostk.astrodynamics.Access,
type: ostk.astrodynamics.Access.Type,
acquisition_of_signal: ostk.physics.time.Instant,
time_of_closest_approach: ostk.physics.time.Instant,
loss_of_signal: ostk.physics.time.Instant,
max_elevation: ostk.physics.unit.Angle,
)

Bases: pybind11_object

Object-to-object visibility

This class encapsulates the concept of visibility access between two trajectories.

Constructs an Access object.

Parameters:
  • type (Access.Type) -- Type of the access (Complete, Partial, Undefined)

  • acquisition_of_signal (Instant) -- The instant when the signal is first acquired

  • time_of_closest_approach (Instant) -- The time of closest approach between objects

  • loss_of_signal (Instant) -- The instant when the signal is lost

  • max_elevation (Angle) -- The maximum elevation angle during the access

Methods

get_acquisition_of_signal

Get the acquisition of signal of the access.

get_duration

Get the duration of the access.

get_interval

Get the interval of the access.

get_loss_of_signal

Get the loss of signal of the access.

get_max_elevation

Get the maximum elevation of the access.

get_time_of_closest_approach

Get the time of closest approach of the access.

get_type

Get the type of the access.

is_complete

Check if the access is complete.

is_defined

Check if the Access object is defined.

string_from_type

Returns a string representation of the Access type.

undefined

Creates an undefined Access object.

class Type(self: ostk.astrodynamics.Access.Type, value: int)

Bases: pybind11_object

Access type.

Members:

Undefined : Undefined

Complete : Complete

Partial : Partial

property name
get_acquisition_of_signal(
self: ostk.astrodynamics.Access,
) ostk.physics.time.Instant

Get the acquisition of signal of the access.

Returns:

The acquisition of signal of the access.

Return type:

Instant

get_duration(self: ostk.astrodynamics.Access) ostk.physics.time.Duration

Get the duration of the access.

Returns:

The duration of the access.

Return type:

Duration

get_interval(self: ostk.astrodynamics.Access) ostk.physics.time.Interval

Get the interval of the access.

Returns:

The interval of the access.

Return type:

Interval

get_loss_of_signal(self: ostk.astrodynamics.Access) ostk.physics.time.Instant

Get the loss of signal of the access.

Returns:

The loss of signal of the access.

Return type:

Instant

get_max_elevation(self: ostk.astrodynamics.Access) ostk.physics.unit.Angle

Get the maximum elevation of the access.

Returns:

The maximum elevation of the access.

Return type:

Angle

get_time_of_closest_approach(
self: ostk.astrodynamics.Access,
) ostk.physics.time.Instant

Get the time of closest approach of the access.

Returns:

The time of closest approach of the access.

Return type:

Instant

get_type(self: ostk.astrodynamics.Access) ostk.astrodynamics.Access.Type

Get the type of the access.

Returns:

The type of the access.

Return type:

Access.Type

is_complete(self: ostk.astrodynamics.Access) bool

Check if the access is complete.

Returns:

True if complete, False otherwise.

Return type:

bool

is_defined(self: ostk.astrodynamics.Access) bool

Check if the Access object is defined.

Returns:

True if defined, False otherwise.

Return type:

bool

static string_from_type(type: ostk.astrodynamics.Access.Type) ostk.core.type.String

Returns a string representation of the Access type.

Parameters:

type (Access.Type) -- The type of the access.

Returns:

A string representation of the type.

Return type:

str

static undefined() ostk.astrodynamics.Access

Creates an undefined Access object.

Returns:

An undefined Access object.

Return type:

Access