Partition naming

[modules/shaper.git] / src / ExchangePlugin / ExchangePlugin_Validators.h

diff --git a/src/ExchangePlugin/ExchangePlugin_Validators.h b/src/ExchangePlugin/ExchangePlugin_Validators.h
index 1e93f95accb8c8d164b6882b3bedbcbeb4e42961..ab1a142f9a2fb72b2450307987189a4ff7c15388 100644 (file)
--- a/src/ExchangePlugin/ExchangePlugin_Validators.h
+++ b/src/ExchangePlugin/ExchangePlugin_Validators.h
@@ -1,8 +1,8 @@
 // Copyright (C) 2014-20xx CEA/DEN, EDF R&D
 
-// File:        SketchPlugin_Validators.h
-// Created:     01 Aug 2014
-// Author:      Vitaly SMETANNIKOV
+// File:    ExchangePlugin_Validators.h
+// Created: Aug 01, 2014
+// Author:  Sergey BELASH
 
 #ifndef EXCHANGEPLUGIN_VALIDATORS_H
 #define EXCHANGEPLUGIN_VALIDATORS_H
@@ -10,22 +10,51 @@
 #include "ExchangePlugin.h"
 #include <ModelAPI_AttributeValidator.h>
 
-class ExchangePlugin_ImportFormatValidator : public ModelAPI_AttributeValidator
+/**
+ * \class ExchangePlugin_FormatValidator
+ * \ingroup Validators
+ * \brief Validator for the imported formats checking
+ *
+ * The configuration file of import/export features contains the information
+ * about which formats are supported and the extension of the associated files.
+ * This validator filters out files that are out of this description.
+ */
+class ExchangePlugin_FormatValidator : public ModelAPI_AttributeValidator
 {
-  /*
-   * Parses input arguments "BREP:BREPImport", "STEP:STEPImport"
-   * into list of file formats "BREP","STEP"
+  /**
+   * Parses input arguments "BREP:BREPImport", "STEP|STP:STEPImport"
+   * into list of file formats "BREP","STEP","STP"
    * and list of corresponding plugins: "BREPImport", "STEPImport"
    */
   static bool parseFormats(const std::list<std::string>& theArguments,
-                             std::list<std::string>& outFormats);
-  static bool parsePlugins(const std::list<std::string>& theArguments,
-                           std::list<std::string>& outPlugins);
- public:
+                           std::list<std::string>& outFormats);
+public:
+  /**
+   * Returns true is the file-name attribute correctly corresponds to the set of
+   * allowed formats.
+   */
   virtual bool isValid(const AttributePtr& theAttribute,
-                       const std::list<std::string>& theArguments) const;
+                       const std::list<std::string>& theArguments,
+                       std::string& theError) const;
+};
+
+/**
+ * \class ExchangePlugin_ImportFormatValidator
+ * \ingroup Validators
+ * \brief Validator for the import format.
+ */
+class ExchangePlugin_ImportFormatValidator : public ExchangePlugin_FormatValidator
+{
 
+};
 
+/**
+ * \class ExchangePlugin_ExportFormatValidator
+ * \ingroup Validators
+ * \brief Validator for the export format.
+ */
+class ExchangePlugin_ExportFormatValidator : public ExchangePlugin_FormatValidator
+{
 
 };