X-Git-Url: http://git.salome-platform.org/gitweb/?a=blobdiff_plain;f=src%2FGeomValidators%2FGeomValidators_ShapeType.h;h=57de1470897b06bba892e4ab5678fb3a42b3cc38;hb=3205d0f18200948632155bbe7b640bc1e482243d;hp=782d9eaeb3b4f61888d85fb37b3ed0b99be39478;hpb=314b1e87c30b9c4e2f8dfc7fc33ee2ca5f094b0d;p=modules%2Fshaper.git diff --git a/src/GeomValidators/GeomValidators_ShapeType.h b/src/GeomValidators/GeomValidators_ShapeType.h index 782d9eaeb..57de14708 100644 --- a/src/GeomValidators/GeomValidators_ShapeType.h +++ b/src/GeomValidators/GeomValidators_ShapeType.h @@ -23,7 +23,7 @@ class GeomValidators_ShapeType : public ModelAPI_AttributeValidator { public: - // the edge type + /// Type of shape enum TypeOfShape { Empty, @@ -34,41 +34,47 @@ class GeomValidators_ShapeType : public ModelAPI_AttributeValidator Face, Solid, Compound, + Plane, AnyShape }; public: GEOMVALIDATORS_EXPORT GeomValidators_ShapeType() {} - //! returns true if attribute is valid - //! \param theAttribute the checked attribute - //! \param theArguments arguments of the attribute + //! Returns true if attribute has shape type listed in the parameter arguments + //! \param[in] theAttribute the checked attribute + //! \param[in] theArguments arguments of the attribute + //! \param[out] theError error message. GEOMVALIDATORS_EXPORT virtual bool isValid(const AttributePtr& theAttribute, - const std::list& theArguments) const; + const std::list& theArguments, + std::string& theError) const; protected: /// Convert string to TypeOfShape value /// \param theType a string value static TypeOfShape shapeType(const std::string& theType); - bool isValidArgument(const AttributePtr& theAttribute, - const std::string& theArgument) const; - /// Returns true if the attibute's object type satisfies the argument value - /// \param theAttribute a checked attribute - /// \param theArgument a parameter + /// \param[in] theAttribute a checked attribute + /// \param[in] theShapeType a type of shape + /// \param[out] theError error message. bool isValidAttribute(const AttributePtr& theAttribute, - const TypeOfShape theShapeType) const; + const TypeOfShape theShapeType, + std::string& theError) const; /// Returns true if the attibute's object type satisfies the argument value - /// \param theAttribute a checked object - /// \param theShapeType a shape type + /// \param[in] theObject a checked object + /// \param[in] theShapeType a shape type + /// \param[out] theError error message. bool isValidObject(const ObjectPtr& theObject, - const TypeOfShape theShapeType) const; + const TypeOfShape theShapeType, + std::string& theError) const; /// Returns true if the attibute's object type satisfies the argument value - /// \param theShape a checked shape - /// \param theShapeType a shape type + /// \param[in] theShape a checked shape + /// \param[in] theShapeType a shape type + /// \param[out] theError error message. bool isValidShape(const GeomShapePtr theShape, - const TypeOfShape theShapeType) const; + const TypeOfShape theShapeType, + std::string& theError) const; };