NearFieldReceivingAntennaCollection

A collection of solution receiving antennas.

Example

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

standardConfiguration = project.SolutionConfigurations['StandardConfiguration1']

    -- Get the 'NearFieldReceivingAntennaCollections'

nearFieldReceivingAntennaCollection = standardConfiguration.NearFieldReceivingAntennas

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

numberOfNearFieldRxAntennas = #nearFieldReceivingAntennaCollection

Usage locations (collections)

The following objects contain the NearFieldReceivingAntennaCollection collection:

Property List

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

Method List

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

Property Details

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

Method Details

Add (properties table)
Create a near field receiving antenna request using the table of properties.
Input Parameters
properties(table)
The table of properties.
Return
NearFieldReceivingAntenna
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 NearFieldReceivingAntenna.
Return
boolean
The success of the check.
Item (index number)
Returns the NearFieldReceivingAntenna at the given index.
Input Parameters
index(number)
The index of the NearFieldReceivingAntenna.
Return
NearFieldReceivingAntenna
The NearFieldReceivingAntenna at the given index.
Item (label string)
Returns the NearFieldReceivingAntenna with the given label.
Input Parameters
label(string)
The label of the NearFieldReceivingAntenna.
Return
NearFieldReceivingAntenna
The NearFieldReceivingAntenna with the given label.
Items ()
Returns a table of NearFieldReceivingAntenna.
Return
List of NearFieldReceivingAntenna
A table of NearFieldReceivingAntenna.
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 NearFieldReceivingAntenna.