pycatia.fitting_interfaces.sampleds

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.sampleds.Sampleds(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
Sampleds

The collection of all the Sampled objects currently contained in the current
document.
A Sampled object is the base type for Track objects.
add() → Sampled

Note

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

Creates a new Sampled object and adds it to the Sampleds
collection.

Returns:
The created Sampled
Example:
The following example creates a Sampled (called newSampled) with in the
Sampleds collection.

Set newSampled = Sampleds.Add
Return type:

Sampled

add_from_sel() → Sampled

Note

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

Creates a new Sampled from the selection and adds it to the Sampleds
collection.

Returns:
The created Sampled
Example:
The following example creates a Sampled (called newSampled) with in the
Sampleds collection.

Set newSampled = Sampleds.Add
Return type:

Sampled

item(i_index: cat_variant) → Sampled

Note

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

Returns a CATIASampled object using its index from the CATIASampled
collection.

Parameters:

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


Returns:
The retrieved Sampled
Example:
The following example retrieves the second Sampled from the Sampleds
collection of the active document.

Dim newSampled as Sampled
Set newSampled = Sampleds.Item (2)
Parameters:

i_index (cat_variant) –

Return type:

Sampled

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 CATIASampled object from the CATIASampled
collection.

Parameters:

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

Example:
The following example removes the third Sampled from the Sampleds
collection of the active document.

Sampleds.Remove (3)
Parameters:

i_index (cat_variant) –

Return type:

None