pycatia.cat_tps_interfaces.noa

Module initially auto generated using V5Automation files from CATIA V5 R28 on 2020-09-25 14:34:21.593357

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.cat_tps_interfaces.noa.Noa(com_object)

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)

System.IUnknown

System.IDispatch

System.CATBaseUnknown

System.CATBaseDispatch

System.AnyObject

Noa

Interface for the TPS Noa object.

add_url(i_url: str) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))

o Sub AddURL(CATBSTR iUrl)

Sets an URL.

Parameters:

iUrl

URL to Set

Parameters:

i_url (str) –

Return type:

None

property flag_text: str

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)

o Property FlagText() As CATBSTR

Retrieves or sets Flag Text.

Parameters:

oText

Returned text for NOA hidden text.

Return type:

str

get_ditto() → DrawingComponent

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))

o Func GetDitto() As DrawingComponent

Gets the ditto as a DrawingComponent of the Noa entity.

Return type:

DrawingComponent

get_modifiable_text(i_index: cat_variant) → AnyObject

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))

o Func GetModifiableText(CATVariant iIndex) As AnyObject

Gets by index a modifiable Text included in the ditto which represents this

NOA.

Parameters:

iIndex

Index of the modifiable text.

oText

returns a CATIADrawingText

Parameters:

i_index (cat_variant) –

Return type:

AnyObject

get_modifiable_texts_count() → int

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))

o Func GetModifiableTextsCount() As long

Gets the number of modifiable texts included in the ditto which represents

this NOA.

Parameters:

oCount

returns the number of modifiable text included into the ditto which

represents this NOA.

Return type:

int

get_nbr_url(o_number_of_url: cat_variant) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))

o Sub GetNbrURL(CATVariant oNumberOfURL)

Deprecated:

V5-6R2017 This method is replaced by Noa.GetNbrURL2

Parameters:

o_number_of_url (cat_variant) –

Return type:

None

get_nbr_url_2() → int

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))

o Func GetNbrURL2() As long

Gets the number of URL.

Parameters:

oNumberOfURL

returns param oNumberOfURL.

Return type:

int

modify_url(i_url: str, i_index: cat_variant) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))

o Sub ModifyURL(CATBSTR iUrl,

CATVariant iIndex)

Modifies an URL.

Parameters:

iUrl

URL to Set.

iIndex

index of the URL to modify.

Parameters:

• i_url (str) –

• i_index (cat_variant) –

Return type:

None

remove_url(i_index: cat_variant) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))

o Sub RemoveURL(CATVariant iIndex)

Removes an URL.

Parameters:

iIndex

position of the URL to remove.

Parameters:

i_index (cat_variant) –

Return type:

None

property text: str

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)

o Property Text() As CATBSTR

Retrieves or sets Text Representation.

Parameters:

oText

Returned text for graphical representation.

Return type:

str

tps_parallel_on_screen() → TPSParallelOnScreen

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))

o Func TPSParallelOnScreen() As TPSParallelOnScreen

Gets the annotation on TPSParallelOnScreen interface.

Return type:

TPSParallelOnScreen

url(i_index: cat_variant) → str

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))

o Func URL(CATVariant iIndex) As CATBSTR

Retrieves URL.

Parameters:

iIndex

Index of URL.

oUrl

URL

Parameters:

i_index (cat_variant) –

Return type:

str