WSF
WsfPlatformObserver Struct Reference

#include <WsfPlatformObserver.hpp>

Public Attributes

WsfObserver::CommentCallback Comment
WsfObserver::CrashedIntoGroundCallback CrashedIntoGround
WsfObserver::ExecuteCallbackCallback ExecuteCallback
WsfObserver::GroupAddedCallback GroupAdded
WsfObserver::NavigationStatusChangedCallback NavigationStatusChanged
WsfObserver::PlatformAddedCallback PlatformAdded
WsfObserver::PlatformAppearanceChangedCallback PlatformAppearanceChanged
WsfObserver::PlatformBrokenCallback PlatformBroken
WsfObserver::PlatformDamageChangedCallback PlatformDamageChanged
WsfObserver::PlatformDeletedCallback PlatformDeleted
WsfObserver::PlatformInitializedCallback PlatformInitialized
WsfObserver::PlatformOmittedCallback PlatformOmitted

Detailed Description

The implementation of the Platform observer objects. An instance of this class is maintained by the simulation.

Member Data Documentation

◆ Comment

WsfObserver::CommentCallback WsfPlatformObserver::Comment

◆ CrashedIntoGround

WsfObserver::CrashedIntoGroundCallback WsfPlatformObserver::CrashedIntoGround

A platform has crashed into the ground.

Parameters
aSimTimeThe current simulation time.
aPlatformPtrThe platform that crashed.

◆ ExecuteCallback

WsfObserver::ExecuteCallbackCallback WsfPlatformObserver::ExecuteCallback

A 'callback' is being invoked on a platform.

Parameters
aSimTimeThe current simulation time.
aPlatformPtrThe platform.
aCallbackThe callback being invoked.

◆ GroupAdded

WsfObserver::GroupAddedCallback WsfPlatformObserver::GroupAdded

A new platform / platform part group has been added.

Parameters
aGroupName- the name of the group.
aGroupType- the type of the group.

◆ NavigationStatusChanged

WsfObserver::NavigationStatusChangedCallback WsfPlatformObserver::NavigationStatusChanged

The navigation status (GPS availability) of a platform has changed.

Parameters
aSimTimeThe current simulation time.
aPlatformPtrThe platform whose status changed.
aStatusThe new navigation status.

◆ PlatformAdded

WsfObserver::PlatformAddedCallback WsfPlatformObserver::PlatformAdded

A platform was added to the simulation.

This is called before the platforms' 'Initialize()' method so be careful. The only assumptions that can be made are that the platform and its associated systems are present and they have been properly registered. Other than that you should not assume anything about position, state, etc.

Parameters
aSimTimeThe current simulation time.
aPlatformPtrThe platform that was added.

◆ PlatformAppearanceChanged

WsfObserver::PlatformAppearanceChangedCallback WsfPlatformObserver::PlatformAppearanceChanged

The appearance of a platform has changed.

Parameters
aSimTimeThe current simulation time.
aPlatformPtrThe platform whose appearance has changed.
aItemTypeThe type of the item being changed.

◆ PlatformBroken

WsfObserver::PlatformBrokenCallback WsfPlatformObserver::PlatformBroken

A platform that was completely damaged is being removed from the simulation.

Parameters
aSimTimeThe current simulation time.
aPlatformPtrThe platform that has been broken.

◆ PlatformDamageChanged

WsfObserver::PlatformDamageChangedCallback WsfPlatformObserver::PlatformDamageChanged

The damage state of a platform has changed.

Parameters
aSimTimeThe current simulation time.
aPlatformPtrThe platform whose damage state has changed.

◆ PlatformDeleted

WsfObserver::PlatformDeletedCallback WsfPlatformObserver::PlatformDeleted

A platform is being deleted from simulation.

This is called just before the platform is removed from the simulation.

Parameters
aSimTimeThe current simulation time.
aPlatformPtrThe platform that is being deleted.

◆ PlatformInitialized

WsfObserver::PlatformInitializedCallback WsfPlatformObserver::PlatformInitialized

A platform has been initialized.

This is called just after the platforms Initialize method has been called.

Parameters
aSimTimeThe current simulation time.
aPlatformPtrThe platform that was initialized.

◆ PlatformOmitted

WsfObserver::PlatformOmittedCallback WsfPlatformObserver::PlatformOmitted

A platform has been omitted from the simulation because the 'platform_availability' has indicated the platform is not available or the user-defined 'on_platform_injection' script has indicated it shouldn't be added.

Parameters
aSimTimeThe current simulation time (should always be zero in this case).
aPlatformPtrThe platform is unavailable.

The documentation for this struct was generated from the following file:
Copyrights Multiple, All Rights Reserved