WsfOpticalPathCoefficientTypes Class Reference

#include <WsfOpticalPath.hpp>

Static methods to return a reference to the type list associated with a scenario.
using	Coefficients = WsfOpticalPath::LaserCoefficients
static WSF_MIL_EXPORT WsfOpticalPathCoefficientTypes &	Get (WsfScenario &aScenario)
	Return a modifiable reference to the type list associated with the specified scenario.
static WSF_MIL_EXPORT const WsfOpticalPathCoefficientTypes &	Get (const WsfScenario &aScenario)
	Return a const reference to the type list associated with the specified scenario.
WSF_MIL_EXPORT bool	LoadType (UtInput &aInput)
WSF_MIL_EXPORT const Coefficients &	GetCoefficients (unsigned aWavelength_nm, unsigned aAtmosphereModel=2, unsigned aHazeModel=1) const
	Convert parameters to a string in order to find the coefficient table.
WSF_MIL_EXPORT const Coefficients &	GetCoefficients (double aWavelength, unsigned aAtmosphereModel=2, unsigned aHazeModel=1) const
	Convert parameters to a string in order to find the coefficient table (deprecated version; see above).

Member Typedef Documentation

Coefficients

using WsfOpticalPathCoefficientTypes::Coefficients = WsfOpticalPath::LaserCoefficients

Member Function Documentation

Get() [1/2]

const WsfOpticalPathCoefficientTypes & WsfOpticalPathCoefficientTypes::Get ( const WsfScenario & aScenario )

static

Return a const reference to the type list associated with the specified scenario.

References WsfMilExtension::Get(), and WsfMilExtension::GetOpticalPathCoefficientTypes().

Get() [2/2]

WsfOpticalPathCoefficientTypes & WsfOpticalPathCoefficientTypes::Get ( WsfScenario & aScenario )

static

Return a modifiable reference to the type list associated with the specified scenario.

References WsfMilExtension::Get(), and WsfMilExtension::GetOpticalPathCoefficientTypes().

GetCoefficients() [1/2]

const WsfOpticalPathCoefficientTypes::Coefficients & WsfOpticalPathCoefficientTypes::GetCoefficients	(	double	aWavelength,
		unsigned	aAtmosphereModel = 2,
		unsigned	aHazeModel = 1 ) const

Convert parameters to a string in order to find the coefficient table (deprecated version; see above).

References GetCoefficients().

GetCoefficients() [2/2]

const WsfOpticalPathCoefficientTypes::Coefficients & WsfOpticalPathCoefficientTypes::GetCoefficients	(	unsigned	aWavelength_nm,
		unsigned	aAtmosphereModel = 2,
		unsigned	aHazeModel = 1 ) const

Convert parameters to a string in order to find the coefficient table.

Referenced by GetCoefficients(), WsfOpticalPath::Initialize(), WsfOpticalPath::WsfOpticalPath(), and WsfOpticalPath::WsfOpticalPath().

LoadType()

bool WsfOpticalPathCoefficientTypes::LoadType

(

UtInput &

aInput

)

This method will process input from a standard UtInput stream, placing filled tables in the mCoeffs map.

Parameters

aInput

aStandard input stream.

Returns

Whether the current input was processed.

---

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

• WsfOpticalPath.hpp
• WsfOpticalPath.cpp