#include <ModelAPI_AttributeValidator.h>
#include <ModelAPI_FeatureValidator.h>
+/// \class FeaturesPlugin_ValidatorPipePath
+/// \ingroup Validators
+/// \brief A validator for selection pipe path.
+class FeaturesPlugin_ValidatorPipePath: public ModelAPI_AttributeValidator
+{
+public:
+ //! \return True if the attribute is valid.
+ //! \param[in] theAttribute the checked attribute.
+ //! \param[in] theArguments arguments of the attribute.
+ //! \param[out] theError error message.
+ virtual bool isValid(const AttributePtr& theAttribute,
+ const std::list<std::string>& theArguments,
+ Events_InfoMessage& theError) const;
+};
+
/// \class FeaturesPlugin_ValidatorPipeLocations
/// \ingroup Validators
/// \brief Validator for the pipe locations.
//! \param theError error message
virtual bool isValid(const std::shared_ptr<ModelAPI_Feature>& theFeature,
const std::list<std::string>& theArguments,
- std::string& theError) const;
+ Events_InfoMessage& theError) const;
/// Returns true if the attribute in feature is not obligatory for the feature execution
virtual bool isNotObligatory(std::string theFeature, std::string theAttribute);
class FeaturesPlugin_ValidatorBaseForGeneration: public ModelAPI_AttributeValidator
{
public:
- //! Returns true if attribute has selection type listed in the parameter arguments.
+ //! \return true if attribute has selection type listed in the parameter arguments.
//! \param[in] theAttribute the checked attribute.
//! \param[in] theArguments arguments of the attribute.
//! \param[out] theError error message.
virtual bool isValid(const AttributePtr& theAttribute,
const std::list<std::string>& theArguments,
- std::string& theError) const;
+ Events_InfoMessage& theError) const;
private:
bool isValidAttribute(const AttributePtr& theAttribute,
const std::list<std::string>& theArguments,
- std::string& theError) const;
+ Events_InfoMessage& theError) const;
};
/// \class FeaturesPlugin_ValidatorCompositeLauncher
class FeaturesPlugin_ValidatorCompositeLauncher: public ModelAPI_AttributeValidator
{
public:
- //! Returns true if attribute has selection type listed in the parameter arguments.
+ //! \return true if attribute has selection type listed in the parameter arguments.
//! \param[in] theAttribute the checked attribute.
//! \param[in] theArguments arguments of the attribute.
//! \param[out] theError error message.
virtual bool isValid(const AttributePtr& theAttribute,
const std::list<std::string>& theArguments,
- std::string& theError) const;
+ Events_InfoMessage& theError) const;
};
-/// \class FeaturesPlugin_ValidatorCanBeEmpty
+/// \class FeaturesPlugin_ValidatorExtrusionDir
/// \ingroup Validators
-/// \brief A validator for extrusion direction attribute and bounding planes for extrusion and
-/// revolution. Allows them to be empty if base objects are planar and do not contain
-/// vertices and edges.
-class FeaturesPlugin_ValidatorCanBeEmpty: public ModelAPI_FeatureValidator
+/// \brief A validator for extrusion direction attribute. Allows it to be empty if base objects are
+/// planar and do not contain vertices and edges.
+class FeaturesPlugin_ValidatorExtrusionDir: public ModelAPI_FeatureValidator
{
public:
- //! Returns true if attribute listed in the parameter arguments are planar.
+ //! \return true if attribute listed in the parameter arguments are planar.
//! \param[in] theFeature the checked feature.
//! \param[in] theArguments arguments of the attribute.
//! \param[out] theError error message.
virtual bool isValid(const std::shared_ptr<ModelAPI_Feature>& theFeature,
const std::list<std::string>& theArguments,
- std::string& theError) const;
+ Events_InfoMessage& theError) const;
- /// Returns true if the attribute in feature is not obligatory for the feature execution
+ /// \return true if the attribute in feature is not obligatory for the feature execution
virtual bool isNotObligatory(std::string theFeature, std::string theAttribute);
private:
bool isShapesCanBeEmpty(const AttributePtr& theAttribute,
- std::string& theError) const;
+ Events_InfoMessage& theError) const;
+};
+
+/// \class FeaturesPlugin_ValidatorBooleanSelection
+/// \ingroup Validators
+/// \brief Validates selection for boolean operation.
+class FeaturesPlugin_ValidatorBooleanSelection: public ModelAPI_AttributeValidator
+{
+public:
+ /// \return True if the attribute is valid. It checks whether the selection
+ /// is acceptable for boolean operation.
+ /// \param[in] theAttribute an attribute to check.
+ /// \param[in] theArguments a filter parameters.
+ /// \param[out] theError error message.
+ virtual bool isValid(const AttributePtr& theAttribute,
+ const std::list<std::string>& theArguments,
+ Events_InfoMessage& theError) const;
+};
+
+/// \class FeaturesPlugin_ValidatorPartitionSelection
+/// \ingroup Validators
+/// \brief Validates selection for partition.
+class FeaturesPlugin_ValidatorPartitionSelection: public ModelAPI_AttributeValidator
+{
+public:
+ /// \return True if the attribute is valid. It checks whether the selection
+ /// is acceptable for operation.
+ /// \param[in] theAttribute an attribute to check.
+ /// \param[in] theArguments a filter parameters.
+ /// \param[out] theError error message.
+ virtual bool isValid(const AttributePtr& theAttribute,
+ const std::list<std::string>& theArguments,
+ Events_InfoMessage& theError) const;
};
-/// \class FeaturesPlugin_ValidatorBaseForWire
+/// \class FeaturesPlugin_ValidatorRemoveSubShapesSelection
/// \ingroup Validators
-/// \brief A validator for selection base shapes for wire. Allows to select edges on sketch and
-/// wires objects that are connected to already selected shapes.
-class FeaturesPlugin_ValidatorBaseForWire: public ModelAPI_AttributeValidator
+/// \brief Validates selection for "Remove Sub-Shapes" feature.
+class FeaturesPlugin_ValidatorRemoveSubShapesSelection: public ModelAPI_AttributeValidator
{
public:
- //! Returns true if attribute is ok.
+ /// \return True if the attribute is valid. It checks whether the selection
+ /// is acceptable for operation.
+ /// \param[in] theAttribute an attribute to check.
+ /// \param[in] theArguments a filter parameters.
+ /// \param[out] theError error message.
+ virtual bool isValid(const AttributePtr& theAttribute,
+ const std::list<std::string>& theArguments,
+ Events_InfoMessage& theError) const;
+};
+
+/// \class FeaturesPlugin_ValidatorRemoveSubShapesResult
+/// \ingroup Validators
+/// \brief Validator for the Remove Sub-Shapes feature.
+class FeaturesPlugin_ValidatorRemoveSubShapesResult: public ModelAPI_FeatureValidator
+{
+ public:
+ //! \return true if result is valid shape.
+ //! \param theFeature the checked feature
+ //! \param theArguments arguments of the feature (not used)
+ //! \param theError error message
+ virtual bool isValid(const std::shared_ptr<ModelAPI_Feature>& theFeature,
+ const std::list<std::string>& theArguments,
+ Events_InfoMessage& theError) const;
+
+ /// \return true if the attribute in feature is not obligatory for the feature execution
+ virtual bool isNotObligatory(std::string theFeature, std::string theAttribute);
+};
+
+/// \class FeaturesPlugin_ValidatorUnionSelection
+/// \ingroup Validators
+/// \brief Validates selection for "Union" feature.
+class FeaturesPlugin_ValidatorUnionSelection: public ModelAPI_AttributeValidator
+{
+public:
+ /// \return True if the attribute is valid. It checks whether the selection
+ /// is acceptable for operation.
+ /// \param[in] theAttribute an attribute to check.
+ /// \param[in] theArguments a filter parameters.
+ /// \param[out] theError error message.
+ virtual bool isValid(const AttributePtr& theAttribute,
+ const std::list<std::string>& theArguments,
+ Events_InfoMessage& theError) const;
+};
+
+/// \class FeaturesPlugin_ValidatorUnionArguments
+/// \ingroup Validators
+/// \brief Validator for the "Union" feature.
+class FeaturesPlugin_ValidatorUnionArguments: public ModelAPI_FeatureValidator
+{
+ public:
+ //! \return true if result is valid shape.
+ //! \param theFeature the checked feature
+ //! \param theArguments arguments of the feature (not used)
+ //! \param theError error message
+ virtual bool isValid(const std::shared_ptr<ModelAPI_Feature>& theFeature,
+ const std::list<std::string>& theArguments,
+ Events_InfoMessage& theError) const;
+
+ /// \return true if the attribute in feature is not obligatory for the feature execution
+ virtual bool isNotObligatory(std::string theFeature, std::string theAttribute);
+};
+
+/// \class FeaturesPlugin_ValidatorConcealedResult
+/// \ingroup Validators
+/// \brief Validator for the "Recover" feature.
+class FeaturesPlugin_ValidatorConcealedResult: public ModelAPI_AttributeValidator
+{
+ public:
+ //! \return True if the attribute is valid.
//! \param[in] theAttribute the checked attribute.
//! \param[in] theArguments arguments of the attribute.
//! \param[out] theError error message.
virtual bool isValid(const AttributePtr& theAttribute,
const std::list<std::string>& theArguments,
- std::string& theError) const;
+ Events_InfoMessage& theError) const;
};
#endif
