#include <WsfPlatformPart.hpp>

Inheritance diagram for WsfPlatformPart:

[legend]

Collaboration diagram for WsfPlatformPart:

[legend]

Public Types
enum	{ cLEVEL_ONE_DEBUG = 0x00000001 , cLEVEL_TWO_DEBUG = 0x00000002 }
using	InternalMessageQueue = std::queue<WsfMessage*>
using	RecipientMessageQueue = std::queue<std::pair<WsfPlatformPart, WsfMessage>>
Public Types inherited from WsfObject
typedef std::vector< WsfStringId >	TypeList
	The list of types returned by GetTypeList.
Public Types inherited from WsfComponentT< WsfPlatform >
typedef WsfPlatform	ParentType
	This is needed to support the WsfComponentList template.

Public Member Functions
	WsfPlatformPart (const WsfScenario &aScenario, int aPartType)
WsfPlatformPart &	operator= (const WsfPlatformPart &aRhs)=delete
	~WsfPlatformPart () override
const int *	GetComponentRoles () const override
void *	QueryInterface (int aRole) override
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
virtual WsfObject *	Clone () const =0
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)
Public Member Functions inherited from WsfComponentT< WsfPlatform >
	WsfComponentT ()
	WsfComponentT (const WsfComponentT &) noexcept
WsfComponentT &	operator= (const WsfComponentT &) noexcept
	~WsfComponentT () override=default
ParentType *	GetComponentParent () const
void	SetComponentParent (ParentType *aParentPtr)
Public Member Functions inherited from WsfComponent
virtual	~WsfComponent ()=default
virtual WsfComponent *	CloneComponent () const =0
virtual int	GetComponentInitializationOrder () const
template<typename T>
bool	QueryInterfaceT (T *&aRolePtr)
bool	ComponentHasRole (int aRole)
	Returns true if the component has the specified role.
virtual bool	PreInitialize (double aSimTime)
virtual void	PreInput ()
Public Member Functions inherited from WsfUniqueId
	WsfUniqueId ()
	Construtor initializes the unique identifier to 0.
	WsfUniqueId (const WsfUniqueId &)
	Copy constructor initializes the unique identifier to 0.
WsfUniqueId &	operator= (const WsfUniqueId &)
unsigned int	GetUniqueId () const
	Get the unique identifier assigned to this object.
template<typename T>
void	Serialize (T &aBuff)
	For XIO (de)serialization.
Public Member Functions inherited from WsfAuxDataEnabled
	WsfAuxDataEnabled ()=default
	WsfAuxDataEnabled (const WsfAuxDataEnabled &aSrc)=default
WsfAuxDataEnabled &	operator= (const WsfAuxDataEnabled &aRhs)
	WsfAuxDataEnabled (WsfAuxDataEnabled &&)=default
WsfAuxDataEnabled &	operator= (WsfAuxDataEnabled &&)=default
virtual	~WsfAuxDataEnabled () noexcept
void	SetAuxData (const WsfAttributeContainer &aAuxData)
void	DeleteAuxData ()
	Delete the aux data container from the object.
void	MergeAuxData (const WsfAuxDataEnabled &aSrc)
	Merge the object's aux data with aux data from an existing object.
void	UpdateAuxData (const WsfAuxDataEnabled &aSrc)
	Update the object's aux data with aux data from an existing object.
bool	HasAuxData () const
	Returns true if this object has aux data.
bool	ProcessInput (UtInput &aInput)
template<typename T>
void	Serialize (T &aBuff)
	(De)serialization for XIO
WsfAttributeContainer &	GetAuxData ()
const WsfAttributeContainer &	GetAuxData () const noexcept
const WsfAttributeContainer &	GetAuxDataConst () const noexcept

debugging control
bool	DebugEnabled () const
	Returns 'true' if debugging is enabled for this instance.
void	SetDebugEnabled (bool aDebugEnabled)
unsigned int	GetDebugMask ()
bool	IsExternallyControlled () const
virtual void	SetExternallyControlled (double aSimTime, bool aIsExternallyControlled)
int	GetPartType () const
const char *	GetScriptClassName () const override
WsfSimulation *	GetSimulation () const
const WsfScenario &	GetScenario () const
	WsfPlatformPart (const WsfPlatformPart &aSrc)
	Copy constructor (for Clone()).

Component infrastructure methods.
Note that all of the required methods are not defined by this class. They are defined by the leaf that defines the platform part (e.g. WsfComm, WsfProcessor, etc.).
WsfStringId	GetComponentName () const override
void	ComponentParentChanged (WsfPlatform *aPlatformPtr) override

Common infrastructure methods.
bool	Initialize (double aSimTime) override
bool	Initialize2 (double aSimTime) override
bool	ProcessInput (UtInput &aInput) override
virtual void	Update (double aSimTime)

Platform association methods.
WsfPlatform *	GetPlatform () const
virtual void	SetPlatform (WsfPlatform *aPlatformPtr)

Platform notification methods.
These methods are invoked whenever another platform is added or deleted from the simulation.
virtual void	PlatformAdded (double aSimTime, WsfPlatform *aPlatformPtr)
virtual void	PlatformDeleted (WsfPlatform *aPlatformPtr)

Status (on/off) methods.
double	GetLastStatusChangeTime () const
void	SetLastStatusChangeTime (double aSimTime)
	Allows a system to set the time at which the device was initialized.
bool	CanBeMadeOperational () const
	Returns an indication that this system can be made operational.
bool	CanBeMadeNonOperational () const
	Returns an indication that this system can be made non-operational.
bool	CanBeTurnedOn () const
	Returns an indication that this system can be turned on.
bool	CanBeTurnedOff () const
	Returns an indication that this system can be turned off.
bool	IsTurnedOn () const
bool	InitiallyTurnedOn () const
	Is the system to be turned 'on' when added to the simulation?
void	SetInitiallyTurnedOn (bool aInitiallyTurnedOn)
	Sets if the system is turned on when added to the simulation.
virtual void	TurnOff (double aSimTime)
virtual void	TurnOn (double aSimTime)
virtual void	SetOperational (double aSimTime)
virtual void	SetNonOperational (double aSimTime)
virtual void	PartBroken (double aSimTime)
virtual void	Restore (double aSimTime)

Operational status methods.
A part may be defined to be non-operational, in which case it cannot be used (turned on) until it is made operational. This can be used to deactivate a certain part without having to remove it from the platform.
bool	IsOperational () const
bool	SetOperational (double aSimTime, bool aMakeOperational)
double	GetDamageFactor () const
bool	SetDamageFactor (double aSimTime, double aDamageFactor)
bool	IsCritical () const
void	SetCritical (bool aValue)
virtual void	OnPlatformBrokenEvent (double aSimTime)
	Owning platform has issued a broken event.
bool	IsBroken () const

Inter-part communication methods.
WsfInternalLinks &	GetInternalLinks ()
	Return the internal links for this part.
virtual bool	HasInternalLinks () const
	Does this platform part have a communication link to other platform parts?
