WSF
WsfCommObserver Struct Reference

#include <WsfCommObserver.hpp>

Public Attributes

WsfObserver::CommFrequencyChangedCallback CommFrequencyChanged
WsfObserver::CommTurnedOffCallback CommTurnedOff
WsfObserver::RouterTurnedOffCallback RouterTurnedOff
WsfObserver::CommTurnedOnCallback CommTurnedOn
WsfObserver::RouterTurnedOnCallback RouterTurnedOn
WsfObserver::CommNonOperationalCallback CommNonOperational
WsfObserver::RouterNonOperationalCallback RouterNonOperational
WsfObserver::CommOperationalCallback CommOperational
WsfObserver::RouterOperationalCallback RouterOperational
WsfObserver::CommBrokenCallback CommBroken
WsfObserver::RouterBrokenCallback RouterBroken
WsfObserver::MessageDeliveryAttemptCallback MessageDeliveryAttempt
WsfObserver::MessageDiscardedCallback MessageDiscarded
WsfObserver::MessageHopCallback MessageHop
WsfObserver::MessageFailedRoutingCallback MessageFailedRouting
WsfObserver::MessageUpdatedCallback MessageUpdated
WsfObserver::MessageQueuedCallback MessageQueued
WsfObserver::MessageReceivedCallback MessageReceived
WsfObserver::MessageTransmittedCallback MessageTransmitted
WsfObserver::MessageTransmitEndedCallback MessageTransmitEnded
WsfObserver::MessageTransmittedHeartbeatCallback MessageTransmittedHeartbeat
WsfObserver::CommAddedToManagerCallback CommAddedToManager
WsfObserver::CommRemovedFromManagerCallback CommRemovedFromManager
WsfObserver::LinkAddedToManagerCallback LinkAddedToManager
WsfObserver::LinkRemovedFromManagerCallback LinkRemovedFromManager
WsfObserver::LinkEnabledOnManagerCallback LinkEnabledOnManager
WsfObserver::LinkDisabledOnManagerCallback LinkDisabledOnManager
WsfObserver::CommAddedToLocalCallback CommAddedToLocal
WsfObserver::CommRemovedFromLocalCallback CommRemovedFromLocal
WsfObserver::LinkAddedToLocalCallback LinkAddedToLocal
WsfObserver::LinkRemovedFromLocalCallback LinkRemovedFromLocal
WsfObserver::LinkEnabledOnLocalCallback LinkEnabledOnLocal
WsfObserver::LinkDisabledOnLocalCallback LinkDisabledOnLocal
WsfObserver::NetworkAddedCallback NetworkAdded
WsfObserver::NetworkRemovedCallback NetworkRemoved

Detailed Description

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

Member Data Documentation

◆ CommAddedToLocal

WsfObserver::CommAddedToLocalCallback WsfCommObserver::CommAddedToLocal
Parameters
aSimTimeThe current simulation time.
aRouterPtrThe router.
aProtocolPtrThe protocol.
aAddressPtrThe address.

Referenced by wsf::comm::router::Router::AddLink(), wsf::comm::router::Router::AddNode(), and wsf::comm::router::ProtocolAdHoc::ExecuteOnCommAdded().

◆ CommAddedToManager

WsfObserver::CommAddedToManagerCallback WsfCommObserver::CommAddedToManager
Parameters
aSimTimeThe current simulation time.
aCommPtrThe comm device.

◆ CommBroken

WsfObserver::CommBrokenCallback WsfCommObserver::CommBroken
Parameters
aSimTimeThe current simulation time.
aCommPtrThe comm device.

◆ CommFrequencyChanged

WsfObserver::CommFrequencyChangedCallback WsfCommObserver::CommFrequencyChanged
Parameters
aSimTimeThe current simulation time.
aCommPtrThe comm device.

◆ CommNonOperational

WsfObserver::CommNonOperationalCallback WsfCommObserver::CommNonOperational
Parameters
aSimTimeThe current simulation time.
aCommPtrThe comm device.

◆ CommOperational

WsfObserver::CommOperationalCallback WsfCommObserver::CommOperational
Parameters
aSimTimeThe current simulation time.
aCommPtrThe comm device.

