FlightGear next
flightgear::FlightPlan::Leg Class Reference

flight-plan leg encapsulation More...

#include <FlightPlan.hxx>

Inherits SGReferenced.

Public Member Functions

FlightPlanowner () const
 
Wayptwaypoint () const
 
LegnextLeg () const
 
bool setHoldCount (int count)
 requesting holding at the waypoint upon reaching it.
 
int holdCount () const
 
bool convertWaypointToHold ()
 
unsigned int index () const
 
int altitudeFt () const
 
double speed (RouteUnits units=DEFAULT_UNITS) const
 
double altitude (RouteUnits units=DEFAULT_UNITS) const
 
int speedKts () const
 
double speedMach () const
 
RouteRestriction altitudeRestriction () const
 
RouteRestriction speedRestriction () const
 
void setSpeed (RouteRestriction ty, double speed, RouteUnits units=DEFAULT_UNITS)
 
void setAltitude (RouteRestriction ty, double alt, RouteUnits units=DEFAULT_UNITS)
 
double courseDeg () const
 
double distanceNm () const
 
double distanceAlongRoute () const
 
void markWaypointDirty ()
 helper function, if the waypoint is modified in some way, to notify the flightplan owning this leg, and hence any delegates obsering us
 

Friends

class FlightPlan
 

Detailed Description

flight-plan leg encapsulation

Definition at line 104 of file FlightPlan.hxx.

Member Function Documentation

◆ altitude()

double flightgear::FlightPlan::Leg::altitude ( RouteUnits units = DEFAULT_UNITS) const

Definition at line 1580 of file FlightPlan.cxx.

◆ altitudeFt()

int flightgear::FlightPlan::Leg::altitudeFt ( ) const

Definition at line 1589 of file FlightPlan.cxx.

◆ altitudeRestriction()

RouteRestriction flightgear::FlightPlan::Leg::altitudeRestriction ( ) const

Definition at line 1613 of file FlightPlan.cxx.

◆ convertWaypointToHold()

bool flightgear::FlightPlan::Leg::convertWaypointToHold ( )

Definition at line 1672 of file FlightPlan.cxx.

◆ courseDeg()

double flightgear::FlightPlan::Leg::courseDeg ( ) const

Definition at line 1656 of file FlightPlan.cxx.

◆ distanceAlongRoute()

double flightgear::FlightPlan::Leg::distanceAlongRoute ( ) const

Definition at line 1666 of file FlightPlan.cxx.

◆ distanceNm()

double flightgear::FlightPlan::Leg::distanceNm ( ) const

Definition at line 1661 of file FlightPlan.cxx.

◆ holdCount()

int flightgear::FlightPlan::Leg::holdCount ( ) const

Definition at line 1720 of file FlightPlan.cxx.

◆ index()

unsigned int flightgear::FlightPlan::Leg::index ( ) const

Definition at line 1575 of file FlightPlan.cxx.

◆ markWaypointDirty()

void flightgear::FlightPlan::Leg::markWaypointDirty ( )

helper function, if the waypoint is modified in some way, to notify the flightplan owning this leg, and hence any delegates obsering us

Definition at line 1712 of file FlightPlan.cxx.

◆ nextLeg()

FlightPlan::Leg * flightgear::FlightPlan::Leg::nextLeg ( ) const

Definition at line 1567 of file FlightPlan.cxx.

◆ owner()

FlightPlan * flightgear::FlightPlan::Leg::owner ( ) const
inline

Definition at line 107 of file FlightPlan.hxx.

◆ setAltitude()

void flightgear::FlightPlan::Leg::setAltitude ( RouteRestriction ty,
double alt,
RouteUnits units = DEFAULT_UNITS )

Definition at line 1646 of file FlightPlan.cxx.

◆ setHoldCount()

bool flightgear::FlightPlan::Leg::setHoldCount ( int count)

requesting holding at the waypoint upon reaching it.

This will convert the waypt to a Hold if not already defined as one, but with default hold data.

If the waypt is not of a type suitable for holding at, returns false (eg a runway or dynamic waypoint)

Definition at line 1696 of file FlightPlan.cxx.

◆ setSpeed()

void flightgear::FlightPlan::Leg::setSpeed ( RouteRestriction ty,
double speed,
RouteUnits units = DEFAULT_UNITS )

Definition at line 1631 of file FlightPlan.cxx.

◆ speed()

double flightgear::FlightPlan::Leg::speed ( RouteUnits units = DEFAULT_UNITS) const

Definition at line 1594 of file FlightPlan.cxx.

◆ speedKts()

int flightgear::FlightPlan::Leg::speedKts ( ) const

Definition at line 1603 of file FlightPlan.cxx.

◆ speedMach()

double flightgear::FlightPlan::Leg::speedMach ( ) const

Definition at line 1608 of file FlightPlan.cxx.

◆ speedRestriction()

RouteRestriction flightgear::FlightPlan::Leg::speedRestriction ( ) const

Definition at line 1622 of file FlightPlan.cxx.

◆ waypoint()

Waypt * flightgear::FlightPlan::Leg::waypoint ( ) const
inline

Definition at line 110 of file FlightPlan.hxx.

Friends And Related Symbol Documentation

◆ FlightPlan

friend class FlightPlan
friend

Definition at line 157 of file FlightPlan.hxx.


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