cadex::ModelCheck_BRepChecker Class Reference

Provides an interface to perform various checks to BRep shape. More...

#include <cadex/ModelCheck_BRepChecker.hxx>

Classes
class	Options
	Holds options for checker tools. More...
class	ProblemIterator
class	ProblemWithShape
class	ProblemWithShapeIterator
struct	Tool
	Tools flags. More...

Public Types
typedef Options	OptionsType
typedef std::shared_ptr< internal::ModelCheck_BRepCheckerImpl >	ImplType

Public Member Functions
	ModelCheck_BRepChecker ()
	Constructor.
	ModelCheck_BRepChecker (const OptionsType &theOptions)
	Constructor.
OptionsType &	SetOptions ()
	Returns an internal Options object.
void	SetOptions (const OptionsType &theOptions)
	Sets an Options object.
const OptionsType &	Options () const
	Returns an internal Options object.
bool	Check (const ModelData_Shape &theShape)
	Performs check on the given shape.
bool	HasProblems () const
	Returns true if last checked shape has problems and false otherwise.
ModelData_ShapeList	ProblematicShapes () const
	Returns all subshapes which has problems.
ProblemIterator	Problems (const ModelData_Shape &theShape) const
	Returns iterator over problems of the given subshape.
ProblemWithShapeIterator	Problems (ModelCheck_ErrorLevel theLevel) const
	Returns iterator over problem with shapes of the given level.
size_t	NumberOfProblems (const ModelData_Shape &theShape) const
	Returns number of problems for the given subshape.
size_t	NumberOfProblems (ModelCheck_ErrorLevel theLevel) const
	Returns number of problems for the given level.
const ModelData_Shape &	Shape () const
	Returns the last checked shape.
size_t	FindID (const ModelData_Shape &theShape) const
	Returns the ID of subshape.
ModelData_Shape	FindShape (size_t theID) const
	Returns the shape with given ID.
const Base_ProgressStatus &	ProgressStatus () const
	Returns progress status.
Base_ProgressStatus &	ProgressStatus ()
	Returns progress status.
const ImplType &	Impl () const

Protected Attributes
ImplType	myImpl

Detailed Description

Provides an interface to perform various checks to BRep shape.

Usage example:

typedef ModelCheck_BRepChecker::Tool    Tool;
 
ModelCheck_BRepChecker aChecker;
aChecker.SetOptions()
    .Tools (Tool::Intersection | Tool::Tolerance) // select tools
    .ToleranceControlPoints (11) // tune
    .UseSameParam (true);        // options
 
ModelData_Shape aShape; // some real shape
aChecker.Check (aShape);
 
// Go through all shapes with problems.
ModelData_ShapeList aProblematicShapes = aChecker.ProblematicShapes();
for (ModelData_ShapeList::SizeType i = 0; i < aProblematicShapes.Size(); ++i) {
    const ModelData_Shape& aShape = aProblematicShapes[i];
 
    ModelCheck_BRepChecker::ProblemIterator aProblemsIt = aChecker.Problems (aShape);
    while (aProblemsIt.HasNext()) {
        const std::shared_ptr <ModelCheck_BaseProblem>& aProblem = aProblemsIt.Next();
 
        // Inspect problem. Consider using ModelCheck_ProblemVisitor.
    }
}
 
// Generate an .xml report.
ModelCheck_XmlReportGenerator aGen ("D:/report.xml");
aGen.Generate (aChecker);
aGen.Dump();

Examples

modeling/assembly/main.cxx.

Member Function Documentation

Check()

bool cadex::ModelCheck_BRepChecker::Check

(

const ModelData_Shape &

theShape

)

Performs check on the given shape.

One checker can be safely applied to a set of shapes (e.g. in loop). The options will remain same and all internal data will be reinitialized to work with new shape.

Examples

modeling/assembly/main.cxx.

Problems()

ModelCheck_BRepChecker::ProblemWithShapeIterator cadex::ModelCheck_BRepChecker::Problems

(

ModelCheck_ErrorLevel

theLevel

)

const

Returns iterator over problem with shapes of the given level.

This is an another approach to get all collected problems from checker. A simple example on how to use this method:

ModelCheck_BRepChecker::ProblemWithShapeIterator aProblemsByLevelIt =
     aChecker.Problems (ModelCheck_EL_Warning2); // all problems of Warning2 level
 
 while (aProblemsByLevelIt.HasNext()) {
     // Get current problem with shape and advance iterator
     const ModelCheck_BRepChecker::ProblemWithShape& aProblemWithShape = aProblemsByLevelIt.Next();
 
     const std::shared_ptr <ModelCheck_BaseProblem>& aProblem = aProblemWithShape.Problem();
     const ModelData_Shape&                          aShape   = aProblemWithShape.Shape();
 
     // Inspect the shape and problem. Consider using ModelCheck_ProblemVisitor.
 
 }