CableSpiceNetwork
A cable spice network component.
Example
app = cf.GetApplication() project = app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/Cables.cfx]]) -- Add 'CableSpiceNetwork' with 4 pins referencing a file cableHarness = project.Cables.Harnesses["CableHarness1"] resistor = cableHarness.SchematicComponents:AddSpiceNetworkFromFile(4, "SPICECircuitFile") -- Change the number of pins the 'CableSpiceNetwork' has to 2 cableHarness.SchematicComponents["Circuit1"].NumberOfPins = 2
Inheritance
The CableSpiceNetwork object is derived from the CableSchematicComponent object.
Property List
- AutoSubCircuitNameEnabled
- Enabled if the auto circuit name is used. (Read/Write boolean)
- Filename
- The file containing the contents of the spice circuit. This is only valid if the SpiceCircuitSource has the type File. (Read/Write string)
- Label
- The object label. (Read/Write string)
- ManualSource
- The contents of the spice circuit of the source is Manual. This is only valid if SpiceCircuitSource has the type Manual. (Read/Write string)
- NumberOfPins
- The number of pins in the spice networks. (Read/Write number)
- Position
- The schematic symbol position. (Read only SchematicSymbolPosition)
- SpiceCircuitSource
- The source of the spice network circuit. (Read/Write CableSpiceNetworkSourceTypeEnum)
- SubCircuitName
- The sub circuit name. (Read/Write string)
- 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
- AutoSubCircuitNameEnabled
- Enabled if the auto circuit name is used.
- Type
- boolean
- Access
- Read/Write
- Filename
- The file containing the contents of the spice circuit. This is only valid if the SpiceCircuitSource has the type File.
- Type
- string
- Access
- Read/Write
- Label
- The object label.
- Type
- string
- Access
- Read/Write
- ManualSource
- The contents of the spice circuit of the source is Manual. This is only valid if SpiceCircuitSource has the type Manual.
- Type
- string
- Access
- Read/Write
- NumberOfPins
- The number of pins in the spice networks.
- Type
- number
- Access
- Read/Write
- Position
- The schematic symbol position.
- Type
- SchematicSymbolPosition
- Access
- Read only
- SpiceCircuitSource
- The source of the spice network circuit.
- Type
- CableSpiceNetworkSourceTypeEnum
- Access
- Read/Write
- SubCircuitName
- The sub circuit name.
- Type
- string
- Access
- Read/Write
- 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.