Model_Data.h

// Copyright (C) 2014-2025  CEA, EDF
//
// This library is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public
// License as published by the Free Software Foundation; either
// version 2.1 of the License, or (at your option) any later version.
//
// This library is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
// Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
//
// See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
//
 
#ifndef Model_Data_H_
#define Model_Data_H_
 
#include <Model.h>
#include <ModelAPI_Attribute.h>
#include <ModelAPI_AttributeBoolean.h>
#include <ModelAPI_AttributeDocRef.h>
#include <ModelAPI_AttributeDouble.h>
#include <ModelAPI_AttributeInteger.h>
#include <ModelAPI_AttributeRefAttr.h>
#include <ModelAPI_AttributeReference.h>
#include <ModelAPI_AttributeRefList.h>
#include <ModelAPI_AttributeRefAttrList.h>
#include <ModelAPI_AttributeString.h>
#include <ModelAPI_AttributeStringArray.h>
#include <ModelAPI_AttributeIntArray.h>
#include <ModelAPI_AttributeImage.h>
#include <ModelAPI_Data.h>
#include <ModelAPI_Feature.h>
#include <ModelAPI_Folder.h>
#include <ModelAPI_Object.h>
 
#include <TDF_Label.hxx>
#include <TDataStd_BooleanArray.hxx>
 
#include <memory>
 
#include <map>
#include <list>
#include <string>
#include <vector>
#include <set>
 
class ModelAPI_Attribute;
 
class Model_Data : public ModelAPI_Data
{
  typedef std::map<std::string, std::pair<std::shared_ptr<ModelAPI_Attribute>, int> > AttributeMap;
 
  TDF_Label myLab;  
  AttributeMap myAttrs;
  Handle(TDataStd_BooleanArray) myFlags;
 
  ObjectPtr myObject;
 
  std::set<AttributePtr> myRefsToMe;
  bool mySendAttributeUpdated;
  std::list<ModelAPI_Attribute*> myWasChangedButBlocked;
 
  TDF_Label label()
  {
    return myLab;
  }
 
  friend class Model_Document;
  friend class Model_Objects;
  friend class Model_Update;
  friend class Model_AttributeReference;
  friend class Model_AttributeRefAttr;
  friend class Model_AttributeRefList;
  friend class Model_AttributeRefAttrList;
  friend class Model_AttributeSelection;
  friend class Model_AttributeSelectionList;
  friend class Model_ValidatorsFactory;
  friend class Model_SelectionNaming;
  friend class Model_ResultConstruction;
  friend class Model_ResultBody;
  friend class Model_Tools;
 
 public:
  Model_Data();
  MODEL_EXPORT virtual std::wstring name();
  MODEL_EXPORT virtual std::wstring name(std::shared_ptr<GeomAPI_Shape> theSubShape);
  MODEL_EXPORT virtual void setName(const std::wstring& theName);
  MODEL_EXPORT virtual bool hasUserDefinedName() const;
  MODEL_EXPORT virtual std::string version();
  MODEL_EXPORT virtual void setVersion(const std::string& theVersion);
  MODEL_EXPORT virtual std::shared_ptr<ModelAPI_AttributeDocRef> document(const std::string& theID);
  MODEL_EXPORT virtual std::shared_ptr<ModelAPI_AttributeDouble> real(const std::string& theID);
  MODEL_EXPORT virtual
    std::shared_ptr<ModelAPI_AttributeDoubleArray> realArray(const std::string& theID);
  MODEL_EXPORT virtual std::shared_ptr<ModelAPI_AttributeInteger>
    integer(const std::string& theID);
  MODEL_EXPORT virtual std::shared_ptr<ModelAPI_AttributeReference>
    reference(const std::string& theID);
  MODEL_EXPORT virtual std::shared_ptr<ModelAPI_AttributeSelection>
    selection(const std::string& theID);
  MODEL_EXPORT virtual std::shared_ptr<ModelAPI_AttributeSelectionList>
    selectionList(const std::string& theID);
  MODEL_EXPORT virtual std::shared_ptr<ModelAPI_AttributeRefAttr>
    refattr(const std::string& theID);
  MODEL_EXPORT virtual std::shared_ptr<ModelAPI_AttributeRefList>
    reflist(const std::string& theID);
  MODEL_EXPORT virtual std::shared_ptr<ModelAPI_AttributeRefAttrList>
    refattrlist(const std::string& theID);
  MODEL_EXPORT virtual std::shared_ptr<ModelAPI_AttributeBoolean>
    boolean(const std::string& theID);
  MODEL_EXPORT virtual std::shared_ptr<ModelAPI_AttributeString>
    string(const std::string& theID);
  MODEL_EXPORT virtual std::shared_ptr<ModelAPI_AttributeIntArray>
    intArray(const std::string& theID);
  MODEL_EXPORT virtual std::shared_ptr<ModelAPI_AttributeStringArray>
    stringArray(const std::string& theID);
  MODEL_EXPORT virtual std::shared_ptr<ModelAPI_AttributeTables>
    tables(const std::string& theID);
  MODEL_EXPORT virtual std::shared_ptr<ModelAPI_AttributeImage>
    image(const std::string& theID);
 
  MODEL_EXPORT virtual std::shared_ptr<ModelAPI_Attribute> attribute(const std::string& theID);
  MODEL_EXPORT virtual std::list<std::shared_ptr<ModelAPI_Attribute> >
    attributes(const std::string& theType);
  MODEL_EXPORT virtual std::list<std::string> attributesIDs(const std::string& theType);
 
