std::list<std::shared_ptr<ModelAPI_Result> > myResults;
///< is feature disabled or not
bool myIsDisabled;
+ ///< is feature is stable (not editing)
+ bool myIsStable;
+
public:
/// Returns the unique kind of a feature (like "Point")
virtual const std::string& getKind() = 0;
virtual bool compute(const std::string& theAttributeId) { return false; };
/// Registers error during the execution, causes the ExecutionFailed state
- virtual void setError(const std::string& theError, bool isSend = true) {
- data()->setError(theError, isSend);
- }
+ MODELAPI_EXPORT virtual void setError(const std::string& theError,
+ bool isSend = true,
+ bool isTranslate = true);
/// Returns error, arose during the execution
virtual std::string error() const {
const int theIndex);
/// removes the result from the feature
MODELAPI_EXPORT void removeResult(const std::shared_ptr<ModelAPI_Result>& theResult);
- /// removes all results starting from the gived index (zero-based)
+ /// removes all results starting from the given index (zero-based)
/// \param theSinceIndex - index of the deleted result and all after also will be deleted
/// \param theFlush - if it is false, REDISPLAY message is not flushed
MODELAPI_EXPORT void removeResults(const int theSinceIndex, const bool theFlush = true);
/// Returns the feature by the object (result).
MODELAPI_EXPORT static std::shared_ptr<ModelAPI_Feature> feature(ObjectPtr theObject);
+ /// Set the stable feature flag. If feature is currently editing then it is not stable.
+ /// \returns true if state is really changed
+ MODELAPI_EXPORT virtual bool setStable(const bool theFlag);
+
+ /// Returns the feature is stable or not.
+ MODELAPI_EXPORT virtual bool isStable();
+
+ /// Performs some custom feature specific functionality (normally called by some GUI button)
+ /// \param theActionId an action key
+ /// \return a boolean value about it is performed
+ MODELAPI_EXPORT virtual bool customAction(const std::string& theActionId);
+
//
// Helper methods, aliases for data()->method()
// -----------------------------------------------------------------------------------------------
{
return data()->integer(theID);
}
+ /// Returns the integer array attribute by the identifier
+ inline std::shared_ptr<ModelAPI_AttributeIntArray> intArray(const std::string& theID)
+ {
+ return data()->intArray(theID);
+ }
/// Returns the reference attribute by the identifier
inline std::shared_ptr<ModelAPI_AttributeRefAttr> refattr(const std::string& theID)
{
{
return data()->string(theID);
}
+ /// Returns the string array attribute by the identifier
+ inline std::shared_ptr<ModelAPI_AttributeStringArray> stringArray(const std::string& theID)
+ {
+ return data()->stringArray(theID);
+ }
+ /// Returns the tables attribute by the identifier
+ inline std::shared_ptr<ModelAPI_AttributeTables> tables(const std::string& theID)
+ {
+ return data()->tables(theID);
+ }
/// Returns the attribute by the identifier
inline std::shared_ptr<ModelAPI_Attribute> attribute(const std::string& theID)
{
return data()->attribute(theID);
}
- // -----------------------------------------------------------------------------------------------
+ protected:
+ /// This method is called just after creation of the object: it must initialize
+ /// all fields, normally initialized in the constructor
+ MODELAPI_EXPORT virtual void init();
+
+ friend class Model_Document;
+ friend class Model_Objects;
};
//! Pointer on feature object
