Schematic

Example

application = cf.Application.getInstance()
project = application:NewProject()

    -- Obtain a 'Schematic' object

application.MainWindow.MdiArea:CreateGeneralNetworkSchematicView()
schematic = application.MainWindow.MdiArea:Item(1)

    -- Close the schematic

application.MainWindow.MdiArea:CloseWindow(schematic)

Inheritance

The Schematic object is derived from the Object object.

Usage locations

The Schematic object can be accessed from the following locations:

• Properties
  • Capacitor object has property Schematic.
  • Ground object has property Schematic.
  • Resistor object has property Schematic.
  • CableConnector object has property Schematic.
  • CableGeneralNetwork object has property Schematic.
  • CableSchematicCurrentProbe object has property Schematic.
  • CableSchematicVoltageProbe object has property Schematic.
  • CableSpiceNetwork object has property Schematic.
  • ComplexLoad object has property Schematic.
  • Inductor object has property Schematic.
  • Transformer object has property Schematic.
  • VoltageControlledVoltageSource object has property Schematic.
  • CablePort object has property Schematic.
  • EdgeMeshPort object has property Schematic.
  • EdgePort object has property Schematic.
  • AbstractFEMLinePort object has property Schematic.
  • FEMLineMeshPort object has property Schematic.
  • FEMLinePort object has property Schematic.
  • MicrostripMeshPort object has property Schematic.
  • WireMeshPort object has property Schematic.
  • MicrostripPort object has property Schematic.
  • WirePort object has property Schematic.
  • GeneralNetwork object has property Schematic.
  • TransmissionLine object has property Schematic.

Property List

Label

The object label. (Read/Write string)

SchematicItems

The list of schematic components on the schematic. (Read only List of Object)

Type

The object type string. (Read only string)

Collection List

Nets

The nets on the schematic. (NetCollection of Net.)

Terminals

The collection of terminals on the schematic. (TerminalCollection of Terminal.)

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

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.

Static Function List

GetDefaultProperties ()

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

Property Details

Label

The object label.

Type

string

Access

Read/Write

SchematicItems

The list of schematic components on the schematic.

Access

Read only

Type

The object type string.

Type

string

Access

Read only

Collection Details

Nets

The nets on the schematic.

Type

NetCollection

Terminals

The collection of terminals on the schematic.

Type

TerminalCollection

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.

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.

Static Function Details

GetDefaultProperties ()

Creates a table containing the default settings to create an object.

Return

table

A table containing the default properties.