DeviceGround
A cable device ground component.
Example
application = cf.Application.GetInstance() project = application:Load({FEKO_HOME..[[/shared/Resources/Automation/Cables.cfx]]}) -- Add a ground to the schematic cableHarness = project.Contents.CableHarnesses["CableHarness1"] terminal1 = cableHarness.Connectors["CableConnector2"].Pins["Pin2"].Terminal ground = cableHarness.CableSchematic.Components:AddDeviceGround(terminal1) ground.ShortToInstallation = true -- Get the terminals that the ground component is connected to terminalList = cableHarness.CableSchematic.Components["DeviceGround1"].Terminals
Inheritance
The DeviceGround object is derived from the Object object.
Usage locations
The DeviceGround object can be accessed from the following locations:
- Methods
- CableSchematicComponentCollection collection has method AddDeviceGround().
- CableSchematicComponentCollection collection has method AddDeviceGroundAtLocation(GridLocation).
- CableSchematicComponentCollection collection has method AddDeviceGround(Terminal).
- CableSchematicComponentCollection collection has method AddDeviceGround(table).
Property List
- Label
- The object label. (Read/Write string)
- 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)
- ShortToInstallation
- Shorts the device ground to installation. (Read/Write boolean)
- 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
- Label
- The object label.
- Type
- string
- 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
- ShortToInstallation
- Shorts the device ground to installation.
- Type
- boolean
- Access
- Read/Write
- 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.