CylindricalAntennaArray

INTERNAL:A finite antenna array with a cylindrical or circular distribution.

Inheritance

The CylindricalAntennaArray object is derived from the AntennaArray object.

Property List

CountN
The number of finite antenna array elements in the N dimension. (Read/Write Expression)
CountPhi
The number of finite antenna array elements in the Phi dimension. (Read/Write Expression)
ElementsRotated
Rotate each element by the same angle used to determine its new position. (Read/Write boolean)
Label
The object label. (Read/Write string)
OffsetZ
The distance between the finite antenna array elements along the Z axis. (Read/Write Expression)
PhiAngle
The angle (in degrees) between the finite antenna array elements in the Phi dimension. Only applicable if PhiSpacingType is Specified. (Read/Write Expression)
PhiSpacingType
The element spacing type in the Phi dimension. A uniform spacing will ensure that each element are equally spaced from each other. (Read/Write AntennaArrayDistributionTypeEnum)
Radius
The radius of the cylindrical/circular antenna array. (Read/Write Expression)
Type
The object type string. (Read only string)
UniformSourceDistributionEnabled
The finite array elements will either have an uniform distribution or the distribution will be calculated from the plane wave if a plane wave is present in the model. If it is set to false, the source of each element can be specified. (Read/Write boolean)
Visible
Specifies whether the antenna array must be shown or hidden. (Read/Write boolean)

Collection List

Source
The collection of finite antenna array element excitations. Only applicable if UniformSourceDistributionEnabled is false. (CircularAntennaArraySourceCollection of AntennaArraySource.)

Method List

ConvertToCustomArray ()
Convert the finite antenna array into a collection of individual custom array elements. (Returns a List of AntennaArrayElement object.)
Delete ()
Delete the antenna array.
Duplicate ()
Duplicate the antenna array. (Returns a SolutionEntity 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.)
SetProperties (properties table)
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

CountN
The number of finite antenna array elements in the N dimension.
Type
Expression
Access
Read/Write
CountPhi
The number of finite antenna array elements in the Phi dimension.
Type
Expression
Access
Read/Write
ElementsRotated
Rotate each element by the same angle used to determine its new position.
Type
boolean
Access
Read/Write
Label
The object label.
Type
string
Access
Read/Write
OffsetZ
The distance between the finite antenna array elements along the Z axis.
Type
Expression
Access
Read/Write
PhiAngle
The angle (in degrees) between the finite antenna array elements in the Phi dimension. Only applicable if PhiSpacingType is Specified.
Type
Expression
Access
Read/Write
PhiSpacingType
The element spacing type in the Phi dimension. A uniform spacing will ensure that each element are equally spaced from each other.
Type
AntennaArrayDistributionTypeEnum
Access
Read/Write
Radius
The radius of the cylindrical/circular antenna array.
Type
Expression
Access
Read/Write
Type
The object type string.
Type
string
Access
Read only
UniformSourceDistributionEnabled
The finite array elements will either have an uniform distribution or the distribution will be calculated from the plane wave if a plane wave is present in the model. If it is set to false, the source of each element can be specified.
Type
boolean
Access
Read/Write
Visible
Specifies whether the antenna array must be shown or hidden.
Type
boolean
Access
Read/Write

Collection Details

Source
The collection of finite antenna array element excitations. Only applicable if UniformSourceDistributionEnabled is false.
Type
CircularAntennaArraySourceCollection

Method Details

ConvertToCustomArray ()
Convert the finite antenna array into a collection of individual custom array elements.
Return
List of AntennaArrayElement
The list of antenna array elements.
Delete ()
Delete the antenna array.
Duplicate ()
Duplicate the antenna array.
Return
SolutionEntity
The duplicated antenna array.
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 properties table.
SetProperties (properties table)
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(table)
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
The default properties table.