A collection of one or more reflectivity tables that represent the reflectivity of a platform. More...

#include <WsfStandardOpticalReflectivity.hpp>

Inheritance diagram for WsfStandardOpticalReflectivity:

[legend]

Collaboration diagram for WsfStandardOpticalReflectivity:

[legend]

Classes
class	Table
	A table (i.e.: f(az,el)) for a given wavelength limit with a state. More...
class	State
	'State' represents all of the tables for a given state. More...

Public Types
using	TableSet = std::vector<Table>
	A 'TableSet' is just a collection of 'Table's.
using	States = std::vector<State>
Public Types inherited from WsfOpticalReflectivity
enum	{ cSIGNATURE_INDEX = 3 }
Public Types inherited from WsfObject
typedef std::vector< WsfStringId >	TypeList
	The list of types returned by GetTypeList.

Public Member Functions
	WsfStandardOpticalReflectivity ()=default
WsfStandardOpticalReflectivity *	Clone () const override
bool	InitializeType () override
std::vector< WsfStringId >	GetStateNames () const override
	get the list of all valid states belonging to the signature
bool	ProcessInput (UtInput &aInput) override
float	GetOpticalReflectivity (double aSimTime, WsfStringId aStateId, double aWavelength, double aTgtToXmtrAz, double aTgtToXmtrEl, double aTgtToRcvrAz, double aTgtToRcvrEl) override
const States &	GetStates () const
Public Member Functions inherited from WsfOpticalReflectivity
	WsfOpticalReflectivity ()
Public Member Functions inherited from WsfSignature
	WsfSignature ()
	WsfSignature (const WsfSignature &aSrc)
WsfSignature &	operator= (const WsfSignature &)=delete
	~WsfSignature () override=default
virtual bool	Initialize (double aSimTime, WsfPlatform *aPlatformPtr)
virtual bool	IsA_ValidState (WsfStringId aId) const
bool	RequiresPlatform () const
	indicates that a signature can be queried without a valid mPlatform
Public Member Functions inherited from WsfObject
	WsfObject ()
	This is the constructor for the WsfObject class.
	~WsfObject () override
	This is the destructor for the WsfObject class.
const char *	GetScriptClassName () const override
const std::string &	GetType () const
WsfStringId	GetTypeId () const
	Get the string ID of the 'type' of the object.
void	SetType (WsfStringId aType)
const std::string &	GetBaseType () const
WsfStringId	GetBaseTypeId () const
const TypeList &	GetTypeList () const
bool	IsA_TypeOf (WsfStringId aType) const
WsfObject &	operator= (const WsfObject &aRhs)
	Assignment operator.
template<typename T>
void	Serialize (T &aBuff)
	For XIO (de)serialization.
const std::string &	GetName () const
WsfStringId	GetNameId () const
void	SetName (WsfStringId aName)

Static Public Member Functions
static WsfOpticalReflectivity *	ObjectFactory (const std::string &aTypeName)
	Factory method called by WsfOpticalReflectivityTypes.
static WsfStringId	GetInputType (WsfPlatform *aPlatformPtr)
static WsfStringId	GetState (WsfPlatform *aPlatformPtr)
static bool	SetState (WsfPlatform *aPlatformPtr, WsfStringId aState)
static float	GetScaleFactor (WsfPlatform *aPlatformPtr)
static bool	SetScaleFactor (WsfPlatform *aPlatformPtr, float aScaleFactor)
static float	GetValue (double aSimTime, WsfPlatform *aPlatformPtr, double aWavelength, double aTgtToXmtrAz, double aTgtToXmtrEl, double aTgtToRcvrAz, double aTgtToRcvrEl)
static WsfOpticalReflectivity *	GetObject (WsfPlatform *aPlatformPtr)
static void	RegisterScriptMethods (UtScriptTypes &aScriptTypes)
static void	RegisterInterface (WsfScenario &aScenario)
	Register the platform interface object on the prototype signature list in the specified scenario.

Additional Inherited Members
	WsfObject (const WsfObject &aSrc)
	Copy constructor (for Clone()).
Static Protected Member Functions inherited from WsfSignature
template<class SignatureState, WsfStringId SignatureState::* IdMember, typename Iterator>
static std::vector< WsfStringId >	GetStateNamesP (Iterator aBegin, Iterator aEnd)
Protected Attributes inherited from WsfSignature
WsfPlatform *	mPlatformPtr
double	mBaseTime
bool	mRequiresPlatform {false}

Detailed Description

A collection of one or more reflectivity tables that represent the reflectivity of a platform.

