wsf::AirCombat::EventPipe Class Reference

This is the class that is responsible for logging all Air Combat related events. More...

#include <WsfAirCombatEventPipe.hpp>

Inheritance diagram for wsf::AirCombat::EventPipe:

Collaboration diagram for wsf::AirCombat::EventPipe:

Public Member Functions
	EventPipe (WsfEventPipeInterface *aEventPipeInterfacePtr)
	Event pipe constructor.
void	UpdateSubscriptions (const WsfEventPipeOptions &aNewCombinedOptions, const WsfEventPipeOptions &aPreviousCombinedOptions) override
	This should be called whenever an event pipe option is changed.
Public Member Functions inherited from WsfEventPipeLogger
virtual	~WsfEventPipeLogger ()=default

Static Public Member Functions
static void	RegisterEvents (WsfEventPipeExtension &aEventPipeExtension)
	This registers the AIRCOMBAT option with aEventPipeExtension, adds its schema, adds EventPipe::RegisterMessages to aEventPipeExtension's callback list.
static void	RegisterMessages (UtPackSerializer *aSerializerPtr)
	Calls a function called UtPack_register_all_wsf_air_combat_events_types.

Detailed Description

This is the class that is responsible for logging all Air Combat related events.

Constructor & Destructor Documentation

EventPipe()

wsf::AirCombat::EventPipe::EventPipe ( WsfEventPipeInterface * aEventPipeInterfacePtr )

explicit

Event pipe constructor.

It assigns the internal simulation pointer to the simulation referenced by aEventPipeInterfacePtr, assigns its internal interface pointer to aEventPipeInterfacePtr, and sets cAIRCOMBAT to its event ID from aEventPipeInterfacePtr.

Parameters

aEventPipeInterfacePtr

the event pipe interface associated with the simulation.

References WsfEventPipeInterface::GetEventId().

Member Function Documentation

RegisterEvents()

void wsf::AirCombat::EventPipe::RegisterEvents ( WsfEventPipeExtension & aEventPipeExtension )

static

This registers the AIRCOMBAT option with aEventPipeExtension, adds its schema, adds EventPipe::RegisterMessages to aEventPipeExtension's callback list.

Parameters

aEventPipeExtension

The event pipe extension to which the events are registered.

References WsfEventPipeExtension::AddCallback(), WsfEventPipeExtension::AddSchema(), WsfEventPipeExtension::RegisterEventOption(), WsfEventPipeExtension::RegisterExtensionMessages, and RegisterMessages().

Referenced by WsfAirCombatTypeManager::AddedToScenario().

RegisterMessages()

void wsf::AirCombat::EventPipe::RegisterMessages ( UtPackSerializer * aSerializerPtr )

static

Calls a function called UtPack_register_all_wsf_air_combat_events_types.

That function appears to be auto-generated. It seems to add a couple struct definitions to aSerializePtr.

Parameters

aSerializerPtr

The serializer to which the messages are registered.

Referenced by RegisterEvents().

UpdateSubscriptions()

void wsf::AirCombat::EventPipe::UpdateSubscriptions ( const WsfEventPipeOptions & aNewCombinedOptions, const WsfEventPipeOptions & aPreviousCombinedOptions )

overridevirtual

This should be called whenever an event pipe option is changed.

It adds this plugin's observer callbacks to the EventPipe's internal callback list if the AIRCOMBAT option was enabled, or removes them otherwise.

Parameters

aNewCombinedOptions	The new set of options.
aPreviousCombinedOptions	The old set of options.

Implements WsfEventPipeLogger.

References WsfObserver::AirCombatSendEngagementSummaryData(), WsfObserver::AirCombatSendFlightControlsData(), WsfObserver::AirCombatSendFlightKinematicsData(), WsfObserver::AirCombatSendFuelData(), WsfObserver::AirCombatSendNavData(), WsfObserver::AirCombatSendPerceivedAssetsData(), WsfObserver::AirCombatSendPerceivedItemsData(), WsfObserver::AirCombatSendPrioritizedThreatsAndTargetsData(), WsfObserver::AirCombatSendTrackData(), WsfObserver::AirCombatSendWeaponsData(), and WsfEventPipeOptions::IsOptionEnabled().

---

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

• WsfAirCombatEventPipe.hpp
• WsfAirCombatEventPipe.cpp