virtual bool	ProcessMessage (double aSimTime, const WsfMessage &aMessage)
virtual bool	ReceiveMessage (double aSimTime, const WsfMessage &aMessage)
virtual void	SendMessage (double aSimTime, const WsfMessage &aMessage)

Recipient communication methods.
virtual void	SendMessageTo (double aSimTime, const WsfMessage &aMessage, WsfStringId aRecipientId)
void	SendMessageToProcessor (double aSimTime, const WsfMessage &aMessage, WsfStringId aRecipientId)
virtual void	SendQueuedMessages (double aSimTime)

Category methods.
These methods allow the parts to 'categorized'.
const WsfCategoryList &	GetCategories () const
	Get the categories to which this part belongs.
void	AddCategory (WsfStringId aCategoryId)
	Adds the provided category to the platform part's category list.
bool	IsCategoryMember (WsfStringId aCategoryId) const

Group management.
const WsfGroupList &	GetGroups () const
	Get the groups to which this platform part belongs.
void	JoinGroup (WsfGroup *aGroupPtr)
	Join the given group.
void	LeaveGroup (WsfGroup *aGroupPtr)
	Leave the given group.
bool	IsGroupMember (WsfStringId aGroupId)

Event-Driven simulation methods.
virtual double	GetUpdateInterval () const =0

Methods for simulation control of the update interval.
Note These methods are only intended for use by simulation executives (classes derived from WsfSimulation) and WsfPlatformPartEvent and should not be invoked from any other place. Any other use is at your own risk.
virtual void	SetUpdateInterval (double aUpdateInterval)=0
unsigned int	GetUpdateEventEpoch () const
void	IncrementUpdateEventEpoch ()
bool	UpdateEventActive () const
	Is an 'Update' event active?
void	SetUpdateEventActive (bool aUpdateEventActive)
	Indicate if the 'Update' event is active.

Additional Inherited Members
Static Public Attributes inherited from WsfAuxDataEnabled
static UtCallbackListN< void(const WsfAuxDataEnabled *)>	AuxDataAccessed
static UtCallbackListN< void(const WsfAuxDataEnabled *)>	AuxDataDestroyed
	WsfObject (const WsfObject &aSrc)
	Copy constructor (for Clone()).
Protected Member Functions inherited from WsfUniqueId
void	AssignUniqueId (WsfSimulation *aSimulationPtr)

Detailed Description

WsfPlatformPart is the base object for all objects aggregated by platforms.

These objects include the following:

This base class provides the abstract interface that subclasses must support:

WsfPlatformPart::Initialize
WsfPlatformPart::ProcessInput
WsfPlatformPart::Update

It also provides:

The ability for the parts to be send messages to other parts on the platform.
Support for inclusion within categories (see WsfCategoryList)

It enforces that:

Setting damage to 1.0 at least temporarily disables the part:
a. If Turned On, it is Forced Off.
b. If Operational, it is set Non-Operational.
c. If identified as not restorable, damage state latches at 1.0 (broken).
d. If identified as critical, the containing platform is destroyed.
e. Observer call-backs are embedded for state transitions.

Member Typedef Documentation

◆ InternalMessageQueue

using WsfPlatformPart::InternalMessageQueue = std::queue<WsfMessage*>

◆ RecipientMessageQueue

using WsfPlatformPart::RecipientMessageQueue = std::queue<std::pair<WsfPlatformPart*, WsfMessage*>>

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

Enumerator
cLEVEL_ONE_DEBUG	General debug.
cLEVEL_TWO_DEBUG	Full debug.

Constructor & Destructor Documentation

◆ WsfPlatformPart() [1/2]

WsfPlatformPart::WsfPlatformPart	(	const WsfScenario &	aScenario,
		int	aPartType )

References WsfObject::WsfObject().

Referenced by operator=(), wsf::comm::Comm::QueryInterface(), wsf::comm::router::Router::QueryInterface(), wsf::UCI_Component::QueryInterface(), wsf::UCI_Computer::QueryInterface(), WsfFuel::QueryInterface(), WsfSensor::QueryInterface(), WsfThermalSystem::QueryInterface(), WsfVisualPart::QueryInterface(), wsf::comm::router::Router::Router(), wsf::comm::router::Router::Router(), SendMessageTo(), SendQueuedMessages(), wsf::UCI_Component::UCI_Component(), wsf::UCI_Component::UCI_Component(), WsfArticulatedPart::WsfArticulatedPart(), WsfArticulatedPart::WsfArticulatedPart(), WsfFuel::WsfFuel(), WsfFuel::WsfFuel(), WsfMover::WsfMover(), WsfMover::WsfMover(), WsfPlatformPart(), WsfProcessor::WsfProcessor(), WsfProcessor::WsfProcessor(), WsfThermalSystem::WsfThermalSystem(), and WsfThermalSystem::WsfThermalSystem().

◆ ~WsfPlatformPart()

WsfPlatformPart::~WsfPlatformPart ( )

override

◆ WsfPlatformPart() [2/2]

WsfPlatformPart::WsfPlatformPart ( const WsfPlatformPart & aSrc )

protected

Copy constructor (for Clone()).

References WsfAuxDataEnabled::WsfAuxDataEnabled(), WsfObject::WsfObject(), and WsfPlatformPart().

Member Function Documentation

◆ AddCategory()

void WsfPlatformPart::AddCategory ( WsfStringId aCategoryId )

inline

Adds the provided category to the platform part's category list.

Referenced by WsfRF_Jammer::ProcessInput().

◆ CanBeMadeNonOperational()

bool WsfPlatformPart::CanBeMadeNonOperational ( ) const

inline

Returns an indication that this system can be made non-operational.

Referenced by SetOperational().

◆ CanBeMadeOperational()

bool WsfPlatformPart::CanBeMadeOperational ( ) const

inline

Returns an indication that this system can be made operational.

Referenced by SetOperational().

◆ CanBeTurnedOff()

bool WsfPlatformPart::CanBeTurnedOff ( ) const

inline

Returns an indication that this system can be turned off.

Referenced by WsfLaserDesignator::TurnOff().

◆ CanBeTurnedOn()

bool WsfPlatformPart::CanBeTurnedOn ( ) const

inline

Returns an indication that this system can be turned on.

Referenced by wsf::UCI_PartComponent::TurnOn(), WsfLaserDesignator::TurnOn(), and WsfSimulation::TurnPartOnP().

◆ ComponentParentChanged()

void WsfPlatformPart::ComponentParentChanged ( WsfPlatform * aParentPtr )

inlineoverridevirtual

The parent to which the component is attached has been updated. This virtual method is called whenever the components parent attachment has been changed. This is provided so derived class receives notification of the change.

Parameters

aParentPtr Pointer to the new parent. The new parent may be null if the attachment was severed.

Reimplemented from WsfComponentT< WsfPlatform >.

References SetPlatform().

◆ DebugEnabled()

bool WsfPlatformPart::DebugEnabled ( ) const

inline

Returns 'true' if debugging is enabled for this instance.

◆ GetCategories()

const WsfCategoryList & WsfPlatformPart::GetCategories ( ) const

inline

Get the categories to which this part belongs.

Referenced by WsfBMUtils::GetSensorType(), and WsfMilExtInterface::GetWarheadEnum().

