WsfCommComponent.hpp

Go to the documentation of this file.

// ****************************************************************************
// CUI
//
// The Advanced Framework for Simulation, Integration, and Modeling (AFSIM)
//
// Copyright 2003-2015 The Boeing 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 WSFCOMMCOMPONENT_HPP
#define WSFCOMMCOMPONENT_HPP
 
#include "wsf_export.h"
 
#include "WsfComponent.hpp"
 
class WsfMessage;
class WsfPlatform;
class WsfSimulation;
 
namespace wsf
{
namespace comm
{
 
class Address;
class Comm;
class Message;
class Result;

class WSF_EXPORT Component : public WsfComponentT<Comm>
{
public:
   Component()           = default;
   ~Component() override = default;


   Comm*          GetComm() const { return GetComponentParent(); }
   WsfPlatform*   GetPlatform() const;
   WsfSimulation* GetSimulation() const;


   using WsfComponent::Initialize;
   using WsfComponent::Initialize2;
   using WsfComponent::PreInitialize;
   using WsfComponent::ProcessInput;
   virtual void TurnOn(double aSimTime) {}
   virtual void TurnOff(double aSimTime) {}
   virtual void Setup() {}
   virtual void PendingStart() {}


 
   virtual void AttemptToTransmit(double aSimTime, Result& aResult) {}
 
   virtual void AttemptToReceive(double aSimTime, Result& aResult) {}
 
   virtual bool CanInteractWith(const Comm* aXmtrPtr);
 
   virtual bool Receive(double aSimTime, Comm* aXmtrPtr, Message& aMessage) { return true; }
   virtual bool Send(double aSimTime, const WsfMessage& aMessage, const Address& aAddress) { return true; }



   static void AttemptToTransmit(Comm& aComm, double aSimTime, Result& aResult);
 
   static void AttemptToReceive(Comm& aComm, double aSimTime, Result& aResult);
 
   static bool Receive(Comm& aComm, double aSimTime, Comm* aXmtrPtr, Message& aMessage);
   static bool Send(Comm& aComm, double aSimTime, const WsfMessage& aMessage, const Address& aAddress);
};
 
} // namespace comm
} // namespace wsf
 
#endif