`GeneralNetwork`

A general non-radiating network.

Example

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

    -- Set up 2D table to use for constructing 'GeneralNetwork'

real = {}
imaginary = {}

for n=1,2 do
  real[n] = {}
  imaginary[n] = {}
  for m=1,2 do
    real[n][m] = 50
    imaginary[n][m] = 0
  end
end

    -- Create a 'GeneralNetwork' with two terminals

networks = project.SolutionConfigurations["StandardConfiguration1"].Networks
networks:AddGeneralNetwork(cf.Enums.GeneralNetworkDataTypeEnum.SMatrix, 2, real, imaginary)

    -- Configure the 'GeneralNetwork' to use a SPICENetwork

properties = networks["GeneralNetwork1"]:GetProperties()
properties.DataType = cf.Enums.GeneralNetworkDataTypeEnum.SPICENetwork
properties.Filename = "SPICE_file.cir"
networks["GeneralNetwork1"]:SetProperties(properties)

Inheritance

The GeneralNetwork object is derived from the SolutionEntity object.

Property List

CircuitName: The SPICE Circuit name. Setting disables the automatic generation of the name. (Read/Write string)
CouplingParameters: The general network's coupling parameters when specified manually. (Read only GeneralNetworkCouplingParameters)
DataType: The type of data for the general network. (Read/Write GeneralNetworkDataTypeEnum)
Filename: The Touchstone or SPICE filename that describes the network. (Read/Write string)
Included: Specifies whether the solution entity must be included or excluded. (Read/Write boolean)
Label: The object label. (Read/Write string)
SPICEPortReference: Specifies the port reference of the SPICE file. (Read/Write GeneralNetworkSPICEPortReferenceEnum)
Source: Specifies the source of the data for the general network. (Read/Write GeneralNetworkSourceEnum)
TerminalCount: The number of terminals. (Read/Write number)
Type: The object type string. (Read only string)
Visible: Specifies whether the solution entity must be shown or hidden. (Read/Write boolean)

Collection List

Terminals: The collection of terminals on the general network. (GeneralNetworkTerminalCollection of Terminal.)

Method List

Delete (): Delete the solution entity.
Duplicate (): Duplicate the solution entity. (Returns a SolutionEntity object.)
GetCouplingParametersImaginary (): Get the square table of expressions for the imaginary values of the coupling parameters. (Returns a List of List of Expression object.)
GetCouplingParametersReal (): Get the square table of expressions for the real values of the coupling parameters. (Returns a List of List of Expression 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.)
GetReferenceImpedances (): Get the reference impedance values. Only valid when DataType is SMatrix. (Returns a List of Expression object.)
SetCouplingParameters (numterminals number, realvalues List of List of Expression, imaginaryvalues List of List of Expression): Set the coupling parameters from a 2D table of expressions.
SetProperties (properties table): 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.
SetReferenceImpedances (expressions List of Expression): Set the reference impedance values. Only valid when DataType is SMatrix.

Static Function List

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

Property Details

CircuitName

The SPICE Circuit name. Setting disables the automatic generation of the name.

Type: string
Access: Read/Write

CouplingParameters

The general network's coupling parameters when specified manually.

Type: GeneralNetworkCouplingParameters
Access: Read only

DataType

The type of data for the general network.

Type: GeneralNetworkDataTypeEnum
Access: Read/Write

Filename

The Touchstone or SPICE filename that describes the network.

Type: string
Access: Read/Write

Included

Specifies whether the solution entity must be included or excluded.

Type: boolean
Access: Read/Write

Label

The object label.

Type: string
Access: Read/Write

SPICEPortReference

Specifies the port reference of the SPICE file.

Type: GeneralNetworkSPICEPortReferenceEnum
Access: Read/Write

Source

Specifies the source of the data for the general network.

Type: GeneralNetworkSourceEnum
Access: Read/Write

TerminalCount

The number of terminals.

Type: number
Access: Read/Write

Type

The object type string.

Type: string
Access: Read only

Visible

Specifies whether the solution entity must be shown or hidden.

Type: boolean
Access: Read/Write

Collection Details

Terminals

The collection of terminals on the general network.

Type: GeneralNetworkTerminalCollection

Method Details

Delete ()

Delete the solution entity.

Duplicate ()

Duplicate the solution entity.

Return

SolutionEntity: The duplicated entity.

GetCouplingParametersImaginary ()

Get the square table of expressions for the imaginary values of the coupling parameters.

Return

List of List of Expression: The square table of expressions for the imaginary values of the coupling parameters.

GetCouplingParametersReal ()

Get the square table of expressions for the real values of the coupling parameters.

Return

List of List of Expression: The square table of expressions for the real values of the coupling parameters.

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 properties table.

GetReferenceImpedances ()

Get the reference impedance values. Only valid when DataType is SMatrix.

Return

List of Expression: A table containing the reference impedances.

SetCouplingParameters (numterminals number, realvalues List of List of Expression, imaginaryvalues List of List of Expression)

Set the coupling parameters from a 2D table of expressions.

Input Parameters

numterminals(number): The number of port terminals.
realvalues(List of List of Expression): The square 2D table containing the coupling parameters real values.
imaginaryvalues(List of List of Expression): The square 2D table containing the coupling parameters imaginary values.

SetProperties (properties table)

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(table): A table of properties defining the new state of the object.

SetReferenceImpedances (expressions List of Expression)

Set the reference impedance values. Only valid when DataType is SMatrix.

Input Parameters

expressions(List of Expression): The list of expressions containing the reference impedance values.

Static Function Details

GetDefaultProperties ()

Creates a table containing the default settings to create an object.

Return

table: The default properties table.