WsfATA_LaunchComputer::EvenlySpaced Class Reference

#include <WsfATA_LaunchComputer.hpp>

Public Member Functions
	EvenlySpaced ()=default
void	SetNumBins (unsigned int aSize)
unsigned int	GetNumBins () const
void	SetDelta (double aValue)
double	Delta () const
void	SetMin (double aValue)
double	Min () const
double	Max () const
bool	BinCenter (unsigned int aIndex, double &aValue) const
	Get the floating point value that is half way between the upper and lower bound of this "bin" index.
bool	BinLower (unsigned int aIndex, double &aValue) const
	Get the floating point value that is the lower bound of this "bin" index.
bool	BinUpper (unsigned int aIndex, double &aValue) const
	Get the floating point value that is the upper bound of this "bin" index.
bool	GetIndex (double aValue, unsigned int &aIndex) const

Detailed Description

This nested class represents an evenly-spaced array of floating-point numbers that identify the constrained range of an independent variable, such as elevation values for which a weapon may be launched. Refer to "bins" that are zero-indexed, where the bin center is the floating point value that is half way between the upper and lower bounds of the bin. Example: If there are 7 bins, there are 8 values (in total) bounding the upper and lower edges of all bins, and valid bin indices are 0 to 6.

Constructor & Destructor Documentation

EvenlySpaced()

WsfATA_LaunchComputer::EvenlySpaced::EvenlySpaced ( )

default

Member Function Documentation

BinCenter()

bool WsfATA_LaunchComputer::EvenlySpaced::BinCenter	(	unsigned int	aIndex,
		double &	aValue ) const

Get the floating point value that is half way between the upper and lower bound of this "bin" index.

References success.

BinLower()

bool WsfATA_LaunchComputer::EvenlySpaced::BinLower	(	unsigned int	aIndex,
		double &	aValue ) const

Get the floating point value that is the lower bound of this "bin" index.

References success.

BinUpper()

bool WsfATA_LaunchComputer::EvenlySpaced::BinUpper	(	unsigned int	aIndex,
		double &	aValue ) const

Get the floating point value that is the upper bound of this "bin" index.

References success.

Delta()

double WsfATA_LaunchComputer::EvenlySpaced::Delta ( ) const

inline

GetIndex()

bool WsfATA_LaunchComputer::EvenlySpaced::GetIndex	(	double	aValue,
		unsigned int &	aIndex ) const

Get the "bin" index for a floating point value within its range.

Returns

False if outside the valid range of floating point values.

References Max(), and success.

GetNumBins()

unsigned int WsfATA_LaunchComputer::EvenlySpaced::GetNumBins ( ) const

inline

Max()

double WsfATA_LaunchComputer::EvenlySpaced::Max ( ) const

inline

Referenced by GetIndex().

Min()

double WsfATA_LaunchComputer::EvenlySpaced::Min ( ) const

inline

SetDelta()

void WsfATA_LaunchComputer::EvenlySpaced::SetDelta ( double aValue )

inline

SetMin()

void WsfATA_LaunchComputer::EvenlySpaced::SetMin ( double aValue )

inline

SetNumBins()

void WsfATA_LaunchComputer::EvenlySpaced::SetNumBins ( unsigned int aSize )

inline

---

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

• WsfATA_LaunchComputer.hpp
• WsfATA_LaunchComputer.cpp