Dtk_feat_thread Class Reference

Feature Thread (taraudage) More...

Public Member Functions
	Dtk_feat_thread ()
	Constructor of Thread Feature More...
int	get_direction_reversed (Bool *)
	Returns thread direction reversed. More...
int	get_inner_thread (Dtk_feat_inner_thread **)
	Returns the inner thread parameters. More...
int	get_limit (Dtk_feat_geometry **)
	Returns thread limit surface. More...
int	get_support (Dtk_feat_geometry **)
	Returns the thread support surface. More...
int	get_support_depth (double *)
	Returns the thread support surface depth. More...
int	get_support_depth_has_tol (Bool *)
	Tests whether there is a tolerance set on support depth. More...
int	get_support_depth_with_tol (double *, double *, double *)
	Returns the thread support surface depth with tolerance values if any. More...
int	get_support_diameter (double *)
	Returns the thread support surface diameter. More...
int	get_support_diameter_has_tol (Bool *)
	Tests whether there is a tolerance set on support diameter. More...
int	get_support_diameter_with_tol (double *, double *, double *)
	Returns the thread support surface diameter with tolerance values if any. More...
Dtk_feat_inner_thread *	GetInnerThread () const
Dtk_feat_geometry *	GetLimit () const
Dtk_feat_geometry *	GetSupport () const
Dtk_Double64	GetSupportDepth () const
Dtk_feat_tolerance_set *	GetSupportDepthTolerance () const
Dtk_Double64	GetSupportDiameter () const
Dtk_feat_tolerance_set *	GetSupportDiameterTolerance () const
Dtk_bool	HasSupportDepthTolerance () const
Dtk_bool	HasSupportDiameterTolerance () const
Dtk_bool	IsReversed () const
	~Dtk_feat_thread ()
	Desstructor of Thread Feature More...

Data Fields
Bool	direction_reversed
Dtk_feat_geometry *	face_limit
Dtk_feat_inner_thread *	inner_thread
Dtk_feat_geometry *	support
double	support_depth
double	support_diameter
Dtk_feat_tolerance_set *	tol_support_depth
Dtk_feat_tolerance_set *	tol_support_diameter

Detailed Description

Feature Thread (taraudage)

Constructor & Destructor Documentation

Dtk_feat_thread()

Dtk_feat_thread::Dtk_feat_thread

(

)

Constructor of Thread Feature

Parameters

	[in/out]
[out]	Allocated	thread feature

Returns

Remarks

~Dtk_feat_thread()

Dtk_feat_thread::~Dtk_feat_thread

(

)

Desstructor of Thread Feature

Parameters

	[in/out]
[out]	Free	Thread feature

Returns

Remarks

Member Function Documentation

get_direction_reversed()

int Dtk_feat_thread::get_direction_reversed

(

Bool *

)

Returns thread direction reversed.

Parameters

[in]	Thread	feature
	[in/out]
[out]	Direction	reversed flag

Returns

NOTOK if error, ISOK if ok

Remarks

get_inner_thread()

int Dtk_feat_thread::get_inner_thread

(

Dtk_feat_inner_thread **

)

Returns the inner thread parameters.

Parameters

[in]	Thread	feature
	[in/out]
[out]	Inner	thread feature

Returns

NOTOK if error, ISOK if ok

Remarks

The inner thread contains several parameters such as thread diameter, depth, type... See Dtk_feat_inner_thread for more details.

get_limit()

int Dtk_feat_thread::get_limit

(

Dtk_feat_geometry **

)

Returns thread limit surface.

Parameters

[in]	Thread	feature
	[in/out]
[out]	Thread	limit surface

Returns

NOTOK if error, ISOK if ok

Remarks

get_support()

int Dtk_feat_thread::get_support

(

Dtk_feat_geometry **

)

Returns the thread support surface.

Parameters

[in]	Thread	feature
	[in/out]
[out]	Support	surface

Returns

NOTOK if error, ISOK if ok

Remarks

get_support_depth()

int Dtk_feat_thread::get_support_depth

(

double *

)

Returns the thread support surface depth.

Parameters

[in]	Thread	feature
	[in/out]
[out]	Support	surface depth

