SchematicCollection

A collection of schematic views.

Example

app = cf.GetApplication()
project = app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/Cables.cfx]])

    -- Show the cable schematic for the first cable harness
    
app.Schematics:ShowCableSchematic(project.Cables.Harnesses[1])

    -- Show the network schematic
    
app.Schematics:ShowNetworkSchematic()

Usage locations (collections)

The following objects contain the SchematicCollection collection:

Property List

Count
The number of Schematic items in the collection. (Read only number)
Type
The object type string. (Read only string)

Method List

Contains (label string)
Checks if the collection contains an item with the given label. (Returns a boolean object.)
Item (index number)
Returns the Schematic at the given index. (Returns a Schematic object.)
Item (label string)
Returns the Schematic with the given label. (Returns a Schematic object.)
Items ()
Returns a table of Schematic. (Returns a List of Schematic object.)
ShowCableSchematic (cableharness CableHarness)
Show the cable schematic view for the specified cable harness.
ShowNetworkSchematic ()
Show the network schematic view.
UniqueName (label string)
Generates a unique name base of of the provided base name.If the base name already exists in the collection, a digit will be appended until a valid name is generated. (Returns a boolean object.)

Index List

[number]
Returns the Schematic at the given index in the collection. (Read Schematic)
[string]
Returns the Schematic with the given name in the collection. (Read Schematic)

Property Details

Count
The number of Schematic items in the collection.
Type
number
Access
Read only
Type
The object type string.
Type
string
Access
Read only

Method Details

Contains (label string)
Checks if the collection contains an item with the given label.
Input Parameters
label(string)
The label of the Schematic.
Return
boolean
The success of the check.
Item (index number)
Returns the Schematic at the given index.
Input Parameters
index(number)
The index of the Schematic.
Return
Schematic
The Schematic at the given index.
Item (label string)
Returns the Schematic with the given label.
Input Parameters
label(string)
The label of the Schematic.
Return
Schematic
The Schematic with the given label.
Items ()
Returns a table of Schematic.
Return
List of Schematic
A table of Schematic.
ShowCableSchematic (cableharness CableHarness)
Show the cable schematic view for the specified cable harness.
Input Parameters
cableharness(CableHarness)
The cable harness.
ShowNetworkSchematic ()
Show the network schematic view.
UniqueName (label string)
Generates a unique name base of of the provided base name.If the base name already exists in the collection, a digit will be appended until a valid name is generated.
Input Parameters
label(string)
The base name.
Return
boolean
The generated unique name label for Schematic.