pycatia.part_interfaces.thread

Module initially auto generated using V5Automation files from CATIA V5 R28 on 2020-06-11 12:40:47.360445

Warning

The notes denoted “CAA V5 Visual Basic Help” are to be used as reference only. They are there as a guide as to how the visual basic / catscript functions work and thus help debugging in pycatia.

class pycatia.part_interfaces.thread.Thread(com_object)

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)

System.IUnknown

System.IDispatch

System.CATBaseUnknown

System.CATBaseDispatch

System.AnyObject

MecModInterfaces.Shape

PartInterfaces.DressUpShape

Thread

Represents the Thread feature.

It threads or taps cylindrical surface .

create_standard_thread_design_table(i_standard_type: int) → None

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))

o Sub CreateStandardThreadDesignTable(CatThreadStandard

iStandardType)

Creates a Standard Thread design table .

Parameters:

iStandardType

Standard type for thread (see

CatThreadStandard for list of possible types)

Example:

The following example creates a standard table for MetricThinPitch

for thread firstthread:

firstthread.CreateStandardThreadDesignTable

catMetricThinPitch

Parameters:

i_standard_type (int) – enum cat_thread_standard

Return type:

None

create_user_standard_design_table(i_standard_name: str, i_path: str) → None

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))

o Sub CreateUserStandardDesignTable(CATBSTR iStandardName,

CATBSTR iPath)

Creates a UserStandard Thread design table .

Parameters:

iStandardName

Name of the UserStandard thread. iStandardName should be empty if

filepath is to be defined.

iPath

Path of the UserStandard file. iPath is empty if the filepath is

already defined through CATReffilesPath.

Example1:

The following example creates a standard table for UserStandard

for thread firstThread. The file path is already defined thru

CATReffilesPath:

firstThread.CreateUserStandardDesignTable

“UserStandard”,””

Example2:

The following example creates a standard table for UserStandard

for thread firstThread when file path is not defined thru

CATReffilesPath:

firstThread.CreateUserStandardDesignTable

“”,”E:userstandardUserStandard.txt”

Parameters:

• i_standard_name (str) –

• i_path (str) –

Return type:

None

property depth: float

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)

o Property Depth() As double

Returns the thread/tap depth.

Returns:

oDepth Value of the thread/tap depth

Example:

The following example returns in Depth the depth of thread

firstthread:

Set Depth = firstthread.Depth

Return type:

float

property diameter: float

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)

o Property Diameter() As double

Returns the thread/tap diameter.

Returns:

oDiameter Value of the thread/tap diameter

Example:

The following example returns in ThreadDiameter the diameter of

thread firstthread:

Set ThreadDiameter = firstthread.Diameter

Return type:

float

property lateral_face_element: Reference

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)

o Property LateralFaceElement() As Reference

Returns or sets the lateral face (must be cylindrical) .

To set the property, you can use the following Boundary object: Face.

Return type:

Reference

property limit_face_element: Reference

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)

o Property LimitFaceElement() As Reference

Returns or sets the limit face (must be planar ) .

To set the property, you can use the following Boundary object: PlanarFace.

Return type:

Reference

property pitch: float

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)

o Property Pitch() As double

Returns the thread/tap pitch.

Returns:

oPitch Value of the thread/tap pitch

Example:

The following example returns in ThreadPitch the thread pitch of

thread firstthread:

Set ThreadPitch = firstthread.ThreadPitch

Return type:

float

reverse_direction() → None

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))

o Sub ReverseDirection()

Swap the direction of the thread or the tap.

Return type:

None

set_explicit_polarity(i_thread_polarity: int) → None

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))

o Sub SetExplicitPolarity(CatThreadPolarity iThreadPolarity)

Sets the thread polarity explicit. Thread polarity is no more evaluated

implicitly on basis of support face polarity

Parameters:

iThreadPolarity

Standard type for thread (see

CatThreadPolarity for list of possible types)

Example:

The following example sets the thread polarity to Tap explicitly

thread firstthread:

firstthread.SetExplicitPolarity catTap

Parameters:

i_thread_polarity (int) – enum cat_thread_polarity

Return type:

None

property side: int

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)

o Property Side() As CatThreadSide

Returns the thread or tap side.

Returns:

oThreadSide The thread/tap side (see CatThreadSide for list of possible

sides)

Example:

The following example returns in ThreadSide the thread/tap side of

thread firstthread:

Set ThreadSide = firstthreadoThreadSide

Returns:

enum cat_thread_side

Return type:

int

property thread_description: StrParam

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)

o Property ThreadDescription() As StrParam (Read Only)

Returns the thread/tap description parameter. This call is valid only when

a standard/user design table created

Returns:

oThreadDescParam A Parameter object controlling the thread/tap

description (see StrParam for more information)

Example:

The following example returns in threadDescription the thread

description (M12 etc) of thread firstthread:

Set threadDescription = firstthread.ThreadDescription

Return type:

StrParam