WsfSignatureList Class Reference

#include <WsfSignatureList.hpp>

Public Types
typedef WsfSignatureInterface	Interface
	Make typing easier..

Public Member Functions
	WsfSignatureList ()
	WsfSignatureList (const WsfSignatureList &aSrc, WsfPlatform *aPlatformPtr)
	~WsfSignatureList ()
void	AddInterface (Interface *aInterfacePtr, size_t aIndex)
Interface *	GetInterface (size_t aIndex)
	Return the pointer to the interface with the specified index.
bool	Initialize (double aSimTime)
bool	ProcessInput (UtInput &aInput)
void	SetState (WsfStringId aState, const std::string &aType)
std::string	GetClassName (size_t aIndex) const
WsfStringId	GetInputType (size_t aIndex) const
WsfStringId	GetState (size_t aIndex) const
bool	SetState (size_t aIndex, WsfStringId aState)
float	GetScaleFactor (size_t aIndex) const
bool	SetScaleFactor (size_t aIndex, float aScaleFactor)

Detailed Description

Platform interface to signatures (observables).

This class has two main purposes: -) Provide the means to link the platform to its various signatures. -) Provide the interface by which sensors can RAPIDLY access the signatures.

There is an instance of this on every platform and another that is stored on the scenario. The later instance is a skeleton object that is populated during scenario creation when each signature 'type list' is added to the scenario. This skeleton is the initial copy that is attached to each platform.

Member Typedef Documentation

Interface

typedef WsfSignatureInterface WsfSignatureList::Interface

Make typing easier..

Constructor & Destructor Documentation

WsfSignatureList() [1/2]

WsfSignatureList::WsfSignatureList

(

)

Referenced by WsfSignatureList().

WsfSignatureList() [2/2]

WsfSignatureList::WsfSignatureList	(	const WsfSignatureList &	aSrc,
		WsfPlatform *	aPlatformPtr )

References for(), and WsfSignatureList().

~WsfSignatureList()

WsfSignatureList::~WsfSignatureList

(

)

Member Function Documentation

AddInterface()

void WsfSignatureList::AddInterface	(	Interface *	aInterfacePtr,
		size_t	aIndex )

Add a signature item to the prototype signature list.

Parameters

aInterfacePtr	The pointer to the interface. The class assumes ownership.
aIndex	The index of the signature. This must be unique. An exception will be thrown if it is not unique.

Note

This should be called ONLY by the signature type objects or their surrogate.

Referenced by WsfAcousticSignature::RegisterInterface(), WsfInfraredSignature::RegisterInterface(), WsfInherentContrast::RegisterInterface(), WsfOpticalReflectivity::RegisterInterface(), WsfOpticalSignature::RegisterInterface(), and WsfRadarSignature::RegisterInterface().

GetClassName()

std::string WsfSignatureList::GetClassName

(

size_t

aIndex

)

const

Referenced by wsf::event::PlatformAppearanceChanged::Print(), and wsf::event::PlatformAppearanceChanged::PrintCSV().

GetInputType()

WsfStringId WsfSignatureList::GetInputType

(

size_t

aIndex

)

const

Referenced by WsfAcousticSignature::GetInputType(), WsfInfraredSignature::GetInputType(), WsfInherentContrast::GetInputType(), WsfOpticalReflectivity::GetInputType(), WsfOpticalSignature::GetInputType(), and WsfRadarSignature::GetInputType().

GetInterface()

Interface * WsfSignatureList::GetInterface ( size_t aIndex )

inline

Return the pointer to the interface with the specified index.

Referenced by WsfOpticalSignature::UsesInherentContrast().

GetScaleFactor()

float WsfSignatureList::GetScaleFactor

(

size_t

aIndex

)

const

Referenced by WsfAcousticSignature::GetScaleFactor(), WsfInfraredSignature::GetScaleFactor(), WsfInherentContrast::GetScaleFactor(), WsfOpticalReflectivity::GetScaleFactor(), WsfOpticalSignature::GetScaleFactor(), WsfRadarSignature::GetScaleFactor(), wsf::event::PlatformAppearanceChanged::Print(), and wsf::event::PlatformAppearanceChanged::PrintCSV().

GetState()

WsfStringId WsfSignatureList::GetState

(

size_t

aIndex

)

const

Referenced by WsfAcousticSignature::GetState(), WsfInfraredSignature::GetState(), WsfInherentContrast::GetState(), WsfOpticalReflectivity::GetState(), WsfOpticalSignature::GetState(), WsfRadarSignature::GetState(), wsf::event::PlatformAppearanceChanged::Print(), and wsf::event::PlatformAppearanceChanged::PrintCSV().

Initialize()

bool WsfSignatureList::Initialize

(

double

aSimTime

)

References ok.

Referenced by WsfPlatform::Initialize().

ProcessInput()

bool WsfSignatureList::ProcessInput

(

UtInput &

aInput

)

References ProcessInput().

Referenced by ProcessInput().

SetScaleFactor()

bool WsfSignatureList::SetScaleFactor	(	size_t	aIndex,
		float	aScaleFactor )

References WsfObserver::cSIGNATURE_SCALE_FACTOR_START, WsfSignatureInterface::GetScaleFactor(), ok, WsfObserver::PlatformAppearanceChanged(), and WsfSignatureInterface::SetScaleFactor().

Referenced by WsfAcousticSignature::SetScaleFactor(), WsfInfraredSignature::SetScaleFactor(), WsfInherentContrast::SetScaleFactor(), WsfOpticalReflectivity::SetScaleFactor(), WsfOpticalSignature::SetScaleFactor(), and WsfRadarSignature::SetScaleFactor().

SetState() [1/2]

bool WsfSignatureList::SetState	(	size_t	aIndex,
		WsfStringId	aState )

References WsfObserver::cSIGNATURE_STATE_START, WsfSignatureInterface::GetClassName(), WsfSignatureInterface::GetSignature(), WsfSignatureInterface::GetState(), WsfSignature::IsA_ValidState(), WsfObserver::PlatformAppearanceChanged(), and WsfSignatureInterface::SetState().

SetState() [2/2]

void WsfSignatureList::SetState	(	WsfStringId	aState,
		const std::string &	aType )

Set the signature state for the given type of signature.

Parameters

aState	The string Id of the new signature state.
aType	The string of the type of signature to change the state of.

References SetState().

Referenced by WsfAcousticSignature::SetState(), WsfInfraredSignature::SetState(), WsfInherentContrast::SetState(), WsfOpticalReflectivity::SetState(), WsfOpticalSignature::SetState(), WsfRadarSignature::SetState(), SetState(), and WsfDisInterface::UpdatePlatformFromAppearance().

---

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

• WsfSignatureList.hpp
• WsfSignatureList.cpp