src/ModelAPI/ModelAPI_ResultValidator.h

   1 // Copyright (C) 2014-20xx CEA/DEN, EDF R&D
   2
   3 // File:        ModelAPI_ResultValidators.h
   4 // Created:     23 July 2014
   5 // Author:      Vitaly SMETANNIKOV
   6
   7 #ifndef ModelAPI_ResultValidators_H
   8 #define ModelAPI_ResultValidators_H
   9
  10 #include "ModelAPI_Validator.h"
  11 #include "ModelAPI_Object.h"
  12
  13 /**\class ModelAPI_ResultValidator
  14  * \ingroup DataModel
  15  * \brief The base class for selection filter for results of features.
  16  *
  17  * The referenced arguments of feature is normally results displayed in the viewer or by the
  18  * selection attribute. This filter allows to filter out the results not usable as this argument.
  19  */
  20 class ModelAPI_ResultValidator : public ModelAPI_Validator
  21 {
  22 public:
  23   /// The abstract method for implementation in the specific validator.
  24   /// \param theObject the checked object as an argument
  25   /// \returns true if object is OK for this filter
  26   virtual bool isValid(const ObjectPtr theObject) const = 0;
  27 };
  28
  29 #endif