NetworkCollection

A collection of non-radiating networks.

Example

app = cf.GetApplication()
project = app:NewProject()

    -- Use the network collection to add a transmission line

networkCollection = project.SolutionConfigurations[1].Networks
networkCollection:AddTransmissionLine(10, 50, 25, 10)

Usage locations (collections)

The following objects contain the NetworkCollection 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

AddGeneralNetwork (type GeneralNetworkDataTypeEnum, terminalcount number, filename string)
Create a general network from data stored in either a Touchstone or SPICE circuit file. (Returns a GeneralNetwork object.)
AddGeneralNetwork (type GeneralNetworkDataTypeEnum, terminalcount number, real List of List of Expression, imaginary List of List of Expression)
Create a manually specified general network. (Returns a GeneralNetwork object.)
AddGeneralNetwork (properties table)
Create a general network from a table defining the properties. (Returns a GeneralNetwork object.)
AddTransmissionLine (linelength Expression, real Expression, imaginary Expression, attenuation Expression)
Create a transmission line with Z0, length and attenuation specified. This will set the DefinitionMethod to “SpecifiedAttenuation”. (Returns a TransmissionLine object.)
AddTransmissionLine (linelength Expression, real Expression, imaginary Expression, attenuation Expression, velocity Expression)
Create a transmission line with Z0, length, attenuation and VOP specified. This will set the DefinitionMethod to “VelocityOfPropagation”. (Returns a TransmissionLine object.)
AddTransmissionLine (linelength Expression, real Expression, imaginary Expression, medium Dielectric)
Create a transmission line with Z0, length and medium specified. This will set the DefinitionMethod to “MediumAttenuation”. (Returns a TransmissionLine object.)
AddTransmissionLine (properties table)
Create a transmission line from a table defining the properties. (Returns a TransmissionLine 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

AddGeneralNetwork (type GeneralNetworkDataTypeEnum, terminalcount number, filename string)
Create a general network from data stored in either a Touchstone or SPICE circuit file.
Input Parameters
type(GeneralNetworkDataTypeEnum)
The network data type.
terminalcount(number)
The number of network terminals.
filename(string)
The Touchstone or SPICE circuit filename.
Return
GeneralNetwork
The general network.
AddGeneralNetwork (type GeneralNetworkDataTypeEnum, terminalcount number, real List of List of Expression, imaginary List of List of Expression)
Create a manually specified general network.
Input Parameters
type(GeneralNetworkDataTypeEnum)
The data type specified by the NetworkDataTypeEnum. e.g. SMatrix, ZMatrix or YMatrix.
terminalcount(number)
The number of network terminals.
real(List of List of Expression)
The 2D table of coupling parameter real value expressions.
imaginary(List of List of Expression)
The 2D table of coupling parameter imaginary value expressions.
Return
GeneralNetwork
The general network.
AddGeneralNetwork (properties table)
Create a general network from a table defining the properties.
Input Parameters
properties(table)
A table of properties defining the new general network.
Return
GeneralNetwork
The general network.
AddTransmissionLine (linelength Expression, real Expression, imaginary Expression, attenuation Expression)
Create a transmission line with Z0, length and attenuation specified. This will set the DefinitionMethod to “SpecifiedAttenuation”.
Input Parameters
linelength(Expression)
The transmission line length.
real(Expression)
The transmission line real impedance (Ohm).
imaginary(Expression)
The transmission line imaginary impedance (Ohm).
attenuation(Expression)
The transmission attenuation (dB/m).
Return
TransmissionLine
The transmission line.
AddTransmissionLine (linelength Expression, real Expression, imaginary Expression, attenuation Expression, velocity Expression)
Create a transmission line with Z0, length, attenuation and VOP specified. This will set the DefinitionMethod to “VelocityOfPropagation”.
Input Parameters
linelength(Expression)
The transmission line length.
real(Expression)
The transmission line real impedance (Ohm).
imaginary(Expression)
The transmission line imaginary impedance (Ohm).
attenuation(Expression)
The transmission attenuation (dB/m).
velocity(Expression)
.
Return
TransmissionLine
The transmission line.
AddTransmissionLine (linelength Expression, real Expression, imaginary Expression, medium Dielectric)
Create a transmission line with Z0, length and medium specified. This will set the DefinitionMethod to “MediumAttenuation”.
Input Parameters
linelength(Expression)
The transmission line length.
real(Expression)
The transmission line real impedance (Ohm).
imaginary(Expression)
The transmission line imaginary impedance (Ohm).
medium(Dielectric)
.
Return
TransmissionLine
The transmission line.
AddTransmissionLine (properties table)
Create a transmission line from a table defining the properties.
Input Parameters
properties(table)
A table of properties defining the new transmission line.
Return
TransmissionLine
The transmission line.
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.