Member Typedef Documentation

◆ States

using WsfStandardOpticalReflectivity::States = std::vector<State>

◆ TableSet

using WsfStandardOpticalReflectivity::TableSet = std::vector<Table>

A 'TableSet' is just a collection of 'Table's.

Constructor & Destructor Documentation

◆ WsfStandardOpticalReflectivity()

WsfStandardOpticalReflectivity::WsfStandardOpticalReflectivity ( )

default

References WsfStandardOpticalReflectivity().

Referenced by Clone(), ObjectFactory(), and WsfStandardOpticalReflectivity().

Member Function Documentation

◆ Clone()

WsfStandardOpticalReflectivity * WsfStandardOpticalReflectivity::Clone ( ) const

overridevirtual

Return a copy of this object. Must be implemented by all derived types. If cloning is impossible, a WsfUncloneableException should be thrown.

Implements WsfOpticalReflectivity.

References WsfStandardOpticalReflectivity().

◆ GetOpticalReflectivity()

float WsfStandardOpticalReflectivity::GetOpticalReflectivity	(	double	aSimTime,
		WsfStringId	aStateId,
		double	aWavelength,
		double	aTgtToXmtrAz,
		double	aTgtToXmtrEl,
		double	aTgtToRcvrAz,
		double	aTgtToRcvrEl )

overridevirtual

Get the optical reflectivity for a given set of conditions.

Parameters

aSimTime	[input] The simulation time.
aStateId	[input] The string ID representing the signature state to be used.
aWavelength	[input] The wavelength of the signal (meters).
aTgtToXmtrAz	[input] The azimuth of the transmitter with respect to the target (radians).
aTgtToXmtrEl	[input] The elevation of the transmitter with respect to the target (radians).
aTgtToRcvrAz	[input] The azimuth of the receiver with respect to the target (radians).
aTgtToRcvrEl	[input] The elevation of the receiver with respect to the target (radians).

Returns: The optical reflectivity (1/steradian)

Implements WsfOpticalReflectivity.

◆ GetStateNames()

std::vector< WsfStringId > WsfStandardOpticalReflectivity::GetStateNames ( ) const

overridevirtual

get the list of all valid states belonging to the signature

Reimplemented from WsfSignature.

References WsfSignature::GetStateNamesP(), and GetStates().

◆ GetStates()

const std::vector< WsfStandardOpticalReflectivity::State > & WsfStandardOpticalReflectivity::GetStates ( ) const

Returns: The signatures for all of defined states.

Note: This method was created to allow applications access to signature data. It should not be used to look up signatures.

Referenced by GetStateNames().

◆ InitializeType()

bool WsfStandardOpticalReflectivity::InitializeType ( )

overridevirtual

Initialize an signature 'type' instance. This is called by WsfObjectTypeList::LoadType after all the input for the instance has been read.

Returns: true if successful.

Reimplemented from WsfSignature.

References WsfSignature::InitializeType(), and ok.

◆ ObjectFactory()

WsfOpticalReflectivity * WsfStandardOpticalReflectivity::ObjectFactory ( const std::string & aTypeName )

static

Factory method called by WsfOpticalReflectivityTypes.

References WsfOpticalReflectivity::WsfOpticalReflectivity(), and WsfStandardOpticalReflectivity().

Referenced by WsfOpticalReflectivityTypes::WsfOpticalReflectivityTypes().

◆ ProcessInput()

bool WsfStandardOpticalReflectivity::ProcessInput ( UtInput & aInput )

overridevirtual

Process input from a generic source.

Examine the current input command. If it is NOT one of the commands recognized by this class then it simply returns 'false'. If it is one of the commands recognized by this class then it processes the command and returns 'true'.

Parameters

aInput a reference to a UtInput object.

Returns: 'true' if the command was one recognized by the class or 'false' if not.

Exceptions

UtInput::ExceptionBase (or an object derived from it) if the command was recognized but contains some sort of error.

Note: If a derived class does not recognize the command (i.e.: the return value is false) then it should call the base class ProcessInput method. This chain should continue until either the command is recognized or the top-level base class is encountered.

Reimplemented from WsfSignature.

References WsfObject::ProcessInput().

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

Classes

Public Types

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ States

◆ TableSet

Constructor & Destructor Documentation

◆ WsfStandardOpticalReflectivity()

Member Function Documentation

◆ Clone()

◆ GetOpticalReflectivity()

◆ GetStateNames()

◆ GetStates()

◆ InitializeType()

◆ ObjectFactory()

◆ ProcessInput()