WsfTaskStatusMessage.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 WSFTASKSTATUSMESSAGE_HPP
#define WSFTASKSTATUSMESSAGE_HPP
 
#include "wsf_export.h"
 
#include <memory>
#include <string>
 
class UtScriptClass;
class UtScriptTypes;
#include "WsfMessage.hpp"
class WsfPlatform;
#include "WsfStringId.hpp"
class WsfTask;
#include "WsfTrackId.hpp"

class WSF_EXPORT WsfTaskStatusMessage : public WsfMessage
{
public:
   WsfTaskStatusMessage(); // For XIO (de)serialization.
   WsfTaskStatusMessage(WsfPlatform* aPlatformPtr);
   WsfTaskStatusMessage(WsfStringId aStatusId, WsfPlatform* aSenderPtr, const WsfTask& aTask);
 
   WsfMessage* Clone() const override;
 
   const char* GetScriptClassName() const override;
 
   static std::unique_ptr<UtScriptClass> CreateScriptClass(const std::string& aClassName, UtScriptTypes* aScriptTypesPtr);
 
   static WsfStringId GetTypeId();

   unsigned int GetTaskId() const { return mTaskId; }



   unsigned int GetAcknowledgeId() const { return mAcknowledgeId; }

   void SetAcknowledgeId(unsigned int aAcknowledgeId) { mAcknowledgeId = aAcknowledgeId; }


   WsfPlatform* GetAssigner() const;

   size_t GetAssignerPlatformIndex() const { return mAssignerPlatformIndex; }

   void SetAssignerPlatformIndex(size_t aPlatformIndex) { mAssignerPlatformIndex = aPlatformIndex; }

   WsfStringId GetAssignerPlatformName() const { return mAssignerPlatformName; }

   WsfStringId GetAssignerProcessorName() const { return mAssignerProcessorName; }


   WsfPlatform* GetAssignee() const;

   size_t GetAssigneePlatformIndex() const { return mAssigneePlatformIndex; }

   void SetAssigneePlatformIndex(size_t aPlatformIndex) { mAssigneePlatformIndex = aPlatformIndex; }

   WsfStringId GetAssigneePlatformName() const { return mAssigneePlatformName; }

   WsfStringId GetAssigneeProcessorName() const { return mAssigneeProcessorName; }



   WsfStringId GetStatus() const { return mStatus; }

   void SetStatus(WsfStringId aStatus) { mStatus = aStatus; }

   void SetStatus(const std::string& aStatus) { mStatus = aStatus; }

   WsfStringId GetSubStatus() const { return mSubStatus; }

   void SetSubStatus(WsfStringId aSubStatus) { mSubStatus = aSubStatus; }

   void SetSubStatus(const std::string& aSubStatus) { mSubStatus = aSubStatus; }



   const WsfTrackId& GetTrackId() const { return mTrackId; }

   void SetTrackId(const WsfTrackId& aTrackId) { mTrackId = aTrackId; }



   WsfStringId GetTaskType() const { return mTaskType; }

   void SetTaskType(WsfStringId aTaskType) { mTaskType = aTaskType; }

   void SetTaskType(const std::string& aTaskType) { mTaskType = aTaskType; }



   WsfStringId GetResourceName() const { return mResourceName; }

   void SetResourceName(WsfStringId aResourceName) { mResourceName = aResourceName; }

   void SetResourceName(const std::string& aResourceName) { mResourceName = aResourceName; }



   size_t GetObjectPlatformIndex() const { return mObjectPlatformIndex; }

   void SetObjectPlatformIndex(size_t aIndex) { mObjectPlatformIndex = aIndex; }



   bool IsFromAssignee() const { return mIsFromAssignee; }

   void SetIsFromAssignee(bool aIsFromAssignee) { mIsFromAssignee = aIsFromAssignee; }

   template<typename T>
   void Serialize(T& aBuff)
   {
      WsfMessage::Serialize(aBuff);
      aBuff& mAcknowledgeId& mTaskId& mAssignerPlatformIndex& mAssignerPlatformName& mAssignerProcessorName& mAssigneePlatformIndex&
         mAssigneePlatformName& mAssigneeProcessorName& mStatus& mSubStatus& mTrackId& mTaskType& mResourceName& mIsFromAssignee;
   }
 
protected:
   // Using the default copy constructor.
   // WsfTaskStatusMessage(const WsfTaskStatusMessage& aSrc);

   unsigned int mAcknowledgeId;

   unsigned int mTaskId;

   size_t mAssignerPlatformIndex;

   WsfStringId mAssignerPlatformName;

   WsfStringId mAssignerProcessorName;

   size_t mAssigneePlatformIndex;

   WsfStringId mAssigneePlatformName;

   WsfStringId mAssigneeProcessorName;

   WsfStringId mStatus;

   WsfStringId mSubStatus;

   WsfTrackId mTrackId;

   WsfStringId mTaskType;

   WsfStringId mResourceName;

   size_t mObjectPlatformIndex;

   bool mIsFromAssignee;
};
 
#endif