A base class defining the interface for the implementation classes. (Implementor). More...

#include <WsfCommLayer.hpp>

Inheritance diagram for wsf::comm::LayerImp:

[legend]

Public Member Functions
virtual	~LayerImp ()=default

Upper/Lower layer methods, pushed down to this object for retrieval directly from
the implementation from the layer.
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)

Common infrastructure methods.
virtual LayerImp *	Clone () const =0
virtual bool	Initialize (double aSimTime)=0
virtual bool	Initialize2 (double aSimTime)
virtual bool	ProcessInput (UtInput &aInput)=0
virtual bool	Receive (double aSimTime, Comm *aXmtrPtr, Message &aMessage, bool &aNotifyNextLayer)=0
virtual bool	Send (double aSimTime, size_t aLayerIndex, Message &aMessage, bool &aNotifyNextLayer)=0
virtual bool	ProcessLayerMessage (double aSimTime, layer::Message aLayerMessage, Message *aCommMessagePtr)=0

Methods to access the owning communication device.
Comm *	Parent () const
void	SetParent (Comm *aParentCommPtr)

Indexing methods, pushed down to this object for retrieval directly from
the implementation from the layer.
void	SetIndex (size_t aIndex)
size_t	GetIndex () const

Detailed Description

A base class defining the interface for the implementation classes. (Implementor).

Constructor & Destructor Documentation

◆ ~LayerImp()

virtual wsf::comm::LayerImp::~LayerImp ( )

virtualdefault

Member Function Documentation

◆ Clone()

virtual LayerImp * wsf::comm::LayerImp::Clone ( ) const

pure virtual

Implemented in wsf::comm::ApplicationLayer, wsf::comm::DatalinkLayer, wsf::comm::NetworkLayer, wsf::comm::PhysicalLayer, wsf::comm::PhysicalLayerJTIDS, wsf::comm::PhysicalLayerLaser, wsf::comm::PresentationLayer, wsf::comm::SessionLayer, wsf::comm::SlotGroupLayerJTIDS, and wsf::comm::TransportLayer.

◆ DebugEnabled()

bool wsf::comm::LayerImp::DebugEnabled ( ) const

inline

Determine if debugging is enabled.

Referenced by wsf::comm::DatalinkLayer::AddToQueue(), wsf::comm::DatalinkLayer::PurgeQueue(), wsf::comm::SlotGroupLayerJTIDS::Receive(), wsf::comm::PhysicalLayer::Send(), wsf::comm::SlotGroupLayerJTIDS::Send(), wsf::comm::DatalinkLayer::TransmitComplete(), and wsf::comm::DatalinkLayer::TransmitFailed().

◆ GetIndex()

size_t wsf::comm::LayerImp::GetIndex ( ) const

inline

Referenced by wsf::comm::DatalinkLayer::AddToQueue(), wsf::comm::medium::Unguided::EndPropagation(), wsf::comm::medium::Guided::EndTransmission(), wsf::comm::medium::Unguided::EndTransmission(), wsf::comm::NetworkLayer::ProcessLayerMessage(), wsf::comm::PhysicalLayer::ProcessLayerMessage(), wsf::comm::DatalinkLayer::PurgeQueue(), wsf::comm::DatalinkLayer::ReadyToTransmit(), wsf::comm::ApplicationLayer::Receive(), wsf::comm::DatalinkLayer::Receive(), wsf::comm::NetworkLayer::Receive(), wsf::comm::PhysicalLayer::Receive(), wsf::comm::PresentationLayer::Receive(), wsf::comm::SessionLayer::Receive(), wsf::comm::TransportLayer::Receive(), wsf::comm::ApplicationLayer::Send(), wsf::comm::DatalinkLayer::Send(), wsf::comm::NetworkLayer::Send(), wsf::comm::PhysicalLayer::Send(), wsf::comm::PresentationLayer::Send(), wsf::comm::SessionLayer::Send(), wsf::comm::TransportLayer::Send(), wsf::comm::DatalinkLayer::TransmitComplete(), and wsf::comm::DatalinkLayer::TransmitFailed().

◆ GetLowerLayer()

Layer * wsf::comm::LayerImp::GetLowerLayer ( ) const

inline

◆ GetUpperLayer()

Layer * wsf::comm::LayerImp::GetUpperLayer ( ) const

inline

◆ Initialize()

virtual bool wsf::comm::LayerImp::Initialize ( double aSimTime )

pure virtual

Implemented in wsf::comm::ApplicationLayer, wsf::comm::DatalinkLayer, wsf::comm::NetworkLayer, wsf::comm::PhysicalLayer, wsf::comm::PhysicalLayerJTIDS, wsf::comm::PhysicalLayerLaser, wsf::comm::PresentationLayer, wsf::comm::SessionLayer, wsf::comm::SlotGroupLayerJTIDS, and wsf::comm::TransportLayer.

Referenced by wsf::comm::Layer::Initialize().

◆ Initialize2()

virtual bool wsf::comm::LayerImp::Initialize2 ( double aSimTime )

inlinevirtual

Reimplemented in wsf::comm::NetworkLayer.

Referenced by wsf::comm::Layer::Initialize2().

◆ Parent()

Comm * wsf::comm::LayerImp::Parent ( ) const