Returns

NOTOK if error, ISOK if ok

Remarks

get_support_depth_has_tol()

int Dtk_feat_thread::get_support_depth_has_tol

(

Bool *

)

Tests whether there is a tolerance set on support depth.

Parameters

[in]	Thread	feature
	[in/out]
[out]	Bool

Returns

NOTOK if error, ISOK if ok

Remarks

get_support_depth_with_tol()

int Dtk_feat_thread::get_support_depth_with_tol	(	double *	,
		double *	,
		double *
	)

Returns the thread support surface depth with tolerance values if any.

Parameters

[in]	Thread	feature
	[in/out]
[out]	Support	surface depth & tolerances if any

Returns

NOTOK if error, ISOK if ok

Remarks

You have to test if there is a tolerance on the support depth with get_depth_has_tol. In case of direct call and no tolerance set, you should obtain a NOTOK status

get_support_diameter()

int Dtk_feat_thread::get_support_diameter

(

double *

)

Returns the thread support surface diameter.

Parameters

[in]	Thread	feature
	[in/out]
[out]	Support	surface diameter

Returns

NOTOK if error, ISOK if ok

Remarks

get_support_diameter_has_tol()

int Dtk_feat_thread::get_support_diameter_has_tol

(

Bool *

)

Tests whether there is a tolerance set on support diameter.

Parameters

[in]	Thread	feature
	[in/out]
[out]	Bool

Returns

NOTOK if error, ISOK if ok

Remarks

get_support_diameter_with_tol()

int Dtk_feat_thread::get_support_diameter_with_tol	(	double *	,
		double *	,
		double *
	)

Returns the thread support surface diameter with tolerance values if any.

Parameters

[in]	Thread	feature
	[in/out]
[out]	Support	surface diameter & tolerances if any

Returns

NOTOK if error, ISOK if ok

Remarks

You have to test if there is a tolerance on the support diameter with get_diameter_has_tol. In case of direct call and no tolerance set, you should obtain a NOTOK status

GetInnerThread()

Dtk_feat_inner_thread* Dtk_feat_thread::GetInnerThread

(

)

const

{return inner_thread;}

GetLimit()

Dtk_feat_geometry* Dtk_feat_thread::GetLimit

(

)

const

{return face_limit;}

GetSupport()

Dtk_feat_geometry* Dtk_feat_thread::GetSupport

(

)

const

{return support;}

GetSupportDepth()

Dtk_Double64 Dtk_feat_thread::GetSupportDepth

(

)

const

{return support_depth;}

GetSupportDepthTolerance()

Dtk_feat_tolerance_set* Dtk_feat_thread::GetSupportDepthTolerance

(

)

const

{return tol_support_depth;}

GetSupportDiameter()

Dtk_Double64 Dtk_feat_thread::GetSupportDiameter

(

)

const

{return support_diameter;}

GetSupportDiameterTolerance()

Dtk_feat_tolerance_set* Dtk_feat_thread::GetSupportDiameterTolerance

(

)

const

{return tol_support_diameter;}

HasSupportDepthTolerance()

Dtk_bool Dtk_feat_thread::HasSupportDepthTolerance

(

)

const

{return !(tol_support_depth == NULL);}

HasSupportDiameterTolerance()

Dtk_bool Dtk_feat_thread::HasSupportDiameterTolerance

(

)

const

{return !(tol_support_diameter == NULL);}

IsReversed()

Dtk_bool Dtk_feat_thread::IsReversed

(

)

const

{return direction_reversed;}

Field Documentation

direction_reversed

Bool Dtk_feat_thread::direction_reversed

face_limit

Dtk_feat_geometry* Dtk_feat_thread::face_limit

inner_thread

Dtk_feat_inner_thread* Dtk_feat_thread::inner_thread

support

Dtk_feat_geometry* Dtk_feat_thread::support

support_depth

double Dtk_feat_thread::support_depth

support_diameter

double Dtk_feat_thread::support_diameter

tol_support_depth

Dtk_feat_tolerance_set* Dtk_feat_thread::tol_support_depth

tol_support_diameter

Dtk_feat_tolerance_set* Dtk_feat_thread::tol_support_diameter