#include <WsfCompositeOpticalSignature.hpp>

Inheritance diagram for WsfCompositeOpticalSignature:

[legend]

Collaboration diagram for WsfCompositeOpticalSignature:

[legend]

Classes
class	MyMat3d
class	Surface

Public Types
enum	{ cIV_TIME , cIV_THROTTLE , cIV_ALTITUDE , cIV_SPEED , cIV_MACH , cIV_COUNT }
enum	TemperatureType { cTT_UNDEFINED , cTT_TABLE , cTT_AMBIENT , cTT_ADIABATIC_WALL }
using	TablePtr = UtCloneablePtr<UtTable::Table>
Public Types inherited from WsfOpticalSignature
enum	{ cSIGNATURE_INDEX = 1 }
using	BandList = std::vector<WsfEM_Types::OpticalBand>
Public Types inherited from WsfObject
typedef std::vector< WsfStringId >	TypeList
	The list of types returned by GetTypeList.

Public Member Functions
	WsfCompositeOpticalSignature ()
	WsfCompositeOpticalSignature (const WsfCompositeOpticalSignature &aSrc)
	~WsfCompositeOpticalSignature () override
WsfCompositeOpticalSignature &	operator= (const WsfCompositeOpticalSignature &)=delete
WsfOpticalSignature *	Clone () const override
bool	Initialize (double aSimTime, WsfPlatform *aPlatformPtr) 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	GetSignature (double aSimTime, WsfStringId aStateId, double aAzimuth, double aElevation) override
bool	GetProjectedArea (double aSimTime, WsfStringId aStateId, double aAzimuth, double aElevation, double &aProjectedArea) override
bool	GetRadiantIntensity (double aSimTime, WsfStringId aStateId, const BandList &aBands, double aAzimuth, double aElevation, double &aRadiantIntensity) override
Public Member Functions inherited from WsfOpticalSignature
	WsfOpticalSignature ()
bool	UsesInherentContrast () const
Public Member Functions inherited from WsfSignature
	WsfSignature ()
	WsfSignature (const WsfSignature &aSrc)
WsfSignature &	operator= (const WsfSignature &)=delete
	~WsfSignature () override=default
virtual bool	IsA_ValidState (WsfStringId aId) const
bool	ProcessInput (UtInput &aInput) override
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 WsfOpticalSignature *	ObjectFactory (const std::string &aTypeName)
	Factory method called by WsfOpticalSignatureTypes.
