Open CASCADE Technology  7.7.0
Public Member Functions | Protected Member Functions
BOPAlgo_ArgumentAnalyzer Class Reference

check the validity of argument(s) for Boolean Operations More...

#include <BOPAlgo_ArgumentAnalyzer.hxx>

Inheritance diagram for BOPAlgo_ArgumentAnalyzer:
Inheritance graph
[legend]

Public Member Functions

 BOPAlgo_ArgumentAnalyzer ()
 empty constructor More...
 
virtual ~BOPAlgo_ArgumentAnalyzer ()
 
void SetShape1 (const TopoDS_Shape &TheShape)
 sets object shape More...
 
void SetShape2 (const TopoDS_Shape &TheShape)
 sets tool shape More...
 
const TopoDS_ShapeGetShape1 () const
 returns object shape; More...
 
const TopoDS_ShapeGetShape2 () const
 returns tool shape More...
 
BOPAlgo_OperationOperationType ()
 returns ref More...
 
Standard_BooleanStopOnFirstFaulty ()
 returns ref More...
 
Standard_BooleanArgumentTypeMode ()
 Returns (modifiable) mode that means checking types of shapes. More...
 
Standard_BooleanSelfInterMode ()
 Returns (modifiable) mode that means checking of self-intersection of shapes. More...
 
Standard_BooleanSmallEdgeMode ()
 Returns (modifiable) mode that means checking of small edges. More...
 
Standard_BooleanRebuildFaceMode ()
 Returns (modifiable) mode that means checking of possibility to split or rebuild faces. More...
 
Standard_BooleanTangentMode ()
 Returns (modifiable) mode that means checking of tangency between subshapes. More...
 
Standard_BooleanMergeVertexMode ()
 Returns (modifiable) mode that means checking of problem of merging vertices. More...
 
Standard_BooleanMergeEdgeMode ()
 Returns (modifiable) mode that means checking of problem of merging edges. More...
 
Standard_BooleanContinuityMode ()
 Returns (modifiable) mode that means checking of problem of continuity of the shape. More...
 
Standard_BooleanCurveOnSurfaceMode ()
 Returns (modifiable) mode that means checking of problem of invalid curve on surface. More...
 
void Perform (const Message_ProgressRange &theRange=Message_ProgressRange())
 performs analysis More...
 
Standard_Boolean HasFaulty () const
 result of test More...
 
const BOPAlgo_ListOfCheckResultGetCheckResult () const
 returns a result of test More...
 
- Public Member Functions inherited from BOPAlgo_Options
 BOPAlgo_Options ()
 Empty constructor. More...
 
 BOPAlgo_Options (const Handle< NCollection_BaseAllocator > &theAllocator)
 Constructor with allocator. More...
 
virtual ~BOPAlgo_Options ()
 Destructor. More...
 
const Handle< NCollection_BaseAllocator > & Allocator () const
 Returns allocator. More...
 
virtual void Clear ()
 Clears all warnings and errors, and any data cached by the algorithm. User defined options are not cleared. More...
 
void AddError (const Handle< Message_Alert > &theAlert)
 Adds the alert as error (fail) More...
 
void AddWarning (const Handle< Message_Alert > &theAlert)
 Adds the alert as warning. More...
 
Standard_Boolean HasErrors () const
 Returns true if algorithm has failed. More...
 
Standard_Boolean HasError (const Handle< Standard_Type > &theType) const
 Returns true if algorithm has generated error of specified type. More...
 
Standard_Boolean HasWarnings () const
 Returns true if algorithm has generated some warning alerts. More...
 
Standard_Boolean HasWarning (const Handle< Standard_Type > &theType) const
 Returns true if algorithm has generated warning of specified type. More...
 
const Handle< Message_Report > & GetReport () const
 Returns report collecting all errors and warnings. More...
 
void DumpErrors (Standard_OStream &theOS) const
 Dumps the error status into the given stream. More...
 
void DumpWarnings (Standard_OStream &theOS) const
 Dumps the warning statuses into the given stream. More...
 
void ClearWarnings ()
 Clears the warnings of the algorithm. More...
 
void SetFuzzyValue (const Standard_Real theFuzz)
 Sets the additional tolerance. More...
 
