BOPDS_CommonBlock Class Reference

The class BOPDS_CommonBlock is to store the information about pave blocks that have geometrical coincidence (in terms of a tolerance) with: a) other pave block(s); b) face(s). First pave block in the common block (real pave block) is always a pave block with the minimal index of the original edge. More...

#include <BOPDS_CommonBlock.hxx>

Inheritance diagram for BOPDS_CommonBlock:

Public Member Functions
	BOPDS_CommonBlock ()
	Empty constructor.
	BOPDS_CommonBlock (const occ::handle< NCollection_BaseAllocator > &theAllocator)
	Constructor.
void	AddPaveBlock (const occ::handle< BOPDS_PaveBlock > &aPB)
	Modifier Adds the pave block <aPB> to the list of pave blocks of the common block.
void	SetPaveBlocks (const NCollection_List< occ::handle< BOPDS_PaveBlock > > &aLPB)
	Modifier Sets the list of pave blocks for the common block.
void	AddFace (const int aF)
	Modifier Adds the index of the face <aF> to the list of indices of faces of the common block.
void	SetFaces (const NCollection_List< int > &aLF)
	Modifier Sets the list of indices of faces <aLF> of the common block.
void	AppendFaces (NCollection_List< int > &aLF)
	Modifier Appends the list of indices of faces <aLF> to the list of indices of faces of the common block (the input list is emptied).
const NCollection_List< occ::handle< BOPDS_PaveBlock > > &	PaveBlocks () const
	Selector Returns the list of pave blocks of the common block.
const NCollection_List< int > &	Faces () const
	Selector Returns the list of indices of faces of the common block.
const occ::handle< BOPDS_PaveBlock > &	PaveBlock1 () const
	Selector Returns the first pave block of the common block.
occ::handle< BOPDS_PaveBlock > &	PaveBlockOnEdge (const int theIndex)
	Selector Returns the pave block that belongs to the edge with index <theIx>.
bool	IsPaveBlockOnFace (const int theIndex) const
	Query Returns true if the common block contains a pave block that belongs to the face with index <theIx>.
bool	IsPaveBlockOnEdge (const int theIndex) const
	Query Returns true if the common block contains a pave block that belongs to the edge with index <theIx>.
bool	Contains (const occ::handle< BOPDS_PaveBlock > &thePB) const
	Query Returns true if the common block contains a pave block that is equal to <thePB>.
bool	Contains (const int theF) const
	Query Returns true if the common block contains the face with index equal to <theF>.
void	SetEdge (const int theEdge)
	Modifier Assign the index <theEdge> as the edge index to all pave blocks of the common block.
int	Edge () const
	Selector Returns the index of the edge of all pave blocks of the common block.
void	Dump () const
void	SetRealPaveBlock (const occ::handle< BOPDS_PaveBlock > &thePB)
	Moves the pave blocks in the list to make the given pave block to be the first. It will be representative for the whole group.
void	SetTolerance (const double theTol)
	Sets the tolerance for the common block.
double	Tolerance () const
	Return the tolerance of common block.
Public Member Functions inherited from Standard_Transient
	Standard_Transient ()
	Empty constructor.
	Standard_Transient (const Standard_Transient &)
	Copy constructor – does nothing.
Standard_Transient &	operator= (const Standard_Transient &)
	Assignment operator, needed to avoid copying reference counter.
virtual	~Standard_Transient ()=default
	Destructor must be virtual.
virtual const opencascade::handle< Standard_Type > &	DynamicType () const
	Returns a type descriptor about this object.
bool	IsInstance (const opencascade::handle< Standard_Type > &theType) const
	Returns a true value if this is an instance of Type.
bool	IsInstance (const char *const theTypeName) const
	Returns a true value if this is an instance of TypeName.
bool	IsKind (const opencascade::handle< Standard_Type > &theType) const
	Returns true if this is an instance of Type or an instance of any class that inherits from Type. Note that multiple inheritance is not supported by OCCT RTTI mechanism.
bool	IsKind (const char *const theTypeName) const
	Returns true if this is an instance of TypeName or an instance of any class that inherits from TypeName. Note that multiple inheritance is not supported by OCCT RTTI mechanism.
Standard_Transient *	This () const
	Returns non-const pointer to this object (like const_cast). For protection against creating handle to objects allocated in stack or call from constructor, it will raise exception Standard_ProgramError if reference counter is zero.
int	GetRefCount () const noexcept
	Get the reference counter of this object.
void	IncrementRefCounter () noexcept
	Increments the reference counter of this object. Uses relaxed memory ordering since incrementing only requires atomicity, not synchronization with other memory operations.
int	DecrementRefCounter () noexcept
	Decrements the reference counter of this object; returns the decremented value. Uses release ordering for the decrement to ensure all writes to the object are visible before the count reaches zero. An acquire fence is added only when the count reaches zero, ensuring proper synchronization before deletion. This is more efficient than using acq_rel for every decrement.
virtual void	Delete () const
	Memory deallocator for transient classes.

Protected Attributes
NCollection_List< occ::handle< BOPDS_PaveBlock > >	myPaveBlocks
	Pave blocks of the common block.
