FarFieldReceivingAntennaCollection

A collection of solution receiving antennas.

Example

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

standardConfiguration = project.SolutionConfigurations:AddStandardConfiguration()

    -- Get the 'FarFieldReceivingAntennaCollections'

farFieldReceivingAntennaCollection = standardConfiguration.FarFieldReceivingAntennas

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

numberOfFarFieldRxAntennas = #farFieldReceivingAntennaCollection

Usage locations (collections)

The following objects contain the FarFieldReceivingAntennaCollection collection:

Property List

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

Method List

Add (fielddata FieldData)
Create a far field receiving antenna request from the specified field data. (Returns a FarFieldReceivingAntenna object.)
Add (properties table)
Create a far field receiving antenna request using the table of properties. (Returns a FarFieldReceivingAntenna object.)
Contains (label string)
Checks if the collection contains an item with the given label. (Returns a boolean object.)
Item (index number)
Returns the FarFieldReceivingAntenna at the given index. (Returns a FarFieldReceivingAntenna object.)
Item (label string)
Returns the FarFieldReceivingAntenna with the given label. (Returns a FarFieldReceivingAntenna object.)
Items ()
Returns a table of FarFieldReceivingAntenna. (Returns a List of FarFieldReceivingAntenna 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 FarFieldReceivingAntenna at the given index in the collection. (Read FarFieldReceivingAntenna)
[string]
Returns the FarFieldReceivingAntenna with the given name in the collection. (Read FarFieldReceivingAntenna)

Property Details

Count
The number of FarFieldReceivingAntenna 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 far field receiving antenna request from the specified field data.
Input Parameters
fielddata(FieldData)
The field data that the receiving antenna writes to.
Return
FarFieldReceivingAntenna
The far field receiving antenna request.
Add (properties table)
Create a far field receiving antenna request using the table of properties.
Input Parameters
properties(table)
The table of properties.
Return
FarFieldReceivingAntenna
The far 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 FarFieldReceivingAntenna.
Return
boolean
The success of the check.
Item (index number)
Returns the FarFieldReceivingAntenna at the given index.
Input Parameters
index(number)
The index of the FarFieldReceivingAntenna.
Return
FarFieldReceivingAntenna
The FarFieldReceivingAntenna at the given index.
Item (label string)
Returns the FarFieldReceivingAntenna with the given label.
Input Parameters
label(string)
The label of the FarFieldReceivingAntenna.
Return
FarFieldReceivingAntenna
The FarFieldReceivingAntenna with the given label.
Items ()
Returns a table of FarFieldReceivingAntenna.
Return
List of FarFieldReceivingAntenna
A table of FarFieldReceivingAntenna.
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 FarFieldReceivingAntenna.