`CylindricalCircularArray`

A finite antenna array with a cylindrical or circular distribution.

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)

    -- Set a non-uniform source distribution

array.UniformSourceDistributionEnabled = false
array.Distribution[1].MagnitudeScaling = "1.5"
array.Distribution[1].PhaseOffset = "45"
array.Distribution[6].MagnitudeScaling = "1.5"
array.Distribution[6].PhaseOffset = "90"

Inheritance

The CylindricalCircularArray object is derived from the AbstractAntennaArray object.

Usage locations

The CylindricalCircularArray object can be accessed from the following locations:

Methods
- AntennaArrayCollection collection has method AddCylindricalArray(table).
- AntennaArrayCollection collection has method AddCylindricalArray(Expression, number, number, Expression, boolean).
- AntennaArrayCollection collection has method AddCylindricalArray(Expression, number, Expression, number, Expression, boolean).

Property List

BoundingBox: A box indicating the bounding box of this entity. (Read only Box). (Read only Box)
CountN: The number of finite antenna array elements in the N dimension. (Read/Write number)
CountPhi: The number of finite antenna array elements in the Phi dimension. (Read/Write number)
Distribution: The collection of finite antenna array element sources. Only applicable if UniformSourceDistributionEnabled is false. (Read/Write AntennaArraySourceList)
ElementsRotated: Rotate each element by the same angle used to determine its new position. (Read/Write boolean)
Included: A boolean value defining if an entity is excluded or included. (Read/Write boolean)
Label: The object label. (Read/Write string)
LocalWorkplane: The source workplane. (Read/Write LocalWorkplane)
OffsetN: The distance between the finite antenna array elements along the N axis. (Read/Write ParametricExpression)
PhiAngle: The angle (in degrees) between the finite antenna array elements in the Phi dimension. Only applicable if PhiSpacingType is Specified. (Read/Write ParametricExpression)
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 ElementDistributionEnum)
Radius: The radius of the cylindrical/circular antenna array. (Read/Write ParametricExpression)
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)

Collection List

Transforms: The collection of transforms on the operator. (TransformCollection of Transform.)

Method List

ConvertToCustomArray (): Convert the finite antenna array into a collection of individual custom array elements. (Returns a List of AntennaArrayElement object.)
CopyAndMirror (properties table): Apply a copy and mirror using a table defining the properties. (Returns a Object object.)
CopyAndRotate (properties table, count number): Apply a copy and rotate using a table defining the properties. (Returns a List of Object object.)
CopyAndRotate (origin Point, rotationaxis Vector, angle number, count number): Copy and rotate the geometry. (Returns a List of Object object.)
CopyAndTranslate (properties table, count number): Apply a copy and translate using a table defining the properties. (Returns a List of Object object.)
CopyAndTranslate (from Point, to Point, count number): Copy and translate the geometry. (Returns a List of Object 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.)
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

CountN

The number of finite antenna array elements in the N dimension.

Type: number
Access: Read/Write

CountPhi

The number of finite antenna array elements in the Phi dimension.

Type: number
Access: Read/Write

Distribution

The collection of finite antenna array element sources. Only applicable if UniformSourceDistributionEnabled is false.

Type: AntennaArraySourceList
Access: Read/Write

ElementsRotated

Rotate each element by the same angle used to determine its new position.

Type: boolean
Access: Read/Write

Included

A boolean value defining if an entity is excluded or included.

Type: boolean
Access: Read/Write

Label

The object label.

Type: string
Access: Read/Write

LocalWorkplane

The source workplane.

Type: LocalWorkplane
Access: Read/Write

OffsetN

The distance between the finite antenna array elements along the N axis.

Type: ParametricExpression
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: ParametricExpression
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: ElementDistributionEnum
Access: Read/Write

Radius

The radius of the cylindrical/circular antenna array.

Type: ParametricExpression
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

Collection Details

Transforms

The collection of transforms on the operator.

Type: TransformCollection

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.

CopyAndMirror (properties table)

Apply a copy and mirror using a table defining the properties.

Input Parameters

properties(table): A table of properties defining the mirror transform.

Return

Object: The mirrored geometry.

CopyAndRotate (properties table, count number)

Apply a copy and rotate using a table defining the properties.

Input Parameters

properties(table): A table of properties defining the rotate transform.
count(number): The number of transform copies.

Return

List of Object: The list of rotated geometry.

CopyAndRotate (origin Point, rotationaxis Vector, angle number, count number)

Copy and rotate the geometry.

Input Parameters

origin(Point): The coordinates of the origin of the rotation.
rotationaxis(Vector): The axis of rotation.
angle(number): The angle of rotation (degrees).
count(number): The number of copies.

Return

List of Object: The list of rotated geometry.

CopyAndTranslate (properties table, count number)

Apply a copy and translate using a table defining the properties.

Input Parameters

properties(table): A table of properties defining the translate transform.
count(number): The number of transform copies.

Return

List of Object: The list of translated geometry.

CopyAndTranslate (from Point, to Point, count number)

Copy and translate the geometry.

Input Parameters

from(Point): Translate from coordinate.
to(Point): Translate to coordinate.
count(number): The number of copies.

Return

List of Object: The list of translated geometry.

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.

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.