CableGeneralNetwork
A cable general network component.
Example
app = cf.GetApplication() project = app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/Cables.cfx]]) -- Add 'CableGeneralNetwork' with 4 ports referencing a file cableHarness = project.Cables.Harnesses["CableHarness1"] network = cableHarness.SchematicComponents:AddGeneralNetwork(4, "GeneralCircuitFile") -- Change the number of pins the 'CableGeneralNetwork' has to 2 cableHarness.SchematicComponents["Circuit1"].NumberOfPorts = 4
Inheritance
The CableGeneralNetwork object is derived from the CableSchematicComponent object.
Property List
- Filename
- The file containing the contents of the general circuit touchstone file. (Read/Write string)
- Label
- The object label. (Read/Write string)
- NumberOfPorts
- The number of ports on the general networks. (Read/Write number)
- Position
- The schematic symbol position. (Read only SchematicSymbolPosition)
- Type
- The object type string. (Read only string)
Collection List
- Terminals
- The collection of schematic terminals on the symbol. (TerminalCollection of Terminal.)
Method List
- Delete ()
- Deletes the component from the cable schematic.
- 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.)
- Rotate ()
- Rotates the symbol 90 degrees clockwise.
- 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.
Static Function List
- GetDefaultProperties ()
- Creates a table containing the default settings to create an object. (Returns a table object.)
Property Details
- Filename
- The file containing the contents of the general circuit touchstone file.
- Type
- string
- Access
- Read/Write
- Label
- The object label.
- Type
- string
- Access
- Read/Write
- NumberOfPorts
- The number of ports on the general networks.
- Type
- number
- Access
- Read/Write
- Position
- The schematic symbol position.
- Type
- SchematicSymbolPosition
- Access
- Read only
- Type
- The object type string.
- Type
- string
- Access
- Read only
Collection Details
- Terminals
- The collection of schematic terminals on the symbol.
- Type
- TerminalCollection
Method Details
- Delete ()
- Deletes the component from the cable schematic.
- 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.
- Rotate ()
- Rotates the symbol 90 degrees clockwise.
- 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.
Static Function Details
- GetDefaultProperties ()
- Creates a table containing the default settings to create an object.
- Return
- table
- The default properties table.