  MODEL_EXPORT virtual const std::string& id(const std::shared_ptr<ModelAPI_Attribute>& theAttr);
  MODEL_EXPORT virtual bool isEqual(const std::shared_ptr<ModelAPI_Data>& theData);
  MODEL_EXPORT virtual bool isValid();
 
  TDF_Label shapeLab() const
  {
    return myLab.IsNull() ? myLab : myLab.Father().FindChild(2);
  }
 
  MODEL_EXPORT virtual AttributePtr
    addAttribute(const std::string& theID, const std::string theAttrType, const int theIndex = -1);
 
  MODEL_EXPORT virtual AttributePtr
    addFloatingAttribute(const std::string& theID, const std::string theAttrType,
      const std::string& theGroup);
 
  MODEL_EXPORT virtual void allGroups(std::list<std::string>& theGroups);
 
  MODEL_EXPORT virtual void attributesOfGroup(const std::string& theGroup,
    std::list<std::shared_ptr<ModelAPI_Attribute> >& theAttrs);
 
  MODEL_EXPORT virtual void removeAttributes(const std::string& theGroup);
 
  MODEL_EXPORT virtual void sendAttributeUpdated(ModelAPI_Attribute* theAttr);
  MODEL_EXPORT virtual bool blockSendAttributeUpdated(
    const bool theBlock, const bool theSendMessage = true);
 
  MODEL_EXPORT void setLabel(TDF_Label theLab);
 
  MODEL_EXPORT virtual void setObject(ObjectPtr theObject)
  {
    myObject = theObject;
  }
 
  MODEL_EXPORT virtual void erase();
 
  MODEL_EXPORT virtual void execState(const ModelAPI_ExecState theState);
 
  MODEL_EXPORT virtual ModelAPI_ExecState execState();
 
  MODEL_EXPORT virtual void setError(const std::string& theError, bool theSend = true);
 
  void eraseErrorString();
 
  MODEL_EXPORT virtual std::string error() const;
 
  MODEL_EXPORT virtual int featureId() const;
 
  MODEL_EXPORT virtual const std::set<AttributePtr>& refsToMe() {return myRefsToMe;}
 
  MODEL_EXPORT virtual void referencesToObjects(
    std::list<std::pair<std::string, std::list<ObjectPtr> > >& theRefs);
 
  MODEL_EXPORT virtual void copyTo(std::shared_ptr<ModelAPI_Data> theTarget);
 
  MODEL_EXPORT virtual std::shared_ptr<ModelAPI_Data> invalidPtr();
 
  static std::shared_ptr<ModelAPI_Data> invalidData();
 
  MODEL_EXPORT virtual int updateID();
 
  MODEL_EXPORT virtual void setUpdateID(const int theID);
 
  MODEL_EXPORT virtual std::shared_ptr<ModelAPI_Object> owner();
 
protected:
  MODEL_EXPORT virtual bool isInHistory();
 
  MODEL_EXPORT virtual void setIsInHistory(const bool theFlag);
 
  MODEL_EXPORT virtual bool isDeleted();
 
  MODEL_EXPORT virtual void setIsDeleted(const bool theFlag);
 
  void clearAttributes();
 
private:
  void removeBackReference(ObjectPtr theObject, std::string theAttrID);
  void removeBackReference(AttributePtr theAttr);
  void addBackReference(FeaturePtr theFeature, std::string theAttrID,
    const bool theApplyConcealment = true);
  void addBackReference(ObjectPtr theObject, std::string theAttrID);
 
  MODEL_EXPORT virtual void updateConcealmentFlag();
 
  MODEL_EXPORT virtual bool isDisplayed();
 
  MODEL_EXPORT virtual void setDisplayed(const bool theDisplay);
 
  MODEL_EXPORT virtual bool isPrecedingAttribute(const std::string& theAttribute1,
                                                 const std::string& theAttribute2) const;
 
};
 
#define ADD_BACK_REF(TARGET) \
  if (TARGET.get() != NULL) { \
    std::shared_ptr<Model_Data> aTargetData = \
        std::dynamic_pointer_cast<Model_Data>((TARGET)->data()); \
    FeaturePtr anAttributeOwnerFeature = std::dynamic_pointer_cast<ModelAPI_Feature>(owner()); \
    if (anAttributeOwnerFeature.get()) \
      aTargetData->addBackReference(anAttributeOwnerFeature, id(), false); \
    else { \
      FolderPtr anAttributeOwnerFolder = std::dynamic_pointer_cast<ModelAPI_Folder>(owner()); \
      if (anAttributeOwnerFolder.get()) \
        aTargetData->addBackReference(ObjectPtr(anAttributeOwnerFolder), id()); \
    } \
  }
 
#define REMOVE_BACK_REF(TARGET) \
  if (TARGET.get() != NULL) { \
    std::shared_ptr<Model_Data> aTargetData = \
        std::dynamic_pointer_cast<Model_Data>((TARGET)->data()); \
    FeaturePtr anAttOwnerFeature = std::dynamic_pointer_cast<ModelAPI_Feature>(owner()); \
    if (anAttOwnerFeature.get()) \
      aTargetData->removeBackReference(anAttOwnerFeature, id()); \
    else { \
      FolderPtr anAttributeOwnerFolder = std::dynamic_pointer_cast<ModelAPI_Folder>(owner()); \
      if (anAttributeOwnerFolder.get()) \
        aTargetData->removeBackReference(ObjectPtr(anAttributeOwnerFolder), id()); \
    } \
  }
 
#endif