NetCollection

The collection on nets on a schematic.

Example

application = cf.Application.GetInstance()
project = application:Load({FEKO_HOME..[[/shared/Resources/Automation/Cables.cfx]]})

    -- Create the schematic view

harness = project.Contents.CableHarnesses[1]
schematicView = application.MainWindow.MdiArea:CreateCableSchematicView(harness)

    -- Add some nets

net1 = harness.CableSchematic.Nets:AddNet({-8, -1}, {-8, 13})
net2 = harness.CableSchematic.Nets:AddNet({-8, 13}, {-7, 13})

Inheritance

The NetCollection object is derived from the Object object.

Usage locations

The NetCollection object can be accessed from the following locations:

Property List

Count
The number of Net items in the collection. (Read only number)
Label
The object label. (Read/Write string)
Type
The object type string. (Read only string)

Method List

AddNet (start GridLocation, end GridLocation)
Adds a net between the given locations. (Returns a Net object.)
AddNet (start Terminal, end Terminal)
Adds a net between the specified terminals. (Returns a Net object.)
AddNet (path List of GridLocation)
Adds a net along the given path. (Returns a Net object.)
Contains (label string)
Checks if the collection contains an item with the given label. (Returns a boolean object.)
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.)
Item (index number)
Returns the Net for the given index in the collection. (Returns a Net object.)
Item (label string)
Returns the Net for the given label in the collection. (Returns a Net object.)
Items ()
Returns a table of Net items. (Returns a UnsupportedType(List of Net) object.)
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.
UniqueName (label string)
Generates a unique name base 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 string object.)

Static Function List

GetDefaultProperties ()
Creates a table containing the default settings to create an object. (Returns a table object.)

Property Details

Count
The number of Net items in the collection.
Type
number
Access
Read only
Label
The object label.
Type
string
Access
Read/Write
Type
The object type string.
Type
string
Access
Read only

Method Details

AddNet (start GridLocation, end GridLocation)
Adds a net between the given locations.
Input Parameters
start(GridLocation)
The start location.
end(GridLocation)
The end location.
Return
Net
The new net.
AddNet (start Terminal, end Terminal)
Adds a net between the specified terminals.
Input Parameters
start(Terminal)
The start location of the net.
end(Terminal)
The end location of the net.
Return
Net
The new net between the terminals.
AddNet (path List of GridLocation)
Adds a net along the given path.
Input Parameters
path(List of GridLocation)
A list of grid locations.
Return
Net
The new net.
Contains (label string)
Checks if the collection contains an item with the given label.
Input Parameters
label(string)
The label of the item.
Return
boolean
The success of the check.
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.
Item (index number)
Returns the Net for the given index in the collection.
Input Parameters
index(number)
The index of the Net.
Return
Net
The item in the collection
Item (label string)
Returns the Net for the given label in the collection.
Input Parameters
label(string)
The label of the Net.
Return
Net
The item in the collection
Items ()
Returns a table of Net items.
Return
UnsupportedType(List of Net)
The list of items in the collection
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.
UniqueName (label string)
Generates a unique name base 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
string
The generated unique name label for the item.

Static Function Details

GetDefaultProperties ()
Creates a table containing the default settings to create an object.
Return
table
A table containing the default properties.