WsfCommLayer.hpp

Go to the documentation of this file.

// ****************************************************************************
// CUI
//
// The Advanced Framework for Simulation, Integration, and Modeling (AFSIM)
//
// Copyright 2017 Infoscitex, a DCS Company. All rights reserved.
//
// The use, dissemination or disclosure of data in this file is subject to
// limitation or restriction. See accompanying README and LICENSE for details.
// ****************************************************************************
 
#ifndef WSFCOMMLAYER_HPP
#define WSFCOMMLAYER_HPP
 
#include "wsf_export.h"
 
#include <vector>
 
#include "WsfCommLayerMessage.hpp"
#include "WsfUniqueId.hpp"
 
// Forward Declarations
class UtInput;
class WsfPlatform;
 
namespace wsf
{
namespace comm
{
 
class Comm;
class LayerImp;
class Message;

class WSF_EXPORT Layer : public WsfUniqueId
{
public:
   enum class LayerType : size_t
   {
      cPHYSICAL,
      cDATALINK,
      cNETWORK,
      cTRANSPORT,
      cSESSION,
      cPRESENTATION,
      cAPPLICATION,
      cNONE
   };
 
   // Constructor and destructor
   Layer(Layer::LayerType aCommLayerType, LayerImp* aCommLayerImpPtr);
   virtual ~Layer();


   virtual Layer* Clone() const;
   virtual bool   Initialize(double aSimTime);
   virtual bool   Initialize2(double aSimTime);
   virtual bool   ProcessInput(UtInput& aInput);


   virtual bool Receive(double aSimTime, Comm* aXmtrPtr, Message& aMessage);
   virtual bool Send(double aSimTime, Message& aMessage);


   virtual bool ProcessLayerMessage(double aSimTime, layer::Message aLayerMessage, Message* aCommMessagePtr);


   Comm* Parent() const;
   void  SetParent(Comm* aParentCommPtr);
 
   void SetDebugEnabled(bool aDebugEnabled);
 
   LayerType GetLayerType() const { return mCommLayerType; }

   void SetID(WsfSimulation& aSim);

   void   SetUpperLayer(Layer* aLayerPtr);
   void   SetLowerLayer(Layer* aLayerPtr);
   void   SetIndex(size_t aIndex);
   Layer* GetUpperLayer() const { return mUpperCommLayerPtr; }
   Layer* GetLowerLayer() const { return mLowerCommLayerPtr; }
 
 
   // Access to implementation
   LayerImp* GetCommLayerImp();
 
protected:
   // Copy constructor
   Layer(const Layer& aSrc);
 
private:
   Layer& operator=(const Layer& aRhs) = delete;
 
   // Pointer to the layer implementation (Implementor)
   LayerImp* mCommLayerImpPtr;
 
   LayerType mCommLayerType;  // OSI layer type
   size_t    mCommLayerIndex; // Layer index is 0-based
 
   Layer* mUpperCommLayerPtr; // Pointer to the layer above, if it exists
   Layer* mLowerCommLayerPtr; // Pointer to the layer below, if it exists
};
 
// ****************************************************************************
class WSF_EXPORT LayerImp
{
public:
   virtual ~LayerImp() = default;


   virtual LayerImp* Clone() const               = 0;
   virtual bool      Initialize(double aSimTime) = 0;
   virtual bool      Initialize2(double aSimTime) { return true; }
   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;


   Comm* Parent() const;
   void  SetParent(Comm* aParentCommPtr);

   void   SetIndex(size_t aIndex) { mIndex = aIndex; }
   size_t GetIndex() const { return mIndex; }

   void   SetUpperLayer(Layer* aLayerPtr) { mUpperCommLayerPtr = aLayerPtr; }
   Layer* GetUpperLayer() const { return mUpperCommLayerPtr; }
   void   SetLowerLayer(Layer* aLayerPtr) { mLowerCommLayerPtr = aLayerPtr; }
   Layer* GetLowerLayer() const { return mLowerCommLayerPtr; }

   bool DebugEnabled() const { return mDebugEnabled; }

   void SetDebugEnabled(bool aDebugEnabled) { mDebugEnabled = aDebugEnabled; }
 
private:
   Comm*  mParentCommPtr{nullptr}; // Pointer back to the owning communications device
   bool   mDebugEnabled{false};
   size_t mIndex;
   Layer* mUpperCommLayerPtr{nullptr};
   Layer* mLowerCommLayerPtr{nullptr};
};
 
} // namespace comm
} // namespace wsf
 
#endif