pycatia.fitting_interfaces.shot

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.fitting_interfaces.shot.Shot(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
Shot

The interface to access a CATIAShot.
Role: A CATIAShot (or shot) is the base element that Sampled objects are
composed of. For example, when considering a Track, each recorded position is a
shot.
append_abs_datas(i_position: tuple) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub AppendAbsDatas(CATSafeArrayVariant iPosition)

Appends to the data related to the shot. Role: In certain cases, a shot
contains more than one data item. The SetDatas method is used to store the
first data item. This method is then used to specify any additional data
items

Parameters:

iPosition
An array of associated values to the shot. Please note that these
values are absolute (relative to the world coordinate system), specifically to
where the object started from.
Parameters:

i_position (tuple) –

Return type:

None

append_datas(i_position: tuple) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub AppendDatas(CATSafeArrayVariant iPosition)

Appends to the data related to the shot. Role: In certain cases, a shot
contains more than one data item. The SetDatas method is used to store the
first data item. This method is then used to specify any additional data
items.

Parameters:

iPosition
An array of associated values to the shot. Please note that these
values are relative to the position of object, specifically to where the object
started from.
Parameters:

i_position (tuple) –

Return type:

None

get_abs_datas(i_index: int, o_position: tuple) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub GetAbsDatas(short iIndex,
CATSafeArrayVariant oPosition)

Retrieves the data related to the shot. Role: To get the numerical
information related to the shot. For example, for a Track, each shot
corresponds to a position that is used when evaluating a defined trajectory.
Please note that these values are absolute (relative to the world coordinate
system), specifically to where the object started from.

Parameters:

iIndex
A shot can have more than one piece of data associated to it. The
value of iIndex refers to which specific data item to retrieve. The legal
values of iIndex correspond to the rank of the data item (that is the 0 for the
first item, 1 for the second item).

Returns:
An array of associated values to the shot.
Parameters:

  • i_index (int) –

  • o_position (tuple) –

Return type:

None

get_datas(i_index: int, o_position: tuple) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub GetDatas(short iIndex,
CATSafeArrayVariant oPosition)

Retrieves the data related to the shot. Role: To get the numerical
information related to the shot. For example, for a Track, each shot
corresponds to a position that is used when evaluating a defined trajectory.
Please note that these values are relative to the position of object,
specifically to where the object started from.

Parameters:

iIndex
A shot can have more than one piece of data associated to it. The
value value of iIndex refers to which specific data item to retrieve. The legal
values of iIndex correspond to the rank of the data item (that is the 0 for the
first item, 1 for the second item).

Returns:
An array of associated values to the shot.
Parameters:

  • i_index (int) –

  • o_position (tuple) –

Return type:

None

get_duration() → float

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Func GetDuration() As double

Retrieves the duration (in terms of distance) associated to a shot. The
duration of a shot is the amount of time needed to travel from the previous
shot to the current shot. However, this method retrieves the distance of the
current shot from that of the previous shot. It is left for the user to
calculate the Time using distance/speed Formula. Some key things to note
are:

The first shot should have a duration of zero.
The value of the duration is a positive real number. Hence, 0.454 &
1345 are legal while -18 is not.

Parameters:

oTime
The duration (distance) of a shot.
Return type:

float

get_technological_datas(o_datas: tuple) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub GetTechnologicalDatas(CATSafeArrayVariant oDatas)

Retrieves all the data associated to the part.
Parameters:

o_datas (tuple) –

Return type:

None

set_abs_datas(i_position: tuple) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub SetAbsDatas(CATSafeArrayVariant iPosition)

Set the data related to the shot. Role: To set the numerical information
related to the shot. For example, for a Track, each shot corresponds to a
position that is used when evaluating a defined
trajectory.

Parameters:

iPosition
An array of associated values to the shot. Please note that these
values are absolute (relative to the world coordinate system), specifically to
where the object started from.
Parameters:

i_position (tuple) –

Return type:

None

set_datas(i_position: tuple) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub SetDatas(CATSafeArrayVariant iPosition)

Set the data related to the shot. Role: To set the numerical information
related to the shot. For example, for a Track, each shot corresponds to a
position that is used when evaluating a defined
trajectory.

Parameters:

iPosition
An array of associated values to the shot. Please note that these
values are relative to the position of object, specifically to where the object
started from.
Parameters:

i_position (tuple) –

Return type:

None

set_duration(i_duration: float) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub SetDuration(double iDuration)

Sets the duration (in terms of distance) associated to a shot. The duration
of a shot is the amount of time needed to travel from the previous shot to the
current shot. However, this method sets the distance of the current shot from
that of the previous shot. It is left for the user to calculate the distance
that needs to be set for the shot using the Time*Speed Formula. Some key things
to note are:

The first shot should have a duration of zero.
The value of the duration is a positive real number. Hence, 0.454 &
1345 are legal while -18 is not.

Parameters:

oTime
The duration (distance) of a shot.
Parameters:

i_duration (float) –

Return type:

None

set_technological_datas(i_datas: tuple) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub SetTechnologicalDatas(CATSafeArrayVariant iDatas)

Sets all the data associated to the part.
Parameters:

i_datas (tuple) –

Return type:

None