Standard_Real FuzzyValue () const
 Returns the additional tolerance. More...
 
void SetUseOBB (const Standard_Boolean theUseOBB)
 Enables/Disables the usage of OBB. More...
 
Standard_Boolean UseOBB () const
 Returns the flag defining usage of OBB. More...
 
void SetRunParallel (const Standard_Boolean theFlag)
 Set the flag of parallel processing if <theFlag> is true the parallel processing is switched on if <theFlag> is false the parallel processing is switched off. More...
 
Standard_Boolean RunParallel () const
 Returns the flag of parallel processing. More...
 

Protected Member Functions

void Prepare ()
 Prepares data;. More...
 
void TestTypes ()
 
void TestSelfInterferences (const Message_ProgressRange &theRange)
 
void TestSmallEdge ()
 
void TestRebuildFace ()
 
void TestTangent ()
 
void TestMergeSubShapes (const TopAbs_ShapeEnum theType)
 
void TestMergeVertex ()
 
void TestMergeEdge ()
 
void TestContinuity ()
 
void TestCurveOnSurface ()
 
- Protected Member Functions inherited from BOPAlgo_Algo
 BOPAlgo_Algo ()
 Default constructor. More...
 
virtual ~BOPAlgo_Algo ()
 
 BOPAlgo_Algo (const Handle< NCollection_BaseAllocator > &theAllocator)
 
virtual void CheckData ()
 Checks input data. More...
 
virtual void CheckResult ()
 Checks the obtained result. More...
 
void analyzeProgress (const Standard_Real theWhole, BOPAlgo_PISteps &theSteps) const
 Analyze progress steps of the whole operation. More...
 
virtual void fillPIConstants (const Standard_Real theWhole, BOPAlgo_PISteps &theSteps) const
 Fills the values for constant operations - the operations having constant relative running time. More...
 
virtual void fillPISteps (BOPAlgo_PISteps &theSteps) const
 Fills the values for the operations dependent on the inputs. Filled values may not be normalized to represent percentage of total running time. The values should just correlate to each other. E.g. if progress depends on the number of input shapes, the values may look like this: step1 = number_of_input_vertices; step2 = 2 * number_of_input_edges; step3 = 10 * number_of_input_faces. Normalization of these values will be done automatically in analyzeProgress() method. More...
 
- Protected Member Functions inherited from BOPAlgo_Options
Standard_Boolean UserBreak (const Message_ProgressScope &thePS)
 Adds error to the report if the break signal was caught. Returns true in this case, false otherwise. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from BOPAlgo_Options
static Standard_Boolean GetParallelMode ()
 Gets the global parallel mode. More...
 
static void SetParallelMode (const Standard_Boolean theNewMode)
 Sets the global parallel mode. More...
 
- Protected Attributes inherited from BOPAlgo_Options
Handle< NCollection_BaseAllocatormyAllocator
 Enables/Disables the usage of OBB. More...
 
Handle< Message_ReportmyReport
 Enables/Disables the usage of OBB. More...
 
Standard_Boolean myRunParallel
 Enables/Disables the usage of OBB. More...
 
Standard_Real myFuzzyValue
 Enables/Disables the usage of OBB. More...
 
Standard_Boolean myUseOBB
 Enables/Disables the usage of OBB. More...
 

Detailed Description

check the validity of argument(s) for Boolean Operations

Constructor & Destructor Documentation

◆ BOPAlgo_ArgumentAnalyzer()

BOPAlgo_ArgumentAnalyzer::BOPAlgo_ArgumentAnalyzer ( )

empty constructor

◆ ~BOPAlgo_ArgumentAnalyzer()

virtual BOPAlgo_ArgumentAnalyzer::~BOPAlgo_ArgumentAnalyzer ( )
virtual

Member Function Documentation

◆ ArgumentTypeMode()

Standard_Boolean& BOPAlgo_ArgumentAnalyzer::ArgumentTypeMode ( )

Returns (modifiable) mode that means checking types of shapes.

◆ ContinuityMode()

Standard_Boolean& BOPAlgo_ArgumentAnalyzer::ContinuityMode ( )

Returns (modifiable) mode that means checking of problem of continuity of the shape.

◆ CurveOnSurfaceMode()

