WSF
Public Member Functions | List of all members
wsf::comm::SlotGroupLayerJTIDS Class Reference

#include <WsfCommSlotGroupLayerJTIDS.hpp>

Inheritance diagram for wsf::comm::SlotGroupLayerJTIDS:
Inheritance graph
[legend]
Collaboration diagram for wsf::comm::SlotGroupLayerJTIDS:
Collaboration graph
[legend]

Public Member Functions

 SlotGroupLayerJTIDS ()
 ~SlotGroupLayerJTIDS () override
Public Member Functions inherited from wsf::comm::LayerImp
virtual ~LayerImp ()=default
void SetUpperLayer (Layer *aLayerPtr)
Layer * GetUpperLayer () const
void SetLowerLayer (Layer *aLayerPtr)
Layer * GetLowerLayer () const
bool DebugEnabled () const
 Determine if debugging is enabled.
void SetDebugEnabled (bool aDebugEnabled)
virtual bool Initialize2 (double aSimTime)
Comm * Parent () const
void SetParent (Comm *aParentCommPtr)
void SetIndex (size_t aIndex)
size_t GetIndex () const

Callback lists.

UtCallbackListN< void(double, const WsfMessage *, int, WsfJTIDS_SlotGroup *)> MessageSent
 SlotGroupLayerJTIDS (const SlotGroupLayerJTIDS &aSrc)

Common infrastructure methods.

wsf::comm::LayerImp * Clone () const override
bool Initialize (double aSimTime) override
bool ProcessInput (UtInput &aInput) override

Send/Receive methods

bool Receive (double aSimTime, Comm *aXmtrPtr, Message &aMessage, bool &aNotifyNextLayer) override
bool Send (double aSimTime, size_t aLayerIndex, Message &aMessage, bool &aNotifyNextLayer) override

Comm event methods.

bool ProcessLayerMessage (double aSimTime, layer::Message aMessage, Message *aCommMessagePtr) override
 Process a layer event.
void TurnOff (double aSimTime)
WsfJTIDS_SlotGroup * FindGroup (WsfStringId aGroupId)
int GetBitsPerSlot () const
 Return the number of bits per slot at standard packing.
double GetSecondsPerSlot () const
 Return the number of seconds in a slot.
int GetSetsPerFrame () const
 Return the number of sets per frame.
int GetSlotsPerFrame () const
 Return the number of slots in a frame (slots/set * sets/frame).
int GetSlotsPerSet () const
 Return the number of slots per set.

Constructor & Destructor Documentation

◆ SlotGroupLayerJTIDS() [1/2]

wsf::comm::SlotGroupLayerJTIDS::SlotGroupLayerJTIDS ( )

Referenced by Clone(), and SlotGroupLayerJTIDS().

◆ ~SlotGroupLayerJTIDS()

wsf::comm::SlotGroupLayerJTIDS::~SlotGroupLayerJTIDS ( )
override

◆ SlotGroupLayerJTIDS() [2/2]

wsf::comm::SlotGroupLayerJTIDS::SlotGroupLayerJTIDS ( const SlotGroupLayerJTIDS & aSrc)
protected

References SlotGroupLayerJTIDS().

Member Function Documentation

◆ Clone()

wsf::comm::LayerImp * wsf::comm::SlotGroupLayerJTIDS::Clone ( ) const
overridevirtual

Implements wsf::comm::LayerImp.

References SlotGroupLayerJTIDS().

◆ FindGroup()

WsfJTIDS_SlotGroup * wsf::comm::SlotGroupLayerJTIDS::FindGroup ( WsfStringId aGroupId)

Find group with the specified ID.

Parameters
aGroupIdThe ID of the group to be located.
Returns
The pointer to the group or 0 if it could not be found.

Referenced by ProcessInput().

◆ GetBitsPerSlot()

int wsf::comm::SlotGroupLayerJTIDS::GetBitsPerSlot ( ) const
inline

