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

#include <WsfStandardInherentContrast.hpp>

Inheritance diagram for WsfStandardInherentContrast:

[legend]

Collaboration diagram for WsfStandardInherentContrast:

[legend]

Public Member Functions
	WsfStandardInherentContrast ()=default
WsfStandardInherentContrast *	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	GetInherentContrast (WsfStringId aStateId, double aAzimuth, double aElevation) override
Public Member Functions inherited from WsfInherentContrast
	WsfInherentContrast ()
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 WsfInherentContrast *	ObjectFactory (const std::string &aTypeName)
	Factory method called by WsfInherentContrastTypes.
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 (WsfPlatform *aPlatformPtr, double aAzimuth, double aElevation, bool aLogWarning=true)
static WsfInherentContrast *	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
Public Types inherited from WsfInherentContrast
enum	{ cSIGNATURE_INDEX = 4 }
Public Types inherited from WsfObject
typedef std::vector< WsfStringId >	TypeList
	The list of types returned by GetTypeList.
	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 inherent contrast tables that represent the inherent contrast of a platform.

Constructor & Destructor Documentation

◆ WsfStandardInherentContrast()

WsfStandardInherentContrast::WsfStandardInherentContrast ( )

default

References WsfStandardInherentContrast().

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

Member Function Documentation

◆ Clone()

WsfStandardInherentContrast * WsfStandardInherentContrast::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 WsfInherentContrast.

References WsfStandardInherentContrast().

◆ GetInherentContrast()

float WsfStandardInherentContrast::GetInherentContrast	(	WsfStringId	aStateId,
		double	aAzimuth,
		double	aElevation )

overridevirtual

Get the inherent contrast.

Parameters

aStateId	[input] The string ID representing the signature state to be used.
aAzimuth	[input] azimuth of the observer with respect to this platform (radians).
aElevation	[input] elevation of the observer with respect to this platform (radians).

Returns: The inherent contrast (non-dimensional)

Implements WsfInherentContrast.

◆ GetStateNames()

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

overridevirtual

get the list of all valid states belonging to the signature

Reimplemented from WsfSignature.

References WsfSignature::GetStateNamesP().

◆ InitializeType()

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

WsfInherentContrast * WsfStandardInherentContrast::ObjectFactory ( const std::string & aTypeName )

static

Factory method called by WsfInherentContrastTypes.

References WsfInherentContrast::WsfInherentContrast(), and WsfStandardInherentContrast().

Referenced by WsfInherentContrastTypes::WsfInherentContrastTypes().

◆ ProcessInput()

bool WsfStandardInherentContrast::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:

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ WsfStandardInherentContrast()

Member Function Documentation

◆ Clone()

◆ GetInherentContrast()

◆ GetStateNames()

◆ InitializeType()

◆ ObjectFactory()

◆ ProcessInput()