Feature Inner Thread. More...

Public Member Functions
	Dtk_feat_inner_thread ()
	Constructor of Inner Thread Feature More...

int	get_depth (double *)
	Returns the thread depth. More...

int	get_depth_has_tol (Bool *)
	Tests whether there is a tolerance set on thread depth. More...

int	get_depth_with_tol (double , double , double *)
	Returns the thread depth with tolerance values if any. More...

int	get_diameter (double *)
	Returns the thread diameter. More...

int	get_diameter_has_tol (Bool *)
	Tests whether there is a tolerance set on thread diameter. More...

int	get_diameter_with_tol (double , double , double *)
	Returns the thread diameter with tolerance values if any. More...

int	get_pitch (double *)
	Returns the threading pitch. More...

int	get_pitch_has_tol (Bool *)
	Tests whether there is a tolerance set on thread pitch. More...

int	get_pitch_with_tol (double , double , double *)
	Returns the thread pitch with tolerance values if any. More...

int	get_right_threaded (Bool *)
	Tests whether the thread is rigth-threaded. More...

int	get_thread_limit_reference (Dtk_feat_geometry **)
	Returns the thread limit reference plane if exists. More...

int	get_thread_limit_type (DTK_THREAD_LIMIT_TYPE &)
	Returns the thread limit type value. More...

int	get_thread_type (DTK_THREAD_TYPE &)
	Returns the thread type value. More...

Dtk_string	GetDefinitionType () const

Dtk_string	GetDefinitionValue () const

Dtk_Double64	GetDepth () const

Dtk_feat_tolerance_set *	GetDepthTolerance () const

Dtk_Double64	GetDiameter () const

Dtk_feat_tolerance_set *	GetDiameterTolerance () const

Dtk_feat_geometry *	GetLimitReference () const

DTK_THREAD_LIMIT_TYPE	GetLimitType () const

Dtk_string	GetLimitTypeAsString () const

Dtk_Double64	GetPitch () const

Dtk_feat_tolerance_set *	GetPitchTolerance () const

DTK_THREAD_TYPE	GetType () const

Dtk_string	GetTypeAsString () const

Dtk_bool	HasDepthTolerance () const

Dtk_bool	HasDiameterTolerance () const

Dtk_bool	HasPitchTolerance () const

Dtk_bool	IsNoStandardTable () const

Dtk_bool	IsRightThreaded () const

	SetAsDeprecated ("2024.2", "Use GetDefinitionType()") int get_def_type(wchar_t **)
	Returns the thread standard definition type if any. More...

	SetAsDeprecated ("2024.2", "Use GetDefinitionValue()") int get_def_value(wchar_t **)
	Returns the thread standard definition value if any. More...

	~Dtk_feat_inner_thread ()
	Destructor of Inner Thread Feature More...

Detailed Description

Feature Inner Thread.

Constructor & Destructor Documentation

◆ Dtk_feat_inner_thread()

Dtk_feat_inner_thread::Dtk_feat_inner_thread ( )

Constructor of Inner Thread Feature

Parameters

	[in/out]
[out]	Allocated	inner thread feature

Returns

Remarks: Inner thread contains several threading parameters such as diameter, depth, pitch, type... It is used for inner thread of a hole (Dtk_feat_hole) and in a thread (Dtk_feat_thread)

◆ ~Dtk_feat_inner_thread()

Dtk_feat_inner_thread::~Dtk_feat_inner_thread ( )

Destructor of Inner Thread Feature

Parameters

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

Returns

Remarks

Member Function Documentation

◆ get_depth()

int Dtk_feat_inner_thread::get_depth ( double * )

Returns the thread depth.

Parameters

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

Returns: NOTOK if error, ISOK if ok

Remarks

◆ get_depth_has_tol()

int Dtk_feat_inner_thread::get_depth_has_tol ( Bool * )

Tests whether there is a tolerance set on thread depth.

Parameters

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

Returns: NOTOK if error, ISOK if ok

Remarks

◆ get_depth_with_tol()

int Dtk_feat_inner_thread::get_depth_with_tol	(	double *	,
		double *	,
		double *
	)

Returns the thread depth with tolerance values if any.

Parameters

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

Returns: NOTOK if error, ISOK if ok

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

◆ get_diameter()

int Dtk_feat_inner_thread::get_diameter ( double * )

Returns the thread diameter.

Parameters

[in]	Inner	Thread feature
	[in/out]
[out]	Threading	diameter

Returns: NOTOK if error, ISOK if ok

Remarks

◆ get_diameter_has_tol()

int Dtk_feat_inner_thread::get_diameter_has_tol ( Bool * )

Tests whether there is a tolerance set on thread diameter.

Parameters

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

Returns: NOTOK if error, ISOK if ok

Remarks

◆ get_diameter_with_tol()

int Dtk_feat_inner_thread::get_diameter_with_tol	(	double *	,
		double *	,
		double *
	)

