SchematicLinkCollection
A collection of schematic links that connects circuit elements on the schematic with the geometry model.
Example
application = cf.Application.GetInstance() project = application:Load({FEKO_HOME..[[/shared/Resources/Automation/Cable_Schematic_Link.cfx]]}) -- Access an existing 'CableHarness' CableHarness = project.Contents.CableHarnesses:Item("CableHarness1") -- Access an reference face referenceFace = project.Contents.Geometry:Item("Connector").Faces:Item("ReferenceFace") -- Creat a schematic link properties = cf.SchematicLink.GetDefaultProperties() properties.LinkProperties[1] = {} properties.LinkProperties[1].PinName = "W1" properties.LinkProperties[1].DefinitionMethod = cf.Enums.SchematicLinkDefinitionMethodEnum.Port w1Port = project.Contents.Ports:Item("W1Port") properties.LinkProperties[1].Terminal = w1Port properties.ReferenceFaces[1] = {} properties.ReferenceFaces[1] = referenceFace properties.Label = "SchematicLink" schematicLink1 = project.Contents.CableHarnesses:Item("CableHarness1").SchematicLinks:AddSchematicLink(properties)
Inheritance
The SchematicLinkCollection object is derived from the Object object.
Usage locations
The SchematicLinkCollection object can be accessed from the following locations:
- Collection lists
Property List
Method List
- 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 SchematicLink for the given index in the collection. (Returns a SchematicLink object.)
- Item (label string)
- Returns the SchematicLink for the given label in the collection. (Returns a SchematicLink object.)
- Items ()
- Returns a table of SchematicLink items. (Returns a UnsupportedType(List of SchematicLink) 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
Method Details
- Contains (label string)
- Checks if the collection contains an item with the given label.
- 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 SchematicLink for the given index in the collection.
- Input Parameters
- index(number)
- The index of the SchematicLink.
- Return
- SchematicLink
- The item in the collection
- Item (label string)
- Returns the SchematicLink for the given label in the collection.
- Input Parameters
- label(string)
- The label of the SchematicLink.
- Return
- SchematicLink
- The item in the collection
- Items ()
- Returns a table of SchematicLink items.
- Return
- UnsupportedType(List of SchematicLink)
- 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.
Static Function Details
- GetDefaultProperties ()
- Creates a table containing the default settings to create an object.
- Return
- table
- A table containing the default properties.