-// Copyright (C) 2014-20xx CEA/DEN, EDF R&D
-
-// File: ModelAPI_Feature.hxx
-// Created: 21 Mar 2014
-// Author: Mikhail PONIKAROV
+// Copyright (C) 2014-2019 CEA/DEN, EDF R&D
+//
+// 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_Feature_H_
#define ModelAPI_Feature_H_
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 {
/// sets the result by index (zero based), results before this must be set before
MODELAPI_EXPORT void setResult(const std::shared_ptr<ModelAPI_Result>& theResult,
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 given index (zero-based)
/// \param theSinceIndex - index of the deleted result and all after also will be deleted
+ /// \param theForever - removes results for long period (not just because of feature disabling)
/// \param theFlush - if it is false, REDISPLAY message is not flushed
- MODELAPI_EXPORT void removeResults(const int theSinceIndex, const bool theFlush = true);
+ MODELAPI_EXPORT void removeResults(const int theSinceIndex,
+ const bool theForever = true, const bool theFlush = true);
/// removes all results from the feature
- MODELAPI_EXPORT void eraseResults();
+ MODELAPI_EXPORT void eraseResults(const bool theForever = true);
/// removes all fields from this feature: results, data, etc
MODELAPI_EXPORT virtual void erase();
/// removes the result from the list of feature (not doing in disabled): normally this
/// 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)
{
