larcfm::AlertThresholds Class Reference

Inheritance diagram for larcfm::AlertThresholds:

Public Member Functions
bool	isValid () const
	AlertThresholds (const Detection3D *det, double alerting_time, double early_alerting_time, BandsRegion::Region region)
	AlertThresholds (const AlertThresholds &athr)
AlertThresholds &	operator= (const AlertThresholds &athr)
Detection3D &	getCoreDetectionRef () const
Detection3D *	getCoreDetectionPtr () const
void	setCoreDetectionRef (const Detection3D &det)
void	setCoreDetectionPtr (const Detection3D *det)
double	getAlertingTime () const
double	getAlertingTime (const std::string &u) const
void	setAlertingTime (double val)
void	setAlertingTime (double val, const std::string &u)
double	getEarlyAlertingTime () const
double	getEarlyAlertingTime (const std::string &u) const
void	setEarlyAlertingTime (double val)
void	setEarlyAlertingTime (double val, const std::string &u)
BandsRegion::Region	getRegion () const
void	setRegion (BandsRegion::Region region)
double	getHorizontalDirectionSpread () const
double	getHorizontalDirectionSpread (const std::string &u) const
void	setHorizontalDirectionSpread (double spread)
void	setHorizontalDirectionSpread (double spread, const std::string &u)
double	getHorizontalSpeedSpread () const
double	getHorizontalSpeedSpread (const std::string &u) const
void	setHorizontalSpeedSpread (double spread)
void	setHorizontalSpeedSpread (double spread, const std::string &u)
double	getVerticalSpeedSpread () const
double	getVerticalSpeedSpread (const std::string &u) const
void	setVerticalSpeedSpread (double spread)
void	setVerticalSpeedSpread (double spread, const std::string &u)
double	getAltitudeSpread () const
double	getAltitudeSpread (const std::string &u) const
void	setAltitudeSpread (double spread)
void	setAltitudeSpread (double spread, const std::string &u)
std::string	toString () const
std::string	toPVS () const
ParameterData	getParameters () const
void	updateParameterData (ParameterData &p) const
void	setParameters (const ParameterData &p)
std::string	getUnits (const std::string &key) const

Static Public Member Functions
static const AlertThresholds &	INVALID ()

Private Member Functions
void	copyFrom (const AlertThresholds &athr)

Private Attributes
Detection3D *	detector_
double	alerting_time_
double	early_alerting_time_
BandsRegion::Region	region_
double	spread_hdir_
double	spread_hs_
double	spread_vs_
double	spread_alt_
std::map< std::string, std::string >	units_

Constructor & Destructor Documentation

AlertThresholds()

larcfm::AlertThresholds::AlertThresholds	(	const Detection3D *	detector,
		double	alerting_time,
		double	early_alerting_time,
		BandsRegion::Region	region
	)

Creates an alert threholds object. Parameter det is a detector, alerting_time is a non-negative alerting time (possibly positive infinity), early_alerting_time is a early alerting time >= at (for maneuver guidance), region is the type of guidance

Member Function Documentation

getAlertingTime() [1/2]

double larcfm::AlertThresholds::getAlertingTime

(

)

const

Return alerting time in seconds.

getAlertingTime() [2/2]

double larcfm::AlertThresholds::getAlertingTime

(

const std::string &

u

)

const

Return alerting time in specified units.

getAltitudeSpread() [1/2]

double larcfm::AlertThresholds::getAltitudeSpread

(

)

const

Get altitude spread in internal units [m]. Spread is relative to ownship's altitude

getAltitudeSpread() [2/2]

double larcfm::AlertThresholds::getAltitudeSpread

(

const std::string &

u

)

const

Get altitude spread in given units. Spread is relative to ownship's altitude

getCoreDetectionPtr()

Detection3D * larcfm::AlertThresholds::getCoreDetectionPtr ( ) const

virtual

Return detector pointer.

Return detector.

Implements larcfm::Detection3DAcceptor.

getCoreDetectionRef()

Detection3D & larcfm::AlertThresholds::getCoreDetectionRef ( ) const

virtual

Return detector reference.

Implements larcfm::Detection3DAcceptor.

getEarlyAlertingTime() [1/2]

double larcfm::AlertThresholds::getEarlyAlertingTime

(

)

const

Return early alerting time in seconds.

getEarlyAlertingTime() [2/2]

double larcfm::AlertThresholds::getEarlyAlertingTime

(

const std::string &

u

)

const

Return early alerting time in specified units.

getHorizontalDirectionSpread() [1/2]

double larcfm::AlertThresholds::getHorizontalDirectionSpread

(

)

const

Get track spread in internal units [rad]. Spread is relative to ownship's track

getHorizontalDirectionSpread() [2/2]

double larcfm::AlertThresholds::getHorizontalDirectionSpread

(

const std::string &

u

)

const

Get track spread in given units [u]. Spread is relative to ownship's track

getHorizontalSpeedSpread() [1/2]

double larcfm::AlertThresholds::getHorizontalSpeedSpread

