BRepAlgoAPI_Check Class Reference

The class Check provides a diagnostic tool for checking
single shape or couple of shapes.
Single shape is checking on topological validity, small edges
and self-interference. For couple of shapes added check
on validity for boolean operation of given type.

The class provides two ways of checking shape(-s)
More...

#include <BRepAlgoAPI_Check.hxx>

Public Member Functions
	BRepAlgoAPI_Check ()
	Empty constructor. More...
virtual	~BRepAlgoAPI_Check ()
	BRepAlgoAPI_Check (const TopoDS_Shape &theS, const Standard_Boolean bTestSE=Standard_True, const Standard_Boolean bTestSI=Standard_True)
	Constructor for checking single shape. <br> It calls methods Init(theS, TopoDS_Shape(), BOPAlgo_UNKNOWN, bTestSE, bTestSI) and Perform(). Params: theS - the shape that should be checked; bTestSE - flag that specifies whether check on small edges should be performed; by default it is set to TRUE; bTestSI - flag that specifies whether check on self-interference should be performed; by default it is set to TRUE; More...
	BRepAlgoAPI_Check (const TopoDS_Shape &theS1, const TopoDS_Shape &theS2, const BOPAlgo_Operation theOp=BOPAlgo_UNKNOWN, const Standard_Boolean bTestSE=Standard_True, const Standard_Boolean bTestSI=Standard_True)
	Constructor for couple of shapes. <br> It calls methods Init(theS1, theS2, theOp, bTestSE, bTestSI) and Perform(). Params: theS1, theS2 - the initial shapes. theOp - the type of Boolean Operation; if it is not defined (set to UNKNOWN) for each shape performed check as for single shape. bTestSE - flag that specifies whether check on small edges should be performed; by default it is set to TRUE; bTestSI - flag that specifies whether check on self-interference should be performed; by default it is set to TRUE; More...
void	SetData (const TopoDS_Shape &theS, const Standard_Boolean bTestSE=Standard_True, const Standard_Boolean bTestSI=Standard_True)
	Sets data for check by Init method. <br> The method provides alternative way for checking single shape. More...
void	SetData (const TopoDS_Shape &theS1, const TopoDS_Shape &theS2, const BOPAlgo_Operation theOp=BOPAlgo_UNKNOWN, const Standard_Boolean bTestSE=Standard_True, const Standard_Boolean bTestSI=Standard_True)
	Sets data for check by Init method. <br> The method provides alternative way for checking couple of shapes. More...
void	Perform ()
	Performs the check. More...
Standard_Boolean	IsValid ()
	Shows whether shape(s) valid or not. More...
const BOPAlgo_ListOfCheckResult &	Result ()
	Returns faulty shapes. More...

Protected Member Functions
void	Init (const TopoDS_Shape &theS1, const TopoDS_Shape &theS2, const BOPAlgo_Operation theOp, const Standard_Boolean bTestSE, const Standard_Boolean bTestSI)
	Initialyzes data. More...

Protected Attributes
TopoDS_Shape	myS1
TopoDS_Shape	myS2
BOPAlgo_PArgumentAnalyzer	myAnalyzer
BOPAlgo_ListOfCheckResult	myResult

Detailed Description

The class Check provides a diagnostic tool for checking
single shape or couple of shapes.
Single shape is checking on topological validity, small edges
and self-interference. For couple of shapes added check
on validity for boolean operation of given type.

The class provides two ways of checking shape(-s)

1. Constructors
   BRepAlgoAPI_Check aCh(theS);
   Standard_Boolean bV=aCh.IsValid();
   
2. Methods SetData and Perform
   BRepAlgoAPI_Check aCh;
   aCh.SetData(theS1, theS2, BOPAlgo_FUSE, Standard_False);
   aCh.Perform();
   Standard_Boolean bV=aCh.IsValid();
   

Constructor & Destructor Documentation

BRepAlgoAPI_Check::BRepAlgoAPI_Check

(

)

Empty constructor.

virtual BRepAlgoAPI_Check::~BRepAlgoAPI_Check ( )

virtual

BRepAlgoAPI_Check::BRepAlgoAPI_Check	(	const TopoDS_Shape &	theS,
		const Standard_Boolean	bTestSE = Standard_True,
		const Standard_Boolean	bTestSI = Standard_True
	)

  Constructor for checking single shape. <br>

It calls methods
Init(theS, TopoDS_Shape(), BOPAlgo_UNKNOWN, bTestSE, bTestSI)
and Perform().
Params:
theS - the shape that should be checked;
bTestSE - flag that specifies whether check on small edges
should be performed; by default it is set to TRUE;
bTestSI - flag that specifies whether check on self-interference
should be performed; by default it is set to TRUE;

BRepAlgoAPI_Check::BRepAlgoAPI_Check	(	const TopoDS_Shape &	theS1,
		const TopoDS_Shape &	theS2,
		const BOPAlgo_Operation	theOp = BOPAlgo_UNKNOWN,
		const Standard_Boolean	bTestSE = Standard_True,
		const Standard_Boolean	bTestSI = Standard_True
	)

 Constructor for couple of shapes. <br>

It calls methods
Init(theS1, theS2, theOp, bTestSE, bTestSI) and Perform().
Params:
theS1, theS2 - the initial shapes.
theOp - the type of Boolean Operation;
if it is not defined (set to UNKNOWN) for each shape
performed check as for single shape.
bTestSE - flag that specifies whether check on small edges
should be performed; by default it is set to TRUE;
bTestSI - flag that specifies whether check on self-interference
should be performed; by default it is set to TRUE;

Member Function Documentation

void BRepAlgoAPI_Check::Init ( const TopoDS_Shape &  theS1, const TopoDS_Shape &  theS2, const BOPAlgo_Operation  theOp, const Standard_Boolean  bTestSE, const Standard_Boolean  bTestSI  )

protected

Initialyzes data.

Standard_Boolean BRepAlgoAPI_Check::IsValid

(

)

Shows whether shape(s) valid or not.

void BRepAlgoAPI_Check::Perform

(

)

Performs the check.

const BOPAlgo_ListOfCheckResult& BRepAlgoAPI_Check::Result

(

)

Returns faulty shapes.

void BRepAlgoAPI_Check::SetData	(	const TopoDS_Shape &	theS,
		const Standard_Boolean	bTestSE = Standard_True,
		const Standard_Boolean	bTestSI = Standard_True
	)

 Sets data for check by Init method. <br>

The method provides alternative way for checking single shape.

void BRepAlgoAPI_Check::SetData	(	const TopoDS_Shape &	theS1,
		const TopoDS_Shape &	theS2,
		const BOPAlgo_Operation	theOp = BOPAlgo_UNKNOWN,
		const Standard_Boolean	bTestSE = Standard_True,
		const Standard_Boolean	bTestSI = Standard_True
	)

 Sets data for check by Init method. <br>

The method provides alternative way for checking couple of shapes.

Field Documentation

BOPAlgo_PArgumentAnalyzer BRepAlgoAPI_Check::myAnalyzer

protected

BOPAlgo_ListOfCheckResult BRepAlgoAPI_Check::myResult

protected

TopoDS_Shape BRepAlgoAPI_Check::myS1

protected

TopoDS_Shape BRepAlgoAPI_Check::myS2

protected

---

The documentation for this class was generated from the following file:

• BRepAlgoAPI_Check.hxx