Open CASCADE Technology  7.4.1.dev
Public Member Functions
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:
Inheritance graph
[legend]

Public Member Functions

 ShapeAnalysis_FreeBoundData ()
 Empty constructor. More...
 
 ShapeAnalysis_FreeBoundData (const TopoDS_Wire &freebound)
 Creates object with contour given in the form of TopoDS_Wire. More...
 
void Clear ()
 Clears all properties of the contour. Contour bound itself is not cleared. More...
 
void SetFreeBound (const TopoDS_Wire &freebound)
 Sets contour. More...
 
void SetArea (const Standard_Real area)
 Sets area of the contour. More...
 
void SetPerimeter (const Standard_Real perimeter)
 Sets perimeter of the contour. More...
 
void SetRatio (const Standard_Real ratio)
 Sets ratio of average length to average width of the contour. More...
 
void SetWidth (const Standard_Real width)
 Sets average width of the contour. More...
 
void AddNotch (const TopoDS_Wire &notch, const Standard_Real width)
 Adds notch on the contour with its maximum width. More...
 
TopoDS_Wire FreeBound () const
 Returns contour. More...
 
Standard_Real Area () const
 Returns area of the contour. More...
 
Standard_Real Perimeter () const
 Returns perimeter of the contour. More...
 
Standard_Real Ratio () const
 Returns ratio of average length to average width of the contour. More...
 
Standard_Real Width () const
 Returns average width of the contour. More...
 
Standard_Integer NbNotches () const
 Returns number of notches on the contour. More...
 
Handle< TopTools_HSequenceOfShape > Notches () const
 Returns sequence of notches on the contour. More...
 
TopoDS_Wire Notch (const Standard_Integer index) const
 Returns notch on the contour. More...
 
Standard_Real NotchWidth (const Standard_Integer index) const
 Returns maximum width of notch specified by its rank number on the contour. More...
 
Standard_Real NotchWidth (const TopoDS_Wire &notch) const
 Returns maximum width of notch specified as TopoDS_Wire on the contour. More...
 
- Public Member Functions inherited from Standard_Transient
 Standard_Transient ()
 Empty constructor. More...
 
 Standard_Transient (const Standard_Transient &)
 Copy constructor – does nothing. More...
 
Standard_Transientoperator= (const Standard_Transient &)
 Assignment operator, needed to avoid copying reference counter. More...
 
virtual ~Standard_Transient ()
 Destructor must be virtual. More...
 
virtual void Delete () const
 Memory deallocator for transient classes. More...
 
virtual const opencascade::handle< Standard_Type > & DynamicType () const
 Returns a type descriptor about this object. More...
 
Standard_Boolean IsInstance (const opencascade::handle< Standard_Type > &theType) const
 Returns a true value if this is an instance of Type. More...
 
Standard_Boolean IsInstance (const Standard_CString theTypeName) const
 Returns a true value if this is an instance of TypeName. More...
 
Standard_Boolean 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. More...
 
Standard_Boolean IsKind (const Standard_CString 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. More...
 
Standard_TransientThis () 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. More...
 
Standard_Integer GetRefCount () const
 Get the reference counter of this object. More...
 
void IncrementRefCounter () const
 Increments the reference counter of this object. More...
 
Standard_Integer DecrementRefCounter () const
 Decrements the reference counter of this object; returns the decremented value. More...
 

Additional Inherited Members

- Public Types inherited from Standard_Transient
typedef void base_type
 Returns a type descriptor about this object. More...
 
- Static Public Member Functions inherited from Standard_Transient
static const char * get_type_name ()
 Returns a type descriptor about this object. More...
 
static const opencascade::handle< Standard_Type > & get_type_descriptor ()
 Returns type descriptor of Standard_Transient class. More...
 

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:

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 Standard_Real  width 
)

Adds notch on the contour with its maximum width.

◆ Area()

Standard_Real 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()

Standard_Integer ShapeAnalysis_FreeBoundData::NbNotches ( ) const

Returns number of notches on the contour.

◆ Notch()

TopoDS_Wire ShapeAnalysis_FreeBoundData::Notch ( const Standard_Integer  index) const

Returns notch on the contour.

◆ Notches()

Handle< TopTools_HSequenceOfShape > ShapeAnalysis_FreeBoundData::Notches ( ) const

Returns sequence of notches on the contour.

◆ NotchWidth() [1/2]

Standard_Real ShapeAnalysis_FreeBoundData::NotchWidth ( const Standard_Integer  index) const

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

◆ NotchWidth() [2/2]

Standard_Real ShapeAnalysis_FreeBoundData::NotchWidth ( const TopoDS_Wire notch) const

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

◆ Perimeter()

Standard_Real ShapeAnalysis_FreeBoundData::Perimeter ( ) const

Returns perimeter of the contour.

◆ Ratio()

Standard_Real ShapeAnalysis_FreeBoundData::Ratio ( ) const

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

◆ SetArea()

void ShapeAnalysis_FreeBoundData::SetArea ( const Standard_Real  area)

Sets area of the contour.

◆ SetFreeBound()

void ShapeAnalysis_FreeBoundData::SetFreeBound ( const TopoDS_Wire freebound)

Sets contour.

◆ SetPerimeter()

void ShapeAnalysis_FreeBoundData::SetPerimeter ( const Standard_Real  perimeter)

Sets perimeter of the contour.

◆ SetRatio()

void ShapeAnalysis_FreeBoundData::SetRatio ( const Standard_Real  ratio)

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

◆ SetWidth()

void ShapeAnalysis_FreeBoundData::SetWidth ( const Standard_Real  width)

Sets average width of the contour.

◆ Width()

Standard_Real ShapeAnalysis_FreeBoundData::Width ( ) const

Returns average width of the contour.


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