ModelAPI_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 ModelAPI_Data_H_
#define ModelAPI_Data_H_
 
#ifdef _WINDOWS // to avoid too long decorated name warning
#pragma warning( disable : 4503 )
#endif
 
#include "ModelAPI.h"
#include <string>
#include <vector>
#include <list>
#include <set>
#include <memory>
 
class ModelAPI_Attribute;
class ModelAPI_AttributeDocRef;
class ModelAPI_AttributeInteger;
class ModelAPI_AttributeDouble;
class ModelAPI_AttributeDoubleArray;
class ModelAPI_AttributeReference;
class ModelAPI_AttributeRefAttr;
class ModelAPI_AttributeRefList;
class ModelAPI_AttributeRefAttrList;
class ModelAPI_AttributeBoolean;
class ModelAPI_AttributeString;
class ModelAPI_AttributeStringArray;
class ModelAPI_Document;
class ModelAPI_Attribute;
class ModelAPI_Feature;
class ModelAPI_AttributeSelection;
class ModelAPI_AttributeSelectionList;
class ModelAPI_AttributeIntArray;
class ModelAPI_AttributeImage;
class ModelAPI_AttributeTables;
class ModelAPI_Object;
class GeomAPI_Shape;
 
enum ModelAPI_ExecState {
  ModelAPI_StateDone, 
  ModelAPI_StateMustBeUpdated, 
  ModelAPI_StateExecFailed, 
  ModelAPI_StateInvalidArgument, 
  ModelAPI_StateNothing 
};
 
class MODELAPI_EXPORT ModelAPI_Data
{
 public:
 
  virtual std::wstring name() = 0;
  virtual std::wstring name(std::shared_ptr<GeomAPI_Shape> theSubShape) = 0;
  virtual void setName(const std::wstring& theName) = 0;
  virtual bool hasUserDefinedName() const = 0;
 
  virtual std::string version() = 0;
  virtual void setVersion(const std::string& theVersion) = 0;
 
  virtual std::shared_ptr<ModelAPI_AttributeDocRef> document(const std::string& theID) = 0;
  virtual std::shared_ptr<ModelAPI_AttributeDouble> real(const std::string& theID) = 0;
  virtual std::shared_ptr<ModelAPI_AttributeDoubleArray> realArray(const std::string& theID) = 0;
  virtual std::shared_ptr<ModelAPI_AttributeInteger> integer(const std::string& theID) = 0;
  virtual std::shared_ptr<ModelAPI_AttributeReference> reference(const std::string& theID) = 0;
  virtual std::shared_ptr<ModelAPI_AttributeSelection> selection(const std::string& theID) = 0;
  virtual std::shared_ptr<ModelAPI_AttributeSelectionList>
    selectionList(const std::string& theID) = 0;
  virtual std::shared_ptr<ModelAPI_AttributeRefAttr> refattr(const std::string& theID) = 0;
  virtual std::shared_ptr<ModelAPI_AttributeRefList> reflist(const std::string& theID) = 0;
  virtual std::shared_ptr<ModelAPI_AttributeRefAttrList> refattrlist(const std::string& theID) = 0;
  virtual std::shared_ptr<ModelAPI_AttributeBoolean> boolean(const std::string& theID) = 0;
  virtual std::shared_ptr<ModelAPI_AttributeString> string(const std::string& theID) = 0;
  virtual std::shared_ptr<ModelAPI_AttributeIntArray> intArray(const std::string& theID) = 0;
  virtual std::shared_ptr<ModelAPI_AttributeStringArray> stringArray(const std::string& theID) = 0;
  virtual std::shared_ptr<ModelAPI_AttributeImage> image(const std::string& theID) = 0;
  virtual std::shared_ptr<ModelAPI_AttributeTables> tables(const std::string& theID) = 0;
 
  virtual std::shared_ptr<ModelAPI_Attribute> attribute(const std::string& theID) = 0;
  virtual std::list<std::shared_ptr<ModelAPI_Attribute> >
  attributes(const std::string& theType) = 0;
  virtual std::list<std::string> attributesIDs(const std::string& theType) = 0;
  virtual const std::string& id(const std::shared_ptr<ModelAPI_Attribute>& theAttr) = 0;
  virtual bool isEqual(const std::shared_ptr<ModelAPI_Data>& theData) = 0;
  virtual bool isValid() = 0;
 
  virtual std::shared_ptr<ModelAPI_Attribute> addAttribute(
    const std::string& theID, const std::string theAttrType, const int theIndex = -1) = 0;
 
  virtual std::shared_ptr<ModelAPI_Attribute>
    addFloatingAttribute(const std::string& theID, const std::string theAttrType,
      const std::string& theGroup) = 0;
 
  virtual void allGroups(std::list<std::string>& theGroups) = 0;
 
  virtual void attributesOfGroup(const std::string& theGroup,
    std::list<std::shared_ptr<ModelAPI_Attribute> >& theAttrs) = 0;
 
  virtual void removeAttributes(const std::string& theGroup) = 0;
 
  virtual void sendAttributeUpdated(ModelAPI_Attribute* theAttr) = 0;
  virtual bool blockSendAttributeUpdated(
    const bool theBlock, const bool theSendMessage = true) = 0;
 
  virtual void erase() = 0;
 
  virtual ~ModelAPI_Data();
 
  virtual void execState(const ModelAPI_ExecState theState) = 0;
 
  virtual ModelAPI_ExecState execState() = 0;
 
  virtual void setError(const std::string& theError, bool theSend = true) = 0;
 
  virtual std::string error() const = 0;
 
  virtual int featureId() const = 0;
 
  virtual const std::set<std::shared_ptr<ModelAPI_Attribute> >& refsToMe() = 0;
 
  virtual void referencesToObjects(
    std::list<std::pair<std::string, std::list<std::shared_ptr<ModelAPI_Object> > > >& theRefs) =0;
 
  virtual void copyTo(std::shared_ptr<ModelAPI_Data> theTarget) = 0;
 
  virtual std::shared_ptr<ModelAPI_Data> invalidPtr() = 0;
 
  virtual int updateID() = 0;
 
  virtual void setUpdateID(const int theID) = 0;
 
  virtual std::shared_ptr<ModelAPI_Object> owner() = 0;
 
  virtual bool isDeleted() = 0;
 
  virtual void setIsDeleted(const bool theFlag) = 0;
 
  virtual bool isPrecedingAttribute(const std::string& theAttribute1,
                                    const std::string& theAttribute2) const = 0;
 
 protected:
  ModelAPI_Data();
 
  virtual bool isInHistory() = 0;
 
  virtual void setIsInHistory(const bool theFlag) = 0;
 
  virtual bool isDisplayed() = 0;
 
  virtual void setDisplayed(const bool theDisplay) = 0;
 
  friend class ModelAPI_Object;
};
 
typedef std::shared_ptr<ModelAPI_Data> DataPtr;
 
#endif