◆ GetComponentName()

WsfStringId WsfPlatformPart::GetComponentName ( ) const

inlineoverridevirtual

Returns the component's name. Each component in a component list has a unique name. Names are usually defined by the user, but they may also be generated by code and prefixed with a '#' to guarantee no collisions with user-defined names.

Implements WsfComponent.

References WsfObject::GetNameId().

◆ GetComponentRoles()

const int * WsfPlatformPart::GetComponentRoles ( ) const

overridevirtual

Returns a zero-terminated array of component roles. Note that the array should be in decreasing order of specificity and should generally the inheritance hierarchy. The first entry should be the components 'primary' role. For example a sensor would do the following:

static const int roles[] = { cWSF_COMPONENT_SENSOR, cWSF_COMPONENT_ARTICULATED_PART,
                             cWSF_COMPONENT_PLATFORM_PART, 0 };
return roles;

Implements WsfComponent.

Reimplemented in WsfProcessor, WsfRF_Jammer, WsfSensor, WsfSpaceMoverBase, WsfTaskManager, WsfThermalSystem, WsfVisualPart, and WsfWeapon.

References cWSF_COMPONENT_NULL, and cWSF_COMPONENT_PLATFORM_PART.

◆ GetDamageFactor()

double WsfPlatformPart::GetDamageFactor ( ) const

inline

Is the part damaged? Zero indicates undamaged. One indicates totally damaged. A transition from positive to zero will trigger the part type becoming non-operational as an observed event.

Returns: [0 to 1]

Referenced by WsfExplicitWeapon::Fire(), WsfImplicitWeapon::Fire(), WsfRotorcraftMover::LocalUpdate(), WsfAirMover::PostMoveUpdate(), WsfMover::Restore(), wsf::six_dof::Mover::SetDamageFactor(), WsfMover::UpdateAllowed(), wsf::six_dof::Mover::UpdateAppearance(), and WsfWaypointMover::UpdatePosition().

◆ GetDebugMask()

unsigned int WsfPlatformPart::GetDebugMask ( )

inline

Referenced by WsfTRIMSIM_Processor::ComputeMeasurementErrors(), WsfOTH_RadarSensor::OTH_Beam::Initialize(), WsfRadarSensor::RadarBeam::Initialize(), WsfRF_Jammer::JammerMode::Initialize(), WsfCoherentSensorProcessor::Update(), and WsfCoherentSensorProcessor::UpdateTrack().

◆ GetGroups()

const WsfGroupList & WsfPlatformPart::GetGroups ( ) const

inline

Get the groups to which this platform part belongs.

◆ GetInternalLinks()

WsfInternalLinks & WsfPlatformPart::GetInternalLinks ( )

inline

Return the internal links for this part.

Referenced by getInternallyLinkedPlatformParts(), WsfCompositeSensor::Initialize(), WsfRIPRProcessor::Initialize(), WsfMessageProcessor::Action::ProcessInput(), wsf::UCI_Computer::ReceiveUCI_Message(), and WsfMessageProcessor::SendMessage().

◆ GetLastStatusChangeTime()

double WsfPlatformPart::GetLastStatusChangeTime ( ) const

inline

Returns the time at which this system was last turned on or off.

Returns: The simulation time at which the device was turned on or off.

Referenced by wsf::comm::medium::Guided::TransmitMessage(), and wsf::comm::medium::Unguided::TransmitMessage().

◆ GetPartType()

int WsfPlatformPart::GetPartType ( ) const

inline

Referenced by WsfPlatformPartEvent::Execute(), WsfXIO_PlatformInfoService::FillPartState(), WsfEventStepSimulation::SetPartUpdateInterval(), WsfXIO_ScriptService::StoreScript(), WsfFrameStepSimulation::TurnPartOffP(), WsfEventStepSimulation::TurnPartOn(), and WsfFrameStepSimulation::TurnPartOnP().

◆ GetPlatform()

WsfPlatform * WsfPlatformPart::GetPlatform ( ) const

inline

Get the platform to which this part is attached.

Returns: Pointer to the containing platform or 0 if the part is not associated with a platform.

◆ GetScenario()

const WsfScenario & WsfPlatformPart::GetScenario ( ) const

inline

◆ GetScriptClassName()

const char * WsfPlatformPart::GetScriptClassName ( ) const

override

◆ GetSimulation()

WsfSimulation * WsfPlatformPart::GetSimulation ( ) const

◆ GetUpdateEventEpoch()

unsigned int WsfPlatformPart::GetUpdateEventEpoch ( ) const

inline

Get the current update event 'epoch'. The event 'epoch' is used to recognize and ignore obsolete events.

Referenced by WsfPlatformPartEvent::Execute().

◆ GetUpdateInterval()

virtual double WsfPlatformPart::GetUpdateInterval ( ) const

pure virtual

Get interval at which Update() is called. This value is set by calling WsfSimulation::GetInstance().SetProcessorUpdateInterval();

Implemented in wsf::comm::Comm, wsf::comm::router::Router, wsf::UCI_Component, WsfFuel, WsfMover, WsfObserver::Comm, WsfObserver::Router, WsfProcessor, WsfSensor, WsfThermalSystem, WsfVisualPart, and WsfWeapon.

Referenced by WsfPlatformPartEvent::Execute().

◆ HasInternalLinks()

virtual bool WsfPlatformPart::HasInternalLinks ( ) const

inlinevirtual

Does this platform part have a communication link to other platform parts?

◆ IncrementUpdateEventEpoch()

void WsfPlatformPart::IncrementUpdateEventEpoch ( )

inline

Increment the 'epoch' for the update event. This should be called whenever the update interval is changed or if the processor is turned off or on.

Referenced by WsfPlatformPartEvent::Execute(), and WsfEventStepSimulation::SetPartUpdateInterval().

◆ Initialize()

bool WsfPlatformPart::Initialize ( double aSimTime )

overridevirtual

Perform phase 1 initialization of the part. This is invoked by WsfPlatform::Initialize() during phase 1 initialization of the platform. During phase 1 initialization, platform components must not assume the existence of ANY data that is the responsibility of another platform component. In particular, the platform location and initial tracks cannot be assumed to be valid.

Parameters

aSimTime The current simulation time.

Returns: 'true' if successful or 'false' if some sort of error occurred.

Reimplemented from WsfComponent.

Reimplemented in WsfProcessor, WsfQuantumTaskerProcessor, WsfRadarSensor, WsfRF_Jammer, WsfRIPRProcessor, WsfRoadMover, WsfRotorcraftMover, WsfRouteMover, WsfSA_Processor, WsfSAR_Sensor, WsfScriptProcessor, WsfScriptStateMachineProcessor, WsfSensor, WsfSensorProcessor, WsfSensorsManagerFov, WsfShadowMover, WsfSimpleSensorsManager, WsfSOSM_Sensor, WsfSpaceMover, WsfSpaceMoverBase, WsfStraightLineMover, WsfSubsurfaceMover, WsfSurfaceWaveRadarSensor, WsfTabularRateFuel, WsfTankedFuel, WsfTaskManager, WsfTaskProcessor, WsfTBM_Mover, WsfThermalSystem, WsfThreatProcessor, WsfTowedMover, WsfTrackProcessor, WsfTrackStateControllerProcessor, WsfTSPI_Mover, WsfUplinkProcessor, WsfVariableRateFuel, WsfVisualPart, WsfWaypointMover, WsfWeapon, WsfWeaponFuse, WsfWeaponsManagerAI, WsfWeaponsManagerSAM, WsfWeaponThreatProcessor, and WsfWeaponTrackProcessor.

