#include <WsfSpaceOpticalSignature.hpp>

Inheritance diagram for WsfSpaceOpticalSignature:

[legend]

Collaboration diagram for WsfSpaceOpticalSignature:

[legend]

Classes
class	MyMat3d
struct	Data
class	Surface

Public Member Functions
	WsfSpaceOpticalSignature ()
	WsfSpaceOpticalSignature (const WsfSpaceOpticalSignature &aSrc)
	~WsfSpaceOpticalSignature () override=default
WsfSpaceOpticalSignature &	operator= (const WsfSpaceOpticalSignature &)=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	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
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.
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

WsfSpaceOpticalSignature provides the visual/infrared signature and projected area for space platforms based on the position of the Sun.

Constructor & Destructor Documentation

◆ WsfSpaceOpticalSignature() [1/2]

WsfSpaceOpticalSignature::WsfSpaceOpticalSignature ( )

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

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

◆ WsfSpaceOpticalSignature() [2/2]

WsfSpaceOpticalSignature::WsfSpaceOpticalSignature ( const WsfSpaceOpticalSignature & aSrc )

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

◆ ~WsfSpaceOpticalSignature()

WsfSpaceOpticalSignature::~WsfSpaceOpticalSignature ( )

overridedefault

Member Function Documentation

◆ Clone()

WsfOpticalSignature * WsfSpaceOpticalSignature::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 WsfOpticalSignature::WsfOpticalSignature(), and WsfSpaceOpticalSignature().

◆ GetProjectedArea()

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

overridevirtual

Reimplemented from WsfOpticalSignature.

References WsfSignature::mPlatformPtr.

Referenced by GetSignature().

◆ GetRadiantIntensity()

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

overridevirtual

Reimplemented from WsfOpticalSignature.

References WsfSignature::mPlatformPtr, WsfSpaceOpticalSignature::Data::mTemp_p, and WsfSpaceOpticalSignature::Data::mUnit_po.

◆ GetSignature()

float WsfSpaceOpticalSignature::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 > WsfSpaceOpticalSignature::GetStateNames ( ) const

overridevirtual

get the list of all valid states belonging to the signature

Reimplemented from WsfSignature.

References WsfSignature::GetStateNamesP().

◆ Initialize()

bool WsfSpaceOpticalSignature::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 WsfSpaceOpticalSignature::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 * WsfSpaceOpticalSignature::ObjectFactory ( const std::string & aTypeName )

static

Factory method called by WsfOpticalSignatureTypes.

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

Referenced by WsfSpaceExtension::AddedToScenario().

◆ operator=()

WsfSpaceOpticalSignature & WsfSpaceOpticalSignature::operator= ( const WsfSpaceOpticalSignature & )

delete

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

◆ ProcessInput()

bool WsfSpaceOpticalSignature::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 WsfOpticalEnvironment::PrintComputedData(), and WsfObject::ProcessInput().

◆ SurfaceFactory()

WsfSpaceOpticalSignature::Surface * WsfSpaceOpticalSignature::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=().

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

Classes

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ WsfSpaceOpticalSignature() [1/2]

◆ WsfSpaceOpticalSignature() [2/2]

◆ ~WsfSpaceOpticalSignature()

Member Function Documentation

◆ Clone()

◆ GetProjectedArea()

◆ GetRadiantIntensity()

◆ GetSignature()

◆ GetStateNames()

◆ Initialize()

◆ InitializeType()

◆ ObjectFactory()

◆ operator=()

◆ ProcessInput()

◆ SurfaceFactory()