`AntennaArrayCollection`

A collection of finite antenna arrays.

Example

application = cf.Application.GetInstance()
project = application:NewProject()
antennaArrays = project.Contents.SolutionSettings.AntennaArrays

    -- Create a 6x3 circular array with radius of 3

phiIncrement = 25
offsetN = 2
array = antennaArrays:AddCylindricalArray(3, 6, phiIncrement, 3, offsetN, false)

    -- Convert the array to custom

array:ConvertToCustomArray()
print(#antennaArrays)

Inheritance

The AntennaArrayCollection object is derived from the Object object.

Usage locations

The AntennaArrayCollection object can be accessed from the following locations:

Collection lists

Property List

BoundingBox: A box indicating the bounding box of this entity. (Read only Box). (Read only Box)
Count: The number of AbstractAntennaArray items in the collection. (Read only number)
Label: The object label. (Read/Write string)
Type: The object type string. (Read only string)

Method List

AddArrayElement (properties table): Create a custom antenna array element using the table of properties. (Returns a AntennaArrayElement object.)
AddArrayElement (origin Point, magnitudescaling Expression, phaseoffset Expression): Create a custom antenna array element. (Returns a AntennaArrayElement object.)
AddCylindricalArray (properties table): Create a cylindrical/circular antenna array using the table of properties. (Returns a CylindricalCircularArray object.)
AddCylindricalArray (radius Expression, countphi number, countn number, offsetn Expression, rotateelements boolean): Create a cylindrical/circular antenna array where the elements is equally spaced in the Phi dimension. (Returns a CylindricalCircularArray object.)
AddCylindricalArray (radius Expression, countphi number, angle Expression, countn number, offsetn Expression, rotateelements boolean): Create a cylindrical/circular antenna array where the element spacing in the Phi dimension is specified. (Returns a CylindricalCircularArray object.)
AddPlanarArray (properties table): Create a planar/linear antenna array using the table of properties. (Returns a LinearPlanarArray object.)
AddPlanarArray (countu number, offsetu Expression, countv number, offsetv Expression): Create a planar/linear antenna array. (Returns a LinearPlanarArray 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 AbstractAntennaArray for the given index in the collection. (Returns a AbstractAntennaArray object.)
Item (label string): Returns the AbstractAntennaArray for the given label in the collection. (Returns a AbstractAntennaArray object.)
Items (): Returns a table of AbstractAntennaArray items. (Returns a UnsupportedType(List of AbstractAntennaArray) 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

BoundingBox

A box indicating the bounding box of this entity. (Read only Box).

Type: Box
Access: Read only

Count

The number of AbstractAntennaArray 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

AddArrayElement (properties table)

Create a custom antenna array element using the table of properties.

Input Parameters

properties(table): The table of properties.

Return

AntennaArrayElement: The custom antenna array element.

AddArrayElement (origin Point, magnitudescaling Expression, phaseoffset Expression)

Create a custom antenna array element.

Input Parameters

origin(Point): The element origin point.
magnitudescaling(Expression): The element excitation magnitude scaling.
phaseoffset(Expression): The element excitation phase offset.

Return

AntennaArrayElement: The custom antenna array element.

AddCylindricalArray (properties table)

Create a cylindrical/circular antenna array using the table of properties.

Input Parameters

properties(table): The table of properties.

Return

CylindricalCircularArray: The cylindrical/circular antenna array.

AddCylindricalArray (radius Expression, countphi number, countn number, offsetn Expression, rotateelements boolean)

Create a cylindrical/circular antenna array where the elements is equally spaced in the Phi dimension.

Input Parameters

radius(Expression): The radius.
countphi(number): The number of elements in the Phi dimension.
countn(number): The number of elements in the N dimension.
offsetn(Expression): The offset along the N axis in the N dimension.
rotateelements(boolean): Whether to rotate each element to determine its new position.

Return

CylindricalCircularArray: The cylindrical/circular antenna array.

AddCylindricalArray (radius Expression, countphi number, angle Expression, countn number, offsetn Expression, rotateelements boolean)

Create a cylindrical/circular antenna array where the element spacing in the Phi dimension is specified.

Input Parameters

radius(Expression): The radius.
countphi(number): The number of elements in the Phi dimension.
angle(Expression): The spacing increment (in degress) in the Phi dimension.
countn(number): The number of elements in the N dimension.
offsetn(Expression): The offset along the N axis in the N dimension.
rotateelements(boolean): Whether to rotate each element to determine its new position.

Return

CylindricalCircularArray: The cylindrical/circular antenna array.

AddPlanarArray (properties table)

Create a planar/linear antenna array using the table of properties.

Input Parameters

properties(table): The table of properties.

Return

LinearPlanarArray: The planar/linear antenna array.

AddPlanarArray (countu number, offsetu Expression, countv number, offsetv Expression)

Create a planar/linear antenna array.

Input Parameters

countu(number): The number of elements in the U dimension.
offsetu(Expression): The offset along the U axis in the U dimension.
countv(number): The number of the elements in the V dimension.
offsetv (Expression): The offset along the V axis in the V dimension.

Return

LinearPlanarArray: The planar/linear antenna array.

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 AbstractAntennaArray for the given index in the collection.

Input Parameters

index(number): The index of the AbstractAntennaArray.

Return

AbstractAntennaArray: The item in the collection

Item (label string)

Returns the AbstractAntennaArray for the given label in the collection.

Input Parameters

label(string): The label of the AbstractAntennaArray.

Return

AbstractAntennaArray: The item in the collection

Items ()

Returns a table of AbstractAntennaArray items.

Return

UnsupportedType(List of AbstractAntennaArray): 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.