References WsfUniqueId::AssignUniqueId(), and GetSimulation().

Referenced by wsf::comm::router::Router::Initialize(), WsfArticulatedPart::Initialize(), WsfFuel::Initialize(), WsfMover::Initialize(), WsfProcessor::Initialize(), and WsfThermalSystem::Initialize().

◆ Initialize2()

bool WsfPlatformPart::Initialize2 ( double aSimTime )

overridevirtual

Perform phase 2 initialization of the part. This is invoked by WsfPlatform::Initialize() during phase 2 initialization of the platform. During phase 2, platform components may assume that the platform location has been defined, initial tracks have been loaded and that all components have completed phase 1 initialization.

Parameters

aSimTime The current simulation time.

Returns: 'true' if successful or 'false' if some sort of error occurred.

Reimplemented from WsfComponent.

Reimplemented in WsfProcessor, WsfQuantumTaskerProcessor, WsfRIPRProcessor, WsfRotorcraftMover, WsfRouteMover, WsfSA_Processor, WsfScriptProcessor, WsfSensor, WsfSensorsManagerFov, WsfSimpleSensorsManager, WsfSpaceMoverBase, WsfTaskManager, WsfTaskProcessor, WsfTBM_Mover, WsfWeapon, WsfWeaponFuse, WsfWeaponsManagerAI, WsfWeaponsManagerSAM, and WsfWeaponTrackProcessor.

Referenced by WsfMover::Clone(), wsf::comm::router::Router::Initialize2(), wsf::UCI_Component::Initialize2(), WsfFuel::Initialize2(), and WsfProcessor::Initialize2().

◆ InitiallyTurnedOn()

bool WsfPlatformPart::InitiallyTurnedOn ( ) const

inline

Is the system to be turned 'on' when added to the simulation?

Referenced by WsfRF_Jammer::Initialize(), WsfRouteMover::Initialize2(), and WsfPlatform::SwapMover().

◆ IsBroken()

bool WsfPlatformPart::IsBroken ( ) const

inline

Is the part permanently broken?

Returns: true if the part is broken.

Referenced by WsfEventPipeInterface::SendPartStatus(), and SetDamageFactor().

◆ IsCategoryMember()

bool WsfPlatformPart::IsCategoryMember ( WsfStringId aCategoryId ) const

inline

Is this part a member of the indicated category?

Parameters

aCategoryId String Id of the category to be checked.

Returns: 'true' if a member of the category.

Referenced by WsfSA_Processor::CalculateEmissions(), and HorizontalMapFunction::InSelectorList().

◆ IsCritical()

bool WsfPlatformPart::IsCritical ( ) const

inline

Is the part critical?

Returns: true if the part is critical. If true and damage = 1.0, the platform will be destroyed.

◆ IsExternallyControlled()

bool WsfPlatformPart::IsExternallyControlled ( ) const

inline

Referenced by WsfPlatformPartEvent::Execute(), WsfXIO_TaskService::HandleRequest(), WsfXIO_ObjectInfoLoad::Load_PlatformPart(), WsfTaskManager::OperatingLevelChanged(), WsfTaskProcessor::ProcessMessage(), WsfTaskManager::ReportTaskComplete(), WsfTaskManager::TaskAssigned(), WsfTaskManager::TaskAssignSent(), WsfTaskManager::TaskCanceled(), WsfTaskManager::TaskCompleted(), WsfTaskProcessor::TaskCompleted(), WsfSensor::TrackCoasted(), WsfSensor::TrackDropped(), WsfSensor::TrackUpdated(), WsfSensorProcessor::TrackUpdated(), WsfTaskProcessor::TurnOn(), WsfMultiThreadManager::TurnSensorOn(), and WsfDisMover::Update().

◆ IsGroupMember()

bool WsfPlatformPart::IsGroupMember ( WsfStringId aGroupId )

◆ IsOperational()

bool WsfPlatformPart::IsOperational ( ) const

inline

Is the part operational?

Returns: true if the device is operational.

Referenced by wsf::UCI_Component::CanHandleMessage(), wsf::UCI_PartComponent::CheckPartStatus(), UCI_Util::GetSubsystemState(), WsfXIO_ObjectInfoLoad::Load_PlatformPart(), WsfEventPipeInterface::SendPartStatus(), WsfSimulation::SetPartOperationalP(), WsfEventStepSimulation::TurnPartOn(), WsfSimulation::TurnPartOnP(), and WsfWeaponTrackProcessor::Update().

◆ IsTurnedOn()

bool WsfPlatformPart::IsTurnedOn ( ) const

inline

Is the system currently turned 'on'?

Returns: true if the device is turned on.

Referenced by WsfTaskManager::AcquireResource(), WsfTRIMSIM_Processor::AttemptToDetect(), WsfSA_Processor::CalculateEmissions(), wsf::UCI_Component::CanHandleMessage(), WsfRF_Repeater::CheckDetectAndUpdate(), wsf::UCI_PartComponent::CheckPartStatus(), HorizontalMapFunction::CreateSensorList(), FlightPathAnalysisFunction::Execute(), WsfXIO_PlatformInfoService::FillPartState(), WsfCuedLaserWeapon::Fire(), WsfOTH_RadarSensor::GetEM_Rcvr(), WsfRadarSensor::GetEM_Rcvr(), WsfOTH_RadarSensor::GetEM_RcvrCount(), WsfRadarSensor::GetEM_RcvrCount(), WsfOTH_RadarSensor::GetEM_Xmtr(), WsfRadarSensor::GetEM_Xmtr(), WsfOTH_RadarSensor::GetEM_XmtrCount(), WsfRadarSensor::GetEM_XmtrCount(), UCI_Util::GetSubsystemState(), wsf::comm::router::Router::IsActive(), WsfXIO_ObjectInfoLoad::Load_PlatformPart(), WsfEOIR_Sensor::PlatformAdded(), WsfEOIR_Sensor::PlatformDeleted(), WsfBeamDirector::PointAtTarget(), wsf::comm::Comm::ReceiveSetup(), WsfGuidanceComputer::SelectPhase(), SendMessageTo(), SendMessageToProcessor(), WsfEventPipeInterface::SendPartStatus(), SendQueuedMessages(), wsf::comm::Comm::SendSetup(), WsfCompositeSensor::SensorDetectionChanged(), WsfDisPlatform::SensorFrequencyChanged(), WsfDisPlatform::SensorModeActivated(), WsfDisPlatform::SensorModeDeactivated(), WsfDisPlatform::SensorRequestCanceled(), WsfDisPlatform::SensorRequestInitiated(), WsfDisPlatform::SensorRequestUpdated(), WsfCompositeSensor::SensorTurnedOff(), WsfTaskProcessor::SetExternallyControlled(), WsfSensor::SetIsSlave(), SetNonOperational(), WsfEventStepSimulation::SetPartUpdateInterval(), WsfRF_Jammer::StartJamming(), WsfGuidanceComputer::StartProgram(), WsfRF_Jammer::StopJamming(), WsfGuidanceComputer::StopProgram(), WsfLaserTracker::TurnOff(), WsfSensor::TurnOff(), WsfVisualPart::TurnOff(), WsfLaserTracker::TurnOn(), WsfSensor::TurnOn(), WsfVisualPart::TurnOn(), WsfEventStepSimulation::TurnPartOff(), WsfSimulation::TurnPartOffP(), WsfEventStepSimulation::TurnPartOn(), WsfSimulation::TurnPartOnP(), WsfWeaponFuse::Update(), WsfWeaponTrackProcessor::Update(), WsfMover::UpdateAllowed(), WsfEventPipeInterface::UpdateArticulation(), wsf::six_dof::GuidanceComputer::UpdateGuidance(), WsfGuidanceComputer::UpdateGuidance(), WsfP6DOF_GuidanceComputer::UpdateGuidance(), and WsfMilEventPipe::UpdateWeaponArticulation().

