ModelAPI_Validator.h

// Copyright (C) 2014-2023  CEA, EDF
//
// This library is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public
// License as published by the Free Software Foundation; either
// version 2.1 of the License, or (at your option) any later version.
//
// This library is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
// Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
//
// See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
//
 
#ifndef ModelAPI_Validator_H_
#define ModelAPI_Validator_H_
 
#include <ModelAPI.h>
#include <ModelAPI_Feature.h>
#include <memory>
#include <list>
 
class ModelAPI_Feature;
class Events_InfoMessage;
 
class MODELAPI_EXPORT ModelAPI_Validator
{
 public:
  // Make virtual destructor in order to make the class polymorphic
  virtual ~ModelAPI_Validator()
  {
  }
};
 
typedef std::shared_ptr<ModelAPI_Validator> ValidatorPtr;
 
class MODELAPI_EXPORT ModelAPI_ValidatorsFactory
{
 public:
   virtual ~ModelAPI_ValidatorsFactory() {}
 
  virtual void registerValidator(const std::string& theID, ModelAPI_Validator* theValidator) = 0;
 
  virtual void assignValidator(const std::string& theID, const std::string& theFeatureID) = 0;
 
  virtual void assignValidator(const std::string& theID,
                                            const std::string& theFeatureID,
                                            const std::list<std::string>& theArguments) = 0;
 
  virtual void assignValidator(const std::string& theID, const std::string& theFeatureID,
                               const std::string& theAttrID,
                               const std::list<std::string>& theArguments) = 0;
 
  typedef std::list<std::pair<std::string, std::list<std::string> > > Validators;
  virtual void validators(const std::string& theFeatureID,
                          Validators& theResult) const = 0;
  virtual void validators(const std::string& theFeatureID, const std::string& theAttrID,
                          Validators& theResult) const = 0;
 
  virtual const ModelAPI_Validator* validator(const std::string& theID) const = 0;
 
  virtual bool validate(const std::shared_ptr<ModelAPI_Feature>& theFeature) const = 0;
 
  virtual bool validate(const std::shared_ptr<ModelAPI_Attribute>& theAttribute,
                        std::string& theValidator, Events_InfoMessage& theError) const = 0;
 
  virtual void registerNotObligatory(std::string theFeature, std::string theAttribute) = 0;
 
  virtual bool isNotObligatory(std::string theFeature, std::string theAttribute) = 0;
 
  virtual void registerConcealment(std::string theFeature, std::string theAttribute) = 0;
 
  virtual bool isConcealed(std::string theFeature, std::string theAttribute) = 0;
 
  virtual void registerMainArgument(std::string theFeature, std::string theAttribute) = 0;
 
  virtual bool isMainArgument(std::string theFeature, std::string theAttribute) = 0;
 
  virtual void registerCase(std::string theFeature, std::string theAttribute,
    const std::list<std::pair<std::string, std::string> >& theCases) = 0;
 
  virtual bool isCase(FeaturePtr theFeature, std::string theAttribute) = 0;
 
  virtual void registerGeometricalSelection(std::string theFeature, std::string theAttribute) = 0;
 
  virtual bool isGeometricalSelection(std::string theFeature, std::string theAttribute) = 0;
 
 protected:
  ModelAPI_ValidatorsFactory()
  {
  }
};
 
#endif