Returns the thread diameter with tolerance values if any.

Parameters

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

Returns: NOTOK if error, ISOK if ok

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

◆ get_pitch()

int Dtk_feat_inner_thread::get_pitch ( double * )

Returns the threading pitch.

Parameters

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

Returns: NOTOK if error, ISOK if ok

Remarks

◆ get_pitch_has_tol()

int Dtk_feat_inner_thread::get_pitch_has_tol ( Bool * )

Tests whether there is a tolerance set on thread pitch.

Parameters

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

Returns: NOTOK if error, ISOK if ok

Remarks

◆ get_pitch_with_tol()

int Dtk_feat_inner_thread::get_pitch_with_tol	(	double *	,
		double *	,
		double *
	)

Returns the thread pitch with tolerance values if any.

Parameters

[in]	Inner	Thread feature
	[in/out]
[out]	Thread	pitch & tolerances if any

Returns: NOTOK if error, ISOK if ok

Remarks: You have to test if there is a tolerance on the thread pitch with get_dtk_feat_inner_thread_pitch_has_tol. In case of direct call and no tolerance set, you should obtain a NOTOK status

◆ get_right_threaded()

int Dtk_feat_inner_thread::get_right_threaded ( Bool * )

Tests whether the thread is rigth-threaded.

Parameters

[in]	Inner	Thread feature
	[in/out]
[out]	Bool	(DTK_TRUE = right, DTK_FALSE = left)

Returns: NOTOK if error, ISOK if ok

Remarks

◆ get_thread_limit_reference()

int Dtk_feat_inner_thread::get_thread_limit_reference ( Dtk_feat_geometry ** )

Returns the thread limit reference plane if exists.

Parameters

[in]	Inner	Thread feature
	[in/out]
[out]	Thread	limit plane if exists or NULL

Returns: NOTOK if error, ISOK if ok

Remarks: Available only if thread limit type is "Up To Plane"

◆ get_thread_limit_type()

int Dtk_feat_inner_thread::get_thread_limit_type ( DTK_THREAD_LIMIT_TYPE & )

Returns the thread limit type value.

Parameters

[in]	Inner	Thread feature
	[in/out]
[out]	Thread	limit type

Returns: NOTOK if error, ISOK if ok

Remarks: type : "Dimension", "Support Depth" or "Up To Plane"

◆ get_thread_type()

int Dtk_feat_inner_thread::get_thread_type ( DTK_THREAD_TYPE & )

Returns the thread type value.

Parameters

[in]	Inner	Thread feature
	[in/out]
[out]	Thread	definition type

Returns: NOTOK if error, ISOK if ok

Remarks: ex : "M8", "M12"...

◆ GetDefinitionType()

Dtk_string Dtk_feat_inner_thread::GetDefinitionType ( ) const

1400 {return thread_definition_type; }

◆ GetDefinitionValue()

Dtk_string Dtk_feat_inner_thread::GetDefinitionValue ( ) const

1410 {return thread_definition_value; }

◆ GetDepth()

Dtk_Double64 Dtk_feat_inner_thread::GetDepth ( ) const

1330 {return thread_params[IND_DEPTH];}

◆ GetDepthTolerance()

Dtk_feat_tolerance_set* Dtk_feat_inner_thread::GetDepthTolerance ( ) const

1339 {return tol_thread_params[IND_DEPTH]; }

◆ GetDiameter()

Dtk_Double64 Dtk_feat_inner_thread::GetDiameter ( ) const

1297 {return thread_params[IND_DIAMETER];}

◆ GetDiameterTolerance()

Dtk_feat_tolerance_set* Dtk_feat_inner_thread::GetDiameterTolerance ( ) const

1308 {return tol_thread_params[IND_DIAMETER]; }

◆ GetLimitReference()

Dtk_feat_geometry* Dtk_feat_inner_thread::GetLimitReference ( ) const

1443 {return thread_limit_reference;}

◆ GetLimitType()

DTK_THREAD_LIMIT_TYPE Dtk_feat_inner_thread::GetLimitType ( ) const

1433 {return thread_limit_type;}

◆ GetLimitTypeAsString()

Dtk_string Dtk_feat_inner_thread::GetLimitTypeAsString ( ) const

◆ GetPitch()

Dtk_Double64 Dtk_feat_inner_thread::GetPitch ( ) const

1358 {return thread_params[0];}

◆ GetPitchTolerance()

Dtk_feat_tolerance_set* Dtk_feat_inner_thread::GetPitchTolerance ( ) const

1368 {return tol_thread_params[0]; }

◆ GetType()

DTK_THREAD_TYPE Dtk_feat_inner_thread::GetType ( ) const

1421 {return thread_type;}

◆ GetTypeAsString()

Dtk_string Dtk_feat_inner_thread::GetTypeAsString ( ) const

◆ HasDepthTolerance()