◆ JoinGroup()

void WsfPlatformPart::JoinGroup ( WsfGroup * aGroupPtr )

Join the given group.

References GetPlatform(), and WsfUniqueId::GetUniqueId().

Referenced by WsfGroupTypes::JoinGroupType(), WsfGroupManager::LoadInstance(), and UT_DEFINE_SCRIPT_METHOD().

◆ LeaveGroup()

void WsfPlatformPart::LeaveGroup ( WsfGroup * aGroupPtr )

Leave the given group.

References GetPlatform(), and WsfUniqueId::GetUniqueId().

Referenced by UT_DEFINE_SCRIPT_METHOD().

◆ OnPlatformBrokenEvent()

void WsfPlatformPart::OnPlatformBrokenEvent ( double aSimTime )

virtual

Owning platform has issued a broken event.

Inform the internal systems that this platform is broken.

Parameters

aSimTime The current simulation time.

Reimplemented in wsf::six_dof::Mover, and WsfP6DOF_Mover.

References SetNonOperational(), SetOperational(), and TurnOff().

Referenced by WsfPlatform::OnBrokenEvent().

◆ operator=()

WsfPlatformPart & WsfPlatformPart::operator= ( const WsfPlatformPart & aRhs )

delete

References WsfPlatformPart().

◆ PartBroken()

void WsfPlatformPart::PartBroken ( double aSimTime )

virtual

Inform the internal systems that this part is broken.

Parameters

aSimTime The current simulation time.

Reimplemented in wsf::comm::Comm, wsf::comm::router::Router, WsfGuidedMoverBase, WsfMover, WsfObserver::Comm, WsfObserver::Router, WsfProcessor, WsfSensor, WsfVisualPart, and WsfWeapon.

References WsfObject::GetNameId(), SendMessage(), and WsfStatusMessage::SetSystemNameId().

Referenced by wsf::comm::Comm::PartBroken(), wsf::comm::router::Router::PartBroken(), WsfMover::PartBroken(), WsfProcessor::PartBroken(), WsfSensor::PartBroken(), WsfVisualPart::PartBroken(), WsfWeapon::PartBroken(), and SetDamageFactor().

◆ PlatformAdded()

void WsfPlatformPart::PlatformAdded	(	double	aSimTime,
		WsfPlatform *	aPlatformPtr )

virtual

Some other platform has been added to the simulation.

This is invoked (via WsfPlatform::PlatformAdded) whenever another platform has been added to the simulation.

Parameters

aSimTime	The current simulation time.
aPlatformPtr	Pointer to the platform being added.

Reimplemented in WsfEOIR_Sensor, WsfOffsetMover, WsfOTH_RadarSensor, WsfRadarSensor, WsfSA_Processor, WsfSAR_Sensor, WsfSensor, WsfSensorProcessor, and WsfSurfaceWaveRadarSensor.

Referenced by WsfPlatform::PlatformAdded(), and WsfSensor::PlatformAdded().

◆ PlatformDeleted()

void WsfPlatformPart::PlatformDeleted ( WsfPlatform * aPlatformPtr )

virtual

Some other platform has been deleted from the simulation.

This is invoked (via WsfPlatform::PlatformDeleted) whenever another platform has been deleted from the simulation.

Parameters

aPlatformPtr Pointer to the platform being deleted.

Reimplemented in WsfEOIR_Sensor, WsfExchangeProcessor, WsfFusionCenter, WsfLaserDesignator, WsfOffsetMover, WsfOpticalSensor, WsfQuantumTaskerProcessor, WsfSA_Processor, WsfSAR_Sensor, WsfSensor, WsfSensorProcessor, WsfSOSM_Sensor, WsfTankedFuel, WsfTaskManager, and WsfTaskProcessor.

Referenced by WsfPlatform::PlatformDeleted(), and WsfSensor::PlatformDeleted().

◆ ProcessInput()

bool WsfPlatformPart::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 WsfObject.

Reimplemented in WsfProcessor, WsfQuantumTaskerProcessor, WsfRadarSensor, WsfRF_Jammer, WsfRIPRProcessor, WsfRoadMover, WsfRotorcraftMover, WsfRouteMover, WsfSA_Processor, WsfSAR_Sensor, WsfScriptProcessor, WsfScriptStateMachineProcessor, WsfSensor, WsfSensorProcessor, WsfSensorsManagerFov, WsfShadowMover, WsfSimpleSensorsManager, WsfSOSM_Sensor, WsfSpaceMover, WsfSpaceMoverBase, WsfStraightLineMover, WsfSurfaceMover, WsfSurfaceWaveRadarSensor, WsfTabularRateFuel, WsfTankedFuel, WsfTaskManager, WsfTaskProcessor, WsfTBM_Mover, WsfThermalSystem, WsfThreatProcessor, WsfTowedMover, WsfTrackProcessor, WsfTrackStateControllerProcessor, WsfTRIMSIM_Processor, WsfTSPI_Mover, WsfUnclassifiedAssetManager, WsfUnclassifiedBattleManager, WsfUnclassifiedDisseminateC2, WsfUplinkProcessor, WsfVariableRateFuel, WsfVisualPart, WsfWaypointMover, WsfWeapon, WsfWeaponFuse, WsfWeaponsManagerAI, WsfWeaponsManagerSAM, WsfWeaponThreatProcessor, and WsfWeaponTrackProcessor.

References WsfAuxDataEnabled::ProcessInput(), and WsfObject::ProcessInput().

Referenced by wsf::comm::router::Router::ProcessInput(), wsf::UCI_Component::ProcessInput(), WsfArticulatedPart::ProcessInput(), WsfFuel::ProcessInput(), WsfMover::ProcessInput(), and WsfProcessor::ProcessInput().

◆ ProcessMessage()

bool WsfPlatformPart::ProcessMessage	(	double	aSimTime,
		const WsfMessage &	aMessage )

