icarus::PhaseManager< Scalar > Class Template Reference

Manages flight phase transitions. More...

#include <PhaseManager.hpp>

Public Member Functions
	PhaseManager ()=default
void	Configure (const PhaseConfig &config)
	Configure phase manager with phase definitions and transitions.
void	EvaluateTransitions (const SignalRegistry< Scalar > &registry)
	Evaluate transition conditions and potentially change phase.
int32_t	CurrentPhase () const
	Get current phase value.
std::string	CurrentPhaseName () const
	Get current phase name.
int32_t	PreviousPhase () const
	Get previous phase value (before last EvaluateTransitions).
bool	PhaseChangedThisStep () const
	Check if phase changed in last EvaluateTransitions call.
bool	IsConfigured () const
	Check if phase manager is configured.
std::string	GetPhaseSignalPath () const
	Get phase signal path for this entity.
const PhaseConfig &	GetConfig () const
	Get the phase configuration.
void	Reset ()
	Reset to initial phase.
void	SetPhase (const std::string &phase_name)
	Force set phase (for testing or initialization).
void	SetPhaseValue (int32_t value)
	Force set phase by value (for testing or initialization).

Detailed Description

template<typename Scalar>
class icarus::PhaseManager< Scalar >

Manages flight phase transitions.

The PhaseManager tracks the current phase and evaluates transition conditions after each simulation step. It follows no-cascade semantics: at most one transition fires per step.

Example usage:

PhaseConfig config;
config.definitions = {{"GROUND", 0}, {"BOOST", 1}, {"COAST", 2}};
config.initial_phase = "GROUND";
config.transitions = {
    {0, 1, "Propulsion.ignition == 1"},
    {1, 2, "Propulsion.fuel_mass < 0.01"}
};
 
PhaseManager<double> pm;
pm.Configure(config);
 
// After each Step():
pm.EvaluateTransitions(registry);
if (pm.PhaseChangedThisStep()) {
    // Handle phase change
}

Constructor & Destructor Documentation

PhaseManager()

template<typename Scalar>

icarus::PhaseManager< Scalar >::PhaseManager ( )

default

Member Function Documentation

Configure()

template<typename Scalar>

void icarus::PhaseManager< Scalar >::Configure ( const PhaseConfig & config )

inline

Configure phase manager with phase definitions and transitions.

Parameters

config

Phase configuration

Exceptions

ConfigError

if initial phase not found or transitions invalid

CurrentPhase()

template<typename Scalar>

int32_t icarus::PhaseManager< Scalar >::CurrentPhase ( ) const

inlinenodiscard

Get current phase value.

CurrentPhaseName()

template<typename Scalar>

std::string icarus::PhaseManager< Scalar >::CurrentPhaseName ( ) const

inlinenodiscard

Get current phase name.

EvaluateTransitions()

template<typename Scalar>

void icarus::PhaseManager< Scalar >::EvaluateTransitions ( const SignalRegistry< Scalar > & registry )

inline

Evaluate transition conditions and potentially change phase.

Called after each Step(). Evaluates all applicable transitions in order and fires the first one whose condition is true. No-cascade: at most one transition per call.

Parameters

registry

Signal registry for condition evaluation

GetConfig()

template<typename Scalar>

const PhaseConfig & icarus::PhaseManager< Scalar >::GetConfig ( ) const

inlinenodiscard

Get the phase configuration.

GetPhaseSignalPath()

template<typename Scalar>

std::string icarus::PhaseManager< Scalar >::GetPhaseSignalPath ( ) const

inlinenodiscard

Get phase signal path for this entity.

Returns

Full signal path (e.g., "Vehicle.phase")

IsConfigured()

template<typename Scalar>

bool icarus::PhaseManager< Scalar >::IsConfigured ( ) const

inlinenodiscard

Check if phase manager is configured.

PhaseChangedThisStep()

template<typename Scalar>

bool icarus::PhaseManager< Scalar >::PhaseChangedThisStep ( ) const

inlinenodiscard

Check if phase changed in last EvaluateTransitions call.

PreviousPhase()

template<typename Scalar>

int32_t icarus::PhaseManager< Scalar >::PreviousPhase ( ) const

inlinenodiscard

Get previous phase value (before last EvaluateTransitions).

Reset()

template<typename Scalar>

void icarus::PhaseManager< Scalar >::Reset ( )

inline

Reset to initial phase.

SetPhase()

template<typename Scalar>

void icarus::PhaseManager< Scalar >::SetPhase ( const std::string & phase_name )

inline

Force set phase (for testing or initialization).

Parameters

phase_name

Phase name to set

Exceptions

ConfigError

if phase name not found

SetPhaseValue()

template<typename Scalar>

void icarus::PhaseManager< Scalar >::SetPhaseValue ( int32_t value )

inline

Force set phase by value (for testing or initialization).

---

The documentation for this class was generated from the following file:

• include/icarus/sim/PhaseManager.hpp