TransceiverCollection#

class ansys.stk.core.stkrfchannelmodeler.TransceiverCollection#

A collection of transceiver objects.

Overview#

item

Given an index, returns the element in the collection.

remove_at

Remove the transceiver with the supplied index.

remove

Remove the supplied transceiver from the collection.

add_new

Add and returns a new transceiver.

add

Add the supplied transceiver to the collection.

remove_all

Remove all transceivers from the collection.

find_by_identifier

Return the transceiver in the collection with the supplied identifier or Null if not found or invalid.

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 TransceiverCollection

Property detail#

property TransceiverCollection.count: int#

Return the number of elements in the collection.

property TransceiverCollection._new_enum: EnumeratorProxy#

Return an enumerator for the collection.

Method detail#

TransceiverCollection.item(self, index: int) Transceiver#

Given an index, returns the element in the collection.

Parameters:

index : int

Returns:

Transceiver

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

Remove the transceiver with the supplied index.

Parameters:

index : int

Returns:

None

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

Remove the supplied transceiver from the collection.

Parameters:

transceiver : Transceiver

Returns:

None

TransceiverCollection.add_new(self, type: TransceiverModelType, name: str, parent_object_path: str) Transceiver#

Add and returns a new transceiver.

Parameters:

type : TransceiverModelType

name : str

parent_object_path : str

Returns:

Transceiver

TransceiverCollection.add(self, value: Transceiver) None#

Add the supplied transceiver to the collection.

Parameters:

value : Transceiver

Returns:

None

TransceiverCollection.remove_all(self) None#

Remove all transceivers from the collection.

Returns:

None

TransceiverCollection.find_by_identifier(self, identifier: str) Transceiver#

Return the transceiver in the collection with the supplied identifier or Null if not found or invalid.

Parameters:

identifier : str

Returns:

Transceiver