FarFieldCollection

A collection of solution far fields for this solution configuration.

Example

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

    -- Add a far field request to the far field collection

configuration = project.Contents.SolutionConfigurations[1]
farFieldCollection = configuration.FarFields
farFieldRequest = farFieldCollection:Add3DPattern()

    -- Remove the far field request from the far field collection

farFieldCollection:Item(farFieldRequest.Label):Delete()

Inheritance

The FarFieldCollection object is derived from the Object object.

Usage locations

The FarFieldCollection object can be accessed from the following locations:

Property List

Count
The number of FarField 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 using the table of properties. (Returns a FarField object.)
Add (starttheta Expression, startphi Expression, endtheta Expression, endphi Expression, thetaincrement Expression, phiincrement Expression)
Create a spherical far field calculation request. (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.)
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 FarField for the given index in the collection. (Returns a FarField object.)
Item (label string)
Returns the FarField for the given label in the collection. (Returns a FarField object.)
Items ()
Returns a table of FarField items. (Returns a UnsupportedType(List of FarField) 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.
UniqueName (label string)
Generates a unique name base 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 string object.)

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 FarField 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 using the table of properties.
Input Parameters
properties(table)
The table of properties.
Return
FarField
The far field.
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 phi start angle (degrees).
endtheta(Expression)
The theta end angle (degrees).
endphi(Expression)
The phi end angle (degrees).
thetaincrement(Expression)
The theta increment (degrees).
phiincrement(Expression)
The phi increment (degrees).
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 item.
Return
boolean
The success of the check.
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 FarField for the given index in the collection.
Input Parameters
index(number)
The index of the FarField.
Return
FarField
The item in the collection
Item (label string)
Returns the FarField for the given label in the collection.
Input Parameters
label(string)
The label of the FarField.
Return
FarField
The item in the collection
Items ()
Returns a table of FarField items.
Return
UnsupportedType(List of FarField)
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.
UniqueName (label string)
Generates a unique name base 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
string
The generated unique name label for the item.

Static Function Details

GetDefaultProperties ()
Creates a table containing the default settings to create an object.
Return
table
A table containing the default properties.