virtual

Process a received message.

Parameters

aSimTime	The current simulation time.
aMessage	The message that is being sent.

Returns: 'true' if the message was processed or 'false' if not.

Note: A message is first received by ReceiveMessage which then calls ProcessMessage to process the message. A derived class ReceiveMessage method may choose to delay the message before calling ProcessMessage or may choose to ignore the message altogether.

Reimplemented in wsf::UCI_Computer, wsf::UCI_IRST_Component, wsf::UCI_PartComponent, WsfAssetManager, WsfBattleManager, WsfBMDisseminateC2, WsfBMSensorsManager, WsfBMWeaponsManager, WsfClassificationProcessor, WsfCompositeSensor, WsfCuedLaserWeapon, WsfDirectionFinderProcessor, WsfImageProcessor, WsfL16::ComputerProcessor, WsfLinkedProcessor, WsfMessageProcessor, WsfPerceptionProcessor, WsfQuantumTaskerProcessor, WsfRF_Jammer, WsfRIPRProcessor, WsfSA_Processor, WsfScriptProcessor, WsfScriptStateMachineProcessor, WsfTaskManager, WsfTaskProcessor, WsfTrackProcessor, WsfTrackStateControllerProcessor, WsfUplinkProcessor, WsfWeaponThreatProcessor, and WsfWeaponTrackProcessor.

References WsfStatusMessage::GetStatusId(), WsfStatusMessage::GetSystemNameId(), WsfMessage::GetType(), and WsfStatusMessage::GetTypeId().

Referenced by wsf::UCI_IRST_Component::ProcessMessage(), and ReceiveMessage().

◆ QueryInterface()

void * WsfPlatformPart::QueryInterface ( int aRole )

overridevirtual

Requests a component's role interface. A component can support one or more roles.

Parameters

aRole The role whose interface is to be returned.

Returns: A pointer to the object if it supports the indicated role, or 'null' if it does not. Usage: WsfProcessor* procPtrOrNull = (WsfProcessor*)componentPtr->QueryComponentInterface(cWSF_COMPONENT_PROCESSOR);

Implements WsfComponent.

Reimplemented in WsfProcessor, WsfRF_Jammer, WsfSensor, WsfSpaceMoverBase, WsfTaskManager, WsfThermalSystem, WsfVisualPart, and WsfWeapon.

References cWSF_COMPONENT_PLATFORM_PART.

Referenced by WsfArticulatedPart::QueryInterface(), WsfMover::QueryInterface(), and WsfProcessor::QueryInterface().

◆ ReceiveMessage()

bool WsfPlatformPart::ReceiveMessage	(	double	aSimTime,
		const WsfMessage &	aMessage )

virtual

Receive a message from another platform part (system). The default implementation simply calls ProcessMessage to process the received message.

Parameters

aSimTime	The current simulation time.
aMessage	The message that is being sent.

Returns: 'true' if the message was received or 'false' if not.

Note: A message is first received by ReceiveMessage which then calls ProcessMessage to process the message. A derived class ReceiveMessage method may choose to delay the message before calling ProcessMessage or may choose to ignore the message altogether.

Reimplemented in wsf::UCI_AMTI_Component, wsf::UCI_ESM_Component, wsf::UCI_WeaponComponent, WsfAssetManager, WsfBattleManager, WsfBMDisseminateC2, WsfBMSensorsManager, WsfBMWeaponsManager, WsfFusionCenter, WsfImageProcessor, WsfMessageProcessor, WsfQuantumTaskerProcessor, WsfRIPRProcessor, and WsfTaskManager.

References ProcessMessage().

Referenced by wsf::UCI_AMTI_Component::ReceiveMessage(), wsf::UCI_ESM_Component::ReceiveMessage(), wsf::UCI_WeaponComponent::ReceiveMessage(), WsfAssetManager::ReceiveMessage(), WsfBattleManager::ReceiveMessage(), WsfBMDisseminateC2::ReceiveMessage(), WsfBMSensorsManager::ReceiveMessage(), WsfBMWeaponsManager::ReceiveMessage(), SendMessageTo(), SendMessageToProcessor(), SendQueuedMessages(), and WsfTaskManager::SendTaskMessage().

◆ Restore()

void WsfPlatformPart::Restore ( double aSimTime )

virtual

Perform process of Restoring a part (return to Operational from non-Operational). This virtual function will usually be a response to a time-queued event. If the Damage Factor of the part is totally damaged, it will be set to "slightly" less than totally damaged, to permit the part to become Operational again.

Parameters

aSimTime The current simulation time.

Reimplemented in WsfMover, and WsfWeapon.

References SetOperational().

Referenced by WsfMover::Restore(), and WsfWeapon::Restore().

◆ SendMessage()

void WsfPlatformPart::SendMessage	(	double	aSimTime,
		const WsfMessage &	aMessage )

virtual

Send a message to platform parts (systems) with whom we are linked.

Parameters

aSimTime	The current simulation time.
aMessage	The message that is being sent.

Reimplemented in WsfLinkedProcessor, WsfMessageProcessor, and WsfScriptProcessor.

References WsfMessage::Clone(), and GetSimulation().

◆ SendMessageTo()

void WsfPlatformPart::SendMessageTo	(	double	aSimTime,
		const WsfMessage &	aMessage,
		WsfStringId	aRecipientId )

virtual

Send a message to a specific platform part on the same platform.

Parameters

aSimTime	The current simulation time.
aMessage	The message that is being sent.
aRecipientId	The string ID of the name of the recipient.

References WsfMessage::Clone(), GetPlatform(), GetSimulation(), IsTurnedOn(), platformPtr, ReceiveMessage(), and WsfPlatformPart().

◆ SendMessageToProcessor()

void WsfPlatformPart::SendMessageToProcessor	(	double	aSimTime,
		const WsfMessage &	aMessage,
		WsfStringId	aRecipientId )

Send a message to a specific processor on the same platform.

Parameters

aSimTime	The current simulation time.
aMessage	The message that is being sent.
aRecipientId	The string ID of the name of the recipient.

References WsfMessage::Clone(), WsfComponentList::GetComponent(), GetPlatform(), GetSimulation(), IsTurnedOn(), and ReceiveMessage().

◆ SendQueuedMessages()

void WsfPlatformPart::SendQueuedMessages ( double aSimTime )

virtual

Send queued messages from the internal and external message queues.

Parameters

aSimTime The current simulation time.

References IsTurnedOn(), ReceiveMessage(), SendMessage(), and WsfPlatformPart().

◆ SetCritical()

void WsfPlatformPart::SetCritical ( bool aValue )

inline

◆ SetDamageFactor()

bool WsfPlatformPart::SetDamageFactor	(	double	aSimTime,
		double	aDamageFactor )

Set the damage factor of the part.

Parameters

aSimTime	Current simulation time.
aDamageFactor	The new value for part damage. Zero is undamaged, one is totally damaged.

Returns: true if the damage factor changed during the request.

Note: If the part is critical, setting damage to one will queue a destruction of the platform.

