pycatia.cat_sch_platform_interfaces.sch_list_of_doubles

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.cat_sch_platform_interfaces.sch_list_of_doubles.SchListOfDoubles(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
SchListOfDoubles

Represents a list of DOUBLEs to be used with Schematic IDLs.
append(i_double: float) → None

Note

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

Adds a double to the end of the list.

Parameters:

iDouble
The double to be added to the list.

Example:

The following example appends an object to the list.

Dim MyDouble As Double
MyDouble = 0.6789
Dim MyList As SchListOfDoubles
MyList.Append(MyDouble)
Parameters:

i_double (float) –

Return type:

None

property count: int

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
o Property Count() As long (Read Only)

Returns the number of doubles in the list.

Example:
This example retrieves in NumberOfdoubles the number of doubles
currently gathered in MyList.

NumberOfdoubles = MyList.Count
Return type:

int

item(i_index: int) → float

Note

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

Returns a double from its index in the list.

Parameters:

iIndex
The index of the first double in the collection is 1, and the index
of the last double is Count.

Returns:
the retrieved double.
Example:

The following example returns in the third double in the
list.

Dim MyDouble As double
Dim MyList As SchListOfDoubles
Set MyDouble = SchListOfDoubles.Item(2)
Parameters:

i_index (int) –

Return type:

float

remove_by_index(i_index: int) → None

Note

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

Remove a double from the list by specifying its position in the
list.

Parameters:

iIndex
The position of the double to be removed in the list.

Example:

The following example removes the second entry in the list. Please
note that the
list index starts with 1.

Dim MyList As SchListOfDoubles
MyList.Remove(1)
Parameters:

i_index (int) –

Return type:

None