PropagatorSP3FileCollection

class ansys.stk.core.stkobjects.PropagatorSP3FileCollection

A collection of SP3 files.

Overview

Methods

item	Given an index, returns an element in the collection.
remove_at	Remove an element from the collection using specified index.
remove_all	Remove all elements from the collection.
add	Load an SP3 file using the specified file path and adds the file to a collection of SP3 files.

Properties

count	Return the number of elements in a collection.
_new_enum	Return an enumerator that can iterate through the collection.

Import detail

from ansys.stk.core.stkobjects import PropagatorSP3FileCollection

Property detail

property PropagatorSP3FileCollection.count: int

Return the number of elements in a collection.

property PropagatorSP3FileCollection._new_enum: EnumeratorProxy

Return an enumerator that can iterate through the collection.

Method detail

PropagatorSP3FileCollection.item(self, index: int) → PropagatorSP3File

Given an index, returns an element in the collection.

Parameters:

index : int

Returns:

PropagatorSP3File

PropagatorSP3FileCollection.remove_at(self, index: int) → None

Remove an element from the collection using specified index.

Parameters:

index : int

Returns:

None

PropagatorSP3FileCollection.remove_all(self) → None

Remove all elements from the collection.

Returns:

None

PropagatorSP3FileCollection.add(self, file_path: str) → PropagatorSP3File

Load an SP3 file using the specified file path and adds the file to a collection of SP3 files.

Parameters:

file_path : str

Returns:

PropagatorSP3File