static Surface *	SurfaceFactory (const std::string &aType, const Surface &aDefaultData)
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 aAzimuth, double aElevation)
static bool	GetProjectedArea (double aSimTime, WsfPlatform *aPlatformPtr, double aAzimuth, double aElevation, double &aProjectedArea)
static bool	GetRadiantIntensity (double aSimTime, WsfPlatform *aPlatformPtr, const BandList &aBands, double aAzimuth, double aElevation, double &aRadiantIntensity)
static bool	UsesInherentContrast (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
void	SetInherentContrast (bool aContrast)
	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

WsfCompositeOpticalSignature provides a dynamic, radiometric calculation of a platform's composite visual and infrared signatures. The basic shape of the platform is user-defined in terms of radiative surfaces (box, cone, cylinder, hemisphere) that are placed relative to each other. This geometry allows for projected area calculations that are used in the signature computations.

Member Typedef Documentation

◆ TablePtr

using WsfCompositeOpticalSignature::TablePtr = UtCloneablePtr<UtTable::Table>

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

Enumerator
cIV_TIME
cIV_THROTTLE
cIV_ALTITUDE
cIV_SPEED
cIV_MACH
cIV_COUNT

◆ TemperatureType

enum WsfCompositeOpticalSignature::TemperatureType

Enumerator
cTT_UNDEFINED
cTT_TABLE
cTT_AMBIENT
cTT_ADIABATIC_WALL

Constructor & Destructor Documentation

◆ WsfCompositeOpticalSignature() [1/2]

WsfCompositeOpticalSignature::WsfCompositeOpticalSignature ( )

References WsfSignature::mRequiresPlatform, and WsfOpticalSignature::WsfOpticalSignature().

Referenced by Clone(), ObjectFactory(), operator=(), and WsfCompositeOpticalSignature().

◆ WsfCompositeOpticalSignature() [2/2]

WsfCompositeOpticalSignature::WsfCompositeOpticalSignature ( const WsfCompositeOpticalSignature & aSrc )

References WsfCompositeOpticalSignature(), and WsfOpticalSignature::WsfOpticalSignature().

◆ ~WsfCompositeOpticalSignature()

WsfCompositeOpticalSignature::~WsfCompositeOpticalSignature ( )

override

Member Function Documentation

◆ Clone()

WsfOpticalSignature * WsfCompositeOpticalSignature::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 WsfOpticalSignature.

References WsfCompositeOpticalSignature(), and WsfOpticalSignature::WsfOpticalSignature().

◆ GetProjectedArea()

bool WsfCompositeOpticalSignature::GetProjectedArea	(	double	aSimTime,
		WsfStringId	aStateId,
		double	aAzimuth,
		double	aElevation,
		double &	aProjectedArea )

overridevirtual

Reimplemented from WsfOpticalSignature.

References WsfSignature::mPlatformPtr.

Referenced by GetSignature().

◆ GetRadiantIntensity()

bool WsfCompositeOpticalSignature::GetRadiantIntensity	(	double	aSimTime,
		WsfStringId	aStateId,
		const BandList &	aBands,
		double	aAzimuth,
		double	aElevation,
		double &	aRadiantIntensity )

overridevirtual

Reimplemented from WsfOpticalSignature.

References WsfCompositeOpticalSignature::Surface::RI_Input::mBands, WsfCompositeOpticalSignature::Surface::RI_Input::mPlatformPtr, WsfSignature::mPlatformPtr, and WsfCompositeOpticalSignature::Surface::RI_Input::mUnit_po.

◆ GetSignature()

float WsfCompositeOpticalSignature::GetSignature	(	double	aSimTime,
		WsfStringId	aStateId,
		double	aAzimuth,
		double	aElevation )

overridevirtual

Get the optical signature for a given set of conditions.

Parameters

aSimTime	[input] The current simulation time.
aStateId	[input] The string ID representing the signature state to be used.
aAzimuth	[input] The azimuth of the observer with respect to the target.
aElevation	[input] The elevation of the observer with respect to the target.

Returns: The optical cross section (m^2)

Implements WsfOpticalSignature.

References GetProjectedArea().

◆ GetStateNames()

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

overridevirtual

get the list of all valid states belonging to the signature

Reimplemented from WsfSignature.

◆ Initialize()

bool WsfCompositeOpticalSignature::Initialize	(	double	aSimTime,
		WsfPlatform *	aPlatformPtr )

overridevirtual

Initialize an instance to prepare for use in a simulation.

Parameters

aSimTime	The current simulation time.
aPlatformPtr	The platform to which the instance is attached.

Returns: true if successful.

Reimplemented from WsfSignature.

References WsfInfraredSignature::cSIGNATURE_INDEX, WsfSignatureInterface::GetInputType(), WsfSignature::Initialize(), WsfSignature::mPlatformPtr, ok, and WsfSignatureInterface::SetSignature().

◆ InitializeType()

bool WsfCompositeOpticalSignature::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()

WsfOpticalSignature * WsfCompositeOpticalSignature::ObjectFactory ( const std::string & aTypeName )

static

Factory method called by WsfOpticalSignatureTypes.

References WsfCompositeOpticalSignature(), and WsfOpticalSignature::WsfOpticalSignature().

Referenced by WsfMilExtension::AddedToScenario().

◆ operator=()

WsfCompositeOpticalSignature & WsfCompositeOpticalSignature::operator= ( const WsfCompositeOpticalSignature & )

delete

References SurfaceFactory(), WsfCompositeOpticalSignature(), and WsfOpticalSignature::WsfOpticalSignature().

◆ ProcessInput()

bool WsfCompositeOpticalSignature::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 WsfObject.

References WsfObject::ProcessInput(), and SurfaceFactory().

◆ SurfaceFactory()

WsfCompositeOpticalSignature::Surface * WsfCompositeOpticalSignature::SurfaceFactory	(	const std::string &	aType,
		const Surface &	aDefaultData )

static

Factory for surfaces.

Parameters

aType	The type of surface to be created.
aDefaultData	The default surface data (reflectance, temperature, etc.)

Returns: Pointer to the new instance or nullptr if the type was not valid.

Referenced by operator=(), and 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

◆ TablePtr

Member Enumeration Documentation

◆ anonymous enum

◆ TemperatureType

Constructor & Destructor Documentation

◆ WsfCompositeOpticalSignature() [1/2]

◆ WsfCompositeOpticalSignature() [2/2]

◆ ~WsfCompositeOpticalSignature()

Member Function Documentation

◆ Clone()

◆ GetProjectedArea()

◆ GetRadiantIntensity()

◆ GetSignature()

◆ GetStateNames()

◆ Initialize()

◆ InitializeType()

◆ ObjectFactory()

◆ operator=()

◆ ProcessInput()

◆ SurfaceFactory()