pycatia.simulation_interfaces.replay

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.simulation_interfaces.replay.Replay(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

Replay

The interface to access a CATIAReplay

Use this interface to customize the Replay object

add_product_motion(i_product: Product) → int

Note

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

o Func AddProductMotion(Product iProduct) As long

Adds a product to be taken into account in the Replay

object.

Parameters:

iProduct

CATIAProduct. Product to add.

oChannel

Channel number.

Parameters:

i_product (Product) –

Return type:

int

add_sample(i_channel: int, i_current_time: float, i_position: tuple) → None

Note

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

o Sub AddSample(long iChannel,

double iCurrentTime,

CATSafeArrayVariant iPosition)

Adds a sample(set of values) for a channel at a specific

time

Parameters:

iChannel

Channel number.

iCurrentTime

Time.

iPosition

Array of values to consider the the specified

channel.

Parameters:

• i_channel (int) –

• i_current_time (float) –

• i_position (tuple) –

Return type:

None

get_nb_product_motion() → int

Note

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

o Func GetNbProductMotion() As long

Get the number of channel related to products.

Parameters:

oNbChannel

Number of channel associated to products.

Return type:

int

get_nb_sample(i_channel: int) → int

Note

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

o Func GetNbSample(long iChannel) As long

Get the number of samples for a channel number.

Parameters:

iChannel

Channel index.

oNbSample

Number of samples.

Parameters:

i_channel (int) –

Return type:

int

get_product(i_channel: int) → Product

Note

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

o Func GetProduct(long iChannel) As Product

Get the product for a channel.

Parameters:

iChannel

Channel index.

oProduct

Product.

Parameters:

i_channel (int) –

Return type:

Product

get_sample_position(i_channel: int, i_sample: int, o_position: tuple) → None

Note

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

o Sub GetSamplePosition(long iChannel,

long iSample,

CATSafeArrayVariant oPosition)

Get the sample values.

Parameters:

iChannel

Channel index.

iSample

Sample index.

oPosition

Array of values.

Parameters:

• i_channel (int) –

• i_sample (int) –

• o_position (tuple) –

Return type:

None

get_sample_time(i_channel: int, i_sample: int) → float

Note

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

o Func GetSampleTime(long iChannel,

long iSample) As double

Get the sample time.

Parameters:

iChannel

Channel index.

iSample

Sample index.

oTime

Time value.

Parameters:

• i_channel (int) –

• i_sample (int) –

Return type:

float

remove_sample(i_channel: int, i_sample: int) → None

Note

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

o Sub RemoveSample(long iChannel,

long iSample)

Remove a specific sample.

Parameters:

iChannel

Channel index.

iSample

Sample index.

Parameters:

• i_channel (int) –

• i_sample (int) –

Return type:

None