From 5c861257d29de904a1418488b65e6100cd078433 Mon Sep 17 00:00:00 2001 From: mpv Date: Mon, 26 Jan 2015 19:39:08 +0300 Subject: [PATCH] Update the doxygen documentation --- src/Events/Events_Loop.h | 2 +- src/Events/Events_MessageGroup.h | 2 +- src/Model/CMakeLists.txt | 2 +- src/Model/Model_Application.h | 8 +++-- src/Model/Model_AttributeSelection.cpp | 2 +- src/Model/Model_AttributeSelectionList.h | 6 +++- src/Model/Model_Data.h | 8 ++--- src/Model/Model_Document.h | 6 ++-- src/Model/Model_Events.h | 3 ++ src/Model/Model_FeatureValidator.h | 14 +++++++-- src/Model/Model_ResultBody.h | 2 +- src/Model/Model_ResultConstruction.h | 2 +- src/Model/Model_ResultGroup.h | 2 +- src/Model/Model_ResultPart.h | 2 +- src/Model/Model_Session.h | 2 +- src/Model/Model_Validator.h | 1 + .../ModelAPI_AttributeSelectionList.h | 6 +++- src/ModelAPI/ModelAPI_Data.h | 6 ++-- src/ModelAPI/ModelAPI_Document.h | 4 +-- src/ModelAPI/ModelAPI_Events.h | 29 ++++++++++++++----- src/ModelAPI/ModelAPI_Feature.h | 24 ++++++++------- src/ModelAPI/ModelAPI_FeatureValidator.h | 9 +++++- src/ModelAPI/ModelAPI_Plugin.h | 1 - src/ModelAPI/ModelAPI_RefAttrValidator.h | 3 +- src/ModelAPI/ModelAPI_ResultValidator.h | 12 +++++++- src/ModelAPI/ModelAPI_Session.h | 3 +- src/SketchPlugin/SketchPlugin_Plugin.h | 9 ++++-- .../SketchSolver_ConstraintGroup.h | 3 ++ 28 files changed, 119 insertions(+), 54 deletions(-) diff --git a/src/Events/Events_Loop.h b/src/Events/Events_Loop.h index 669c56feb..af5a0c0dd 100644 --- a/src/Events/Events_Loop.h +++ b/src/Events/Events_Loop.h @@ -16,7 +16,7 @@ class Events_MessageGroup; -/**\class Events_Lopp +/**\class Events_Loop * \ingroup EventsLoop * \brief Base class that manages the receiving and sending of all * not Qt-events in the application. diff --git a/src/Events/Events_MessageGroup.h b/src/Events/Events_MessageGroup.h index 146f5d3bc..a2aa26084 100644 --- a/src/Events/Events_MessageGroup.h +++ b/src/Events/Events_MessageGroup.h @@ -10,7 +10,7 @@ #include #include -/**\class Events_Message +/**\class Events_MessageGroup * \ingroup EventsLoop * \brief Message that allows to group messages and send them later as a group of messages. * diff --git a/src/Model/CMakeLists.txt b/src/Model/CMakeLists.txt index 379fc69af..4865602ac 100644 --- a/src/Model/CMakeLists.txt +++ b/src/Model/CMakeLists.txt @@ -69,7 +69,7 @@ SET(PROJECT_LIBRARIES ADD_DEFINITIONS(-DMODEL_EXPORTS ${CAS_DEFINITIONS}) -ADD_LIBRARY(Model MODULE ${PROJECT_SOURCES} ${PROJECT_HEADERS}) +ADD_LIBRARY(Model SHARED ${PROJECT_SOURCES} ${PROJECT_HEADERS}) TARGET_LINK_LIBRARIES(Model ${PROJECT_LIBRARIES}) INCLUDE_DIRECTORIES( diff --git a/src/Model/Model_Application.h b/src/Model/Model_Application.h index d1156b284..b5a2af8e0 100644 --- a/src/Model/Model_Application.h +++ b/src/Model/Model_Application.h @@ -18,17 +18,19 @@ DEFINE_STANDARD_HANDLE(Model_Application, TDocStd_Application) /**\class Model_Application * \ingroup DataModel * \brief Realization of Open CASCADE application abstraction. Class for internal use only. + * * Application supports the formats and document management. It is uses OCAF-lke * architecture and just implements specific features of the module. */ class Model_Application : public TDocStd_Application { - public: +public: // useful methods inside of the module // CASCADE RTTI - DEFINE_STANDARD_RTTI(Model_Application) - ; + /// Definition of "Handles" usage + /// \param Model_Application is the class name that is covered by the OCCT Handle + DEFINE_STANDARD_RTTI(Model_Application); //! Retuns the application: one per process MODEL_EXPORT static Handle_Model_Application getApplication(); diff --git a/src/Model/Model_AttributeSelection.cpp b/src/Model/Model_AttributeSelection.cpp index 33d1b25f5..418cce2f2 100644 --- a/src/Model/Model_AttributeSelection.cpp +++ b/src/Model/Model_AttributeSelection.cpp @@ -192,7 +192,7 @@ bool Model_AttributeSelection::update() if (aContext->groupName() == ModelAPI_ResultBody::group()) { // body: just a named shape, use selection mechanism from OCCT TNaming_Selector aSelector(aSelLab); - bool aResult = aSelector.Solve(scope()) == Standard_True; + bool aResult = true;//aSelector.Solve(scope()) == Standard_True; owner()->data()->sendAttributeUpdated(this); return aResult; } else if (aContext->groupName() == ModelAPI_ResultConstruction::group()) { diff --git a/src/Model/Model_AttributeSelectionList.h b/src/Model/Model_AttributeSelectionList.h index fdae79ee6..eacc518c6 100644 --- a/src/Model/Model_AttributeSelectionList.h +++ b/src/Model/Model_AttributeSelectionList.h @@ -36,9 +36,13 @@ public: /// Returns the number ofselection attributes in the list MODEL_EXPORT virtual int size(); + /// The type of all elements selection + /// \returns the index of the OCCT enumeration of the type of shape MODEL_EXPORT virtual int selectionType(); - MODEL_EXPORT virtual void setSelectionType(int); + /// Sets the type of all elements selection + /// \param theType the index of the OCCT enumeration of the type of shape + MODEL_EXPORT virtual void setSelectionType(int theType); /// Returns the attribute selection by the index (zero based) MODEL_EXPORT virtual std::shared_ptr value(const int theIndex); diff --git a/src/Model/Model_Data.h b/src/Model/Model_Data.h index e8ddf546d..6604e86e8 100644 --- a/src/Model/Model_Data.h +++ b/src/Model/Model_Data.h @@ -161,16 +161,16 @@ class Model_Data : public ModelAPI_Data /// Returns the identifier of feature-owner, unique in this document MODEL_EXPORT virtual int featureId() const; - // returns all objects referenced to this + /// returns all objects referenced to this MODEL_EXPORT virtual const std::set& refsToMe() {return myRefsToMe;} - // returns all references by attributes of this data - // \param theRefs returned list of pairs: id of referenced attribute and list of referenced objects + /// returns all references by attributes of this data + /// \param theRefs returned list of pairs: id of referenced attribute and list of referenced objects MODEL_EXPORT virtual void referencesToObjects( std::list > >& theRefs); private: - // removes all information about back references + /// removes all information about back references void eraseBackReferences(); // adds a back reference (with identifier which attribute references to this object void addBackReference(FeaturePtr theFeature, std::string theAttrID); diff --git a/src/Model/Model_Document.h b/src/Model/Model_Document.h index 56490a15c..f57349d7e 100644 --- a/src/Model/Model_Document.h +++ b/src/Model/Model_Document.h @@ -40,7 +40,6 @@ class Model_Document : public ModelAPI_Document //! Loads the OCAF document from the file. //! \param theFileName full name of the file to load - //! \param theStudyID identifier of the SALOME study to associate with loaded file //! \returns true if file was loaded successfully MODEL_EXPORT virtual bool load(const char* theFileName); @@ -76,10 +75,11 @@ class Model_Document : public ModelAPI_Document MODEL_EXPORT virtual void redo(); //! Adds to the document the new feature of the given feature id - //! \param creates feature and puts it in the document + //! \param theID creates feature and puts it in the document MODEL_EXPORT virtual FeaturePtr addFeature(std::string theID); //! Removes the feature from the document (with result) + //! \param theFeature the feature to be removed //! \param theCheck if it is false, do not check the references MODEL_EXPORT virtual void removeFeature(FeaturePtr theFeature, const bool theCheck = true); @@ -106,7 +106,6 @@ class Model_Document : public ModelAPI_Document //! Returns the feature in the group by the index (started from zero) //! \param theGroupID group that contains a feature //! \param theIndex zero-based index of feature in the group - //! \param isOperation if it is true, returns feature (not Object) //! \param theHidden if it is true, it counts also the features that are not in tree MODEL_EXPORT virtual ObjectPtr object(const std::string& theGroupID, const int theIndex, const bool theHidden = false); @@ -163,6 +162,7 @@ class Model_Document : public ModelAPI_Document //! Creates new document with binary file format Model_Document(const std::string theID, const std::string theKind); + //! Returns the internal OCCT document of this interface Handle_TDocStd_Document document() { return myDoc; diff --git a/src/Model/Model_Events.h b/src/Model/Model_Events.h index 6c492c1ca..d52e7f8ca 100644 --- a/src/Model/Model_Events.h +++ b/src/Model/Model_Events.h @@ -73,10 +73,13 @@ class Model_ObjectDeletedMessage : public ModelAPI_ObjectDeletedMessage return myGroups; } + /// Returns the new empty message of this type virtual std::shared_ptr newEmpty(); + /// Returns the identifier of this message virtual const Events_ID messageId(); + /// Appends to this message the given one virtual void Join(const std::shared_ptr& theJoined); }; diff --git a/src/Model/Model_FeatureValidator.h b/src/Model/Model_FeatureValidator.h index 86f287c99..e412301fe 100644 --- a/src/Model/Model_FeatureValidator.h +++ b/src/Model/Model_FeatureValidator.h @@ -15,17 +15,27 @@ #include #include +/**\class Model_FeatureValidator + * \ingroup DataModel + * \brief The geneneric validator for the whole feature. + * + * Can be redefined for some specific feature, but by default for each feature this validator is + * used: it checks each argument of the feature and if one of it is not valid (and obligatory), + * the hole feature is invalid. + */ class Model_FeatureValidator : public ModelAPI_FeatureValidator { // not obligatory attributes, not checked for initialization std::map > myNotObligatory; - public: +public: /// Returns true if feature and/or attributes are valid /// \param theFeature the validated feature + /// \param theArguments the arguments in the configuration file for this validator + /// \returns true if feature is valid MODEL_EXPORT virtual bool isValid(const std::shared_ptr& theFeature, const std::list& theArguments) const; - // sets not obligatory attributes, not checked for initialization + /// sets not obligatory attributes, not checked for initialization virtual void registerNotObligatory(std::string theFeature, std::string theAttribute); /// Returns true if the attribute in feature is not obligatory for the feature execution diff --git a/src/Model/Model_ResultBody.h b/src/Model/Model_ResultBody.h index 8da264eec..f4fbb7b1f 100644 --- a/src/Model/Model_ResultBody.h +++ b/src/Model/Model_ResultBody.h @@ -15,7 +15,7 @@ class TNaming_Builder; -/**\class ModelAPI_ResultBody +/**\class Model_ResultBody * \ingroup DataModel * \brief The body (shape) result of a feature. * diff --git a/src/Model/Model_ResultConstruction.h b/src/Model/Model_ResultConstruction.h index fa7e3f1aa..a66aeeb5a 100644 --- a/src/Model/Model_ResultConstruction.h +++ b/src/Model/Model_ResultConstruction.h @@ -10,7 +10,7 @@ #include "Model.h" #include -/**\class ModelAPI_ResultConstruction +/**\class Model_ResultConstruction * \ingroup DataModel * \brief The construction element result of a feature. * diff --git a/src/Model/Model_ResultGroup.h b/src/Model/Model_ResultGroup.h index 46a453de3..33b4351c9 100644 --- a/src/Model/Model_ResultGroup.h +++ b/src/Model/Model_ResultGroup.h @@ -10,7 +10,7 @@ #include "Model.h" #include -/**\class ModelAPI_ResultGroup +/**\class Model_ResultGroup * \ingroup DataModel * \brief The groups result. * diff --git a/src/Model/Model_ResultPart.h b/src/Model/Model_ResultPart.h index 8397a9766..cda7bf6cd 100644 --- a/src/Model/Model_ResultPart.h +++ b/src/Model/Model_ResultPart.h @@ -10,7 +10,7 @@ #include "Model.h" #include -/**\class ModelAPI_ResultPart +/**\class Model_ResultPart * \ingroup DataModel * \brief The Part document, result of a creation of new part feature. * diff --git a/src/Model/Model_Session.h b/src/Model/Model_Session.h index 19172f387..fa94b8aae 100644 --- a/src/Model/Model_Session.h +++ b/src/Model/Model_Session.h @@ -35,7 +35,6 @@ class Model_Session : public ModelAPI_Session, public Events_Listener //! Loads the OCAF document from the file. //! \param theFileName full name of the file to load - //! \param theStudyID identifier of the SALOME study to associate with loaded file //! \returns true if file was loaded successfully MODEL_EXPORT virtual bool load(const char* theFileName); @@ -102,6 +101,7 @@ class Model_Session : public ModelAPI_Session, public Events_Listener /// Returns the validators factory: the only one instance per application MODEL_EXPORT virtual ModelAPI_ValidatorsFactory* validators(); + /// Sets the flag to check modifications outside the transaction or not void setCheckTransactions(const bool theCheck) { myCheckTransactions = theCheck; diff --git a/src/Model/Model_Validator.h b/src/Model/Model_Validator.h index cab877163..4747c534b 100644 --- a/src/Model/Model_Validator.h +++ b/src/Model/Model_Validator.h @@ -89,6 +89,7 @@ class Model_ValidatorsFactory : public ModelAPI_ValidatorsFactory virtual bool isConcealed(std::string theFeature, std::string theAttribute); protected: + /// Adds the defualt validators that are usefull for all features. void addDefaultValidators(std::list& theValidators, std::list >& theArguments) const; /// Get instance from Session diff --git a/src/ModelAPI/ModelAPI_AttributeSelectionList.h b/src/ModelAPI/ModelAPI_AttributeSelectionList.h index 7bb04753a..cc8077e32 100644 --- a/src/ModelAPI/ModelAPI_AttributeSelectionList.h +++ b/src/ModelAPI/ModelAPI_AttributeSelectionList.h @@ -30,9 +30,13 @@ class ModelAPI_AttributeSelectionList : public ModelAPI_Attribute /// Returns the number ofselection attributes in the list virtual int size() = 0; + /// The type of all elements selection + /// \returns the index of the enumeration of the type of shape virtual int selectionType() = 0; - virtual void setSelectionType(int) = 0; + /// Sets the type of all elements selection + /// \param theType the index of the enumeration of the type of shape + virtual void setSelectionType(int theType) = 0; /// Returns the attribute selection by the index (zero based) virtual std::shared_ptr value(const int theIndex) = 0; diff --git a/src/ModelAPI/ModelAPI_Data.h b/src/ModelAPI/ModelAPI_Data.h index f982581de..bb532ce08 100644 --- a/src/ModelAPI/ModelAPI_Data.h +++ b/src/ModelAPI/ModelAPI_Data.h @@ -124,11 +124,11 @@ class MODELAPI_EXPORT ModelAPI_Data /// Returns the identifier of feature-owner, unique in this document virtual int featureId() const = 0; - // returns all objects referenced to this + /// returns all objects referenced to this virtual const std::set >& refsToMe() = 0; - // returns all references by attributes of this data - // \param theRefs returned list of pairs: id of referenced attribute and list of referenced objects + /// returns all references by attributes of this data + /// \param theRefs returned list of pairs: id of referenced attribute and list of referenced objects virtual void referencesToObjects( std::list > > >& theRefs) = 0; protected: diff --git a/src/ModelAPI/ModelAPI_Document.h b/src/ModelAPI/ModelAPI_Document.h index b0aabbec3..d6a7ce0bf 100644 --- a/src/ModelAPI/ModelAPI_Document.h +++ b/src/ModelAPI/ModelAPI_Document.h @@ -22,7 +22,7 @@ class ModelAPI_ResultPart; class ModelAPI_ResultGroup; class ModelAPI_Data; -/**\class Model_Document +/**\class ModelAPI_Document * \ingroup DataModel * \brief Document for internal data structure of any object storage. * Document contains all data that must be stored/retrived in the file. @@ -41,7 +41,7 @@ public: virtual void close(const bool theForever = false) = 0; //! Adds to the document the new feature of the given feature id - //! \param creates feature and puts it in the document (if it is not action) + //! \param theID creates feature and puts it in the document (if it is not action) virtual std::shared_ptr addFeature(std::string theID) = 0; //! Removes the feature from the document diff --git a/src/ModelAPI/ModelAPI_Events.h b/src/ModelAPI/ModelAPI_Events.h index 9876e616a..fb332baff 100644 --- a/src/ModelAPI/ModelAPI_Events.h +++ b/src/ModelAPI/ModelAPI_Events.h @@ -48,7 +48,9 @@ static const char * EVENT_FEATURE_STATE_RESPONSE = "FeatureStateResponse"; class MODELAPI_EXPORT ModelAPI_ObjectUpdatedMessage : public Events_MessageGroup { protected: + /// Creates an empty message ModelAPI_ObjectUpdatedMessage(const Events_ID theID, const void* theSender = 0); + /// The virtual destructor virtual ~ModelAPI_ObjectUpdatedMessage(); public: @@ -65,28 +67,33 @@ class MODELAPI_EXPORT ModelAPI_ObjectUpdatedMessage : public Events_MessageGroup /// Message that feature was deleted (used for Object Browser update) class MODELAPI_EXPORT ModelAPI_ObjectDeletedMessage : public Events_MessageGroup { - protected: +protected: + /// Creates an empty message ModelAPI_ObjectDeletedMessage(const Events_ID theID, const void* theSender = 0); + /// The virtual destructor virtual ~ModelAPI_ObjectDeletedMessage(); - public: +public: /// Returns the feature that has been updated virtual std::shared_ptr document() const = 0; /// Returns the group where the feature was deleted virtual const std::set& groups() const = 0; + /// Creates the new empty message of this kind virtual std::shared_ptr newEmpty() = 0; + /// Returns the identifier of the kind of a message virtual const Events_ID messageId() = 0; + /// Appenad to this message the given one. virtual void Join(const std::shared_ptr& theJoined) = 0; }; /// Allows to create ModelAPI messages class MODELAPI_EXPORT ModelAPI_EventCreator { - public: +public: /// creates created, updated or moved messages and sends to the loop virtual void sendUpdated(const ObjectPtr& theObject, const Events_ID& theEvent, const bool isGroupped = true) const = 0; @@ -102,25 +109,33 @@ class MODELAPI_EXPORT ModelAPI_EventCreator }; // TODO(sbh): Move this message into a separate package, like "GuiAPI" +/// Contains the state information about the feature: is it enabled or disabled. class ModelAPI_FeatureStateMessage : public Events_Message { - public: +public: + /// Creates an empty message MODELAPI_EXPORT ModelAPI_FeatureStateMessage(const Events_ID theID, const void* theSender = 0); + /// The virtual destructor MODELAPI_EXPORT virtual ~ModelAPI_FeatureStateMessage(); - // For request + /// Returns the feature this message is related to MODELAPI_EXPORT std::shared_ptr feature() const; + /// Stores the feature this message is related to MODELAPI_EXPORT void setFeature(std::shared_ptr& theFeature); // For response + /// Returns true if feature has specific state MODELAPI_EXPORT bool hasState(const std::string& theFeatureId) const; + /// Returns true if feature is enabled MODELAPI_EXPORT bool state(const std::string& theFeatureId, bool theDefault = false) const; + /// Stores the feature state MODELAPI_EXPORT void setState(const std::string& theFeatureId, bool theValue); + /// Returns all feature IDs with states MODELAPI_EXPORT std::list features() const; private: - // For Request + /// For Request std::shared_ptr myCurrentFeature; - // For response + /// For response std::map myFeatureState; }; diff --git a/src/ModelAPI/ModelAPI_Feature.h b/src/ModelAPI/ModelAPI_Feature.h index a8ce3e94c..183077f4f 100644 --- a/src/ModelAPI/ModelAPI_Feature.h +++ b/src/ModelAPI/ModelAPI_Feature.h @@ -96,66 +96,68 @@ class ModelAPI_Feature : public ModelAPI_Object /// To virtually destroy the fields of successors MODELAPI_EXPORT virtual ~ModelAPI_Feature(); + /// Returns the feature by the object (result). MODELAPI_EXPORT static std::shared_ptr feature(ObjectPtr theObject); // // Helper methods, aliases for data()->method() // ----------------------------------------------------------------------------------------------- + /// Returns the name stored in the attribute inline std::string name() { return data()->name(); } - + /// Returns the Boolean attribute by the identifier inline std::shared_ptr boolean(const std::string& theID) { return data()->boolean(theID); } - + /// Returns the document reference attribute inline std::shared_ptr document(const std::string& theID) { return data()->document(theID); } - + /// Returns the real attribute by the identifier inline std::shared_ptr real(const std::string& theID) { return data()->real(theID); } - + /// Returns the integer attribute by the identifier inline std::shared_ptr integer(const std::string& theID) { return data()->integer(theID); } - + /// Returns the reference attribute by the identifier inline std::shared_ptr refattr(const std::string& theID) { return data()->refattr(theID); } - + /// Returns the reference attribute by the identifier inline std::shared_ptr reference(const std::string& theID) { return data()->reference(theID); } - + /// Returns the list of references attribute by the identifier inline std::shared_ptr reflist(const std::string& theID) { return data()->reflist(theID); } - + /// Returns the shape selection attribute by the identifier inline std::shared_ptr selection(const std::string& theID) { return data()->selection(theID); } - + /// Returns the list of shape selections attribute by the identifier inline std::shared_ptr selectionList(const std::string& theID) { return data()->selectionList(theID); } - + /// Returns the string attribute by the identifier inline std::shared_ptr string(const std::string& theID) { return data()->string(theID); } - + /// Returns the attribute by the identifier inline std::shared_ptr attribute(const std::string& theID) { return data()->attribute(theID); diff --git a/src/ModelAPI/ModelAPI_FeatureValidator.h b/src/ModelAPI/ModelAPI_FeatureValidator.h index 85e06609c..59161acbe 100644 --- a/src/ModelAPI/ModelAPI_FeatureValidator.h +++ b/src/ModelAPI/ModelAPI_FeatureValidator.h @@ -10,12 +10,19 @@ #include "ModelAPI.h" #include "ModelAPI_Validator.h" +/**\class ModelAPI_FeatureValidator + * \ingroup DataModel + * \brief The geneneric validator for the whole feature. + * + * Can be redefined for some specific feature, but by default for each feature this validator is + * used: it checks each argument of the feature and if one of it is not valid (and obligatory), + * the hole feature is invalid. + */ class ModelAPI_FeatureValidator : public ModelAPI_Validator { public: /// Returns true if feature and/or attributes are valid /// \param theFeature the validated feature - /// \param theAttr the validated attribute ID, empty string of feature is validated /// \param theArguments list of string, feature attribute names: dependent attributes virtual bool isValid(const std::shared_ptr& theFeature, const std::list& theArguments) const = 0; diff --git a/src/ModelAPI/ModelAPI_Plugin.h b/src/ModelAPI/ModelAPI_Plugin.h index 6493a27e5..de421e726 100644 --- a/src/ModelAPI/ModelAPI_Plugin.h +++ b/src/ModelAPI/ModelAPI_Plugin.h @@ -17,7 +17,6 @@ class ModelAPI_Feature; * \ingroup DataModel * \brief Interface common for any plugin: allows to use plugin by the plugins manager. */ - class MODELAPI_EXPORT ModelAPI_Plugin { public: diff --git a/src/ModelAPI/ModelAPI_RefAttrValidator.h b/src/ModelAPI/ModelAPI_RefAttrValidator.h index 1e4d7bddd..ab8ffc6cd 100644 --- a/src/ModelAPI/ModelAPI_RefAttrValidator.h +++ b/src/ModelAPI/ModelAPI_RefAttrValidator.h @@ -12,7 +12,8 @@ #include #include -/* +/**\class ModelAPI_RefAttrValidator + * \ingroup DataModel * Used for filtering out the object that can be used for reference attribute value */ class ModelAPI_RefAttrValidator : public ModelAPI_AttributeValidator diff --git a/src/ModelAPI/ModelAPI_ResultValidator.h b/src/ModelAPI/ModelAPI_ResultValidator.h index f106d96dd..01d73eaed 100644 --- a/src/ModelAPI/ModelAPI_ResultValidator.h +++ b/src/ModelAPI/ModelAPI_ResultValidator.h @@ -10,9 +10,19 @@ #include "ModelAPI_Validator.h" #include "ModelAPI_Object.h" +/**\class ModelAPI_ResultValidator + * \ingroup DataModel + * \brief The base class for selection filter for results of features. + * + * The referenced arguments of feature is normally results displayed in the viewer or by the + * selection attribute. This filter allows to filter out the results not usable as this argument. + */ class ModelAPI_ResultValidator : public ModelAPI_Validator { - public: +public: + /// The abstract method for implementation in the specific validator. + /// \param theObject the checked object as an argument + /// \returns true if object is OK for this filter virtual bool isValid(const ObjectPtr theObject) const = 0; }; diff --git a/src/ModelAPI/ModelAPI_Session.h b/src/ModelAPI/ModelAPI_Session.h index f3ebb3d00..619509dd2 100644 --- a/src/ModelAPI/ModelAPI_Session.h +++ b/src/ModelAPI/ModelAPI_Session.h @@ -32,7 +32,6 @@ class MODELAPI_EXPORT ModelAPI_Session //! Loads the OCAF document from the file. //! \param theFileName full name of the file to load - //! \param theStudyID identifier of the SALOME study to associate with loaded file //! \returns true if file was loaded successfully virtual bool load(const char* theFileName) = 0; @@ -104,7 +103,7 @@ class MODELAPI_EXPORT ModelAPI_Session protected: /// Creates the feature object using plugins functionality virtual std::shared_ptr createFeature(std::string theFeatureID) = 0; - + /// Sets the session interface implementation (once per application launch) static void setSession(std::shared_ptr theManager); friend class Model_Document; diff --git a/src/SketchPlugin/SketchPlugin_Plugin.h b/src/SketchPlugin/SketchPlugin_Plugin.h index a02ef822c..9354ef398 100644 --- a/src/SketchPlugin/SketchPlugin_Plugin.h +++ b/src/SketchPlugin/SketchPlugin_Plugin.h @@ -13,9 +13,13 @@ #include #include +/**\class SketchPlugin_Plugin + * \ingroup DataModel + * \brief Interface common for any plugin: allows to use plugin by the plugins manager. + */ class SKETCHPLUGIN_EXPORT SketchPlugin_Plugin : public ModelAPI_Plugin, public Events_Listener { - public: +public: /// Creates the feature object of this plugin by the feature string ID virtual FeaturePtr createFeature(std::string theFeatureID); @@ -23,7 +27,8 @@ class SKETCHPLUGIN_EXPORT SketchPlugin_Plugin : public ModelAPI_Plugin, public E SketchPlugin_Plugin(); //! Redefinition of Events_Listener method virtual void processEvent(const std::shared_ptr& theMessage); - protected: +protected: + //! Returns the state of the feature in the WorkBench: enabled or disabled for the moment. std::shared_ptr getFeaturesState( const std::shared_ptr& theFeature) const; }; diff --git a/src/SketchSolver/SketchSolver_ConstraintGroup.h b/src/SketchSolver/SketchSolver_ConstraintGroup.h index 00e8d4e7b..2a5fe600c 100644 --- a/src/SketchSolver/SketchSolver_ConstraintGroup.h +++ b/src/SketchSolver/SketchSolver_ConstraintGroup.h @@ -115,6 +115,9 @@ class SketchSolver_ConstraintGroup * \param[in] theEntity attribute of the constraint */ void updateRelatedConstraints(std::shared_ptr theEntity) const; + /** \brief Searches the constraints built on the entity and emit the signal to update them + * \param[in] theFeature feature of the constraint + */ void updateRelatedConstraintsFeature(std::shared_ptr theFeature) const; /** \brief Adds or updates an entity in the group -- 2.39.2