Message.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 MESSAGE_HPP
#define MESSAGE_HPP
 
#include "usmtf_export.h"
 
#include <memory>
#include <utility>
#include <vector>
 
#include "Segment.hpp"
#include "Set.hpp"
#include "Validatable.hpp"

 

namespace usmtf
{

class USMTF_EXPORT Message : public Validatable
{
public:
   Message(const std::string& aMTF, std::vector<std::unique_ptr<Set>> aSets) noexcept;
   Message(const Message&) = delete;
   Message& operator=(const Message&) = delete;
   virtual ~Message()                 = default;
   const std::string& GetType() const noexcept;
   const Set& GetSet(Segment::SetPosition aSetIndex) const;
   Segment::SetLocations GetSets(const std::string& aSTF) const noexcept;
   Segment::SetLocations GetSets(const std::vector<std::string>& aSTF) const noexcept;
   Segment GetSegment(const Segment::SetPosition& startPosition, const Segment::SetPosition& stopPosition) const;
   std::vector<Segment> GetSegments(const std::string& aSTF) const;
   size_t GetNumberOfSets() const noexcept;
   bool IsEmpty() const noexcept;
 
protected:
   bool                              IsSetPositionOutOfBounds(const Segment::SetPosition& aPos) const noexcept;
   const std::string                 mMessageTextFormat;
   std::vector<std::unique_ptr<Set>> mSets;
}; // The message abstraction is necessary, as it prescribes ordered arrangement of sets. And sets, prescribe ordered
   // arrangement of fields.
} // namespace usmtf
#endif