ostk.physics.environment.Object

class Object

Bases: pybind11_object

This class represents a physical object in the environment. It can be subclassed to represent specific types of objects, like celestial bodies.

Methods

access_frame	Accesses the frame of the Object.
access_name	Accesses the name of the Object.
get_axes_in	Gets the axes of the Object in a given frame.
get_geometry	Gets the geometry of the Object.
get_geometry_in	Gets the geometry of the Object in a given frame.
get_name	Gets the name of the Object.
get_position_in	Gets the position of the Object in a given frame.
get_transform_to	Gets the transformation from the Object to a given frame.
is_defined	Checks if the Object is defined.

access_frame(

self: ostk.physics.environment.Object,

) → ostk.physics.coordinate.Frame

Accesses the frame of the Object.

Returns:

The frame of the Object.

Return type:

Frame

access_name(self: ostk.physics.environment.Object) → ostk.core.type.String

Accesses the name of the Object.

Returns:

The name of the Object.

Return type:

str

get_axes_in(

self: ostk.physics.environment.Object,

frame: ostk.physics.coordinate.Frame,

instant: ostk.physics.time.Instant,

) → ostk.physics.coordinate.Axes

Gets the axes of the Object in a given frame.

Parameters:

• frame (Frame) -- The frame in which the axes are expressed.

• instant (Instant) -- The instant at which the axes are computed.

Returns:

the axes of the Object.

Return type:

Axes

get_geometry(

self: ostk.physics.environment.Object,

) → ostk::physics::environment::object::Geometry

Gets the geometry of the Object.

Returns:

The geometry of the Object.

Return type:

Geometry

get_geometry_in(

self: ostk.physics.environment.Object,

frame: ostk.physics.coordinate.Frame,

instant: ostk.physics.time.Instant,

) → ostk::physics::environment::object::Geometry

Gets the geometry of the Object in a given frame.

Parameters:

• frame (Frame) -- The frame in which the geometry is expressed.

• instant (Instant) -- The instant at which the geometry is computed.

Returns:

the geometry of the Object.

Return type:

Geometry

get_name(self: ostk.physics.environment.Object) → ostk.core.type.String

Gets the name of the Object.

Returns:

The name of the Object.

Return type:

str

get_position_in(

self: ostk.physics.environment.Object,

frame: ostk.physics.coordinate.Frame,

instant: ostk.physics.time.Instant,

) → ostk.physics.coordinate.Position

Gets the position of the Object in a given frame.

Parameters:

• frame (Frame) -- The frame in which the position is expressed.

• instant (Instant) -- The instant at which the position is computed.

Returns:

The position of the Object.

Return type:

Position

get_transform_to(

self: ostk.physics.environment.Object,

frame: ostk.physics.coordinate.Frame,

instant: ostk.physics.time.Instant,

) → ostk.physics.coordinate.Transform

Gets the transformation from the Object to a given frame.

Parameters:

• frame (Frame) -- The frame to which the transformation is expressed.

• instant (Instant) -- The instant at which the transformation is computed.

Returns:

the transformation.

Return type:

Transformation

is_defined(self: ostk.physics.environment.Object) → bool

Checks if the Object is defined.

Returns:

True if the Object is defined, False otherwise.

Return type:

bool