LoadCollection
A collection of loads.
Example
application = cf.Application.GetInstance() project = application:NewProject() -- Get the 'LoadCollection' from the 'SolutionConfiguration' loadCollection = project.Contents.SolutionConfigurations.GlobalLoads -- Add a complex load to the collection. dielectric = project.Definitions.Media.Dielectric:AddDielectric() cube = project.Contents.Geometry:AddCuboid(cf.Point(0, 0, 0), 1, 1, 1) cube.Regions[1].Medium = dielectric cube.Regions[1].SolutionMethod = cf.Enums.RegionSolutionMethodEnum.FEM femLinePort = project.Contents.Ports:AddFEMLinePortBetweenPoints(cf.Point(0,0,0) ,cf.Point(1,1,0) ) complexLoad = loadCollection:AddComplex(femLinePort,"220","0") -- Query the number of loads in the collection numberOfLoads = #loadCollection
Inheritance
The LoadCollection object is derived from the AbstractModifiableCollection object.
Usage locations
The LoadCollection object can be accessed from the following locations:
- Collection lists
- SolutionConfigurationCollection collection has collection GlobalLoads.
- SolutionConfiguration object has collection Loads.
- CharacteristicModesConfiguration object has collection Loads.
- SParameterConfiguration object has collection Loads.
- StandardConfiguration object has collection Loads.
Property List
Method List
- AddComplex (portterminal Port, 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 Port, resistance Expression, capacitance Expression, inductance Expression)
- Create a load on the specified terminal with parallel circuit configuration. (Returns a Load object.)
- AddSeries (portterminal Port, resistance Expression, capacitance Expression, inductance Expression)
- Create a load on the specified terminal with series circuit configuration. (Returns a Load object.)
- AddSinglePortTouchstone (portterminal Port, filename string)
- Create a load on the specified terminal from data stored in a 1-port Touchstone file. (Returns a Load object.)
- AddSpiceCircuit (portterminal Port, filename string)
- Create a load on the specified terminal from data stored in a SPICE circuit file. (Returns a Load 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.)
- Item (index number)
- Returns the Load for the given index in the collection. (Returns a Load object.)
- Item (label string)
- Returns the Load for the given label in the collection. (Returns a Load object.)
- Items ()
- Returns a table of Load items. (Returns a UnsupportedType(List of Load) 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
Method Details
- AddComplex (portterminal Port, real Expression, imaginary Expression)
- Create a load on the specified terminal with complex impedance.
- Input Parameters
- portterminal(Port)
- 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.
- AddParallel (portterminal Port, resistance Expression, capacitance Expression, inductance Expression)
- Create a load on the specified terminal with parallel circuit configuration.
- Input Parameters
- portterminal(Port)
- 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 Port, resistance Expression, capacitance Expression, inductance Expression)
- Create a load on the specified terminal with series circuit configuration.
- Input Parameters
- portterminal(Port)
- 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 Port, filename string)
- Create a load on the specified terminal from data stored in a 1-port Touchstone file.
- AddSpiceCircuit (portterminal Port, filename string)
- Create a load on the specified terminal from data stored in a SPICE circuit file.
- 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.
- Item (index number)
- Returns the Load for the given index in the collection.
- Item (label string)
- Returns the Load for the given label in the collection.
- Items ()
- Returns a table of Load items.
- Return
- UnsupportedType(List of Load)
- The list of items in the collection
- 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.