#include <ModelAPI_Object.h>
#include <TDF_Label.hxx>
+#include <TDataStd_BooleanArray.hxx>
#include <memory>
TDF_Label myLab; ///< label of the feature in the document
/// All attributes of the object identified by the attribute ID
std::map<std::string, std::shared_ptr<ModelAPI_Attribute> > myAttrs;
+ /// Array of flags of this data
+ Handle(TDataStd_BooleanArray) myFlags;
/// needed here to emit signal that object changed on change of the attribute
ObjectPtr myObject;
/// flag that may block the "attribute updated" sending
bool mySendAttributeUpdated;
- Model_Data();
-
/// Returns label of this feature
TDF_Label label()
{
}
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_AttributeSelection;
+ friend class Model_AttributeSelectionList;
public:
+ /// The simplest constructor. "setLabel" must be called just after to initialize correctly.
+ Model_Data();
/// Returns the name of the feature visible by the user in the object browser
MODEL_EXPORT virtual std::string name();
/// Defines the name of the feature visible by the user in the object browser
MODEL_EXPORT virtual ModelAPI_ExecState execState();
/// Registers error during the execution, causes the ExecutionFailed state
- MODEL_EXPORT virtual void setError(const std::string& theError);
+ MODEL_EXPORT virtual void setError(const std::string& theError, bool theSend = true);
+
+ /// Erases the error string if it is not empty
+ void eraseErrorString();
+
+ /// Registers error during the execution, causes the ExecutionFailed state
+ MODEL_EXPORT virtual std::string error() const;
/// Returns the identifier of feature-owner, unique in this document
MODEL_EXPORT virtual int featureId() const;
/// Copies all atributes content into theTarget data
MODEL_EXPORT virtual void copyTo(std::shared_ptr<ModelAPI_Data> theTarget);
+ /// Returns the invalid data pointer (to avoid working with NULL shared ptrs in swig)
+ MODEL_EXPORT virtual std::shared_ptr<ModelAPI_Data> invalidPtr();
+
+ /// Returns the invalid data pointer: static method
+ static std::shared_ptr<ModelAPI_Data> invalidData();
+
+ /// Identifier of the transaction when object (feature or result) was updated last time.
+ MODEL_EXPORT virtual int updateID();
+
+ /// Identifier of the transaction when object (feature or result) was updated last time.
+ /// This method is called by the updater.
+ MODEL_EXPORT virtual void setUpdateID(const int theID);
+
+ /// Returns true if the given object is owner of this data (needed for correct erase of object
+ /// with duplicated data)
+ MODEL_EXPORT virtual std::shared_ptr<ModelAPI_Object> owner();
+
+protected:
+ /// Returns true if "is in history" custom behaviors is defined for the feature
+ MODEL_EXPORT virtual bool isInHistory();
+
+ /// Defines the custom "is in history" behavior
+ MODEL_EXPORT virtual void setIsInHistory(const bool theFlag);
+
+ /// Returns true if the object is deleted, but some data is still keept in memory
+ MODEL_EXPORT virtual bool isDeleted();
+
+ /// Sets true if the object is deleted, but some data is still keept in memory
+ MODEL_EXPORT virtual void setIsDeleted(const bool theFlag);
+
private:
/// Removes all information about back references
void eraseBackReferences();
/// Adds a back reference (with identifier which attribute references to this object
+ /// It does not change the consealment flag of the data object result
/// \param theFeature feature referenced to this
/// \param theAttrID identifier of the attribute that is references from theFeature to this
void removeBackReference(FeaturePtr theFeature, std::string theAttrID);
/// \param theApplyConcealment applies consealment flag changes
void addBackReference(FeaturePtr theFeature, std::string theAttrID,
const bool theApplyConcealment = true);
+
+ /// Makes the concealment flag up to date for this object-owner.
+ MODEL_EXPORT virtual void updateConcealmentFlag();
+
+ /// Returns true if object must be displayed in the viewer: flag is stored in the
+ /// data model, so on undo/redo, open/save or recreation of object by history-playing it keeps
+ /// the original state i nthe current transaction.
+ MODEL_EXPORT virtual bool isDisplayed();
+
+ /// Sets the displayed/hidden state of the object. If it is changed, sends the "redisplay"
+ /// signal.
+ MODEL_EXPORT virtual void setDisplayed(const bool theDisplay);
};
+/// Generic method to register back reference, used in referencing attributes.
+/// Without concealment change, it will be done later, on synchronization.
+#define ADD_BACK_REF(TARGET) \
+ if (TARGET.get() != NULL) { \
+ FeaturePtr anAttributeOwnerFeature = std::dynamic_pointer_cast<ModelAPI_Feature>(owner()); \
+ if (anAttributeOwnerFeature.get()) { \
+ std::shared_ptr<Model_Data> aTargetData = std::dynamic_pointer_cast<Model_Data>( \
+ (TARGET)->data()); \
+ aTargetData->addBackReference(anAttributeOwnerFeature, id(), false); \
+ } \
+ }
+
+/// Generic method to unregister back reference, used in referencing attributes.
+/// Without concealment change, it will be done later, on synchronization.
+#define REMOVE_BACK_REF(TARGET) \
+ if (TARGET.get() != NULL) { \
+ FeaturePtr anAttOwnerFeature = std::dynamic_pointer_cast<ModelAPI_Feature>(owner()); \
+ if (anAttOwnerFeature.get()) { \
+ std::shared_ptr<Model_Data> aTargetData = std::dynamic_pointer_cast<Model_Data>( \
+ (TARGET)->data()); \
+ aTargetData->removeBackReference(anAttOwnerFeature, id()); \
+ } \
+ }
+
#endif
