pycatia.dnb_igp_setup_interfaces.tcp_trace_activity

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.dnb_igp_setup_interfaces.tcp_trace_activity.TCPTraceActivity(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

DMAPSInterfaces.Activity

TCPTraceActivity

Interface representing TCPTraceActivity.

Role: This interface is used to work with TCPTraceActivity which consists of a

various attributes.

get_line_colour(o_r: int, o_g: int, o_b: int) → None

Note

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

o Sub GetLineColor(long oR,

long oG,

long oB)

Indicates the line Color property of trace.

Parameters:

oR,oG,oB

long. Get the line Color property defined in the trace

activity(R,G,B values).

Parameters:

• o_r (int) –

• o_g (int) –

• o_b (int) –

Return type:

None

get_line_thickness() → int

Note

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

o Func GetLineThickness() As long

Indicates the line thickness property of trace.

Parameters:

oThickness

long. Get the line thickness property defined in the trace

activity.

Return type:

int

get_line_type() → int

Note

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

o Func GetLineType() As long

Indicates the line type property of trace.

Parameters:

oType

long. Get the line type property defined in the trace

activity.

Return type:

int

get_tcp_trace_mode() → bool

Note

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

o Func GetTCPTraceMode() As boolean

Indicates if the tracing capability is active or not.

True: tracing capability activated

False: tracing capability deactivated

Parameters:

oTCPTraceMode

Boolean. Indicates if the tracing capability is active or

not.

Return type:

bool

set_line_colour(i_r: int, i_g: int, i_b: int) → None

Note

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

o Sub SetLineColor(long iR,

long iG,

long iB)

Indicates the line Color property of trace.

Parameters:

iR,iG,iB

long. Set the line Color property for the trace activity(R,G,B

values).

Parameters:

• i_r (int) –

• i_g (int) –

• i_b (int) –

Return type:

None

set_line_thickness(i_thickness: int) → None

Note

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

o Sub SetLineThickness(long iThickness)

Indicates the line thickness property of trace.

Parameters:

iThickness

long. Set the line thickness property for the trace

activity.

Parameters:

i_thickness (int) –

Return type:

None

set_line_type(i_type: int) → None

Note

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

o Sub SetLineType(long iType)

Indicates the line type property of trace.

Parameters:

iType

long. Set the line type property for the trace.

Parameters:

i_type (int) –

Return type:

None

set_tcp_trace_mode(i_tcp_trace_mode: bool) → None

Note

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

o Sub SetTCPTraceMode(boolean iTCPTraceMode)

Set the tracing capability as active or not.

True: tracing capability activated

False: tracing capability deactivated

Parameters:

iTCPTraceMode

Boolean. Value to set.

Parameters:

i_tcp_trace_mode (bool) –

Return type:

None