SchematicLink

Define a connection between circuit element on the schematic and 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 SchematicLink object is derived from the Object object.

Usage locations

The SchematicLink object can be accessed from the following locations:

Property List

BoundingBox
A box indicating the bounding box of this entity. (Read only Box). (Read only Box)
Label
The object label. (Read/Write string)
LinkProperties
Specifies a the pin name associated with a port or a point. (Read/Write LinkPropertiesList)
ReferenceFaces
Refernce face on the geometry model. (Read/Write ObjectReferenceList)
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)
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

BoundingBox
A box indicating the bounding box of this entity. (Read only Box).
Type
Box
Access
Read only
Label
The object label.
Type
string
Access
Read/Write
LinkProperties
Specifies a the pin name associated with a port or a point.
Type
LinkPropertiesList
Access
Read/Write
ReferenceFaces
Refernce face on the geometry model.
Type
ObjectReferenceList
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
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.