ShapeAnalysis_FreeBoundData Class Reference

This class is intended to represent free bound and to store its properties. More...

#include <ShapeAnalysis_FreeBoundData.hxx>

Inheritance diagram for ShapeAnalysis_FreeBoundData:

Public Member Functions
	ShapeAnalysis_FreeBoundData ()
	Empty constructor.
	ShapeAnalysis_FreeBoundData (const TopoDS_Wire &freebound)
	Creates object with contour given in the form of TopoDS_Wire.
void	Clear ()
	Clears all properties of the contour. Contour bound itself is not cleared.
void	SetFreeBound (const TopoDS_Wire &freebound)
	Sets contour.
void	SetArea (const double area)
	Sets area of the contour.
void	SetPerimeter (const double perimeter)
	Sets perimeter of the contour.
void	SetRatio (const double ratio)
	Sets ratio of average length to average width of the contour.
void	SetWidth (const double widthwidth)
	Sets average width of the contour.
void	AddNotch (const TopoDS_Wire &notch, const double widthwidth)
	Adds notch on the contour with its maximum width.
TopoDS_Wire	FreeBound () const
	Returns contour.
double	Area () const
	Returns area of the contour.
double	Perimeter () const
	Returns perimeter of the contour.
double	Ratio () const
	Returns ratio of average length to average width of the contour.
double	Width () const
	Returns average width of the contour.
int	NbNotches () const
	Returns number of notches on the contour.
occ::handle< NCollection_HSequence< TopoDS_Shape > >	Notches () const
	Returns sequence of notches on the contour.
TopoDS_Wire	Notch (const int indexindex) const
	Returns notch on the contour.
double	NotchWidth (const int indexindex) const
	Returns maximum width of notch specified by its rank number on the contour.
double	NotchWidth (const TopoDS_Wire &notch) const
	Returns maximum width of notch specified as TopoDS_Wire on the contour.
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.

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

This class is intended to represent free bound and to store its properties.

This class is used by ShapeAnalysis_FreeBoundsProperties class when storing each free bound and its properties.

The properties stored in this class are the following:

• area of the contour,
• perimeter of the contour,
• ratio of average length to average width of the contour,
• average width of contour,
• notches (narrow 'V'-like sub-contours) on the contour and their maximum width.

This class provides methods for setting and getting fields only.

Constructor & Destructor Documentation

ShapeAnalysis_FreeBoundData() [1/2]

ShapeAnalysis_FreeBoundData::ShapeAnalysis_FreeBoundData

(

)

Empty constructor.

ShapeAnalysis_FreeBoundData() [2/2]

ShapeAnalysis_FreeBoundData::ShapeAnalysis_FreeBoundData

(

const TopoDS_Wire &

freebound

)

Creates object with contour given in the form of TopoDS_Wire.

Member Function Documentation

AddNotch()

void ShapeAnalysis_FreeBoundData::AddNotch	(	const TopoDS_Wire &	notch,
		const double	width )

Adds notch on the contour with its maximum width.

Area()

double ShapeAnalysis_FreeBoundData::Area

(

)

const

Returns area of the contour.

Clear()

void ShapeAnalysis_FreeBoundData::Clear

(

)

Clears all properties of the contour. Contour bound itself is not cleared.

FreeBound()

TopoDS_Wire ShapeAnalysis_FreeBoundData::FreeBound

(

)

const

Returns contour.

NbNotches()

int ShapeAnalysis_FreeBoundData::NbNotches

(

)

const

Returns number of notches on the contour.

Notch()

TopoDS_Wire ShapeAnalysis_FreeBoundData::Notch

(

const int

index

)

const

Returns notch on the contour.

Notches()

occ::handle< NCollection_HSequence< TopoDS_Shape > > ShapeAnalysis_FreeBoundData::Notches

(

)

const

Returns sequence of notches on the contour.

NotchWidth() [1/2]

double ShapeAnalysis_FreeBoundData::NotchWidth

(

const int

index

)

const

Returns maximum width of notch specified by its rank number on the contour.

NotchWidth() [2/2]

double ShapeAnalysis_FreeBoundData::NotchWidth

(

const TopoDS_Wire &

notch

)

const

Returns maximum width of notch specified as TopoDS_Wire on the contour.

Perimeter()

double ShapeAnalysis_FreeBoundData::Perimeter

(

)

const

Returns perimeter of the contour.

Ratio()

double ShapeAnalysis_FreeBoundData::Ratio

(

)

const

Returns ratio of average length to average width of the contour.

SetArea()

void ShapeAnalysis_FreeBoundData::SetArea

(

const double

area

)

Sets area of the contour.

SetFreeBound()

void ShapeAnalysis_FreeBoundData::SetFreeBound

(

const TopoDS_Wire &

freebound

)

Sets contour.

SetPerimeter()

void ShapeAnalysis_FreeBoundData::SetPerimeter

(

const double

perimeter

)

Sets perimeter of the contour.

SetRatio()

void ShapeAnalysis_FreeBoundData::SetRatio

(

const double

ratio

)

Sets ratio of average length to average width of the contour.

SetWidth()

void ShapeAnalysis_FreeBoundData::SetWidth

(

const double

width

)

Sets average width of the contour.

Width()

double ShapeAnalysis_FreeBoundData::Width

(

)

const

Returns average width of the contour.

---

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

• ShapeAnalysis_FreeBoundData.hxx