◆ CommRemovedFromLocal

WsfObserver::CommRemovedFromLocalCallback WsfCommObserver::CommRemovedFromLocal
Parameters
aSimTimeThe current simulation time.
aRouterPtrThe router.
aProtocolPtrThe protocol.
aAddressPtrThe address.

Referenced by wsf::comm::router::ProtocolAdHoc::ExecuteOnCommRemoved(), and wsf::comm::router::Router::RemoveNode().

◆ CommRemovedFromManager

WsfObserver::CommRemovedFromManagerCallback WsfCommObserver::CommRemovedFromManager
Parameters
aSimTimeThe current simulation time.
aCommPtrThe comm device.

◆ CommTurnedOff

WsfObserver::CommTurnedOffCallback WsfCommObserver::CommTurnedOff
Parameters
aSimTimeThe current simulation time.
aCommPtrThe comm device.

◆ CommTurnedOn

WsfObserver::CommTurnedOnCallback WsfCommObserver::CommTurnedOn
Parameters
aSimTimeThe current simulation time.
aCommPtrThe comm device.

◆ LinkAddedToLocal

WsfObserver::LinkAddedToLocalCallback WsfCommObserver::LinkAddedToLocal
Parameters
aSimTimeThe current simulation time.
aRouterPtrThe router.
aProtocolPtrThe protocol.
aSourceAddressPtrThe source address.
aDestinationAddressPtrThe destination address.

Referenced by wsf::comm::router::Router::AddLink(), and wsf::comm::router::ProtocolAdHoc::ExecuteOnConnectionAdded().

◆ LinkAddedToManager

WsfObserver::LinkAddedToManagerCallback WsfCommObserver::LinkAddedToManager
Parameters
aSimTimeThe current simulation time.
aCommSenderPtrThe sending comm device.
aCommRecipientPtrThe recipient comm device.

◆ LinkDisabledOnLocal

WsfObserver::LinkDisabledOnLocalCallback WsfCommObserver::LinkDisabledOnLocal
Parameters
aSimTimeThe current simulation time.
aRouterPtrThe router.
aProtocolPtrThe protocol.
aSourceAddressPtrThe source address.
aDestinationAddressPtrThe destination address.

Referenced by wsf::comm::router::Router::DisableLink().

◆ LinkDisabledOnManager

WsfObserver::LinkDisabledOnManagerCallback WsfCommObserver::LinkDisabledOnManager
Parameters
aSimTimeThe current simulation time.
aCommSenderPtrThe sending comm device.
aCommRecipientPtrThe recipient comm device.

◆ LinkEnabledOnLocal

WsfObserver::LinkEnabledOnLocalCallback WsfCommObserver::LinkEnabledOnLocal
Parameters
aSimTimeThe current simulation time.
aRouterPtrThe router.
aProtocolPtrThe protocol.
aSourceAddressPtrThe source address.
aDestinationAddressPtrThe destination address.

Referenced by wsf::comm::router::Router::EnableLink().

◆ LinkEnabledOnManager

WsfObserver::LinkEnabledOnManagerCallback WsfCommObserver::LinkEnabledOnManager
Parameters
aSimTimeThe current simulation time.
aCommSenderPtrThe sending comm device.
aCommRecipientPtrThe recipient comm device.

◆ LinkRemovedFromLocal

WsfObserver::LinkRemovedFromLocalCallback WsfCommObserver::LinkRemovedFromLocal

A link was removed from a local router's table.

Parameters
aSimTimeThe current simulation time.
Therouter object that removed a link.
Theprotocol object that removed a link.
Theaddress of the link source comm.
Theaddress of the link destination comm.

Referenced by wsf::comm::router::ProtocolAdHoc::ExecuteOnConnectionRemoved(), wsf::comm::router::Router::RemoveLink(), and wsf::comm::router::Router::RemoveNode().

◆ LinkRemovedFromManager

WsfObserver::LinkRemovedFromManagerCallback WsfCommObserver::LinkRemovedFromManager
Parameters
aSimTimeThe current simulation time.
aCommSenderPtrThe sending comm device.
aCommRecipientPtrThe recipient comm device.

