WsfMultiThreadManager Class Reference

A specialization class to handle multi-thread capabilities in the WSF core framework via thread pools. More...

#include <WsfMultiThreadManager.hpp>

Classes
class	PlatformElement
class	SensorElement
class	SimulationUpdateThread
	Implementation of worker thread for updating a platform. More...
struct	ThreadFactory

Public Member Functions
	WsfMultiThreadManager (unsigned int aNumberOfThreads, double aBreakUpdateTime, bool aDebugMultiThread, WsfSimulation *aSimulationPtr)
	Constructor.
virtual	~WsfMultiThreadManager ()
void	Initialize ()
void	Complete (double aSimTime)

Priority queue methods.
class	SimulationUpdateThread
bool	PlatformsQueued ()
bool	PopNextPlatformElement (PlatformElement &aPlatformElement)
bool	SensorsQueued ()
bool	PopNextSensorElement (SensorElement &aSensorElement)

Main update methods.
void	UpdatePlatforms (double aCurrentTime)
void	UpdateSensors (double aCurrentTime)
bool	BreakUpdate ()

Platform and Sensor methods
void	AddPlatform (double aSimTime, WsfPlatform *aPlatformPtr)
void	PlatformIntroduced (double aSimTime, WsfPlatform *aPlatformPtr)
void	DeletePlatform (double aSimTime, WsfPlatform *aOldPlatformPtr)
void	PlatformDeleted (double aSimTime, WsfPlatform *aOldPlatformPtr)
void	TurnSensorOff (double aSimTime, WsfSensor *aSensorPtr)
void	TurnSensorOn (double aSimTime, WsfSensor *aSensorPtr)

Detailed Description

A specialization class to handle multi-thread capabilities in the WSF core framework via thread pools.

Current implementation allows for threaded platform (i.e. mover) and sensor updates.

Constructor & Destructor Documentation

WsfMultiThreadManager()

WsfMultiThreadManager::WsfMultiThreadManager	(	unsigned int	aNumberOfThreads,
		double	aBreakUpdateTime,
		bool	aDebugMultiThread,
		WsfSimulation *	aSimulationPtr )

Constructor.

Referenced by SimulationUpdateThread, WsfMultiThreadManager::SimulationUpdateThread::SimulationUpdateThread(), and WsfMultiThreadManager::ThreadFactory::ThreadFactory().

~WsfMultiThreadManager()

WsfMultiThreadManager::~WsfMultiThreadManager ( )

virtual

Member Function Documentation

AddPlatform()

void WsfMultiThreadManager::AddPlatform	(	double	aSimTime,
		WsfPlatform *	aPlatformPtr )

References WsfPlatform::GetIndex(), WsfPlatform::GetMover(), WsfPlatform::SetUpdateLocked(), and WsfMover::ThreadSafe().

Referenced by WsfFrameStepSimulation::AddPlatform(), and PlatformIntroduced().

BreakUpdate()

bool WsfMultiThreadManager::BreakUpdate ( )

inline

Complete()

void WsfMultiThreadManager::Complete

(

double

aSimTime

)

Referenced by WsfEventStepSimulation::Complete(), and WsfFrameStepSimulation::Complete().

DeletePlatform()

void WsfMultiThreadManager::DeletePlatform	(	double	aSimTime,
		WsfPlatform *	aOldPlatformPtr )

References WsfComponentList::RoleIterator< T >::AtEnd(), and WsfPlatform::GetIndex().

Referenced by PlatformDeleted().

Initialize()

void WsfMultiThreadManager::Initialize

(

)

Referenced by WsfEventStepSimulation::Initialize(), and WsfFrameStepSimulation::Initialize().

PlatformDeleted()

void WsfMultiThreadManager::PlatformDeleted ( double aSimTime, WsfPlatform * aOldPlatformPtr )

inline

References DeletePlatform().

Referenced by WsfFrameStepSimulation::DeletePlatform(), and WsfEventStepSimulation::PlatformDeleted().

PlatformIntroduced()

void WsfMultiThreadManager::PlatformIntroduced ( double aSimTime, WsfPlatform * aPlatformPtr )

inline

References AddPlatform().

Referenced by WsfEventStepSimulation::PlatformIntroduced().

PlatformsQueued()

bool WsfMultiThreadManager::PlatformsQueued ( )

inlineprotected

PopNextPlatformElement()

bool WsfMultiThreadManager::PopNextPlatformElement ( PlatformElement & aPlatformElement )

protected

PopNextSensorElement()

bool WsfMultiThreadManager::PopNextSensorElement ( SensorElement & aSensorElement )

protected

SensorsQueued()

bool WsfMultiThreadManager::SensorsQueued ( )

inlineprotected

TurnSensorOff()

void WsfMultiThreadManager::TurnSensorOff	(	double	aSimTime,
		WsfSensor *	aSensorPtr )

Referenced by WsfPlatformPartEvent::Execute(), and WsfFrameStepSimulation::TurnPartOffP().

TurnSensorOn()

void WsfMultiThreadManager::TurnSensorOn	(	double	aSimTime,
		WsfSensor *	aSensorPtr )

References WsfPlatformPart::IsExternallyControlled(), WsfSensor::IsSlave(), and WsfSensor::ThreadSafe().

Referenced by WsfPlatformPartEvent::Execute(), and WsfFrameStepSimulation::TurnPartOnP().

UpdatePlatforms()

void WsfMultiThreadManager::UpdatePlatforms

(

double

aCurrentTime

)

References WsfObserver::FramePlatformsUpdated(), and platformPtr.

Referenced by WsfFrameStepSimulation::AdvanceFrame().

UpdateSensors()

void WsfMultiThreadManager::UpdateSensors

(

double

aCurrentTime

)

Referenced by WsfFrameStepSimulation::AdvanceFrame().

Friends And Related Symbol Documentation

SimulationUpdateThread

friend class SimulationUpdateThread

friend

References WsfMultiThreadManager().

Referenced by WsfMultiThreadManager::ThreadFactory::operator()().

---

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

• WsfMultiThreadManager.hpp
• WsfMultiThreadManager.cpp