`ComponentLibrary`

INTERNAL: The component library.

Usage locations (object properties)

The following objects have properties using the ComponentLibrary object:

Application(.ComponentLibrary)

Property List

Type: The object type string. (Read only string)

Method List (internal only)

AddAntennaElementToExistingModel (label string, frequency number, solvertype string, addconfigurations string, addgroundplane boolean): INTERNAL: Adds an antenna with the specified label from the component library to the existing model. (Returns a Geometry object.)
AddAntennaElementToExistingModelWhichFails (label string, frequency number, solvertype string, addconfigurations string, addgroundplane boolean): INTERNAL: Adds an antenna with the specified label from the component library to the existing model. This will fail with an error after the antenna is created. (Returns a Geometry object.)
AddPlatformElementToExistingModel (label string): INTERNAL: Adds a platform with the specified label from the component library to the existing model. (Returns a Geometry object.)
AddPlatformElementToExistingModelWhichFails (label string): INTERNAL: Adds a platform with the specified label from the component library to the existing model. This will fail with an error after the platform is created. (Returns a Geometry object.)
CreateAntennaElementInNewModel (label string, frequency number, solvertype string, addconfigurations string, addgroundplane boolean): INTERNAL: Creates an antenna with the specified label from the component library in a new model. (Returns a Geometry object.)
CreateAntennaElementInNewModelWhichFails (label string, frequency number, solvertype string, addconfigurations string, addgroundplane boolean): INTERNAL: Creates an antenna with the specified label from the component library in a new model. This will fail with an error after the antenna is created. (Returns a Geometry object.)
CreatePlatformElementInNewModel (label string): INTERNAL: Creates a platform with the specified label from the component library in a new model. (Returns a Geometry object.)
CreatePlatformElementInNewModelWhichFails (label string): INTERNAL: Creates a platform with the specified label from the component library in a new model. This will fail with an error after the platform is created. (Returns a Geometry object.)
GetAntennaElementSupportedSolverTypesFor (label string): INTERNAL: Returns the supported solver type strings for the specified component. (Returns a List of string object.)
GetAntennaElements (): INTERNAL: Returns the labels of the antennas in the component library. (Returns a List of string object.)
GetElements (): INTERNAL: Returns the labels of the components in the component library. (Returns a List of string object.)
GetKeywordsFor (label string): INTERNAL: Returns the keywords for the specified component. (Returns a List of string object.)
GetPlatformElements (): INTERNAL: Returns the labels of the platforms in the component library. (Returns a List of string object.)
GetPrefixFor (label string): INTERNAL: Returns the prefix for the specified component. (Returns a string object.)
HasElement (label string): INTERNAL: Check to see if the component library has an element of the given label. (Returns a boolean object.)
HasGroundPlaneSupportForElement (label string): INTERNAL: Check to see if the component library element has ground plane support (whether it can be created with a ground plane). (Returns a boolean object.)

Property Details

Type

The object type string.

Type: string
Access: Read only

Method Details (internal only)

AddAntennaElementToExistingModel (label string, frequency number, solvertype string, addconfigurations string, addgroundplane boolean)

INTERNAL: Adds an antenna with the specified label from the component library to the existing model.

Input Parameters

label(string): The label of the antenna.
frequency(number): The frequency for the antenna to be created.
solvertype(string): The solver type string indicating the variant of the antenna to be used.
addconfigurations(string): Specify which configuration option should be used when adding the antenna.
addgroundplane(boolean): Specify whether a ground plane for the antenna should be added to the model.

Return

Geometry: The geometry of the created antenna.

AddAntennaElementToExistingModelWhichFails (label string, frequency number, solvertype string, addconfigurations string, addgroundplane boolean)

INTERNAL: Adds an antenna with the specified label from the component library to the existing model. This will fail with an error after the antenna is created.

Input Parameters

label(string): The label of the component.
frequency(number): The frequency for the antenna to be created.
solvertype(string): The solver type string indicating the variant of the antenna to be used.
addconfigurations(string): Specify which configuration option should be used when adding the antenna.
addgroundplane(boolean): Specify whether a ground plane for the antenna should be added to the model.

Return

Geometry: The geometry of the created antenna.

AddPlatformElementToExistingModel (label string)

INTERNAL: Adds a platform with the specified label from the component library to the existing model.

Input Parameters

label(string): The label of the platform.

Return

Geometry: The geometry of the created platform.

AddPlatformElementToExistingModelWhichFails (label string)

INTERNAL: Adds a platform with the specified label from the component library to the existing model. This will fail with an error after the platform is created.

Input Parameters

label(string): The label of the platform.

Return

Geometry: The geometry of the created platform.

CreateAntennaElementInNewModel (label string, frequency number, solvertype string, addconfigurations string, addgroundplane boolean)

INTERNAL: Creates an antenna with the specified label from the component library in a new model.

Input Parameters

label(string): The label of the antenna.
frequency(number): The frequency for the antenna to be created.
solvertype(string): The solver type string indicating the variant of the antenna to be used.
addconfigurations(string): Specify which configuration option should be used when adding the antenna.
addgroundplane(boolean): Specify whether a ground plane for the antenna should be added to the model.

Return

Geometry: The geometry of the created antenna.

CreateAntennaElementInNewModelWhichFails (label string, frequency number, solvertype string, addconfigurations string, addgroundplane boolean)

INTERNAL: Creates an antenna with the specified label from the component library in a new model. This will fail with an error after the antenna is created.

Input Parameters

label(string): The label of the antenna.
frequency(number): The frequency for the antenna to be created.
solvertype(string): The solver type string indicating the variant of the antenna to be used.
addconfigurations(string): Specify which configuration option should be used when adding the antenna.
addgroundplane(boolean): Specify whether a ground plane for the antenna should be added to the model.

Return

Geometry: The geometry of the created antenna.

CreatePlatformElementInNewModel (label string)

INTERNAL: Creates a platform with the specified label from the component library in a new model.

Input Parameters

label(string): The label of the platform.

Return

Geometry: The geometry of the created platform.

CreatePlatformElementInNewModelWhichFails (label string)

INTERNAL: Creates a platform with the specified label from the component library in a new model. This will fail with an error after the platform is created.

Input Parameters

label(string): The label of the platform.

Return

Geometry: The geometry of the created platform.

GetAntennaElementSupportedSolverTypesFor (label string)

INTERNAL: Returns the supported solver type strings for the specified component.

Input Parameters

label(string): The label of the component.

Return

List of string: The solver type strings.

GetAntennaElements ()

INTERNAL: Returns the labels of the antennas in the component library.

Return

List of string: The antenna labels.

GetElements ()

INTERNAL: Returns the labels of the components in the component library.

Return

List of string: The component labels.

GetKeywordsFor (label string)

INTERNAL: Returns the keywords for the specified component.

Input Parameters

label(string): The label of the component.

Return

List of string: The table of keyword strings.

GetPlatformElements ()

INTERNAL: Returns the labels of the platforms in the component library.

Return

List of string: The platform labels.

GetPrefixFor (label string)

INTERNAL: Returns the prefix for the specified component.

Input Parameters

label(string): The label of the component.

Return

string: The prefix string.

HasElement (label string)

INTERNAL: Check to see if the component library has an element of the given label.

Input Parameters

label(string): The label of the component.

Return

boolean: Returns true if the component library has an element of the given label.

HasGroundPlaneSupportForElement (label string)

INTERNAL: Check to see if the component library element has ground plane support (whether it can be created with a ground plane).

Input Parameters

label(string): The label of the component.

Return

boolean: Returns true if the component library has ground plane support.