◆ MessageDeliveryAttempt

WsfObserver::MessageDeliveryAttemptCallback WsfCommObserver::MessageDeliveryAttempt
Parameters
aSimTimeThe current simulation time.
aXmtrPtrThe transmitting comm.
aRcvrPtrThe receiving comm.
aMessageThe message.
aResultThe EM interaction result.

◆ MessageDiscarded

WsfObserver::MessageDiscardedCallback WsfCommObserver::MessageDiscarded
Parameters
aSimTimeThe current simulation time.
aCommPtrThe comm device.
aMessageThe message.

◆ MessageFailedRouting

WsfObserver::MessageFailedRoutingCallback WsfCommObserver::MessageFailedRouting
Parameters
aSimTimeThe current simulation time.
aCommPtrThe comm device.
aPlatformPtrThe platform.
aMessageThe message.

◆ MessageHop

WsfObserver::MessageHopCallback WsfCommObserver::MessageHop
Parameters
aSimTimeThe current simulation time.
aRcvrPtrThe receiving comm device.
aDstPtrThe destination comm device.
aMessageThe message.

◆ MessageQueued

WsfObserver::MessageQueuedCallback WsfCommObserver::MessageQueued
Parameters
aSimTimeThe current simulation time.
aCommPtrThe comm device.
aMessageThe message.

◆ MessageReceived

WsfObserver::MessageReceivedCallback WsfCommObserver::MessageReceived
Parameters
aSimTimeThe current simulation time.
aXmtrPtrThe transmitting comm device.
aRcvrPtrThe receiving comm device.
aMessageThe message.
aResultThe EM interaction result.

◆ MessageTransmitEnded

WsfObserver::MessageTransmitEndedCallback WsfCommObserver::MessageTransmitEnded
Parameters
aSimTimeThe current simulation time.
aXmtrPtrThe transmitting comm device.
aMessageThe message.

◆ MessageTransmitted

WsfObserver::MessageTransmittedCallback WsfCommObserver::MessageTransmitted
Parameters
aSimTimeThe current simulation time.
aXmtrPtrThe transmitting comm device.
aMessageThe message.

◆ MessageTransmittedHeartbeat

WsfObserver::MessageTransmittedHeartbeatCallback WsfCommObserver::MessageTransmittedHeartbeat
Parameters
aSimTimeThe current simulation time.
aXmtrPtrThe transmitting comm device.
aMessageThe message.

◆ MessageUpdated

WsfObserver::MessageUpdatedCallback WsfCommObserver::MessageUpdated
Parameters
aSimTimeThe current simulation time.
aCommPtrThe comm device.
aOldMessageThe previous message.
aNewMessageThe current message.

◆ NetworkAdded

WsfObserver::NetworkAddedCallback WsfCommObserver::NetworkAdded
Parameters
aSimTimeThe current simulation time.
aNetworkPtrThe network.

◆ NetworkRemoved

WsfObserver::NetworkRemovedCallback WsfCommObserver::NetworkRemoved
Parameters
aSimTimeThe current simulation time.
aNetworkPtrThe network.

◆ RouterBroken

WsfObserver::RouterBrokenCallback WsfCommObserver::RouterBroken
Parameters
aSimTimeThe current simulation time.
aRouterPtrThe router.

◆ RouterNonOperational

WsfObserver::RouterNonOperationalCallback WsfCommObserver::RouterNonOperational
Parameters
aSimTimeThe current simulation time.
aRouterPtrThe router.

◆ RouterOperational

WsfObserver::RouterOperationalCallback WsfCommObserver::RouterOperational
Parameters
aSimTimeThe current simulation time.
aRouterPtrThe router.

◆ RouterTurnedOff

WsfObserver::RouterTurnedOffCallback WsfCommObserver::RouterTurnedOff
Parameters
aSimTimeThe current simulation time.
aRouterPtrThe router.

◆ RouterTurnedOn

WsfObserver::RouterTurnedOnCallback WsfCommObserver::RouterTurnedOn
Parameters
aSimTimeThe current simulation time.
aRouterPtrThe router.

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