HelixBRep_BuilderHelix Class Reference

Implementation of building helix wire Values of Error Status returned by algo: 0 - OK 1 - object is just initialized, it means that no input parameters were set 2 - approximation fails. More...

#include <HelixBRep_BuilderHelix.hxx>

Public Member Functions
	HelixBRep_BuilderHelix ()
	Empty constructor.
virtual	~HelixBRep_BuilderHelix ()
void	SetParameters (const gp_Ax3 &theAxis, const NCollection_Array1< double > &theDiams, const NCollection_Array1< double > &theHeights, const NCollection_Array1< double > &thePitches, const NCollection_Array1< bool > &theIsPitches)
	Sets parameters of general composite helix.
void	SetParameters (const gp_Ax3 &theAxis, const double theDiam, const NCollection_Array1< double > &theHeights, const NCollection_Array1< double > &thePitches, const NCollection_Array1< bool > &theIsPitches)
	Sets parameters of pure helix.
void	SetParameters (const gp_Ax3 &theAxis, const double theDiam1, const double theDiam2, const NCollection_Array1< double > &theHeights, const NCollection_Array1< double > &thePitches, const NCollection_Array1< bool > &theIsPitches)
	Sets parameters of pure spiral.
void	SetParameters (const gp_Ax3 &theAxis, const NCollection_Array1< double > &theDiams, const NCollection_Array1< double > &thePitches, const NCollection_Array1< double > &theNbTurns)
	Sets parameters of general composite helix.
void	SetParameters (const gp_Ax3 &theAxis, const double theDiam, const NCollection_Array1< double > &thePitches, const NCollection_Array1< double > &theNbTurns)
	Sets parameters of pure helix.
void	SetParameters (const gp_Ax3 &theAxis, const double theDiam1, const double theDiam2, const NCollection_Array1< double > &thePitches, const NCollection_Array1< double > &theNbTurns)
	Sets parameters of pure spiral.
void	SetApproxParameters (const double theTolerance, const int theMaxDegree, const GeomAbs_Shape theContinuity)
	Sets parameters for approximation.
void	Perform ()
	Performs calculations.
double	ToleranceReached () const
	Gets tolerance reached by approximation.
int	ErrorStatus () const
	Returns error status of algorithm.
int	WarningStatus () const
	Returns warning status of algorithm.
const TopoDS_Shape &	Shape () const
	Gets result of algorithm.

Protected Attributes
gp_Ax3	myAxis3
occ::handle< NCollection_HArray1< double > >	myDiams
occ::handle< NCollection_HArray1< double > >	myHeights
occ::handle< NCollection_HArray1< double > >	myPitches
occ::handle< NCollection_HArray1< bool > >	myIsPitches
double	myTolerance
double	myTolReached
GeomAbs_Shape	myContinuity
int	myMaxDegree
int	myMaxSegments
int	myErrorStatus
int	myWarningStatus
TopoDS_Shape	myShape

Detailed Description

Implementation of building helix wire Values of Error Status returned by algo: 0 - OK 1 - object is just initialized, it means that no input parameters were set 2 - approximation fails.

10 - R < tolerance - starting point is too close to axis 11 - step (Pitch) < tolerance 12 - Height < tolerance 13 - TaperAngle < 0 or TaperAngle > Pi/2 - TolAng Warning Status: 0 - OK 1 - tolerance reached by approximation > requested tolerance.

Constructor & Destructor Documentation

HelixBRep_BuilderHelix()

HelixBRep_BuilderHelix::HelixBRep_BuilderHelix

(

)

Empty constructor.

~HelixBRep_BuilderHelix()

virtual HelixBRep_BuilderHelix::~HelixBRep_BuilderHelix ( )

virtual

Member Function Documentation

ErrorStatus()

int HelixBRep_BuilderHelix::ErrorStatus

(

)

const

Returns error status of algorithm.

Perform()

void HelixBRep_BuilderHelix::Perform

(

)

Performs calculations.

SetApproxParameters()

