pycatia.drafting_interfaces.drawing_welding

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.drafting_interfaces.drawing_welding.DrawingWelding(com_object)

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

System.IUnknown
System.IDispatch
System.CATBaseUnknown
System.CATBaseDispatch
System.AnyObject
DrawingWelding

Represents a drawing welding in a drawing view.
property angle: float

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)
o Property Angle() As double

Returns or sets the angle of the drawing text. The angle is measured
between the axis system of the drawing view and the local axis system of the
drawing text. The angle is measured in radians and is counted
counterclockwise.

Example:
This example sets the angle of the MyText drawing Text to 90 degrees
clockwise. You first need to compute the angle in degrees and set the minus
sign to indicate the rotation is clockwise.

Angle90Clockwise = -90
MyText.Angle = Angle90Clockwise
Return type

float

get_additional_symbol(i_weld: int) → int

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))
o Func GetAdditionalSymbol(CatWelding iWeld) As
CatWeldAdditionalSymbol

Returns the additional symbol of the drawing welding.

Parameters:

iWeld
The xxx

Example:
This example sets an concave additinal symbol on the MyWelding
drawing welding

MyWelding.Symbol = DftConcaveSymbol
Parameters

i_weld (int) –

Returns

enum cat_welding

Return type

int

get_finish_symbol(i_weld: int) → int

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))
o Func GetFinishSymbol(CatWelding iWeld) As
CatDftWeldFinishSymbol

Returns the finish symbol of the drawing welding.

Parameters:

iWeld
The field on which finish symbol is applied.

Example:
This example returns the finish symbol on the first symbol of
the MyWelding drawing welding

MyWelding.GetFinishSymbol(catWeldingFieldOne,oFinishSymbol)
Parameters

i_weld (int) – enum cat_welding

Returns

enum cat_dft_weld_finish_symbol

Return type

int

get_symbol(i_weld: int) → int

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))
o Func GetSymbol(CatWelding iWeld) As CatWeldingSymbol

Returns the symbol of the drawing welding.

Parameters:

iWeld
The field on which the symbol is applied
oSymbol
The welding symbol

Example:
This example gets the symbol on the first field of the
MyWelding drawing welding

MyWelding.GetSymbol(catWeldingFieldOne,oSymbol)
Parameters

i_weld (int) – enum cat_welding

Returns

enum cat_welding_symbol

Return type

int

get_text_range(i_field: int) → pycatia.drafting_interfaces.drawing_text_range.DrawingTextRange

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))
o Func GetTextRange(CatWeldingField iField) As
DrawingTextRange

Returns the field of the drawing welding in a drawing text
range.

Parameters:

iField
The drawing welding field

Returns:
The drawing text range that corresponds to the drawing welding field


Example:
This example retrieves the xxx.

Dim textRange As DrawingTextRange
Set textRange = MyWelding.GetTextRange (catWeldingUp)
Parameters

i_field (int) – enum cat_welding_field

Return type

DrawingTextRange

property identification_line_side: int

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)
o Property IdentificationLineSide() As CatWeldingSide

Returns or sets the welding identification line Side of the drawing welding
symbol.
Precondition: This property is only available for ISO
standard.

Example:
This example sets welding identification line Side to Up
.

MyWeld.IdentificationLineSide = catWeldingUp
Returns

enum cat_welding_side

Return type

int

property leaders: pycatia.drafting_interfaces.drawing_leaders.DrawingLeaders

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)
o Property Leaders() As DrawingLeaders (Read Only)

Returns the drawing leader collection of the drawing
welding.

Example:
This example retrieves in LeaderCollection the collection of leaders of
the MyWelding drawing welding.

Dim LeaderCollection As DrawingLeaders
Set LeaderCollection = MyWelding.Leaders
Return type

DrawingLeaders

set_additional_symbol(i_symbol: int, i_weld: int) → None

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))
o Sub SetAdditionalSymbol(CatWeldAdditionalSymbol iSymbol,
CatWelding iweld)

Sets the additional symbol of the drawing welding.

Parameters:

iSymbol
The welding additional symbol
iWeld
The xxx

Example:
This example sets an concave additinal symbol on the MyWelding
drawing welding

MyWelding.Symbol = DftConcaveSymbol
Parameters

  • i_symbol (int) – enum cat_weld_additional_symbol

  • i_weld (int) – enum cat_welding

Return type

None

set_finish_symbol(i_finish_symbol: int, i_weld: int) → None

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))
o Sub SetFinishSymbol(CatDftWeldFinishSymbol iFinishSymbol,
CatWelding iWeld)

Sets the finish symbol of the drawing welding.

Parameters:

iFinishSymbol
The finish welding symbol
iWeld
The field on which finish symbol will be applied.

Example:
This example sets the finish symbol on the first symbol of the
MyWelding drawing welding


MyWelding.GetFinishSymbol(catWeldingFieldOne,catDftLetterCWelding)
Parameters

  • i_finish_symbol (int) – enum cat_dft_weld_finish_symbol

  • i_weld (int) – enum cat_welding

Return type

None

set_symbol(i_symbol: int, i_weld: int) → None

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))
o Sub SetSymbol(CatWeldingSymbol iSymbol,
CatWelding iweld)

Sets the symbol of the drawing welding.

Parameters:

iSymbol
The welding symbol
iWeld
The field on which the symbol is applied

Example:
This example sets a symbol on the first field of the MyWelding
drawing welding

MyWelding.SetSymbol(catSquareWelding,catWeldingFieldOne)
Parameters

  • i_symbol (int) – enum cat_welding_symbol

  • i_weld (int) – enum cat_welding

Return type

None

property text_properties: pycatia.drafting_interfaces.drawing_text_properties.DrawingTextProperties

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)
o Property TextProperties() As DrawingTextProperties (Read
Only)

Returns the text properties of the drawing welding.

Example:
This example retrieves in TextProperties the text properties of the
MyWelding drawing welding..

Dim TextProperties As DrawingTextProperties
Set TextProperties = MyWelding.TextProperties
Return type

DrawingTextProperties

property welding_side: int

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)
o Property WeldingSide() As CatWeldingSide

Returns or sets the welding side of the drawing welding
symbol.

Example:
This example sets welding side to Up .

MyWeld.WeldingSide = catWeldingUp
Returns

enum cat_welding_side

Return type

int

property welding_tail: int

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)
o Property WeldingTail() As CatDftWeldingTail

Returns or sets the welding tail of the drawing welding
symbol.

Example:
This example displays the welding symbol tail.

MyWeld.WeldingTail = catDftWeldingTailYES
Returns

enum cat_dft_welding_tail

Return type

int

property x: float

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)
o Property x() As double

Returns or sets the x coordinate of the drawing welding. It is expressed
with respect to the current view coordinate system. This coordinate, like any
length, is measured in millimeters.

Example:
This example retrieves in X the x coordinate of the MyWelding drawing
welding.

X = MyWelding.x
Return type

float

property y: float

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)
o Property y() As double

Returns or sets the y coordinate of the drawing welding. It is expressed
with respect to the current view coordinate system. This coordinate, like any
length, is measured in millimeters.

Example:
This example sets the y coordinate of the MyWelding drawing welding to
5 inches. You need first to convert the 5 inches into
millmeters.

NewYCoordinate = 5*25.4/1000
MyWelding.y = NewYCoordinate
Return type

float