RadarSarImageLocationCollection#

class ansys.stk.core.stkrfchannelmodeler.RadarSarImageLocationCollection#

A collection of image location information.

Overview#

add_new

Add and returns a new SAR image location.

contains

Check to see if a given SAR image location exists in the collection.

find

Find a SAR image location by name. Returns Null if the image location name does not exist in the collection.

item

Given an index, returns the element in the collection.

remove

Remove the supplied SAR image location from the collection.

remove_all

Clear all SAR image locations from the collection.

remove_at

Remove the SAR image location with the supplied index.

_new_enum

Return an enumerator for the collection.

count

Return the number of elements in the collection.

Import detail#

from ansys.stk.core.stkrfchannelmodeler import RadarSarImageLocationCollection

Property detail#

property RadarSarImageLocationCollection._new_enum: EnumeratorProxy#

Return an enumerator for the collection.

property RadarSarImageLocationCollection.count: int#

Return the number of elements in the collection.

Method detail#

RadarSarImageLocationCollection.add_new(self) RadarSarImageLocation#

Add and returns a new SAR image location.

Returns:

RadarSarImageLocation

RadarSarImageLocationCollection.contains(self, name_str: str) bool#

Check to see if a given SAR image location exists in the collection.

Parameters:

name_str : str

Returns:

bool

RadarSarImageLocationCollection.find(self, name_str: str) RadarSarImageLocation#

Find a SAR image location by name. Returns Null if the image location name does not exist in the collection.

Parameters:

name_str : str

Returns:

RadarSarImageLocation

RadarSarImageLocationCollection.item(self, index: int) RadarSarImageLocation#

Given an index, returns the element in the collection.

Parameters:

index : int

Returns:

RadarSarImageLocation

RadarSarImageLocationCollection.remove(self, name_str: str) None#

Remove the supplied SAR image location from the collection.

Parameters:

name_str : str

Returns:

None

RadarSarImageLocationCollection.remove_all(self) None#

Clear all SAR image locations from the collection.

Returns:

None

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

Remove the SAR image location with the supplied index.

Parameters:

index : int

Returns:

None