Referenced by wsf::comm::DatalinkLayer::AddToQueue(), wsf::comm::PhysicalLayer::CanReceiveFrom(), wsf::comm::PhysicalLayerLaser::Initialize(), wsf::comm::SlotGroupLayerJTIDS::Initialize(), ProcessLayerMessage(), wsf::comm::NetworkLayer::ProcessLayerMessage(), wsf::comm::PhysicalLayer::ProcessLayerMessage(), wsf::comm::DatalinkLayer::PurgeQueue(), wsf::comm::DatalinkLayer::ReadyToTransmit(), wsf::comm::ApplicationLayer::Receive(), wsf::comm::DatalinkLayer::Receive(), wsf::comm::NetworkLayer::Receive(), wsf::comm::PhysicalLayer::Receive(), wsf::comm::PresentationLayer::Receive(), wsf::comm::SessionLayer::Receive(), wsf::comm::SlotGroupLayerJTIDS::Receive(), wsf::comm::TransportLayer::Receive(), wsf::comm::ApplicationLayer::Send(), wsf::comm::DatalinkLayer::Send(), wsf::comm::NetworkLayer::Send(), wsf::comm::PhysicalLayer::Send(), wsf::comm::PresentationLayer::Send(), wsf::comm::SessionLayer::Send(), wsf::comm::SlotGroupLayerJTIDS::Send(), wsf::comm::TransportLayer::Send(), wsf::comm::DatalinkLayer::TransmitComplete(), and wsf::comm::DatalinkLayer::TransmitFailed().

◆ ProcessInput()

virtual bool wsf::comm::LayerImp::ProcessInput ( UtInput & aInput )

pure virtual

Implemented in wsf::comm::ApplicationLayer, wsf::comm::DatalinkLayer, wsf::comm::NetworkLayer, wsf::comm::PhysicalLayer, wsf::comm::PhysicalLayerJTIDS, wsf::comm::PresentationLayer, wsf::comm::SessionLayer, wsf::comm::SlotGroupLayerJTIDS, and wsf::comm::TransportLayer.

Referenced by wsf::comm::Layer::ProcessInput().

◆ ProcessLayerMessage()

virtual bool wsf::comm::LayerImp::ProcessLayerMessage	(	double	aSimTime,
		layer::Message	aLayerMessage,
		Message *	aCommMessagePtr )

pure virtual

Process a layer event.

Parameters

aSimTime	[input] The current simulation time.
aLayerMessage	[input] The layer message.
aCommMessagePtr	[input] The message being processed.

Implemented in wsf::comm::ApplicationLayer, wsf::comm::DatalinkLayer, wsf::comm::NetworkLayer, wsf::comm::PhysicalLayer, wsf::comm::PhysicalLayerJTIDS, wsf::comm::PresentationLayer, wsf::comm::SessionLayer, wsf::comm::SlotGroupLayerJTIDS, and wsf::comm::TransportLayer.

References Parent(), and SetParent().

Referenced by wsf::comm::Layer::ProcessLayerMessage().

◆ Receive()

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

pure virtual

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.

Implemented in wsf::comm::ApplicationLayer, wsf::comm::DatalinkLayer, wsf::comm::NetworkLayer, wsf::comm::PhysicalLayer, wsf::comm::PhysicalLayerJTIDS, wsf::comm::PresentationLayer, wsf::comm::SessionLayer, wsf::comm::SlotGroupLayerJTIDS, and wsf::comm::TransportLayer.

Referenced by wsf::comm::Layer::Receive().

◆ Send()

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

pure virtual

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.

Implemented in wsf::comm::ApplicationLayer, wsf::comm::DatalinkLayer, wsf::comm::NetworkLayer, wsf::comm::PhysicalLayer, wsf::comm::PhysicalLayerJTIDS, wsf::comm::PresentationLayer, wsf::comm::SessionLayer, wsf::comm::SlotGroupLayerJTIDS, and wsf::comm::TransportLayer.

Referenced by wsf::comm::Layer::Send().

◆ SetDebugEnabled()

void wsf::comm::LayerImp::SetDebugEnabled ( bool aDebugEnabled )

inline

Set the debug state.

Parameters

aDebugEnabled New debug state

Referenced by wsf::comm::Layer::SetDebugEnabled().

◆ SetIndex()

void wsf::comm::LayerImp::SetIndex ( size_t aIndex )

inline

Referenced by wsf::comm::Layer::SetIndex().

◆ SetLowerLayer()

void wsf::comm::LayerImp::SetLowerLayer ( Layer * aLayerPtr )

inline

◆ SetParent()

void wsf::comm::LayerImp::SetParent ( Comm * aParentCommPtr )

Referenced by wsf::comm::Layer::Layer(), ProcessLayerMessage(), and wsf::comm::Layer::SetParent().

◆ SetUpperLayer()

void wsf::comm::LayerImp::SetUpperLayer ( Layer * aLayerPtr )

inline

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

Public Member Functions

Upper/Lower layer methods, pushed down to this object for retrieval directly from

Common infrastructure methods.

Methods to access the owning communication device.

Indexing methods, pushed down to this object for retrieval directly from

Detailed Description

Constructor & Destructor Documentation

◆ ~LayerImp()

Member Function Documentation

◆ Clone()

◆ DebugEnabled()

◆ GetIndex()

◆ GetLowerLayer()

◆ GetUpperLayer()

◆ Initialize()

◆ Initialize2()

◆ Parent()

◆ ProcessInput()

◆ ProcessLayerMessage()

◆ Receive()

◆ Send()

◆ SetDebugEnabled()

◆ SetIndex()

◆ SetLowerLayer()

◆ SetParent()

◆ SetUpperLayer()