`SchematicSymbolCollection`

A collection of schematic symbols.

Example

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

app.Schematics:ShowCableSchematic(project.Cables.Harnesses[1])

    -- Use SchematicSymbolCollection to access the schematic symbols
    
schematicSymbolCollection = app.Schematics[1].Symbols
schematicSymbolCollection:Item(1):Rotate()

Usage locations (collections)

The following objects contain the SchematicSymbolCollection collection:

Schematic(.Symbols)

Property List

Count: The number of SchematicSymbol 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 SchematicSymbol at the given index. (Returns a SchematicSymbol object.)
Item (label string): Returns the SchematicSymbol with the given label. (Returns a SchematicSymbol object.)
Items (): Returns a table of SchematicSymbol. (Returns a List of SchematicSymbol object.)
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 SchematicSymbol at the given index in the collection. (Read SchematicSymbol)
[string]: Returns the SchematicSymbol with the given name in the collection. (Read SchematicSymbol)

Property Details

Count

The number of SchematicSymbol 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 SchematicSymbol.

Return

boolean: The success of the check.

Item (index number)

Returns the SchematicSymbol at the given index.

Input Parameters

index(number): The index of the SchematicSymbol.

Return

SchematicSymbol: The SchematicSymbol at the given index.

Item (label string)

Returns the SchematicSymbol with the given label.

Input Parameters

label(string): The label of the SchematicSymbol.

Return

SchematicSymbol: The SchematicSymbol with the given label.

Items ()

Returns a table of SchematicSymbol.

Return

List of SchematicSymbol: A table of SchematicSymbol.

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 SchematicSymbol.