WsfObject.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 WSFOBJECT_HPP
#define WSFOBJECT_HPP
 
#include <memory>
#include <vector>
 
class UtInput;
#include "wsf_export.h"
 
#include "UtReferenceTracked.hpp"
#include "UtScriptAccessible.hpp"
#include "WsfStringId.hpp"
 
// =================================================================================================
// PROGRAMMING NOTE: See the source code file for information about thread-safety.
//                   DO NOT MODIFY THIS CLASS IF YOU DON'T UNDERSTAND THE INFORMATION.
// =================================================================================================

class WSF_EXPORT WsfObject : public UtScriptAccessible, public UtReferenceTracked
{
public:
   friend class WsfObjectTypeListBase;
   friend class WsfPluginManager;

   // See comments in code why this is a vector and not a list.
   typedef std::vector<WsfStringId> TypeList;
 
   WsfObject();
   ~WsfObject() override;
 
   const char* GetScriptClassName() const override;

   virtual WsfObject* Clone() const = 0;
 
   virtual bool ProcessInput(UtInput& aInput);


   const std::string& GetName() const;

   WsfStringId GetNameId() const { return mName; }

   void SetName(WsfStringId aName) { mName = aName; }


   const std::string& GetType() const;

   WsfStringId GetTypeId() const { return mTypeDataPtr->mType; }
 
   void SetType(WsfStringId aType);
 
   const std::string& GetBaseType() const;

   WsfStringId GetBaseTypeId() const { return mTypeDataPtr->mBaseType; }

   const TypeList& GetTypeList() const { return mTypeDataPtr->mTypeList; }

   bool IsA_TypeOf(WsfStringId aType) const { return mTypeDataPtr->IsA_TypeOf(aType); }
 
   WsfObject& operator=(const WsfObject& aRhs);

   template<typename T>
   void Serialize(T& aBuff)
   {
      aBuff& mName & mTypeDataPtr->mType & mTypeDataPtr->mBaseType & mTypeDataPtr->mTypeList;
   }
 
protected:
   WsfObject(const WsfObject& aSrc);
 
private:
   void SetTypeAndBaseType(WsfStringId aType, WsfStringId aBaseType);

   WsfStringId mName;

   class SharedTypeData
   {
   public:
      void AddToTypeList(WsfStringId aType);
 
      bool IsA_TypeOf(WsfStringId aType) const;

      WsfStringId mType;

      WsfStringId mBaseType;

      TypeList mTypeList;
   };
 
   std::shared_ptr<SharedTypeData> mTypeDataPtr;
};

class WSF_EXPORT WsfUncloneableObject : public WsfObject
{
public:
   WsfUncloneableObject()
      : WsfObject()
   {
   }
   WsfObject* Clone() const override;
};
 
#endif