FarFieldCollection

A collection of solution far fields for this solution configuration.

Example

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

    -- Add a far field request to the far field collection
    
configuration = project.SolutionConfigurations[1]
farFieldCollection = configuration.FarFields
farFieldRequest = farFieldCollection:Add3DPattern()

    -- Remove the far field request from the far field collection
    
farFieldCollection:Item(farFieldRequest.Label):Delete()

Usage locations (collections)

The following objects contain the FarFieldCollection collection:

Property List

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

Method List

Add (starttheta Expression, startphi Expression, endtheta Expression, endphi Expression, thetaincrement Expression, phiincrement Expression)
Create a spherical far field calculation request. (Returns a FarField object.)
Add (properties table)
Create a far field using the table of properties. (Returns a FarField object.)
Add3DPattern ()
Create a 3D pattern spherical far field calculation request. (Returns a FarField object.)
AddHorizontalCutUVPlane ()
Create a horizontal cut UV plane spherical far field calculation request. (Returns a FarField object.)
AddRequestInPlaneWaveIncidentDirection ()
Create a far field calculation request in the plane wave incident direction. (Returns a FarField object.)
AddSquareGrid ()
Create a square grid pattern Cartesian far field calculation request. (Returns a FarField object.)
AddVerticalCutUNPlane ()
Create a vertical cut UN plane spherical far field calculation request. (Returns a FarField object.)
AddVerticalCutVNPlane ()
Create a vertical cut VN plane spherical far field calculation request. (Returns a FarField object.)
Contains (label string)
Checks if the collection contains an item with the given label. (Returns a boolean object.)
Item (index number)
Returns the FarField at the given index. (Returns a FarField object.)
Item (label string)
Returns the FarField with the given label. (Returns a FarField object.)
Items ()
Returns a table of FarField. (Returns a List of FarField 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 FarField at the given index in the collection. (Read FarField)
[string]
Returns the FarField with the given name in the collection. (Read FarField)

Property Details

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

Method Details

Add (starttheta Expression, startphi Expression, endtheta Expression, endphi Expression, thetaincrement Expression, phiincrement Expression)
Create a spherical far field calculation request.
Input Parameters
starttheta(Expression)
The theta start angle (degrees).
startphi(Expression)
The theta start angle (degrees).
endtheta(Expression)
The theta end angle (degrees).
endphi(Expression)
The theta end angle (degrees).
thetaincrement(Expression)
The theta increment (degrees).
phiincrement(Expression)
The theta increment (degrees).
Return
FarField
The far field.
Add (properties table)
Create a far field using the table of properties.
Input Parameters
properties(table)
The table of properties.
Return
FarField
The far field.
Add3DPattern ()
Create a 3D pattern spherical far field calculation request.
Return
FarField
The far field.
AddHorizontalCutUVPlane ()
Create a horizontal cut UV plane spherical far field calculation request.
Return
FarField
The far field.
AddRequestInPlaneWaveIncidentDirection ()
Create a far field calculation request in the plane wave incident direction.
Return
FarField
The far field.
AddSquareGrid ()
Create a square grid pattern Cartesian far field calculation request.
Return
FarField
The far field.
AddVerticalCutUNPlane ()
Create a vertical cut UN plane spherical far field calculation request.
Return
FarField
The far field.
AddVerticalCutVNPlane ()
Create a vertical cut VN plane spherical far field calculation request.
Return
FarField
The far field.
Contains (label string)
Checks if the collection contains an item with the given label.
Input Parameters
label(string)
The label of the FarField.
Return
boolean
The success of the check.
Item (index number)
Returns the FarField at the given index.
Input Parameters
index(number)
The index of the FarField.
Return
FarField
The FarField at the given index.
Item (label string)
Returns the FarField with the given label.
Input Parameters
label(string)
The label of the FarField.
Return
FarField
The FarField with the given label.
Items ()
Returns a table of FarField.
Return
List of FarField
A table of FarField.
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 FarField.