src/Model/Model_AttributeRefList.h

   1 // Copyright (C) 2014-20xx CEA/DEN, EDF R&D
   2
   3 // File:        Model_AttributeRefList.h
   4 // Created:     8 May 2014
   5 // Author:      Mikhail PONIKAROV
   6
   7 #ifndef Model_AttributeRefList_H_
   8 #define Model_AttributeRefList_H_
   9
  10 #include "Model.h"
  11 #include "ModelAPI_AttributeRefList.h"
  12 #include "ModelAPI_Feature.h"
  13
  14 #include <TDataStd_ReferenceList.hxx>
  15
  16 /**\class Model_AttributeRefList
  17  * \ingroup DataModel
  18  * \brief Attribute that contains list of references to features (located in the same document).
  19  * For the current moment it does not support references t oobjects in other documents.
  20  */
  21
  22 class Model_AttributeRefList : public ModelAPI_AttributeRefList
  23 {
  24   Handle_TDataStd_ReferenceList myRef;  ///< references to the features labels
  25  public:
  26   /// Appends the feature to the end of a list
  27   MODEL_EXPORT virtual void append(ObjectPtr theObject);
  28
  29   /// Erases the first meet of the feature in the list
  30   MODEL_EXPORT virtual void remove(ObjectPtr theObject);
  31
  32   /// Returns number of features in the list
  33   MODEL_EXPORT virtual int size() const;
  34
  35   /// Removes all references from the list
  36   MODEL_EXPORT virtual void clear();
  37
  38   /// Returns the list of features
  39   MODEL_EXPORT virtual std::list<ObjectPtr> list();
  40
  41   /// Returns the list of features
  42   MODEL_EXPORT virtual ObjectPtr object(const int theIndex) const;
  43
  44   /// Returns true if attribute was  initialized by some value
  45   MODEL_EXPORT virtual bool isInitialized();
  46  protected:
  47   /// Objects are created for features automatically
  48   MODEL_EXPORT Model_AttributeRefList(TDF_Label& theLabel);
  49
  50   friend class Model_Data;
  51 };
  52
  53 #endif