(

)

const

Get ground speed spread in internal units [m/s]. Spread is relative to ownship's ground speed

getHorizontalSpeedSpread() [2/2]

double larcfm::AlertThresholds::getHorizontalSpeedSpread

(

const std::string &

u

)

const

Get ground speed spread in given units. Spread is relative to ownship's ground speed

getParameters()

ParameterData larcfm::AlertThresholds::getParameters ( ) const

virtual

Implements larcfm::ParameterProvider.

getRegion()

BandsRegion::Region larcfm::AlertThresholds::getRegion

(

)

const

Return guidance region.

getVerticalSpeedSpread() [1/2]

double larcfm::AlertThresholds::getVerticalSpeedSpread

(

)

const

Get vertical speed spread in internal units [m/s]. Spread is relative to ownship's vertical speed

getVerticalSpeedSpread() [2/2]

double larcfm::AlertThresholds::getVerticalSpeedSpread

(

const std::string &

u

)

const

Get vertical speed spread in given units. Spread is relative to ownship's vertical speed

setAlertingTime() [1/2]

void larcfm::AlertThresholds::setAlertingTime

(

double

val

)

Set alerting time in seconds. Alerting time is non-negative number.

setAlertingTime() [2/2]

void larcfm::AlertThresholds::setAlertingTime	(	double	t,
		const std::string &	u
	)

Set alerting time in specified units. Alerting time is non-negative number.

setAltitudeSpread() [1/2]

void larcfm::AlertThresholds::setAltitudeSpread

(

double

spread

)

Set altitude spread in internal units [m]. Spread is relative to ownship's altitude and is expected to be non-negative

setAltitudeSpread() [2/2]

void larcfm::AlertThresholds::setAltitudeSpread	(	double	spread,
		const std::string &	u
	)

Set altitude spread in given units. Spread is relative to ownship's altitude and is expected to be non-negative

setCoreDetectionPtr()

void larcfm::AlertThresholds::setCoreDetectionPtr ( const Detection3D *  det )

virtual

Set detector as a pointer.

Set detector.

Implements larcfm::Detection3DAcceptor.

setCoreDetectionRef()

void larcfm::AlertThresholds::setCoreDetectionRef ( const Detection3D &  det )

virtual

Set detector as a reference.

Set detector.

Implements larcfm::Detection3DAcceptor.

setEarlyAlertingTime() [1/2]

void larcfm::AlertThresholds::setEarlyAlertingTime

(

double

t

)

Set early alerting time in seconds. Early alerting time is a positive number >= alerting time

setEarlyAlertingTime() [2/2]

void larcfm::AlertThresholds::setEarlyAlertingTime	(	double	t,
		const std::string &	u
	)

Set early alerting time in specified units. Early alerting time is a positive number >= alerting time

setHorizontalDirectionSpread() [1/2]

void larcfm::AlertThresholds::setHorizontalDirectionSpread

(

double

spread

)

Set track spread in internal units. Spread is relative to ownship's track and is expected to be in [0,pi].

setHorizontalDirectionSpread() [2/2]

void larcfm::AlertThresholds::setHorizontalDirectionSpread	(	double	spread,
		const std::string &	u
	)

Set track spread in given units. Spread is relative to ownship's track and is expected to be in [0,pi] [u].

setHorizontalSpeedSpread() [1/2]

void larcfm::AlertThresholds::setHorizontalSpeedSpread

(

double

spread

)

Set ground speed spread in internal units [m/s]. Spread is relative to ownship's ground speed and is expected to be non-negative

setHorizontalSpeedSpread() [2/2]

void larcfm::AlertThresholds::setHorizontalSpeedSpread	(	double	spread,
		const std::string &	u
	)

Set ground speed spread in given units. Spread is relative to ownship's ground speed and is expected to be non-negative

setParameters()

void larcfm::AlertThresholds::setParameters ( const ParameterData &  p )

virtual

Implements larcfm::ParameterAcceptor.

setRegion()

void larcfm::AlertThresholds::setRegion

(

BandsRegion::Region

region

)

Set guidance region.

setVerticalSpeedSpread() [1/2]

void larcfm::AlertThresholds::setVerticalSpeedSpread

(

double

spread

)

Set vertical speed spread in internal units [m/s]. Spread is relative to ownship's vertical speed and is expected to be non-negative

setVerticalSpeedSpread() [2/2]

void larcfm::AlertThresholds::setVerticalSpeedSpread	(	double	spread,
		const std::string &	u
	)

Set vertical speed spread in given units. Spread is relative to ownship's vertical speed and is expected to be non-negative

toString()

std::string larcfm::AlertThresholds::toString ( ) const

virtual

Implements larcfm::ParameterTable.

updateParameterData()

void larcfm::AlertThresholds::updateParameterData ( ParameterData &  p ) const

virtual

Implements larcfm::ParameterProvider.

---

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

• Modules/ACCoRD/inc/AlertThresholds.h
• Modules/ACCoRD/src/AlertThresholds.cpp