Dtk_bool Dtk_feat_inner_thread::HasDepthTolerance ( ) const

1349 {return !(tol_thread_params[IND_DEPTH] == NULL);}

◆ HasDiameterTolerance()

Dtk_bool Dtk_feat_inner_thread::HasDiameterTolerance ( ) const

1319 {return !(tol_thread_params[IND_DIAMETER] == NULL);}

◆ HasPitchTolerance()

Dtk_bool Dtk_feat_inner_thread::HasPitchTolerance ( ) const

1378 {return !(tol_thread_params[IND_DEPTH] == NULL);}

◆ IsNoStandardTable()

Dtk_bool Dtk_feat_inner_thread::IsNoStandardTable ( ) const

1389 {return no_standard_table;}

◆ IsRightThreaded()

Dtk_bool Dtk_feat_inner_thread::IsRightThreaded ( ) const

1388 {return right_threaded;}

◆ SetAsDeprecated() [1/2]

Dtk_feat_inner_thread::SetAsDeprecated	(	"2024.2"	,
		"Use GetDefinitionType()"
	)

Returns the thread standard definition type if any.

Parameters

[in]	Inner	Thread feature
[out]	Thread	definition type - must call delete[]

Returns: NOTOK if error, ISOK if ok

Remarks: "Metric_Thick_Pitch" | "Metric_Thin_Pitch"

Deprecated:: Use GetDefinitionType()

◆ SetAsDeprecated() [2/2]

Dtk_feat_inner_thread::SetAsDeprecated	(	"2024.2"	,
		"Use GetDefinitionValue()"
	)

Returns the thread standard definition value if any.

Parameters

[in]	Inner	Thread feature
[out]	Thread	definition value - must call delete[]

Returns: NOTOK if error, ISOK if ok

Remarks: ex : "M8", "M12"...

Deprecated:: Use GetDefinitionValue()

Field Documentation

◆ no_standard_table

Bool Dtk_feat_inner_thread::no_standard_table

◆ normal_to_surface

Bool Dtk_feat_inner_thread::normal_to_surface

◆ right_threaded

Bool Dtk_feat_inner_thread::right_threaded

◆ thread_definition_type

Dtk_string Dtk_feat_inner_thread::thread_definition_type

◆ thread_definition_value

Dtk_string Dtk_feat_inner_thread::thread_definition_value

◆ thread_limit_reference

Dtk_feat_geometry* Dtk_feat_inner_thread::thread_limit_reference

◆ thread_limit_type

DTK_THREAD_LIMIT_TYPE Dtk_feat_inner_thread::thread_limit_type

◆ thread_params

Dtk_thread_params Dtk_feat_inner_thread::thread_params

◆ thread_type

DTK_THREAD_TYPE Dtk_feat_inner_thread::thread_type

◆ tol_thread_params

Dtk_feat_tolerance_set* Dtk_feat_inner_thread::tol_thread_params[3]

Data Fields
Bool	no_standard_table

Bool	normal_to_surface

Bool	right_threaded

Dtk_string	thread_definition_type

Dtk_string	thread_definition_value

Dtk_feat_geometry *	thread_limit_reference

DTK_THREAD_LIMIT_TYPE	thread_limit_type

Dtk_thread_params	thread_params

DTK_THREAD_TYPE	thread_type

Dtk_feat_tolerance_set *	tol_thread_params [3]

Public Member Functions

Data Fields

Detailed Description

Constructor & Destructor Documentation

◆ Dtk_feat_inner_thread()

◆ ~Dtk_feat_inner_thread()

Member Function Documentation

◆ get_depth()

◆ get_depth_has_tol()

◆ get_depth_with_tol()

◆ get_diameter()

◆ get_diameter_has_tol()

◆ get_diameter_with_tol()

◆ get_pitch()

◆ get_pitch_has_tol()

◆ get_pitch_with_tol()

◆ get_right_threaded()

◆ get_thread_limit_reference()

◆ get_thread_limit_type()

◆ get_thread_type()

◆ GetDefinitionType()

◆ GetDefinitionValue()

◆ GetDepth()

◆ GetDepthTolerance()

◆ GetDiameter()

◆ GetDiameterTolerance()

◆ GetLimitReference()

◆ GetLimitType()

◆ GetLimitTypeAsString()

◆ GetPitch()

◆ GetPitchTolerance()

◆ GetType()

◆ GetTypeAsString()

◆ HasDepthTolerance()

◆ HasDiameterTolerance()

◆ HasPitchTolerance()

◆ IsNoStandardTable()

◆ IsRightThreaded()

◆ SetAsDeprecated() [1/2]

◆ SetAsDeprecated() [2/2]

Field Documentation

◆ no_standard_table

◆ normal_to_surface

◆ right_threaded

◆ thread_definition_type

◆ thread_definition_value

◆ thread_limit_reference

◆ thread_limit_type

◆ thread_params

◆ thread_type

◆ tol_thread_params