Open CASCADE Technology  7.7.0
Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes

BOPAlgo_WireSplitter Class Reference

The class is to build loops from the given set of edges. More...

#include <BOPAlgo_WireSplitter.hxx>

Inheritance diagram for BOPAlgo_WireSplitter:
Inheritance graph
[legend]

Public Member Functions

 BOPAlgo_WireSplitter ()
 
virtual ~BOPAlgo_WireSplitter ()
 
 BOPAlgo_WireSplitter (const Handle< NCollection_BaseAllocator > &theAllocator)
 
void SetWES (const BOPAlgo_WireEdgeSet &theWES)
 
BOPAlgo_WireEdgeSetWES ()
 
void SetContext (const Handle< IntTools_Context > &theContext)
 Sets the context for the algorithm. More...
 
const Handle< IntTools_Context > & Context ()
 Returns the context. More...
 
virtual void Perform (const Message_ProgressRange &theRange=Message_ProgressRange()) override
 The main method to implement the operation Providing the range allows to enable Progress indicator User break functionalities. 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...
 

Static Public Member Functions

static void MakeWire (TopTools_ListOfShape &theLE, TopoDS_Wire &theW)
 
static void SplitBlock (const TopoDS_Face &theF, BOPTools_ConnexityBlock &theCB, const Handle< IntTools_Context > &theContext)
 
- 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 Member Functions

virtual void CheckData () override
 Checks input data. More...
 
void MakeWires (const Message_ProgressRange &theRange)
 
- Protected Member Functions inherited from BOPAlgo_Algo
 BOPAlgo_Algo ()
 Default constructor. More...
 
virtual ~BOPAlgo_Algo ()
 
 BOPAlgo_Algo (const Handle< NCollection_BaseAllocator > &theAllocator)
 
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...
 

Protected Attributes

BOPAlgo_PWireEdgeSet myWES
 
BOPTools_ListOfConnexityBlock myLCB
 
Handle< IntTools_ContextmyContext
 
- 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

The class is to build loops from the given set of edges.

It returns the following Error statuses

Constructor & Destructor Documentation

◆ BOPAlgo_WireSplitter() [1/2]

BOPAlgo_WireSplitter::BOPAlgo_WireSplitter ( )

◆ ~BOPAlgo_WireSplitter()

virtual BOPAlgo_WireSplitter::~BOPAlgo_WireSplitter ( )
virtual

◆ BOPAlgo_WireSplitter() [2/2]

BOPAlgo_WireSplitter::BOPAlgo_WireSplitter ( const Handle< NCollection_BaseAllocator > &  theAllocator)

Member Function Documentation

◆ CheckData()

virtual void BOPAlgo_WireSplitter::CheckData ( )
overrideprotectedvirtual

Checks input data.

Reimplemented from BOPAlgo_Algo.

◆ Context()

const Handle< IntTools_Context >& BOPAlgo_WireSplitter::Context ( )

Returns the context.

◆ MakeWire()

static void BOPAlgo_WireSplitter::MakeWire ( TopTools_ListOfShape theLE,
TopoDS_Wire theW 
)
static

◆ MakeWires()

void BOPAlgo_WireSplitter::MakeWires ( const Message_ProgressRange theRange)
protected

◆ Perform()

virtual void BOPAlgo_WireSplitter::Perform ( const Message_ProgressRange theRange = Message_ProgressRange())
overridevirtual

The main method to implement the operation Providing the range allows to enable Progress indicator User break functionalities.

Implements BOPAlgo_Algo.

◆ SetContext()

void BOPAlgo_WireSplitter::SetContext ( const Handle< IntTools_Context > &  theContext)

Sets the context for the algorithm.

◆ SetWES()

void BOPAlgo_WireSplitter::SetWES ( const BOPAlgo_WireEdgeSet theWES)

◆ SplitBlock()

static void BOPAlgo_WireSplitter::SplitBlock ( const TopoDS_Face theF,
BOPTools_ConnexityBlock theCB,
const Handle< IntTools_Context > &  theContext 
)
static

◆ WES()

BOPAlgo_WireEdgeSet& BOPAlgo_WireSplitter::WES ( )

Field Documentation

◆ myContext

Handle< IntTools_Context > BOPAlgo_WireSplitter::myContext
protected

◆ myLCB

BOPTools_ListOfConnexityBlock BOPAlgo_WireSplitter::myLCB
protected

◆ myWES

BOPAlgo_PWireEdgeSet BOPAlgo_WireSplitter::myWES
protected

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