CableSignal
The cable signal.
Example
app = cf.GetApplication() project = app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/Cables.cfx]]) -- Get an existing 'CableHarness' cableHarness = project.Cables.Harnesses["CableHarness1"] -- Get a 'CableInstance' cableInstance = cableHarness.CableInstances["Cable1"] -- Set a signal on the 'CableInstance' to none cableInstance.Signals[1].Destination = cf.CableConnectorPin.CreateNonePin() -- Change the signal name cableInstance.Signals[1].Name = "UnconnectedSignal" -- Swap source connection pins cableInstance.Signals[1].Source = cableHarness.Connectors["CableConnector1"].Pins["Pin2"] cableInstance.Signals[2].Source = cableHarness.Connectors["CableConnector1"].Pins["Pin1"]
Inheritance
The CableSignal object is derived from the Object object.
Usage locations
The CableSignal object can be accessed from the following locations:
- Methods
- CableSignalCollection collection has method Item(number).
- CableSignalCollection collection has method Item(string).
Property List
- Destination
- The destination connector pin this signal is attached to. (Read/Write CableConnectorPin)
- Label
- The object label. (Read/Write string)
- Source
- The source connector pin this signal is attached to. (Read/Write CableConnectorPin)
- 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.)
- 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
- Destination
- The destination connector pin this signal is attached to.
- Type
- CableConnectorPin
- Access
- Read/Write
- Label
- The object label.
- Type
- string
- Access
- Read/Write
- Source
- The source connector pin this signal is attached to.
- Type
- CableConnectorPin
- Access
- Read/Write
- 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.
- 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.