WsfSignatureInterface Class Reference

#include <WsfSignatureInterface.hpp>

Collaboration diagram for WsfSignatureInterface:

Public Member Functions
	WsfSignatureInterface ()
	WsfSignatureInterface (const WsfSignatureInterface &aSrc)
WsfSignatureInterface &	operator= (const WsfSignatureInterface &)=delete
virtual	~WsfSignatureInterface ()
virtual std::string	GetClassName () const =0
virtual std::string	GetShortName () const =0
virtual WsfSignatureInterface *	Clone () const =0
virtual WsfSignature *	CloneSignature (const WsfScenario &aScenario) const =0
virtual bool	Initialize (double aSimTime, WsfPlatform *aPlatformPtr)
virtual bool	ProcessInput (UtInput &aInput)

Get/Set methods for the member variables.
No extra documentation is provided as they should be self-explanatory.
WsfVariable< WsfStringId >	mInputType
	The type of the signature specified by the user.
WsfStringId	mState
	The current configuration state.
float	mScaleFactor
	An additional scale factor to be applied to the raw signature value before returning it to the user.
WsfSignature *	mSignaturePtr
	Pointer to the raw signature.
WsfStringId	GetInputType () const
WsfStringId	GetState () const
void	SetState (WsfStringId aState)
float	GetScaleFactor () const
void	SetScaleFactor (float aScaleFactor)
WsfSignature *	GetSignature () const
void	SetSignature (WsfSignature *aSignaturePtr)

Detailed Description

Abstract class that defines the interface between a platform and a signature.

A signature class must provide at least the GetClassName(), GetShortName(), Clone() and CloneSignature() methods. The other virtual methods may be overridden if something other than the default behavior is desired for platform input and initialization procession.

Constructor & Destructor Documentation

WsfSignatureInterface() [1/2]

WsfSignatureInterface::WsfSignatureInterface

(

)

References mInputType, mScaleFactor, mSignaturePtr, and mState.

Referenced by Clone(), operator=(), and WsfSignatureInterface().

WsfSignatureInterface() [2/2]

WsfSignatureInterface::WsfSignatureInterface

(

const WsfSignatureInterface &

aSrc

)

References mInputType, mScaleFactor, mSignaturePtr, mState, and WsfSignatureInterface().

~WsfSignatureInterface()

WsfSignatureInterface::~WsfSignatureInterface ( )

virtual

References mSignaturePtr.

Member Function Documentation

Clone()

virtual WsfSignatureInterface * WsfSignatureInterface::Clone ( ) const

pure virtual

References WsfSignatureInterface().

CloneSignature()

virtual WsfSignature * WsfSignatureInterface::CloneSignature ( const WsfScenario & aScenario ) const

pure virtual

References Initialize(), and ProcessInput().

Referenced by Initialize().

GetClassName()

virtual std::string WsfSignatureInterface::GetClassName ( ) const

pure virtual

Referenced by Initialize(), ProcessInput(), and WsfSignatureList::SetState().

GetInputType()

WsfStringId WsfSignatureInterface::GetInputType ( ) const

inline

References mInputType.

Referenced by WsfCompositeOpticalSignature::Initialize(), and WsfSpaceOpticalSignature::Initialize().

GetScaleFactor()

float WsfSignatureInterface::GetScaleFactor ( ) const

inline

References mScaleFactor.

Referenced by WsfSignatureList::SetScaleFactor().

GetShortName()

virtual std::string WsfSignatureInterface::GetShortName ( ) const

pure virtual

GetSignature()

WsfSignature * WsfSignatureInterface::GetSignature ( ) const

inline

References mSignaturePtr.

Referenced by WsfSignatureList::SetState().

GetState()

WsfStringId WsfSignatureInterface::GetState ( ) const

inline

References mState.

Referenced by WsfSignatureList::SetState().

Initialize()

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

virtual

References CloneSignature(), GetClassName(), WsfPlatform::GetScenario(), WsfPlatform::GetScriptContext(), WsfSimulation::GetScriptContext(), WsfPlatform::GetSimulation(), mInputType, mSignaturePtr, and ok.

Referenced by CloneSignature().

operator=()

WsfSignatureInterface & WsfSignatureInterface::operator= ( const WsfSignatureInterface & )

delete

References WsfSignatureInterface().

ProcessInput()

bool WsfSignatureInterface::ProcessInput ( UtInput & aInput )

virtual

References GetClassName(), and mInputType.

Referenced by CloneSignature().

SetScaleFactor()

void WsfSignatureInterface::SetScaleFactor ( float aScaleFactor )

inline

References mScaleFactor.

Referenced by WsfSignatureList::SetScaleFactor().

SetSignature()

void WsfSignatureInterface::SetSignature

(

WsfSignature *

aSignaturePtr

)

References mSignaturePtr.

Referenced by WsfCompositeOpticalSignature::Initialize(), and WsfSpaceOpticalSignature::Initialize().

SetState()

void WsfSignatureInterface::SetState ( WsfStringId aState )

inline

References mState.

Referenced by WsfSignatureList::SetState().

Member Data Documentation

mInputType

WsfVariable<WsfStringId> WsfSignatureInterface::mInputType

protected

The type of the signature specified by the user.

Referenced by GetInputType(), Initialize(), ProcessInput(), WsfSignatureInterface(), and WsfSignatureInterface().

mScaleFactor

float WsfSignatureInterface::mScaleFactor

protected

An additional scale factor to be applied to the raw signature value before returning it to the user.

Referenced by GetScaleFactor(), SetScaleFactor(), WsfSignatureInterface(), and WsfSignatureInterface().

mSignaturePtr

WsfSignature* WsfSignatureInterface::mSignaturePtr

protected

Pointer to the raw signature.

Referenced by GetSignature(), Initialize(), SetSignature(), WsfSignatureInterface(), WsfSignatureInterface(), and ~WsfSignatureInterface().

mState

WsfStringId WsfSignatureInterface::mState

protected

The current configuration state.

Referenced by GetState(), SetState(), WsfSignatureInterface(), and WsfSignatureInterface().

---

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

• WsfSignatureInterface.hpp
• WsfSignatureInterface.cpp