`FarFieldReceivingAntennaCollection`

A collection of solution receiving antennas.

Example

application = cf.Application.GetInstance()
project = application:NewProject()

standardConfiguration = project.Contents.SolutionConfigurations:AddStandardConfiguration()

    -- Get the 'FarFieldReceivingAntennaCollections'

farFieldReceivingAntennaCollection = standardConfiguration.FarFieldReceivingAntennas

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

numberOfFarFieldRxAntennas = #farFieldReceivingAntennaCollection

Inheritance

The FarFieldReceivingAntennaCollection object is derived from the Object object.

Usage locations

The FarFieldReceivingAntennaCollection object can be accessed from the following locations:

Collection lists
- StandardConfiguration object has collection FarFieldReceivingAntennas.

Property List

Count: The number of FarFieldReceivingAntenna items in the collection. (Read only number)
Label: The object label. (Read/Write string)
Type: The object type string. (Read only string)

Method List

Add (properties table): Create a far field receiving antenna request using the table of properties. (Returns a FarFieldReceivingAntenna object.)
Add (fielddata FarFieldData): Create a far field receiving antenna request from the specified field data. (Returns a FarFieldReceivingAntenna object.)
Delete (): Deletes the entity.
Duplicate (): Duplicates the entity. (Returns a Object object.)
GetProperties (): Returns a table of properties representing the state of the object. The properties table can be used with the SetProperties method to change multiple properties of the object in one step. (Returns a table object.)
Item (index number): Returns the FarFieldReceivingAntenna for the given index in the collection. (Returns a FarFieldReceivingAntenna object.)
Item (label string): Returns the FarFieldReceivingAntenna for the given label in the collection. (Returns a FarFieldReceivingAntenna object.)
Items (): Returns a table of FarFieldReceivingAntenna items. (Returns a UnsupportedType(List of FarFieldReceivingAntenna) object.)
SetProperties (properties Object): Modifies the state of the object using the provided table of properties. This method is used to modify multiple properties of the object in a single step.

Static Function List

GetDefaultProperties (): Creates a table containing the default settings to create an object. (Returns a table object.)

Property Details

Count

The number of FarFieldReceivingAntenna items in the collection.

Type: number
Access: Read only

Label

The object label.

Type: string
Access: Read/Write

Type

The object type string.

Type: string
Access: Read only

Method Details

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.

Add (fielddata FarFieldData)

Create a far field receiving antenna request from the specified field data.

Input Parameters

fielddata(FarFieldData): The field data that the receiving antenna writes to.

Return

FarFieldReceivingAntenna: The far field receiving antenna request.

Delete ()

Deletes the entity.

Duplicate ()

Duplicates the entity.

Return

Object: The new (duplicated) entity.

GetProperties ()

Returns a table of properties representing the state of the object. The properties table can be used with the SetProperties method to change multiple properties of the object in one step.

Return

table: A table defining the properties.

Item (index number)

Returns the FarFieldReceivingAntenna for the given index in the collection.

Input Parameters

index(number): The index of the FarFieldReceivingAntenna.

Return

FarFieldReceivingAntenna: The item in the collection

Item (label string)

Returns the FarFieldReceivingAntenna for the given label in the collection.

Input Parameters

label(string): The label of the FarFieldReceivingAntenna.

Return

FarFieldReceivingAntenna: The item in the collection

Items ()

Returns a table of FarFieldReceivingAntenna items.

Return

UnsupportedType(List of FarFieldReceivingAntenna): The list of items in the collection

SetProperties (properties Object)

Modifies the state of the object using the provided table of properties. This method is used to modify multiple properties of the object in a single step.

Input Parameters

properties(Object): A table of properties defining the new state of the object.

Static Function Details

GetDefaultProperties ()

Creates a table containing the default settings to create an object.

Return

table: A table containing the default properties.