Result CompSolid should inherits ResultBody. All model realization concerned Naming...

[modules/shaper.git] / src / Config / Config_ValidatorMessage.h

diff --git a/src/Config/Config_ValidatorMessage.h b/src/Config/Config_ValidatorMessage.h
index e344cd8863fcfd2f7b6461e70b55e54c0ea0a554..99650e22efeaaec2e5990f0a0a3bec0e647644e5 100644 (file)
--- a/src/Config/Config_ValidatorMessage.h
+++ b/src/Config/Config_ValidatorMessage.h
@@ -1,12 +1,14 @@
+// Copyright (C) 2014-20xx CEA/DEN, EDF R&D
+
 /*
  * Config_ValidatorMessage.h
  *
- *  Created on: 08 Jul 2014 ã.
+ *  Created on: 08 Jul 2014 �.
  *      Author: sbh
  */
 
-#ifndef Config_ValidatorMessage_H_
-#define Config_ValidatorMessage_H_
+#ifndef CONFIG_VALIDATORMESSAGE_H_
+#define CONFIG_VALIDATORMESSAGE_H_
 
 #include <Events_Message.h>
 #include <Config_def.h>
@@ -14,9 +16,14 @@
 #include <list>
 #include <string>
 
-/// Event ID that feature is loaded (comes with Config_FeatureMessage)
+/// Event ID that Validator is loaded (comes with Config_ValidatorMessage)
 static const char * EVENT_VALIDATOR_LOADED = "ValidatorLoaded";
 
+/*!
+ * \class Config_ValidatorMessage
+ * \ingroup Config
+ * \brief Transmits info about created validator on "ValidatorLoaded" event
+ */
 class Config_ValidatorMessage : public Events_Message
 {
   std::string myValidatorId;
@@ -25,16 +32,33 @@ class Config_ValidatorMessage : public Events_Message
   std::list<std::string> myVaidatorParameters;
 
  public:
-  CONFIG_EXPORT Config_ValidatorMessage(const Events_ID theId, const void* theParent = 0);CONFIG_EXPORT virtual ~Config_ValidatorMessage();
-
-  //CONFIG_EXPORT static const char* UID() const;
+  /*!
+   * Constructor.
+   * \param theId - Events_ID of the message
+   * \param theParent - pointer to the sender
+   */
+  CONFIG_EXPORT Config_ValidatorMessage(const Events_ID theId, const void* theParent = 0);
+  CONFIG_EXPORT virtual ~Config_ValidatorMessage();
 
-  CONFIG_EXPORT const std::string& validatorId() const;CONFIG_EXPORT const std::string& featureId() const;CONFIG_EXPORT const std::string& attributeId() const;CONFIG_EXPORT const std::list<
-      std::string>& parameters() const;CONFIG_EXPORT bool isValid() const;
+  //! Get id of the filter
+  CONFIG_EXPORT const std::string& validatorId() 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;
+  //! Returns true if validator id is not empty
+  CONFIG_EXPORT bool isValid() const;
 
-  CONFIG_EXPORT void setValidatorId(const std::string& theId);CONFIG_EXPORT void setFeatureId(
-      const std::string& theId);CONFIG_EXPORT void setAttributeId(const std::string& theId);CONFIG_EXPORT void setValidatorParameters(
-      const std::list<std::string>& parameters);
+  //! Set id of the filter
+  CONFIG_EXPORT void setValidatorId(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 setValidatorParameters(const std::list<std::string>& parameters);
 };
 
 #endif /* Config_ValidatorMessage_H_ */