CableConnectorCollection
A collection of CableConnectors.
Example
application = cf.Application.getInstance() project = application:Load({FEKO_HOME..[[/shared/Resources/Automation/Cables.cfx]]}) -- Retrieve a 'CablePath' and 'CableHarness' used to construct a connector cablePath = project.Definitions.Cables.Paths["CablePath1"] cableHarness = project.Contents.CableHarnesses:Item("CableHarness1") -- Construct a 'CableConnector' with three pins pinList = {"StartPin1", "StartPin2", "StartPin3"} CableConnector = cableHarness.Connectors:Add(cablePath.StartTerminal, pinList) -- Check if there is a connector on the harness with a specific label found = cableHarness.Connectors:Contains("CableConnector2")
Inheritance
The CableConnectorCollection object is derived from the Object object.
Usage locations
The CableConnectorCollection object can be accessed from the following locations:
- Collection lists
- CableHarness object has collection Connectors.
Property List
Method List
- Add (properties table)
- Adds a new cable connector to the harness using the table of properties. (Returns a CableConnector object.)
- Add (position Point, pinNames string)
- Adds a new cable connector at the given position to the harness. (Returns a CableConnector object.)
- Add (terminal CablePathTerminal, pinNames string)
- Adds a new cable connector at the given path terminal to the harness. (Returns a CableConnector object.)
- Add (properties table, pinNames string)
- Adds a new cable connector to the harness using the table of properties. (Returns a CableConnector object.)
- Delete ()
- Deletes the entity.
- DeleteEntities ( List of Object)
- Delete the given list of entities from the collection.
- 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
- Add (properties table)
- Adds a new cable connector to the harness using the table of properties.
- Input Parameters
- properties(table)
- The table of properties.
- Return
- CableConnector
- The cable connector.
- Add (position Point, pinNames string)
- Adds a new cable connector at the given position to the harness.
- Input Parameters
- Return
- CableConnector
- The cable connector.
- Add (terminal CablePathTerminal, pinNames string)
- Adds a new cable connector at the given path terminal to the harness.
- Input Parameters
- terminal(CablePathTerminal)
- The cable path terminal the connector is connected to.
- pinNames(string)
- The names of the connector pins.
- Return
- CableConnector
- The cable connector.
- Add (properties table, pinNames string)
- Adds a new cable connector to the harness using the table of properties.
- Input Parameters
- Return
- CableConnector
- The cable connector.
- Delete ()
- Deletes the entity.
- DeleteEntities ( List of Object)
- Delete the given list of entities from the collection.
- 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.