WsfCommMediumMessageStatus.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 WSFCOMMMEDIUMMESSAGESTATUS_HPP
#define WSFCOMMMEDIUMMESSAGESTATUS_HPP
 
#include "wsf_export.h"
 
#include "UtScriptAccessible.hpp"
#include "UtScriptClassDefine.hpp"
#include "WsfAuxDataEnabled.hpp"
#include "WsfCommLayer.hpp"
#include "WsfCommMessage.hpp"
#include "script/WsfScriptAuxDataUtil.hpp"
 
namespace wsf
{
namespace comm
{
namespace medium
{

class WSF_EXPORT MessageStatus : public UtScriptAccessible, public WsfAuxDataEnabled
{
public:
   MessageStatus(double aSimTime, Message& aMessage, size_t aMode)
      : mMessage(aMessage)
      , mMode(aMode)
      , mTimeStart(aSimTime)
      , mTimeTransmissionEnd(aSimTime)
   {
   }
 
   ~MessageStatus() override                = default;
   MessageStatus(const MessageStatus& aSrc) = default;
 
   const char* GetScriptClassName() const override { return "WsfCommMediumMessageStatus"; }
 
   void SetMessage(const Message& aMessage) { mMessage = aMessage; }
   void SetMode(size_t aMode) { mMode = aMode; }
   void SetLayer(Layer* aLayerPtr) { mLayerPtr = aLayerPtr; }
   void SetIsTransmitting(bool aIsTransmitting) { mTransmitting = aIsTransmitting; }
   void SetIsScheduledDelivery(bool aIsScheduledDelivery) { mScheduledDelivery = aIsScheduledDelivery; }
   void SetTimeStart(double aSimTime) { mTimeStart = aSimTime; }
   void SetTimeTransmissionEnd(double aSimTime) { mTimeTransmissionEnd = aSimTime; }
   void SetTimeDelivery(double aSimTime) { mTimeDelivery = aSimTime; }
   void SetAbortDelivery(bool aAbort) { mAbortDelivery = aAbort; }
   void SetTimeLastXmtrStatusChange(double aSimTime) { mXmtrLastStatusChange = aSimTime; }
   void SetStatusIssued(bool aIssued) { mStatusIssued = aIssued; }
 
   const Message& GetMessage() const { return mMessage; }
   Message&       GetMessage() { return mMessage; }
   size_t         GetMode() const { return mMode; }
   Layer*         GetLayer() const { return mLayerPtr; }
   bool           IsTransmitting() const { return mTransmitting; }
   bool           IsScheduledDelivery() const { return mScheduledDelivery; }
   double         GetTimeStart() const { return mTimeStart; }
   double         GetTimeTransmissionEnd() const { return mTimeTransmissionEnd; }
   double         GetTimeDelivery() const { return mTimeDelivery; }
   bool           AbortDelivery() const { return mAbortDelivery; }
   double         GetTimeLastXmtrStatusChange() const { return mXmtrLastStatusChange; }
   bool           IsStatusIssued() const { return mStatusIssued; }
 
private:
   Message mMessage;

   size_t mMode;

   Layer* mLayerPtr{nullptr};

   bool mTransmitting{true};

   bool mScheduledDelivery{false};

   double mTimeStart;

   double mTimeTransmissionEnd;

   double mTimeDelivery{0.0};

   bool mAbortDelivery{false};

   double mXmtrLastStatusChange{0.0};

   bool mStatusIssued{false};
};
 
class WSF_EXPORT ScriptMediumMessageStatusClass : public UtScriptClass
{
public:
   ScriptMediumMessageStatusClass(const std::string& aClassName, UtScriptTypes* aScriptTypesPtr);
 
   ~ScriptMediumMessageStatusClass() override = default;
 
   UT_DECLARE_SCRIPT_METHOD(GetMessage);
   UT_DECLARE_SCRIPT_METHOD(IsTransmitting);
   UT_DECLARE_SCRIPT_METHOD(GetTimeStart);
   UT_DECLARE_SCRIPT_METHOD(GetTimeTransmissionEnd);
   UT_DECLARE_SCRIPT_METHOD(GetTimeDelivery);
   UT_DECLARE_SCRIPT_METHOD(GetDeliveryFailure);
 
   UT_DECLARE_SCRIPT_METHOD(SetDeliveryFailure);
 
   UT_DECLARE_AUX_DATA_SCRIPT_METHODS()
};
 
} // namespace medium
} // namespace comm
} // namespace wsf
 
#endif