References WsfSimulation::AddEvent(), WsfSimulation::DeletePlatform(), GetPlatform(), GetSimulation(), IsBroken(), PartBroken(), SetNonOperational(), and TurnOff().

Referenced by WsfMobilityAndFirepowerLethality::ApplyEffectTo(), WsfGuidedMover::IgniteStage(), and WsfGuidedMover::SeparateStage().

◆ SetDebugEnabled()

void WsfPlatformPart::SetDebugEnabled ( bool aDebugEnabled )

inline

◆ SetExternallyControlled()

void WsfPlatformPart::SetExternallyControlled	(	double	aSimTime,
		bool	aIsExternallyControlled )

virtual

Reimplemented in WsfTaskProcessor.

Referenced by WsfExtEmission::AddSensor(), and WsfTaskProcessor::SetExternallyControlled().

◆ SetInitiallyTurnedOn()

void WsfPlatformPart::SetInitiallyTurnedOn ( bool aInitiallyTurnedOn )

inline

Sets if the system is turned on when added to the simulation.

Referenced by wsf::comm::Comm::Comm(), Sensor::CreateAndInitialize(), wsf::six_dof::GuidanceComputer::Initialize(), WsfCompositeSensor::Initialize(), WsfGuidanceComputer::Initialize(), WsfP6DOF_GuidanceComputer::Initialize(), wsf::six_dof::Mover::InitializeSubobject(), WsfP6DOF_Mover::InitializeSubobject(), wsf::comm::router::Router::Router(), WsfProcessor::WsfProcessor(), WsfRF_Jammer::WsfRF_Jammer(), WsfSensor::WsfSensor(), WsfVisualPart::WsfVisualPart(), and WsfWeapon::WsfWeapon().

◆ SetLastStatusChangeTime()

void WsfPlatformPart::SetLastStatusChangeTime ( double aSimTime )

inline

Allows a system to set the time at which the device was initialized.

◆ SetNonOperational()

void WsfPlatformPart::SetNonOperational ( double aSimTime )

virtual

Set the system status as Non-Operational.

Parameters

aSimTime The current simulation time.

Reimplemented in wsf::comm::Comm, wsf::comm::router::Router, WsfMover, WsfObserver::Comm, WsfObserver::Router, WsfProcessor, WsfSensor, WsfVisualPart, and WsfWeapon.

References WsfObject::GetNameId(), IsTurnedOn(), SendMessage(), and WsfStatusMessage::SetSystemNameId().

Referenced by OnPlatformBrokenEvent(), SetDamageFactor(), wsf::comm::Comm::SetNonOperational(), wsf::comm::router::Router::SetNonOperational(), WsfMover::SetNonOperational(), WsfProcessor::SetNonOperational(), WsfSensor::SetNonOperational(), WsfVisualPart::SetNonOperational(), WsfWeapon::SetNonOperational(), and SetOperational().

◆ SetOperational() [1/2]

void WsfPlatformPart::SetOperational ( double aSimTime )

virtual

Set the system status as Operational.

Parameters

aSimTime The current simulation time.

Reimplemented in wsf::comm::Comm, wsf::comm::router::Router, WsfMover, WsfObserver::Comm, WsfObserver::Router, WsfProcessor, WsfSensor, WsfVisualPart, and WsfWeapon.

References WsfObject::GetNameId(), SendMessage(), and WsfStatusMessage::SetSystemNameId().

Referenced by OnPlatformBrokenEvent(), Restore(), wsf::comm::Comm::SetOperational(), wsf::comm::router::Router::SetOperational(), WsfMover::SetOperational(), SetOperational(), WsfProcessor::SetOperational(), WsfSensor::SetOperational(), WsfVisualPart::SetOperational(), WsfWeapon::SetOperational(), and WsfSimulation::SetPartOperationalP().

◆ SetOperational() [2/2]

bool WsfPlatformPart::SetOperational	(	double	aSimTime,
		bool	aMakeOperational )

Set the operational status of the part.

Parameters

aSimTime	Current simulation time.
aMakeOperational	true if the part is to be considered operational or false if not.

Returns: true if the request changed the operational status of the part.

References CanBeMadeNonOperational(), CanBeMadeOperational(), SetNonOperational(), SetOperational(), and TurnOff().

◆ SetPlatform()

virtual void WsfPlatformPart::SetPlatform ( WsfPlatform * aPlatformPtr )

inlinevirtual

Set the platform to which this part is associated.

Parameters

aPlatformPtr Pointer to the containing platform.

Note: A part can be associated with only one platform. It is an error to associate a part with more than one platform!

Reimplemented in WsfArticulatedPart, WsfExplicitWeapon, WsfFuel, WsfOffsetMover, WsfScriptProcessor, WsfSensor, WsfWaypointMover, and WsfWeaponTrackProcessor.

Referenced by ComponentParentChanged(), WsfArticulatedPart::SetPlatform(), WsfFuel::SetPlatform(), WsfOffsetMover::SetPlatform(), WsfScriptProcessor::SetPlatform(), WsfWaypointMover::SetPlatform(), WsfWeaponTrackProcessor::SetPlatform(), and WsfPlatform::SwapMover().

◆ SetUpdateEventActive()

void WsfPlatformPart::SetUpdateEventActive ( bool aUpdateEventActive )

inline

Indicate if the 'Update' event is active.

Referenced by WsfPlatformPartEvent::Execute().

◆ SetUpdateInterval()

virtual void WsfPlatformPart::SetUpdateInterval ( double aUpdateInterval )

pure virtual

Set the time interval between the periodic calls to Update(). A value of less than or equal to zero indicates periodic updates are not to be performed.

Parameters

aUpdateInterval The new update interval.

Note: Users should call WsfSimulation::GetInstance().SetProcessorUpdateInterval() to set the interval.

Implemented in wsf::comm::Comm, wsf::comm::router::Router, wsf::UCI_Component, WsfFuel, WsfMover, WsfObserver::Comm, WsfObserver::Router, WsfProcessor, WsfSensor, WsfThermalSystem, WsfVisualPart, and WsfWeapon.

Referenced by WsfEventStepSimulation::SetPartUpdateInterval(), and WsfSimulation::SetPartUpdateInterval().

◆ TurnOff()

void WsfPlatformPart::TurnOff ( double aSimTime )

virtual

Turn off the platform part (system).

Parameters

aSimTime The current simulation time.

Reimplemented in wsf::comm::Comm, wsf::comm::router::Router, wsf::six_dof::GuidanceComputer, wsf::UCI_PartComponent, WsfBeamDirector, WsfCompositeSensor, WsfCuedLaserWeapon, WsfEOIR_Sensor, WsfExplicitWeapon, WsfGuidanceComputer, WsfImageProcessor, WsfJTIDS_Terminal, WsfLaserDesignator, WsfLaserTracker, WsfLaserWeapon, WsfMessageProcessor, WsfMover, WsfObserver::Comm, WsfObserver::Router, WsfP6DOF_GuidanceComputer, WsfPassiveSensor, WsfProcessor, WsfRF_Jammer, WsfRouteMover, WsfSAR_Sensor, WsfSensor, WsfTaskManager, WsfTaskProcessor, WsfTrackStateControllerProcessor, WsfVisualPart, and WsfWeapon.

