#include <WsfSensorModeList.hpp>

Inheritance diagram for WsfSensorModeList:

Collaboration diagram for WsfSensorModeList:

[legend]

Public Member Functions
	WsfSensorModeList (WsfSensorMode *aTemplatePtr)
	WsfSensorModeList (const WsfSensorModeList &aSrc)
WsfSensorModeList	operator= (const WsfSensorModeList &aSrc)=delete
	WsfSensorModeList (const WsfSensorModeList &aSrc, WsfSensorMode aTemplatePtr, const std::vector< WsfSensorMode > &aModeList)
	A special copy constructor used by WsfCompositeSensor.
	~WsfSensorModeList () override=default
void	AddMode (WsfMode *aModePtr) override
Public Member Functions inherited from WsfModeList
	WsfModeList (WsfMode *aTemplatePtr)
	WsfModeList (const WsfModeList &aSrc)
	Copy constructor.
WsfModeList &	operator= (const WsfModeList &)=delete
virtual	~WsfModeList ()
bool	CanMultiSelect () const
size_t	GetCurrentMode () const
size_t	GetModeCount () const
WsfMode *	GetModeEntry (size_t aModeIndex) const
size_t	GetModeByName (WsfStringId aModeNameId) const
WsfStringId	GetModeNameId (size_t aModeIndex) const
WsfMode *	GetModeTemplate () const
	Returns the mode that is the 'mode_template' or the implicit mode.
virtual bool	Initialize ()
virtual bool	ProcessInput (UtInput &aInput)
	The standard ProcessInput method.
virtual void	Deselect (double aSimTime, WsfStringId aModeNameId)
virtual void	Select (double aSimTime, WsfStringId aModeNameId)
virtual void	TurnOff (double aSimTime)
virtual void	TurnOn (double aSimTime)
virtual double	GetModeSelectDelay ()
virtual bool	IsModeChangeScheduled () const
virtual void	SetModeChangeScheduled (bool aModeChangeScheduled)
template<class T>
void	GetDerivedModeList (std::vector< T > &aModeList) const

Friends
class	WsfSensor

Additional Inherited Members
Public Types inherited from WsfModeList
using	ModeList = std::vector<WsfMode*>
Static Public Member Functions inherited from WsfModeList
static WsfStringId	GetDefaultModeNameId ()
	Return the string id of the 'default' mode name.
Protected Member Functions inherited from WsfModeList
void	DeselectP (double aSimTime, size_t aModeIndex)
void	SelectP (double aSimTime, size_t aModeIndex)
Protected Attributes inherited from WsfModeList
std::vector< WsfMode * >	mModeList
	This list of modes.
WsfMode *	mTemplatePtr
	The mode that is the 'mode_template' or the implicit mode.
bool	mExplicitModeUsed
	'true' if 'mode' was or 'mode_template' has been used.
bool	mImplicitModeUsed
	'true' if a mode was implicitly defined without using 'mode' or 'mode_template'.
bool	mCanMultiSelect
WsfStringId	mInitialModeNameId
bool	mIsInitialized
	'true' if the system has been initialized
bool	mIsTurnedOn
	'true' if the system is currently turned on.
size_t	mCurrentModeIndex
	The vector index of the currently selected mode.
double	mModeSelectDelay
bool	mModeChangeScheduled
	The last successful mode selection time.

Detailed Description

A specialization of WsfModeList that provides for automatic linking of sensors to modes. A sensor is not required to use this, but it must use it if uses modes AND it wants to allow modes to invoke WsfSensorComponent methods.

Constructor & Destructor Documentation

◆ WsfSensorModeList() [1/3]

WsfSensorModeList::WsfSensorModeList ( WsfSensorMode * aTemplatePtr )

References WsfModeList::WsfModeList().

Referenced by operator=(), WsfSensor, WsfSensorModeList(), and WsfSensorModeList().

◆ WsfSensorModeList() [2/3]

WsfSensorModeList::WsfSensorModeList ( const WsfSensorModeList & aSrc )

References WsfModeList::WsfModeList(), and WsfSensorModeList().

◆ WsfSensorModeList() [3/3]

WsfSensorModeList::WsfSensorModeList	(	const WsfSensorModeList &	aSrc,
		WsfSensorMode *	aTemplatePtr,
		const std::vector< WsfSensorMode * > &	aModeList )

A special copy constructor used by WsfCompositeSensor.

References for(), WsfModeList::mCanMultiSelect, WsfModeList::mCurrentModeIndex, WsfModeList::mExplicitModeUsed, WsfModeList::mImplicitModeUsed, WsfModeList::mInitialModeNameId, WsfModeList::mIsInitialized, WsfModeList::mIsTurnedOn, WsfModeList::mModeChangeScheduled, WsfModeList::mModeList, WsfModeList::mModeSelectDelay, WsfModeList::WsfModeList(), and WsfSensorModeList().

◆ ~WsfSensorModeList()

WsfSensorModeList::~WsfSensorModeList ( )

overridedefault

References WsfSensor.

Member Function Documentation

◆ AddMode()

void WsfSensorModeList::AddMode ( WsfMode * aModePtr )

overridevirtual

Add a mode to the mode list.

Parameters

aModePtr Pointer to the mode object to be added. The mode list will assume ownership of the object and will delete it when the mode list is deleted.

Reimplemented from WsfModeList.

References WsfModeList::AddMode(), WsfSensorMode::GetBeamCount(), WsfSensorMode::GetBeamEntry(), and WsfSensorMode::mSensorPtr.

◆ operator=()

WsfSensorModeList WsfSensorModeList::operator= ( const WsfSensorModeList & aSrc )

delete

References WsfSensorModeList().

◆ WsfSensor

friend class WsfSensor

friend

References WsfSensor, and WsfSensorModeList().

Referenced by WsfSensor, and ~WsfSensorModeList().

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

Public Member Functions

Friends

Additional Inherited Members