CommunicationsTransceiverConfigurationCollection#

class ansys.stk.core.stkrfchannelmodeler.CommunicationsTransceiverConfigurationCollection#

A collection of communication transceivers.

Overview#

item

Given an index, returns the element in the collection.

remove_at

Remove the configuration with the supplied index.

remove

Remove the supplied configuration from the collection.

add_new

Add and returns a new configuration.

remove_all

Clear all configurations from the collection.

contains

Check to see if a given configuration exists in the collection.

count

Return the number of elements in the collection.

_new_enum

Return an enumerator for the collection.

Import detail#

from ansys.stk.core.stkrfchannelmodeler import CommunicationsTransceiverConfigurationCollection

Property detail#

property CommunicationsTransceiverConfigurationCollection.count: int#

Return the number of elements in the collection.

property CommunicationsTransceiverConfigurationCollection._new_enum: EnumeratorProxy#

Return an enumerator for the collection.

Method detail#

CommunicationsTransceiverConfigurationCollection.item(self, index: int) CommunicationsTransceiverConfiguration#

Given an index, returns the element in the collection.

Parameters:

index : int

Returns:

CommunicationsTransceiverConfiguration

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

Remove the configuration with the supplied index.

Parameters:

index : int

Returns:

None

CommunicationsTransceiverConfigurationCollection.remove(self, transceiver: Transceiver) None#

Remove the supplied configuration from the collection.

Parameters:

transceiver : Transceiver

Returns:

None

CommunicationsTransceiverConfigurationCollection.add_new(self) CommunicationsTransceiverConfiguration#

Add and returns a new configuration.

Returns:

CommunicationsTransceiverConfiguration

CommunicationsTransceiverConfigurationCollection.remove_all(self) None#

Clear all configurations from the collection.

Returns:

None

CommunicationsTransceiverConfigurationCollection.contains(self, transceiver: Transceiver) bool#

Check to see if a given configuration exists in the collection.

Parameters:

transceiver : Transceiver

Returns:

bool