AntennaArrayCollection

INTERNAL:A collection of finite antenna arrays.

Usage locations (collections)

The following objects contain the AntennaArrayCollection collection:

Property List

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

Method List

AddArrayElement (origin Coordinate, magnitudescaling Expression, phaseoffset Expression)
Create a custom antenna array element. (Returns a AntennaArrayElement object.)
AddArrayElement (properties table)
Create a custom antenna array element using the table of properties. (Returns a AntennaArrayElement object.)
AddCylindricalArray (radius Expression, countphi number, countn number, offsetz Expression)
Create a cylindrical/circular antenna array where the elements is equally spaced in the Phi dimension. (Returns a CylindricalAntennaArray object.)
AddCylindricalArray (radius Expression, countphi number, angle Expression, countn number, offsetz Expression)
Create a cylindrical/circular antenna array where the element spacing in the Phi dimension is specified. (Returns a CylindricalAntennaArray object.)
AddCylindricalArray (properties table)
Create a cylindrical/circular antenna array using the table of properties. (Returns a CylindricalAntennaArray object.)
AddPlanarArray (countu number, offsetx Expression, countv number, offsety Expression)
Create a planar/linear antenna array. (Returns a PlanarAntennaArray object.)
AddPlanarArray (properties table)
Create a planar/linear antenna array using the table of properties. (Returns a PlanarAntennaArray object.)
Contains (label string)
Checks if the collection contains an item with the given label. (Returns a boolean object.)
Item (index number)
Returns the AntennaArray at the given index. (Returns a AntennaArray object.)
Item (label string)
Returns the AntennaArray with the given label. (Returns a AntennaArray object.)
Items ()
Returns a table of AntennaArray. (Returns a List of AntennaArray 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 AntennaArray at the given index in the collection. (Read AntennaArray)
[string]
Returns the AntennaArray with the given name in the collection. (Read AntennaArray)

Property Details

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

Method Details

AddArrayElement (origin Coordinate, magnitudescaling Expression, phaseoffset Expression)
Create a custom antenna array element.
Input Parameters
origin(Coordinate)
The element origin point.
magnitudescaling(Expression)
The element excitation magnitude scaling.
phaseoffset(Expression)
The element excitation phase offset.
Return
AntennaArrayElement
The custom array element.
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.
AddCylindricalArray (radius Expression, countphi number, countn number, offsetz Expression)
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.
offsetz(Expression)
The offset along Z axis in the N dimension.
Return
CylindricalAntennaArray
The cylindrical/circular antenna array.
AddCylindricalArray (radius Expression, countphi number, angle Expression, countn number, offsetz Expression)
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 degrees) in the Phi dimension.
countn(number)
The number of elements in the N dimension.
offsetz(Expression)
The offset along Z axis in the N dimension.
Return
CylindricalAntennaArray
The cylindrical/circular antenna array.
AddCylindricalArray (properties table)
Create a cylindrical/circular antenna array using the table of properties.
Input Parameters
properties(table)
The table of properties.
Return
CylindricalAntennaArray
The cylindrical/circular antenna array.
AddPlanarArray (countu number, offsetx Expression, countv number, offsety Expression)
Create a planar/linear antenna array.
Input Parameters
countu(number)
The number of elements in the U dimension.
offsetx(Expression)
The offset along X axis in the U dimension.
countv(number)
The number of elements in the V dimension.
offsety(Expression)
The offset along Y axis in the V dimension.
Return
PlanarAntennaArray
The planar/linear 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
PlanarAntennaArray
The planar/linear antenna array.
Contains (label string)
Checks if the collection contains an item with the given label.
Input Parameters
label(string)
The label of the AntennaArray.
Return
boolean
The success of the check.
Item (index number)
Returns the AntennaArray at the given index.
Input Parameters
index(number)
The index of the AntennaArray.
Return
AntennaArray
The AntennaArray at the given index.
Item (label string)
Returns the AntennaArray with the given label.
Input Parameters
label(string)
The label of the AntennaArray.
Return
AntennaArray
The AntennaArray with the given label.
Items ()
Returns a table of AntennaArray.
Return
List of AntennaArray
A table of AntennaArray.
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 AntennaArray.