WsfCommRouterProtocolInterface.hpp

Go to the documentation of this file.

// ****************************************************************************
// CUI
//
// The Advanced Framework for Simulation, Integration, and Modeling (AFSIM)
//
// Copyright 2019 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 WSFCOMMROUTERPROTOCOLINTERFACE_HPP
#define WSFCOMMROUTERPROTOCOLINTERFACE_HPP
 
#include "wsf_export.h"
 
#include "UtScriptTypes.hpp"
#include "WsfCommGraph.hpp"
#include "WsfCommMessage.hpp"
#include "WsfCommProtocolPriority.hpp"
#include "WsfCommRouter.hpp"
#include "WsfCommRouterComponent.hpp"
#include "WsfObject.hpp"
 
namespace wsf
{
namespace comm
{
namespace router
{
 
class WSF_EXPORT ProtocolInterface : public RouterComponent, public WsfObject
{
public:
   ProtocolInterface()           = default;
   ~ProtocolInterface() override = default;
   const char* GetScriptClassName() const override { return "WsfCommRouterProtocol"; }


   WsfComponent* CloneComponent() const override = 0;
   WsfStringId   GetComponentName() const override 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 bool          ShouldPropagateTruth() const = 0;
   virtual graph::Graph* GetGraph() const             = 0;

   virtual int GetPriority() const = 0;

   virtual std::vector<Address> Routing(double         aSimTime,
                                        const Address& aSendingInterface,
                                        size_t&        aHopNumber,
                                        double&        aCost,
                                        const Message& aMessage) = 0;


   virtual bool Send(double aSimTime, Router::SendData& aData) { return false; }
 
   virtual bool Receive(double aSimTime, const Address& aReceivingInterface, Message& aMessage, bool& aOverrideForward)
   {
      return false;
   }



   virtual void PerfectCommAdded(double aSimTime, Comm* aCommPtr) {}
   virtual void PerfectCommRemoved(double aSimTime, Comm* aCommPtr) {}
   virtual void PerfectNetworkAdded(double aSimTime, Network* aNetworkPtr) {}
   virtual void PerfectNetworkRemoved(double aSimTime, Network* aNetworkPtr) {}
   virtual void PerfectCommEnabled(double aSimTime, Comm* aCommPtr) {}
   virtual void PerfectCommDisabled(double aSimTime, Comm* aCommPtr) {}
   virtual void PerfectConnectionAdded(double aSimTime, const Address& aSourceAddress, const Address& aDestinationAddress)
   {
   }
   virtual void PerfectConnectionRemoved(double aSimTime, const Address& aSourceAddress, const Address& aDestinationAddress)
   {
   }
   virtual void PerfectConnectionEnabled(double aSimTime, const Address& aSourceAddress, const Address& aDestinationAddress)
   {
   }
   virtual void PerfectConnectionDisabled(double aSimTime, const Address& aSourceAddress, const Address& aDestinationAddress)
   {
   }

};

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