SphericalModesReceivingAntennaCollection

A collection of spherical modes receiving antennas.

Example

app = cf.GetApplication()
project = app:NewProject()

standardConfiguration = project.SolutionConfigurations:AddStandardConfiguration()

    -- Get the 'SphericalModesReceivingAntennaCollections'

sphericalModesReceivingAntennaCollection = 
        standardConfiguration.SphericalModesReceivingAntennas

    -- Get the number of 'SphericalModesReceivingAntenna' in the collection

numberOfSphericalModesRxAntennas = #sphericalModesReceivingAntennaCollection

Usage locations (collections)

The following objects contain the SphericalModesReceivingAntennaCollection collection:

Property List

Count
The number of SphericalModesReceivingAntenna items in the collection. (Read only number)
Type
The object type string. (Read only string)

Method List

Add (fielddata FieldData)
Create a spherical modes receiving antenna request from the specified field data. (Returns a SphericalModesReceivingAntenna object.)
Add (properties table)
Create a spherical modes receiving antenna request using the table of properties. (Returns a SphericalModesReceivingAntenna object.)
Contains (label string)
Checks if the collection contains an item with the given label. (Returns a boolean object.)
Item (index number)
Returns the SphericalModesReceivingAntenna at the given index. (Returns a SphericalModesReceivingAntenna object.)
Item (label string)
Returns the SphericalModesReceivingAntenna with the given label. (Returns a SphericalModesReceivingAntenna object.)
Items ()
Returns a table of SphericalModesReceivingAntenna. (Returns a List of SphericalModesReceivingAntenna object.)
UniqueName (label string)
Generates a unique name base of of the provided base name.If the base name already exists in the collection, a digit will be appended until a valid name is generated. (Returns a boolean object.)

Index List

[number]
Returns the SphericalModesReceivingAntenna at the given index in the collection. (Read SphericalModesReceivingAntenna)
[string]
Returns the SphericalModesReceivingAntenna with the given name in the collection. (Read SphericalModesReceivingAntenna)

Property Details

Count
The number of SphericalModesReceivingAntenna items in the collection.
Type
number
Access
Read only
Type
The object type string.
Type
string
Access
Read only

Method Details

Add (fielddata FieldData)
Create a spherical modes receiving antenna request from the specified field data.
Input Parameters
fielddata(FieldData)
The field data that the spherical modes receiving antenna writes to.
Return
SphericalModesReceivingAntenna
The spherical modes receiving antenna request.
Add (properties table)
Create a spherical modes receiving antenna request using the table of properties.
Input Parameters
properties(table)
The table of properties.
Return
SphericalModesReceivingAntenna
The near field receiving antenna request.
Contains (label string)
Checks if the collection contains an item with the given label.
Input Parameters
label(string)
The label of the SphericalModesReceivingAntenna.
Return
boolean
The success of the check.
Item (index number)
Returns the SphericalModesReceivingAntenna at the given index.
Input Parameters
index(number)
The index of the SphericalModesReceivingAntenna.
Return
SphericalModesReceivingAntenna
The SphericalModesReceivingAntenna at the given index.
Item (label string)
Returns the SphericalModesReceivingAntenna with the given label.
Input Parameters
label(string)
The label of the SphericalModesReceivingAntenna.
Return
SphericalModesReceivingAntenna
The SphericalModesReceivingAntenna with the given label.
Items ()
Returns a table of SphericalModesReceivingAntenna.
Return
List of SphericalModesReceivingAntenna
A table of SphericalModesReceivingAntenna.
UniqueName (label string)
Generates a unique name base of of the provided base name.If the base name already exists in the collection, a digit will be appended until a valid name is generated.
Input Parameters
label(string)
The base name.
Return
boolean
The generated unique name label for SphericalModesReceivingAntenna.