ostk.astrodynamics.EventCondition

class EventCondition(*args, **kwargs)

Bases: pybind11_object

An Event Condition defines a criterion that can be evaluated based on a current/previous state vectors and times

Overloaded function.

1. __init__(self: ostk.astrodynamics.EventCondition, name: ostk.core.type.String, evaluator: Callable[[ostk.astrodynamics.trajectory.State], ostk.core.type.Real], target: ostk.astrodynamics.EventCondition.Target) -> None

   Construct a new EventCondition object.

   Args:

   name (str): The name of the event condition. evaluator (callable): The evaluator that accepts a State and returns a float value. target (EventConditionTarget): The target of the event condition.

   Returns:

   event_condition (EventCondition): The new EventCondition object.

2. __init__(self: ostk.astrodynamics.EventCondition, name: ostk.core.type.String, evaluator: Callable[[ostk.astrodynamics.trajectory.State], ostk.core.type.Real], target_value: ostk.core.type.Real) -> None

   Construct a new EventCondition object.

   Args:

   name (str): The name of the event condition. evaluator (callable): The evaluator that accepts a State and returns a float value. target_value (float): The target of the event condition.

   Returns:

   event_condition (EventCondition): The new EventCondition object.

Methods

get_evaluator	Get the evaluator of the event condition.
get_name	Get the name of the event condition.
get_target	Get the target of the event condition.
is_satisfied	Check if the event condition is satisfied.
update_target	Update the target value if the event condition is relative.

class Target(*args, **kwargs)

Bases: pybind11_object

The Event Condition Target.

Overloaded function.

1. __init__(self: ostk.astrodynamics.EventCondition.Target, value: ostk.core.type.Real, type: ostk.astrodynamics.EventCondition.Target.Type = <Type.Absolute: 0>) -> None

   Construct a new EventConditionTarget object.

   Args:

   value (float): The value of the target. type (EventConditionTarget.Type): The type of the target. Defaults to EventConditionTarget.Type.Absolute.

   Returns:

   event_condition_target (EventConditionTarget): The new EventConditionTarget object.

2. __init__(self: ostk.astrodynamics.EventCondition.Target, value: ostk.physics.unit.Length, type: ostk.astrodynamics.EventCondition.Target.Type = <Type.Absolute: 0>) -> None

   Construct a new EventConditionTarget object.

   Args:

   length (Length): The value of the target as a Length. type (EventConditionTarget.Type): The type of the target. Defaults to EventConditionTarget.Type.Absolute.

   Returns:

   event_condition_target (EventConditionTarget): The new EventConditionTarget object.

3. __init__(self: ostk.astrodynamics.EventCondition.Target, value: ostk.physics.unit.Angle, type: ostk.astrodynamics.EventCondition.Target.Type = <Type.Absolute: 0>) -> None

   Construct a new EventConditionTarget object.

   Args:

   angle (Angle): The value of the target as an Angle. type (EventConditionTarget.Type): The type of the target. Defaults to EventConditionTarget.Type.Absolute.

   Returns:

   event_condition_target (EventConditionTarget): The new EventConditionTarget object.

static StringFromType(

arg0: ostk.astrodynamics.EventCondition.Target.Type,

) → ostk.core.type.String

Enum as a string

Parameters:

type (EventConditionTarget.Type) -- The type of the target.

Returns:

Name of the enum as a string.

Return type:

string (str)

class Type(

self: ostk.astrodynamics.EventCondition.Target.Type,

value: int,

)

Bases: pybind11_object

Event Condition Target type.

Members:

Absolute : Absolute

Relative : Relative to the provided State.

property name

property type

The type of the target.

Type:

Type

property value

The value of the target.

Type:

float

property value_offset

The value offset of the target. Used for Relative targets.

Type:

float

get_evaluator(

self: ostk.astrodynamics.EventCondition,

) → Callable[[ostk.astrodynamics.trajectory.State], ostk.core.type.Real]

Get the evaluator of the event condition.

Returns:

The evaluator of the event condition.

Return type:

evaluator (str)

get_name(

self: ostk.astrodynamics.EventCondition,

) → ostk.core.type.String

Get the name of the event condition.

Returns:

The name of the event condition.

Return type:

name (str)

get_target(

self: ostk.astrodynamics.EventCondition,

) → ostk.astrodynamics.EventCondition.Target

Get the target of the event condition.

Returns:

The target of the event condition.

Return type:

target (EventConditionTarget)

is_satisfied(

self: ostk.astrodynamics.EventCondition,

current_state: ostk.astrodynamics.trajectory.State,

previous_state: ostk.astrodynamics.trajectory.State,

) → bool

Check if the event condition is satisfied.

Parameters:

• current_state (State) -- The current state.

• previous_state (State) -- The previous state.

Returns:

True if the event condition is satisfied, False otherwise.

Return type:

is_satisfied (bool)

update_target(

self: ostk.astrodynamics.EventCondition,

state: ostk.astrodynamics.trajectory.State,

) → None

Update the target value if the event condition is relative.

Parameters:

state (State) -- The state to calculate the relative target from.