ScatteringPointProviderCollection#

class ansys.stk.core.stkobjects.ScatteringPointProviderCollection#

Class defining an scattering point provider collection.

Overview#

add

Add a new default scattering point provider element to the collection.

clear

Clear all scattering point provider elements from the collection.

insert_at

Insert a new scattering point provider element at the supplied index, configured with a component with the supplied identifier.

item

Given an index, returns the scattering point provider element in the collection.

remove_at

Remove the scattering point provider element with the specified index.

_new_enum

Return an enumerator for the collection.

count

Return the number of scattering point provider elements in the collection.

Import detail#

from ansys.stk.core.stkobjects import ScatteringPointProviderCollection

Property detail#

property ScatteringPointProviderCollection._new_enum: EnumeratorProxy#

Return an enumerator for the collection.

property ScatteringPointProviderCollection.count: int#

Return the number of scattering point provider elements in the collection.

Method detail#

ScatteringPointProviderCollection.add(self) ScatteringPointProviderCollectionElement#

Add a new default scattering point provider element to the collection.

Returns:

ScatteringPointProviderCollectionElement

ScatteringPointProviderCollection.clear(self) None#

Clear all scattering point provider elements from the collection.

Returns:

None

ScatteringPointProviderCollection.insert_at(self, index: int) ScatteringPointProviderCollectionElement#

Insert a new scattering point provider element at the supplied index, configured with a component with the supplied identifier.

Parameters:

index : int

Returns:

ScatteringPointProviderCollectionElement

ScatteringPointProviderCollection.item(self, index: int) ScatteringPointProviderCollectionElement#

Given an index, returns the scattering point provider element in the collection.

Parameters:

index : int

Returns:

ScatteringPointProviderCollectionElement

ScatteringPointProviderCollection.remove_at(self, index: int) None#

Remove the scattering point provider element with the specified index.

Parameters:

index : int

Returns:

None