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 Network object.
Usage locations
The GeneralNetwork object can be accessed from the following locations:
- Methods
- NetworkCollection collection has method AddGeneralNetwork(table).
- NetworkCollection collection has method AddGeneralNetwork(GeneralNetworkDataTypeEnum, number, string).
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/Write ParametricComplexExpressionTable)
- DataType
- The type of data for the general network. (Read/Write GeneralNetworkDataTypeEnum)
- Filename
- The Touchstone or SPICE filename that describes the network. (Read/Write FileReference)
- Label
- The object label. (Read/Write string)
- SPICEPortReference
- Specifies the port reference of the SPICE file. (Read/Write GeneralNetworkSPICEPortReferenceEnum)
- Schematic
- The schematic associated with this item. (Read only Schematic)
- SchematicLocation
- The location of the item on the schematic. (Read only GridLocation)
- SchematicRotation
- The rotation of the item on the schematic. (Read only SymbolRotationEnum)
- Source
- Specifies the source of the data for the general network. (Read/Write GeneralNetworkSourceEnum)
- TerminalCount
- The number of terminals. (Read/Write number)
- Terminals
- The schematic terminals on this item. (Read only List of Terminal)
- Type
- The object type string. (Read only string)
Method List
- 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.)
- RotateSchematicSymbol ()
- Rotates the item on the schematic.
- 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.
- SetSchematicLocation (location GridLocation)
- Sets the location of the item on the schematic.
- SetSchematicRotation (rotation SymbolRotationEnum)
- Sets the rotation of the item on the schematic.
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
- ParametricComplexExpressionTable
- Access
- Read/Write
- 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
- FileReference
- 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
- Schematic
- The schematic associated with this item.
- Type
- Schematic
- Access
- Read only
- SchematicLocation
- The location of the item on the schematic.
- Type
- GridLocation
- Access
- Read only
- SchematicRotation
- The rotation of the item on the schematic.
- Type
- SymbolRotationEnum
- Access
- Read only
- 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
- Terminals
- The schematic terminals on this item.
- Access
- Read only
- Type
- The object type string.
- Type
- string
- Access
- Read only
Method Details
- 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.
- RotateSchematicSymbol ()
- Rotates the item on the schematic.
- 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.
- SetSchematicLocation (location GridLocation)
- Sets the location of the item on the schematic.
- Input Parameters
- location(GridLocation)
- The schematic location the item should be moved to.
- SetSchematicRotation (rotation SymbolRotationEnum)
- Sets the rotation of the item on the schematic.
- Input Parameters
- rotation(SymbolRotationEnum)
- The rotation setting.
Static Function Details
- GetDefaultProperties ()
- Creates a table containing the default settings to create an object.
- Return
- table
- A table containing the default properties.