SphericalModeReceivingAntennaCollection

A collection of spherical modes receiving antennas.

Example

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

standardConfiguration = project.Contents.SolutionConfigurations:AddStandardConfiguration()

    -- Get the 'SphericalModeReceivingAntennaCollections'

sphericalModeReceivingAntennaCollection =
        standardConfiguration.SphericalModeReceivingAntennas

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

numberOfSphericalModesRxAntennas = #sphericalModeReceivingAntennaCollection

Inheritance

The SphericalModeReceivingAntennaCollection object is derived from the Object object.

Usage locations

The SphericalModeReceivingAntennaCollection object can be accessed from the following locations:

Property List

Count
The number of SphericalModeReceivingAntenna 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 spherical modes receiving antenna request using the table of properties. (Returns a SphericalModeReceivingAntenna object.)
Add (fielddata FieldData)
Create a spherical modes receiving antenna request from the specified field data. (Returns a SphericalModeReceivingAntenna object.)
Delete ()
Deletes the entity.
DeleteEntities ( List of Object)
Delete the given list of entities from the collection.
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 SphericalModeReceivingAntenna for the given index in the collection. (Returns a SphericalModeReceivingAntenna object.)
Item (label string)
Returns the SphericalModeReceivingAntenna for the given label in the collection. (Returns a SphericalModeReceivingAntenna object.)
Items ()
Returns a table of SphericalModeReceivingAntenna items. (Returns a UnsupportedType(List of SphericalModeReceivingAntenna) 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 SphericalModeReceivingAntenna 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 spherical modes receiving antenna request using the table of properties.
Input Parameters
properties(table)
The table of properties.
Return
SphericalModeReceivingAntenna
The near field receiving antenna request.
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
SphericalModeReceivingAntenna
The spherical modes receiving antenna request.
Delete ()
Deletes the entity.
DeleteEntities ( List of Object)
Delete the given list of entities from the collection.
Input Parameters
(List of Object)
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 SphericalModeReceivingAntenna for the given index in the collection.
Input Parameters
index(number)
The index of the SphericalModeReceivingAntenna.
Return
SphericalModeReceivingAntenna
The item in the collection
Item (label string)
Returns the SphericalModeReceivingAntenna for the given label in the collection.
Input Parameters
label(string)
The label of the SphericalModeReceivingAntenna.
Return
SphericalModeReceivingAntenna
The item in the collection
Items ()
Returns a table of SphericalModeReceivingAntenna items.
Return
UnsupportedType(List of SphericalModeReceivingAntenna)
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.