WsfCategoryList.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 WSFCATEGORYLIST_HPP
#define WSFCATEGORYLIST_HPP
 
#include "wsf_export.h"
 
#include <vector>
 
class UtInput;
#include "WsfStringId.hpp"

 
class WSF_EXPORT WsfCategoryList
{
public:
   typedef std::vector<WsfStringId> CategoryList;
 
   WsfCategoryList();

   void Clear() { mCategories.clear(); }
 
   void JoinCategory(WsfStringId aCategoryId);
 
   bool ProcessInput(UtInput& aInput);
 
   bool IsCategoryMember(WsfStringId aCategoryId) const;
 
   bool Intersects(const WsfCategoryList& aOtherList) const;
 
   bool IsASubsetOf(const WsfCategoryList& aOtherList) const;

   const CategoryList& GetCategoryList() const { return mCategories; }
 
private:
   // Using the default copy constructor, destructor and assignment operator.
 
   // The set of categories to which the associated object belongs.
   //
   // Logically this should be a 'set', but most objects will only be a member of a few categories.
   // In such a case, searching a 'vector' is faster than searching a set. Furthermore, sometimes
   // it is desirable to know the order in which categories were added. A 'set' wont work there.
 
   CategoryList mCategories;
};
 
#endif