NCollection_List< int >	myFaces
	Faces on which the pave blocks are lying.
double	myTolerance
	Tolerance of the common block.

Additional Inherited Members
typedef void	base_type
	Returns a type descriptor about this object.
static constexpr const char *	get_type_name ()
	Returns a type descriptor about this object.
static const opencascade::handle< Standard_Type > &	get_type_descriptor ()
	Returns type descriptor of Standard_Transient class.

Detailed Description

The class BOPDS_CommonBlock is to store the information about pave blocks that have geometrical coincidence (in terms of a tolerance) with: a) other pave block(s); b) face(s). First pave block in the common block (real pave block) is always a pave block with the minimal index of the original edge.

Constructor & Destructor Documentation

BOPDS_CommonBlock() [1/2]

BOPDS_CommonBlock::BOPDS_CommonBlock

(

)

Empty constructor.

BOPDS_CommonBlock() [2/2]

BOPDS_CommonBlock::BOPDS_CommonBlock

(

const occ::handle< NCollection_BaseAllocator > &

theAllocator

)

Constructor.

Parameters

theAllocator

the allocator to manage the memory

Member Function Documentation

AddFace()

void BOPDS_CommonBlock::AddFace

(

const int

aF

)

Modifier Adds the index of the face <aF> to the list of indices of faces of the common block.

AddPaveBlock()

void BOPDS_CommonBlock::AddPaveBlock

(

const occ::handle< BOPDS_PaveBlock > &

aPB

)

Modifier Adds the pave block <aPB> to the list of pave blocks of the common block.

AppendFaces()

void BOPDS_CommonBlock::AppendFaces

(

NCollection_List< int > &

aLF

)

Modifier Appends the list of indices of faces <aLF> to the list of indices of faces of the common block (the input list is emptied).

Contains() [1/2]

bool BOPDS_CommonBlock::Contains

(

const int

theF

)

const

Query Returns true if the common block contains the face with index equal to <theF>.

Contains() [2/2]

bool BOPDS_CommonBlock::Contains

(

const occ::handle< BOPDS_PaveBlock > &

thePB

)

const

Query Returns true if the common block contains a pave block that is equal to <thePB>.

Dump()

void BOPDS_CommonBlock::Dump

(

)

const

Edge()

int BOPDS_CommonBlock::Edge

(

)

const

Selector Returns the index of the edge of all pave blocks of the common block.

Faces()

const NCollection_List< int > & BOPDS_CommonBlock::Faces

(

)

const

Selector Returns the list of indices of faces of the common block.

IsPaveBlockOnEdge()

bool BOPDS_CommonBlock::IsPaveBlockOnEdge

(

const int

theIndex

)

const

Query Returns true if the common block contains a pave block that belongs to the edge with index <theIx>.

IsPaveBlockOnFace()

bool BOPDS_CommonBlock::IsPaveBlockOnFace

(

const int

theIndex

)

const

Query Returns true if the common block contains a pave block that belongs to the face with index <theIx>.

PaveBlock1()

const occ::handle< BOPDS_PaveBlock > & BOPDS_CommonBlock::PaveBlock1

(

)

const

Selector Returns the first pave block of the common block.

PaveBlockOnEdge()

occ::handle< BOPDS_PaveBlock > & BOPDS_CommonBlock::PaveBlockOnEdge

(

const int

theIndex

)

Selector Returns the pave block that belongs to the edge with index <theIx>.

PaveBlocks()

const NCollection_List< occ::handle< BOPDS_PaveBlock > > & BOPDS_CommonBlock::PaveBlocks

(

)

const

Selector Returns the list of pave blocks of the common block.

SetEdge()

void BOPDS_CommonBlock::SetEdge

(

const int

theEdge

)

Modifier Assign the index <theEdge> as the edge index to all pave blocks of the common block.

SetFaces()

void BOPDS_CommonBlock::SetFaces

(

const NCollection_List< int > &

aLF

)

Modifier Sets the list of indices of faces <aLF> of the common block.

SetPaveBlocks()

void BOPDS_CommonBlock::SetPaveBlocks

(

const NCollection_List< occ::handle< BOPDS_PaveBlock > > &

aLPB

)

Modifier Sets the list of pave blocks for the common block.

SetRealPaveBlock()

void BOPDS_CommonBlock::SetRealPaveBlock

(

const occ::handle< BOPDS_PaveBlock > &

thePB

)

Moves the pave blocks in the list to make the given pave block to be the first. It will be representative for the whole group.

SetTolerance()

void BOPDS_CommonBlock::SetTolerance ( const double theTol )

inline

Sets the tolerance for the common block.

Tolerance()

double BOPDS_CommonBlock::Tolerance ( ) const

inline

Return the tolerance of common block.

Field Documentation

myFaces

NCollection_List<int> BOPDS_CommonBlock::myFaces

protected

Faces on which the pave blocks are lying.

myPaveBlocks

NCollection_List<occ::handle<BOPDS_PaveBlock> > BOPDS_CommonBlock::myPaveBlocks

protected

Pave blocks of the common block.

myTolerance

double BOPDS_CommonBlock::myTolerance

protected

Tolerance of the common block.

---

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

• BOPDS_CommonBlock.hxx