References WsfObject::GetNameId(), SendMessage(), and WsfStatusMessage::SetSystemNameId().

Referenced by WsfPlatformPartEvent::Execute(), OnPlatformBrokenEvent(), SetDamageFactor(), SetOperational(), wsf::comm::Comm::TurnOff(), wsf::comm::router::Router::TurnOff(), wsf::UCI_PartComponent::TurnOff(), WsfMover::TurnOff(), WsfProcessor::TurnOff(), WsfSensor::TurnOff(), WsfVisualPart::TurnOff(), WsfWeapon::TurnOff(), and WsfSimulation::TurnPartOffP().

◆ TurnOn()

void WsfPlatformPart::TurnOn ( double aSimTime )

virtual

Turn on the platform part (system).

Parameters

aSimTime The current simulation time.

Reimplemented in wsf::comm::Comm, wsf::comm::router::Router, wsf::six_dof::GuidanceComputer, wsf::UCI_PartComponent, WsfBeamDirector, WsfBrawlerMover, WsfCompositeSensor, WsfEOIR_Sensor, WsfGuidanceComputer, WsfLaserDesignator, WsfLaserTracker, WsfMessageProcessor, WsfMover, WsfObserver::Comm, WsfObserver::Router, WsfP6DOF_GuidanceComputer, WsfProcessor, WsfRF_Jammer, WsfRouteMover, WsfSAR_Sensor, WsfSensor, WsfTaskManager, WsfTaskProcessor, WsfTrackStateControllerProcessor, WsfTRIMSIM_Processor, WsfVisualPart, and WsfWeapon.

References WsfObject::GetNameId(), SendMessage(), and WsfStatusMessage::SetSystemNameId().

Referenced by WsfPlatformPartEvent::Execute(), wsf::comm::Comm::TurnOn(), wsf::comm::router::Router::TurnOn(), wsf::UCI_PartComponent::TurnOn(), WsfMover::TurnOn(), WsfProcessor::TurnOn(), WsfSensor::TurnOn(), WsfVisualPart::TurnOn(), WsfWeapon::TurnOn(), and WsfSimulation::TurnPartOnP().

◆ Update()

void WsfPlatformPart::Update ( double aSimTime )

virtual

Update the state of an platform part. Updates the platform part to reflect the state at the specified simulation time.

Parameters

aSimTime The current simulation time.

Reimplemented in Fires::FiresMover, TargetMover, wsf::comm::Comm, wsf::six_dof::Fuel, wsf::six_dof::Mover, WsfAcousticSensor, WsfARGO8_Mover, WsfAssetManager, WsfBattleManager, WsfBeamDirector, WsfBMDisseminateC2, WsfBMSensorsManager, WsfBMWeaponsManager, WsfBrawlerMover, WsfChaffMover, WsfCoherentSensorProcessor, WsfCompositeSensor, WsfDisMover, WsfEOIR_Sensor, WsfFollower, WsfFormationFlyer, WsfFuel, WsfFusionCenter, WsfGeometricSensor, WsfGuidedMoverBase, WsfHybridMover, WsfImplicitWeapon, WsfIRST_Sensor, WsfLADAR_Sensor, WsfLaserDesignator, WsfLaserTracker, WsfLaserWeapon, WsfMessageProcessor, WsfMover, WsfNullSensor, WsfObserver::Comm, WsfOffsetMover, WsfOpticalSensor, WsfOrbitalConjunctionProcessor, WsfOTH_RadarSensor, WsfP6DOF_Fuel, WsfP6DOF_Mover, WsfParabolicMover, WsfPassiveSensor, WsfPerceptionProcessor, WsfPerfectTracker, WsfProcessor, WsfQuantumTaskerProcessor, WsfRadarSensor, WsfRIPRProcessor, WsfRouteMover, WsfSA_Processor, WsfSAR_Sensor, WsfScriptProcessor, WsfScriptStateMachineProcessor, WsfSensor, WsfShadowMover, WsfSimpleSensorsManager, WsfSOSM_Sensor, WsfSpaceMoverBase, WsfStraightLineMover, WsfSurfaceWaveRadarSensor, WsfTankedFuel, WsfTaskManager, WsfTBM_Mover, WsfThreatProcessor, WsfTowedMover, WsfTSPI_Mover, WsfVisualPart, WsfWeapon, WsfWeaponFuse, WsfWeaponsManagerAI, WsfWeaponsManagerSAM, and WsfWeaponTrackProcessor.

Referenced by WsfPlatformPartEvent::Execute(), and WsfLaserWeapon::Update().

◆ UpdateEventActive()

bool WsfPlatformPart::UpdateEventActive ( ) const

inline

Is an 'Update' event active?

Referenced by WsfEventStepSimulation::SetPartUpdateInterval().

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

Public Types

Public Member Functions

debugging control

Component infrastructure methods.

Common infrastructure methods.

Platform association methods.

Platform notification methods.

Status (on/off) methods.

Operational status methods.

Inter-part communication methods.

Recipient communication methods.

Category methods.

Group management.

Event-Driven simulation methods.

Methods for simulation control of the update interval.

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ InternalMessageQueue

◆ RecipientMessageQueue

Member Enumeration Documentation

◆ anonymous enum

Constructor & Destructor Documentation

◆ WsfPlatformPart() [1/2]

◆ ~WsfPlatformPart()

◆ WsfPlatformPart() [2/2]

Member Function Documentation

◆ AddCategory()

◆ CanBeMadeNonOperational()

◆ CanBeMadeOperational()

◆ CanBeTurnedOff()

◆ CanBeTurnedOn()

◆ ComponentParentChanged()

◆ DebugEnabled()

◆ GetCategories()

◆ GetComponentName()

◆ GetComponentRoles()

◆ GetDamageFactor()

◆ GetDebugMask()

◆ GetGroups()

◆ GetInternalLinks()

◆ GetLastStatusChangeTime()

◆ GetPartType()

◆ GetPlatform()

◆ GetScenario()

◆ GetScriptClassName()

◆ GetSimulation()

◆ GetUpdateEventEpoch()

◆ GetUpdateInterval()

◆ HasInternalLinks()

◆ IncrementUpdateEventEpoch()

◆ Initialize()

◆ Initialize2()

◆ InitiallyTurnedOn()

◆ IsBroken()

◆ IsCategoryMember()

◆ IsCritical()

◆ IsExternallyControlled()

◆ IsGroupMember()

◆ IsOperational()

◆ IsTurnedOn()

◆ JoinGroup()

◆ LeaveGroup()

◆ OnPlatformBrokenEvent()

◆ operator=()

◆ PartBroken()

◆ PlatformAdded()

◆ PlatformDeleted()

◆ ProcessInput()

◆ ProcessMessage()

◆ QueryInterface()

◆ ReceiveMessage()

◆ Restore()

◆ SendMessage()

◆ SendMessageTo()

◆ SendMessageToProcessor()

◆ SendQueuedMessages()

◆ SetCritical()

◆ SetDamageFactor()

◆ SetDebugEnabled()