IPosition

class ansys.stk.core.stkutil.IPosition

IPosition provides access to the position of the object.

Overview

Methods

convert_to	Change the position coordinates to type specified.
assign	Assign the coordinates into the system.
assign_geocentric	Assign the position using the Geocentric representation.
assign_geodetic	Assign the position using the Geodetic representation.
assign_spherical	Assign the position using the Spherical representation.
assign_cylindrical	Assign the position using the Cylindrical representation.
assign_cartesian	Assign the position using the Cartesian representation.
assign_planetocentric	Assign the position using the Planetocentric representation.
assign_planetodetic	Assign the position using the Planetodetic representation.
query_planetocentric	Get the position using the Planetocentric representation.
query_planetodetic	Get the position using the Planetodetic representation.
query_spherical	Get the position using the Spherical representation.
query_cylindrical	Get the position using the Cylindrical representation.
query_cartesian	Get the position using the Cartesian representation.
query_planetocentric_array	Return the Planetocentric elements as an array.
query_planetodetic_array	Return the Planetodetic elements as an array.
query_spherical_array	Return the Spherical elements as an array.
query_cylindrical_array	Return the Cylindrical elements as an array.
query_cartesian_array	Return the Cartesian elements as an array.

Properties

position_type	Get the type of position currently being used.
central_body_name	Get the central body.

Import detail

from ansys.stk.core.stkutil import IPosition

Property detail

property IPosition.position_type: PositionType

Get the type of position currently being used.

property IPosition.central_body_name: str

Get the central body.

Method detail

IPosition.convert_to(self, type: PositionType) → IPosition

Change the position coordinates to type specified.

Parameters:

type : PositionType

Returns:

IPosition

IPosition.assign(self, position: IPosition) → None

Assign the coordinates into the system.

Parameters:

position : IPosition

Returns:

None

IPosition.assign_geocentric(self, lat: Any, lon: Any, alt: float) → None

Assign the position using the Geocentric representation.

Parameters:

lat : Any

lon : Any

alt : float

Returns:

None

IPosition.assign_geodetic(self, lat: Any, lon: Any, alt: float) → None

Assign the position using the Geodetic representation.

Parameters:

lat : Any

lon : Any

alt : float

Returns:

None

IPosition.assign_spherical(self, lat: Any, lon: Any, radius: float) → None

Assign the position using the Spherical representation.

Parameters:

lat : Any

lon : Any

radius : float

Returns:

None

IPosition.assign_cylindrical(self, radius: float, z: float, lon: Any) → None

Assign the position using the Cylindrical representation.

Parameters:

radius : float

z : float

lon : Any

Returns:

None

IPosition.assign_cartesian(self, x: float, y: float, z: float) → None

Assign the position using the Cartesian representation.

Parameters:

x : float

y : float

z : float

Returns:

None

IPosition.assign_planetocentric(self, lat: Any, lon: Any, alt: float) → None

Assign the position using the Planetocentric representation.

Parameters:

lat : Any

lon : Any

alt : float

Returns:

None

IPosition.assign_planetodetic(self, lat: Any, lon: Any, alt: float) → None

Assign the position using the Planetodetic representation.

Parameters:

lat : Any

lon : Any

alt : float

Returns:

None

IPosition.query_planetocentric(self) → Tuple[Any, Any, float]

Get the position using the Planetocentric representation.

Returns:

Any, float]

IPosition.query_planetodetic(self) → Tuple[Any, Any, float]

Get the position using the Planetodetic representation.

Returns:

Any, float]

IPosition.query_spherical(self) → Tuple[Any, Any, float]

Get the position using the Spherical representation.

Returns:

Any, float]

IPosition.query_cylindrical(self) → Tuple[float, Any, float]

Get the position using the Cylindrical representation.

Returns:

Any, float]

IPosition.query_cartesian(self) → Tuple[float, float, float]

Get the position using the Cartesian representation.

Returns:

Tuple[float, float, float]

IPosition.query_planetocentric_array(self) → list

Return the Planetocentric elements as an array.

Returns:

list

IPosition.query_planetodetic_array(self) → list

Return the Planetodetic elements as an array.

Returns:

list

IPosition.query_spherical_array(self) → list

Return the Spherical elements as an array.

Returns:

list

IPosition.query_cylindrical_array(self) → list

Return the Cylindrical elements as an array.

Returns:

list

IPosition.query_cartesian_array(self) → list

Return the Cartesian elements as an array.

Returns:

list