AntennaLibraryElement

Inheritance

The AntennaLibraryElement object is derived from the ComponentLibraryElement object.

Property List

Label
The object label. (Read/Write string)
Type
The object type string. (Read only string)

Property List (internal only)

AddGroundPlane
(Read/Write boolean)
AlignComponent
(Read/Write boolean)
BandwidthFactor
(Read/Write number)
Configuration
(Read/Write ConfigurationSelectionTypeEnum)
Description
(Read/Write string)
FarFieldPhiIncrement
(Read/Write number)
FarFieldPhiSinglePoint
(Read/Write number)
FarFieldThetaIncrement
(Read/Write number)
FarFieldThetaSinglePoint
(Read/Write number)
Frequency
(Read/Write ParametricExpression)
FrequencySampleCount
(Read/Write number)
IconLabel
(Read only string)
ImageFilePaths
(Read only string)
Keywords
(Read/Write string)
LuaScriptFilePath
(Read only string)
MaxDimensionInLambda
(Read/Write number)
Path
(Read only string)
PowerImaginary
(Read/Write number)
PowerReal
(Read/Write number)
PowerScaleType
(Read/Write PowerScaleTypeEnum)
PowerSourcePower
(Read/Write number)
PowerSourcesDecoupled
(Read/Write boolean)
Prefix
(Read/Write string)
ReferenceImpedance
(Read/Write number)
SolverType
(Read/Write SolverTypeEnum)
SupportsGroundPlane
(Read/Write boolean)
Tooltip
(Read/Write string)
UniqueLabel
(Read only string)

Method List

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.

Method List (internal only)

Create ()
(Returns a Geometry object.)

Static Function List

GetDefaultProperties ()
Creates a table containing the default settings to create an object. (Returns a table object.)

Property Details

Label
The object label.
Type
string
Access
Read/Write
Type
The object type string.
Type
string
Access
Read only

Property Details (internal only)

AddGroundPlane
Type
boolean
Access
Read/Write
AlignComponent
Type
boolean
Access
Read/Write
BandwidthFactor
Type
number
Access
Read/Write
Configuration
Type
ConfigurationSelectionTypeEnum
Access
Read/Write
Description
Type
string
Access
Read/Write
FarFieldPhiIncrement
Type
number
Access
Read/Write
FarFieldPhiSinglePoint
Type
number
Access
Read/Write
FarFieldThetaIncrement
Type
number
Access
Read/Write
FarFieldThetaSinglePoint
Type
number
Access
Read/Write
Frequency
Type
ParametricExpression
Access
Read/Write
FrequencySampleCount
Type
number
Access
Read/Write
IconLabel
Type
string
Access
Read only
ImageFilePaths
Type
string
Access
Read only
Keywords
Type
string
Access
Read/Write
LuaScriptFilePath
Type
string
Access
Read only
MaxDimensionInLambda
Type
number
Access
Read/Write
Path
Type
string
Access
Read only
PowerImaginary
Type
number
Access
Read/Write
PowerReal
Type
number
Access
Read/Write
PowerScaleType
Type
PowerScaleTypeEnum
Access
Read/Write
PowerSourcePower
Type
number
Access
Read/Write
PowerSourcesDecoupled
Type
boolean
Access
Read/Write
Prefix
Type
string
Access
Read/Write
ReferenceImpedance
Type
number
Access
Read/Write
SolverType
Type
SolverTypeEnum
Access
Read/Write
SupportsGroundPlane
Type
boolean
Access
Read/Write
Tooltip
Type
string
Access
Read/Write
UniqueLabel
Type
string
Access
Read only

Method Details

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.

Method Details (internal only)

Create ()
Return
Geometry

Static Function Details

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