Standard_Boolean& BOPAlgo_ArgumentAnalyzer::CurveOnSurfaceMode ( )

Returns (modifiable) mode that means checking of problem of invalid curve on surface.

◆ GetCheckResult()

const BOPAlgo_ListOfCheckResult& BOPAlgo_ArgumentAnalyzer::GetCheckResult ( ) const

returns a result of test

◆ GetShape1()

const TopoDS_Shape& BOPAlgo_ArgumentAnalyzer::GetShape1 ( ) const

returns object shape;

◆ GetShape2()

const TopoDS_Shape& BOPAlgo_ArgumentAnalyzer::GetShape2 ( ) const

returns tool shape

◆ HasFaulty()

Standard_Boolean BOPAlgo_ArgumentAnalyzer::HasFaulty ( ) const

result of test

◆ MergeEdgeMode()

Standard_Boolean& BOPAlgo_ArgumentAnalyzer::MergeEdgeMode ( )

Returns (modifiable) mode that means checking of problem of merging edges.

◆ MergeVertexMode()

Standard_Boolean& BOPAlgo_ArgumentAnalyzer::MergeVertexMode ( )

Returns (modifiable) mode that means checking of problem of merging vertices.

◆ OperationType()

BOPAlgo_Operation& BOPAlgo_ArgumentAnalyzer::OperationType ( )

returns ref

◆ Perform()

void BOPAlgo_ArgumentAnalyzer::Perform ( const Message_ProgressRange theRange = Message_ProgressRange())
virtual

performs analysis

Implements BOPAlgo_Algo.

◆ Prepare()

void BOPAlgo_ArgumentAnalyzer::Prepare ( )
protected

Prepares data;.

◆ RebuildFaceMode()

Standard_Boolean& BOPAlgo_ArgumentAnalyzer::RebuildFaceMode ( )

Returns (modifiable) mode that means checking of possibility to split or rebuild faces.

◆ SelfInterMode()

Standard_Boolean& BOPAlgo_ArgumentAnalyzer::SelfInterMode ( )

Returns (modifiable) mode that means checking of self-intersection of shapes.

◆ SetShape1()

void BOPAlgo_ArgumentAnalyzer::SetShape1 ( const TopoDS_Shape TheShape)

sets object shape

◆ SetShape2()

void BOPAlgo_ArgumentAnalyzer::SetShape2 ( const TopoDS_Shape TheShape)

sets tool shape

◆ SmallEdgeMode()

Standard_Boolean& BOPAlgo_ArgumentAnalyzer::SmallEdgeMode ( )

Returns (modifiable) mode that means checking of small edges.

◆ StopOnFirstFaulty()

Standard_Boolean& BOPAlgo_ArgumentAnalyzer::StopOnFirstFaulty ( )

returns ref

◆ TangentMode()

Standard_Boolean& BOPAlgo_ArgumentAnalyzer::TangentMode ( )

Returns (modifiable) mode that means checking of tangency between subshapes.

◆ TestContinuity()

void BOPAlgo_ArgumentAnalyzer::TestContinuity ( )
protected

◆ TestCurveOnSurface()

void BOPAlgo_ArgumentAnalyzer::TestCurveOnSurface ( )
protected

◆ TestMergeEdge()

void BOPAlgo_ArgumentAnalyzer::TestMergeEdge ( )
protected

◆ TestMergeSubShapes()

void BOPAlgo_ArgumentAnalyzer::TestMergeSubShapes ( const TopAbs_ShapeEnum  theType)
protected

◆ TestMergeVertex()

void BOPAlgo_ArgumentAnalyzer::TestMergeVertex ( )
protected

◆ TestRebuildFace()

void BOPAlgo_ArgumentAnalyzer::TestRebuildFace ( )
protected

◆ TestSelfInterferences()

void BOPAlgo_ArgumentAnalyzer::TestSelfInterferences ( const Message_ProgressRange theRange)
protected

◆ TestSmallEdge()

void BOPAlgo_ArgumentAnalyzer::TestSmallEdge ( )
protected

◆ TestTangent()

void BOPAlgo_ArgumentAnalyzer::TestTangent ( )
protected

◆ TestTypes()

void BOPAlgo_ArgumentAnalyzer::TestTypes ( )
protected

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