Return the number of bits per slot at standard packing.

◆ GetSecondsPerSlot()

double wsf::comm::SlotGroupLayerJTIDS::GetSecondsPerSlot ( ) const
inline

Return the number of seconds in a slot.

◆ GetSetsPerFrame()

int wsf::comm::SlotGroupLayerJTIDS::GetSetsPerFrame ( ) const
inline

Return the number of sets per frame.

◆ GetSlotsPerFrame()

int wsf::comm::SlotGroupLayerJTIDS::GetSlotsPerFrame ( ) const
inline

Return the number of slots in a frame (slots/set * sets/frame).

◆ GetSlotsPerSet()

int wsf::comm::SlotGroupLayerJTIDS::GetSlotsPerSet ( ) const
inline

Return the number of slots per set.

◆ Initialize()

bool wsf::comm::SlotGroupLayerJTIDS::Initialize ( double aSimTime)
overridevirtual

Implements wsf::comm::LayerImp.

References ok, and wsf::comm::LayerImp::Parent().

◆ ProcessInput()

bool wsf::comm::SlotGroupLayerJTIDS::ProcessInput ( UtInput & aInput)
overridevirtual

Implements wsf::comm::LayerImp.

References FindGroup(), and groupPtr.

◆ ProcessLayerMessage()

bool wsf::comm::SlotGroupLayerJTIDS::ProcessLayerMessage ( double aSimTime,
layer::Message aMessage,
Message * aCommMessagePtr )
overridevirtual

Process a layer event.

Implements wsf::comm::LayerImp.

◆ Receive()

bool wsf::comm::SlotGroupLayerJTIDS::Receive ( double aSimTime,
Comm * aXmtrPtr,
Message & aMessage,
bool & aNotifyNextLayer )
overridevirtual

Receive the message in this layer.

Parameters
aSimTime[input] The current simulation time.
aXmtrPtr[input] The comm device that sent the message.
aMessage[input] The communication message being received.
aNotifyNextLayer[output] True if the next layer above this one should immediately process this message.
Returns
'true' if layer successfully processed the message.

Implements wsf::comm::LayerImp.

References wsf::comm::LayerImp::DebugEnabled(), WsfPlatformPart::DebugEnabled(), and wsf::comm::LayerImp::Parent().

◆ Send()

bool wsf::comm::SlotGroupLayerJTIDS::Send ( double aSimTime,
size_t aLayerIndex,
Message & aMessage,
bool & aNotifyNextLayer )
overridevirtual

Send the message to this layer.

Parameters
aSimTime[input] The current simulation time.
aLayerIndex[input] The index in the protocol stack for this layer.
aMessage[input] The communication message being received.
aNotifyNextLayer[output] True if the next layer below this one should immediately process this message.
Returns
'true' if layer successfully processed the message.

Implements wsf::comm::LayerImp.

References wsf::comm::LayerImp::DebugEnabled(), WsfAuxDataEnabled::GetAuxDataConst(), wsf::comm::NetworkManager::GetComm(), WsfSimulation::GetCommNetworkManager(), WsfObject::GetName(), WsfPlatformPart::GetPlatform(), WsfSimulation::GetPlatformByName(), WsfPlatformPart::GetSimulation(), groupPtr, WsfObserver::MessageDiscarded(), wsf::comm::LayerImp::Parent(), and wsf::comm::Message::SourceMessage().

◆ TurnOff()

void wsf::comm::SlotGroupLayerJTIDS::TurnOff ( double aSimTime)

Turn off the layer

Parameters
aSimTime[input] The current simulation time.

Member Data Documentation

◆ MessageSent

UtCallbackListN<void(double, const WsfMessage*, int, WsfJTIDS_SlotGroup*)> wsf::comm::SlotGroupLayerJTIDS::MessageSent
The documentation for this class was generated from the following files:
Copyrights Multiple, All Rights Reserved