CableConnectorPin
A cable connector pin.
Example
application = cf.Application.GetInstance() project = application:Load({FEKO_HOME..[[/shared/Resources/Automation/Cables.cfx]]}) -- Retrieve a 'CableHarness' cableHarness = project.Contents.CableHarnesses:Item("CableHarness1") -- Retrieve a 'CableConnectorPin' from a 'CableConnector' cableConnectorPin = cableHarness.Connectors["CableConnector2"].Pins["Pin2"] -- Retrieve the terminal associated with the 'CableConnectorPin' terminal = cableConnectorPin.Terminal
Inheritance
The CableConnectorPin object is derived from the Object object.
Usage locations
The CableConnectorPin object can be accessed from the following locations:
- Properties
- CableSignal object has property Destination.
- CableSignal object has property Source.
- Methods
- CableConnectorPinCollection collection has method Item(number).
- CableConnectorPinCollection collection has method Item(string).
Property List
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
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.