void HelixBRep_BuilderHelix::SetApproxParameters	(	const double	theTolerance,
		const int	theMaxDegree,
		const GeomAbs_Shape	theContinuity )

Sets parameters for approximation.

SetParameters() [1/6]

void HelixBRep_BuilderHelix::SetParameters	(	const gp_Ax3 &	theAxis,
		const double	theDiam,
		const NCollection_Array1< double > &	theHeights,
		const NCollection_Array1< double > &	thePitches,
		const NCollection_Array1< bool > &	theIsPitches )

Sets parameters of pure helix.

SetParameters() [2/6]

void HelixBRep_BuilderHelix::SetParameters	(	const gp_Ax3 &	theAxis,
		const double	theDiam,
		const NCollection_Array1< double > &	thePitches,
		const NCollection_Array1< double > &	theNbTurns )

Sets parameters of pure helix.

SetParameters() [3/6]

void HelixBRep_BuilderHelix::SetParameters	(	const gp_Ax3 &	theAxis,
		const double	theDiam1,
		const double	theDiam2,
		const NCollection_Array1< double > &	theHeights,
		const NCollection_Array1< double > &	thePitches,
		const NCollection_Array1< bool > &	theIsPitches )

Sets parameters of pure spiral.

SetParameters() [4/6]

void HelixBRep_BuilderHelix::SetParameters	(	const gp_Ax3 &	theAxis,
		const double	theDiam1,
		const double	theDiam2,
		const NCollection_Array1< double > &	thePitches,
		const NCollection_Array1< double > &	theNbTurns )

Sets parameters of pure spiral.

SetParameters() [5/6]

void HelixBRep_BuilderHelix::SetParameters	(	const gp_Ax3 &	theAxis,
		const NCollection_Array1< double > &	theDiams,
		const NCollection_Array1< double > &	theHeights,
		const NCollection_Array1< double > &	thePitches,
		const NCollection_Array1< bool > &	theIsPitches )

Sets parameters of general composite helix.

SetParameters() [6/6]

void HelixBRep_BuilderHelix::SetParameters	(	const gp_Ax3 &	theAxis,
		const NCollection_Array1< double > &	theDiams,
		const NCollection_Array1< double > &	thePitches,
		const NCollection_Array1< double > &	theNbTurns )

Sets parameters of general composite helix.

Shape()

const TopoDS_Shape & HelixBRep_BuilderHelix::Shape

(

)

const

Gets result of algorithm.

ToleranceReached()

double HelixBRep_BuilderHelix::ToleranceReached

(

)

const

Gets tolerance reached by approximation.

WarningStatus()

int HelixBRep_BuilderHelix::WarningStatus

(

)

const

Returns warning status of algorithm.

Field Documentation

myAxis3

gp_Ax3 HelixBRep_BuilderHelix::myAxis3

protected

myContinuity

GeomAbs_Shape HelixBRep_BuilderHelix::myContinuity

protected

myDiams

occ::handle<NCollection_HArray1<double> > HelixBRep_BuilderHelix::myDiams

protected

myErrorStatus

int HelixBRep_BuilderHelix::myErrorStatus

protected

myHeights

occ::handle<NCollection_HArray1<double> > HelixBRep_BuilderHelix::myHeights

protected

myIsPitches

occ::handle<NCollection_HArray1<bool> > HelixBRep_BuilderHelix::myIsPitches

protected

myMaxDegree

int HelixBRep_BuilderHelix::myMaxDegree

protected

myMaxSegments

int HelixBRep_BuilderHelix::myMaxSegments

protected

myPitches

occ::handle<NCollection_HArray1<double> > HelixBRep_BuilderHelix::myPitches

protected

myShape

TopoDS_Shape HelixBRep_BuilderHelix::myShape

protected

myTolerance

double HelixBRep_BuilderHelix::myTolerance

protected

myTolReached

double HelixBRep_BuilderHelix::myTolReached

protected

myWarningStatus

int HelixBRep_BuilderHelix::myWarningStatus

protected

---

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

• HelixBRep_BuilderHelix.hxx