`CableSchematic`

Inheritance

The CableSchematic object is derived from the Schematic object.

Usage locations

The CableSchematic object can be accessed from the following locations:

Properties
- CableHarness object has property CableSchematic.

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)

Property List (internal only)

DanglingComponents: (Read only List of Object)
Path: (Read only string)
Settings: (Read/Write CableSchematicSettings)
ShortedComponents: (Read only List of Object)

Collection List

Nets: The nets on the schematic. (NetCollection of Net.)
Terminals: The collection of terminals on the schematic. (TerminalCollection of Terminal.)

Collection List (internal only)

CircuitNodes: (CableCircuitNodeCollection of CableCircuitNode.)
Components: (CableSchematicComponentCollection of Object.)
GenericComponents: (ComponentCollection of Object.)
Nodes: (NodeCollection of Node.)

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.

Method List (internal only)

MoveItems ( List of Object, GridLocation)

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

Property Details (internal only)

DanglingComponents

Access: Read only

Path

Type: string
Access: Read only

Settings

Type: CableSchematicSettings
Access: Read/Write

ShortedComponents

Access: Read only

Collection Details

Nets

The nets on the schematic.

Type: NetCollection

Terminals

The collection of terminals on the schematic.

Type: TerminalCollection

Collection Details (internal only)

CircuitNodes

Type: CableCircuitNodeCollection

Components

Type: CableSchematicComponentCollection

GenericComponents

Type: ComponentCollection

Nodes

Type: NodeCollection

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.

Method Details (internal only)

MoveItems ( List of Object, GridLocation)

Input Parameters

(List of Object)
(GridLocation)

Static Function Details

GetDefaultProperties ()

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

Return

table: A table containing the default properties.