CableSpiceNetwork
A cable spice network component.
Example
application = cf.Application.GetInstance() project = application:Load({FEKO_HOME..[[/shared/Resources/Automation/Cables.cfx]]}) -- Add 'CableSpiceNetwork' with 4 pins referencing a file cableHarness = project.Contents.CableHarnesses["CableHarness1"] resistor = cableHarness.CableSchematic.Components:AddSpiceNetworkFromFile(4, "SPICECircuitFile") -- Change the number of pins the 'CableSpiceNetwork' has to 2 cableHarness.CableSchematic.Components["Circuit1"].NumberOfPins = 2
Inheritance
The CableSpiceNetwork object is derived from the Object object.
Usage locations
The CableSpiceNetwork object can be accessed from the following locations:
- Methods
- CableSchematicComponentCollection collection has method AddSpiceNetwork(table).
- CableSchematicComponentCollection collection has method AddSpiceNetworkFromFile(number, string).
- CableSchematicComponentCollection collection has method AddSpiceNetwork(number, string).
Property List
- Filename
- The file containing the contents of the spice circuit. This is only valid if the SpiceCircuitSource has the type File. (Read/Write FileReference)
- 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)
- 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)
- SpiceCircuitSource
- The source of the spice network circuit. (Read/Write CableSpiceNetworkSourceTypeEnum)
- SubCircuitName
- The sub circuit name. (Read/Write string)
- 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
- Filename
- The file containing the contents of the spice circuit. This is only valid if the SpiceCircuitSource has the type File.
- Type
- FileReference
- 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
- 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
- SpiceCircuitSource
- The source of the spice network circuit.
- Type
- CableSpiceNetworkSourceTypeEnum
- Access
- Read/Write
- SubCircuitName
- The sub circuit name.
- Type
- string
- 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.