LoadCollection

A collection of loads.

Example

app = cf.GetApplication()
project = app:NewProject()
standardConfiguration = project.SolutionConfigurations['StandardConfiguration1']

    -- Get the 'LoadCollection' from the 'SolutionConfiguration'

loadCollection = standardConfiguration.Loads

    --  Add a complex load to the collection.
    
femLinePort = project.Ports:AddFEMLinePortBetweenPoints(cf.Point(0,0,0) ,cf.Point(1,1,0) )
complexLoad = loadCollection:AddComplex(femLinePort.Terminal,"220","0")

    --  Query the number of loads in the collection
    
numberOfLoads = #loadCollection

Usage locations (collections)

The following objects contain the LoadCollection collection:

Property List

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

Method List

AddComplex (portterminal TerminalType, real Expression, imaginary Expression)
Create a load on the specified terminal with complex impedance. (Returns a Load object.)
AddLoad (properties table)
Create a load using the table of properties. (Returns a Load object.)
AddParallel (portterminal TerminalType, resistance Expression, capacitance Expression, inductance Expression)
Create a load on the specified terminal with parallel circuit configuration. (Returns a Load object.)
AddSeries (portterminal TerminalType, resistance Expression, capacitance Expression, inductance Expression)
Create a load on the specified terminal with series circuit configuration. (Returns a Load object.)
AddSinglePortTouchstone (portterminal TerminalType, filename string)
Create a load on the specified terminal from data stored in a 1-port Touchstone file. (Returns a Load object.)
AddSpiceCircuit (portterminal TerminalType, filename string)
Create a load on the specified terminal from data stored in a SPICE circuit file. (Returns a Load object.)
Contains (label string)
Checks if the collection contains an item with the given label. (Returns a boolean object.)
Item (index number)
Returns the SolutionEntity at the given index. (Returns a SolutionEntity object.)
Item (label string)
Returns the SolutionEntity with the given label. (Returns a SolutionEntity object.)
Items ()
Returns a table of SolutionEntity. (Returns a List of SolutionEntity 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 SolutionEntity at the given index in the collection. (Read SolutionEntity)
[string]
Returns the SolutionEntity with the given name in the collection. (Read SolutionEntity)

Property Details

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

Method Details

AddComplex (portterminal TerminalType, real Expression, imaginary Expression)
Create a load on the specified terminal with complex impedance.
Input Parameters
portterminal(TerminalType)
The terminal to create the load on.
real(Expression)
The real part of the complex impedance (Ohm).
imaginary(Expression)
The reactive part of the complex impedance (Ohm).
Return
Load
The load.
AddLoad (properties table)
Create a load using the table of properties.
Input Parameters
properties(table)
The table of properties.
Return
Load
The load.
AddParallel (portterminal TerminalType, resistance Expression, capacitance Expression, inductance Expression)
Create a load on the specified terminal with parallel circuit configuration.
Input Parameters
portterminal(TerminalType)
The terminal to create the load on.
resistance(Expression)
The resistive part of the parallel circuit load definition (Ohm).
capacitance(Expression)
The capacitive part of the parallel circuit load definition (F).
inductance(Expression)
The inductive part of the parallel circuit load definition (H).
Return
Load
The load source.
AddSeries (portterminal TerminalType, resistance Expression, capacitance Expression, inductance Expression)
Create a load on the specified terminal with series circuit configuration.
Input Parameters
portterminal(TerminalType)
The terminal to create the load on.
resistance(Expression)
The resistive part of the series circuit load definition (Ohm).
capacitance(Expression)
The capacitive part of the series circuit load definition (F).
inductance(Expression)
The inductive part of the series circuit load definition (H).
Return
Load
The load source.
AddSinglePortTouchstone (portterminal TerminalType, filename string)
Create a load on the specified terminal from data stored in a 1-port Touchstone file.
Input Parameters
portterminal(TerminalType)
The terminal to create the load on.
filename(string)
The Touchstone filename.
Return
Load
The load source.
AddSpiceCircuit (portterminal TerminalType, filename string)
Create a load on the specified terminal from data stored in a SPICE circuit file.
Input Parameters
portterminal(TerminalType)
The terminal to create the load on.
filename(string)
The SPICE circuit filename.
Return
Load
The load source.
Contains (label string)
Checks if the collection contains an item with the given label.
Input Parameters
label(string)
The label of the SolutionEntity.
Return
boolean
The success of the check.
Item (index number)
Returns the SolutionEntity at the given index.
Input Parameters
index(number)
The index of the SolutionEntity.
Return
SolutionEntity
The SolutionEntity at the given index.
Item (label string)
Returns the SolutionEntity with the given label.
Input Parameters
label(string)
The label of the SolutionEntity.
Return
SolutionEntity
The SolutionEntity with the given label.
Items ()
Returns a table of SolutionEntity.
Return
List of SolutionEntity
A table of SolutionEntity.
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 SolutionEntity.