Salome HOME
Process validators on the first feature's creation using the Config_ValidatorReader
[modules/shaper.git] / src / Config / Config_SelectionFilterMessage.h
index fcc54a01097c07e692fc67071233fc5e3fb48466..ed661b93c599173378c22601d7c67f9c1a125429 100644 (file)
@@ -21,6 +21,7 @@ static const char * EVENT_SELFILTER_LOADED = "SelectionFilterLoaded";
 
 /*!
  * \class Config_SelectionFilterMessage
+ * \ingroup Config
  * \brief Transmits info about selection filters on "SelectionFilterLoaded" event
  */
 class Config_SelectionFilterMessage : public Events_Message
@@ -31,17 +32,30 @@ class Config_SelectionFilterMessage : public Events_Message
   std::list<std::string> myFilterParameters;
 
  public:
+  /*!
+   * Constructor.
+   * \param theId - Events_ID of the message
+   * \param theParent - pointer to the sender
+   */
   CONFIG_EXPORT Config_SelectionFilterMessage(const Events_ID theId, const void* theParent = 0);
   CONFIG_EXPORT virtual ~Config_SelectionFilterMessage();
 
+  //! Get id of the filter
   CONFIG_EXPORT const std::string& selectionFilterId() const;
+  //! Get id of a feature to which the filter belongs to
   CONFIG_EXPORT const std::string& featureId() const;
+  //! Get id of an attribute to which the filter belongs to
   CONFIG_EXPORT const std::string& attributeId() const;
+  //! Get filter parameters
   CONFIG_EXPORT const std::list<std::string>& parameters() const;
 
+  //! Set id of the filter
   CONFIG_EXPORT void setSelectionFilterId(const std::string& theId);
+  //! Set id of a feature to which the filter belongs to
   CONFIG_EXPORT void setFeatureId(const std::string& theId);
+  //! Set id of an attribute to which the filter belongs to
   CONFIG_EXPORT void setAttributeId(const std::string& theId);
+  //! Get filter parameters
   CONFIG_EXPORT void setFilterParameters(const std::list<std::string>& parameters);
 };