pycatia.fitting_interfaces.shots

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.shots.Shots(com_object)

Note

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

System.IUnknown
System.IDispatch
System.CATBaseUnknown
System.CATBaseDispatch
System.Collection
Shots

The collection of all shot objects contained in the current
sampled.
append(i_shot: AnyObject) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub Append(CATBaseDispatch iShot)

Adds a shot to the end of the shots collection.

Parameters:

iShot
The shot to be added
Example:
The following example adds a shot (called myShot to the shots
collection.

Shots.Append (myShot)
Parameters:

i_shot (AnyObject) –

Return type:

None

create_shot() → AnyObject

Note

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

Creates a new shot and adds it to the Shots collection.

Returns:
The created shot
Example:
The following example creates a shot newShot in the Shots
collection.

Dim newShot
Set newShot = Shots.CreateShot
Return type:

AnyObject

create_specific_shot(i_type: str) → AnyObject

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Func CreateSpecificShot(CATBSTR iType) As CATBaseDispatch

Creates a new shot of a specific type and adds it to the Shots
collection.

Parameters:

iType
Specifies the type of the shot to be created. The legal values are
FITShotPoints, FITShotDouble, FITShotSimple and FITShotGeneric. These different
types correspond to the need of creating different shots for different types of
objects.

Returns:
The created Shot
Example:
The following example creates a shot shot in the Shots
collection.

Set newShots = Shots.CreateShot (FITSHOTDouble)
Parameters:

i_type (str) –

Return type:

AnyObject

insert_after(i_index: int, i_shot: AnyObject) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub InsertAfter(short iIndex,
CATBaseDispatch iShot)

Adds a shot to a specific location to the shots
collection.

Parameters:

iIndex
The value of the location of an already existing shot. Then when
inserting a new shot, it will be placed after it. It is a positive integer,
with the range of 1 to the value of the last shot.

iShot
The shot to be added
Example:
The following example inserts a shot after the second
shot.

Shots.InsertAfter (2, myShot)
Parameters:
Return type:

None

item(i_index: cat_variant) → AnyObject

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Func Item(CATVariant iIndex) As CATBaseDispatch

Returns a shot using its index from the colection.

Parameters:

iIndex
The index of the item to retrieve from the collection of shots.
Numerically, the index value corresponds to the rank of the shot in the
collection (ie. the first is 1, second is 2, …).


Returns:
The retrieved Shot
Example:
The following example retrieves the second shot from the Shots
collection.

Dim myShot
Set myShot = myShots.Item (2)
Parameters:

i_index (cat_variant) –

Return type:

AnyObject

remove(i_index: cat_variant) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub Remove(CATVariant iIndex)

Removes a shot from the collection.

Parameters:

iIndex
The index of the shot to remove from the collection of the shots.
Numerically, the index value corresponds to the rank of the shot in the
collection (ie. the first is 1, second is 2, …).

Example:
The following example removes the third shot from the Shots
collection of the active document.

Shots.Remove (3)
Parameters:

i_index (cat_variant) –

Return type:

None