WsfCommProtocolInterface.hpp

Go to the documentation of this file.

// ****************************************************************************
// CUI
//
// The Advanced Framework for Simulation, Integration, and Modeling (AFSIM)
//
// Copyright 2018 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 WSFCOMMPROTOCOLINTERFACE_HPP
#define WSFCOMMPROTOCOLINTERFACE_HPP
 
#include "wsf_export.h"
 
#include "UtScriptTypes.hpp"
#include "WsfCommComponent.hpp"
#include "WsfCommProtocolPriority.hpp"
#include "WsfObject.hpp"
#include "WsfSimpleComponent.hpp"
 
namespace wsf
{
namespace comm
{

class WSF_EXPORT ProtocolInterface : public Component, public WsfObject
{
public:
   using ProcessResult = std::pair<bool, bool>;
 
   ProtocolInterface()           = default;
   ~ProtocolInterface() override = default;
   const char* GetScriptClassName() const override { return "WsfCommProtocol"; }


   WsfComponent* CloneComponent() const override = 0;
   WsfStringId   GetComponentName() const final { return GetNameId(); }
   const int*    GetComponentRoles() const override = 0;
   void*         QueryInterface(int aRole) override = 0;


   ProtocolInterface* Clone() const override = 0;


   bool Initialize(double aSimTime) override { return true; }
   bool ProcessInput(UtInput& aInput) override { return false; }


   bool operator<(const ProtocolInterface& aRhs) const { return GetPriority() < aRhs.GetPriority(); }

   virtual ProtocolPriority GetPriority() const = 0;



   virtual ProcessResult ApplicationSend(double aSimTime, size_t aLayerIndex, Message& aMessage)
   {
      return std::make_pair(false, true);
   }
   virtual ProcessResult ApplicationReceive(double aSimTime, size_t aLayerIndex, Message& aMessage)
   {
      return std::make_pair(false, true);
   }


   virtual ProcessResult PresentationSend(double aSimTime, size_t aLayerIndex, Message& aMessage)
   {
      return std::make_pair(false, true);
   }
   virtual ProcessResult PresentationReceive(double aSimTime, size_t aLayerIndex, Message& aMessage)
   {
      return std::make_pair(false, true);
   }


   virtual ProcessResult SessionSend(double aSimTime, size_t aLayerIndex, Message& aMessage)
   {
      return std::make_pair(false, true);
   }
   virtual ProcessResult SessionReceive(double aSimTime, size_t aLayerIndex, Message& aMessage)
   {
      return std::make_pair(false, true);
   }


   virtual ProcessResult TransportSend(double aSimTime, size_t aLayerIndex, Message& aMessage)
   {
      return std::make_pair(false, true);
   }
   virtual ProcessResult TransportReceive(double aSimTime, size_t aLayerIndex, Message& aMessage)
   {
      return std::make_pair(false, true);
   }


   virtual ProcessResult NetworkSend(double aSimTime, size_t aLayerIndex, Message& aMessage)
   {
      return std::make_pair(false, true);
   }
   virtual ProcessResult NetworkReceive(double aSimTime, size_t aLayerIndex, Message& aMessage)
   {
      return std::make_pair(false, true);
   }


   virtual ProcessResult DatalinkSend(double aSimTime, size_t aLayerIndex, Message& aMessage)
   {
      return std::make_pair(false, true);
   }
   virtual ProcessResult DatalinkReceive(double aSimTime, size_t aLayerIndex, Message& aMessage)
   {
      return std::make_pair(false, true);
   }


   virtual ProcessResult PhysicalSend(double aSimTime, size_t aLayerIndex, Message& aMessage)
   {
      return std::make_pair(false, true);
   }
   virtual ProcessResult PhysicalReceive(double aSimTime, size_t aLayerIndex, Message& aMessage)
   {
      return std::make_pair(false, true);
   }


};

class WSF_EXPORT ScriptProtocolClass : public UtScriptClass
{
public:
   ScriptProtocolClass(const std::string& aClassName, UtScriptTypes* aTypesPtr);
 
   ~ScriptProtocolClass() override = default;
};
 
} // namespace comm
} // namespace wsf
 
WSF_DECLARE_COMPONENT_ROLE_TYPE(wsf::comm::ProtocolInterface, cWSF_COMPONENT_COMM_PROTOCOL);
 
#endif