CableConnectorPinCollection
A collection of of connector pins that can be connected to cable signals and cable schematic components.
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)
Inheritance
The CableConnectorPinCollection object is derived from the Object object.
Usage locations
The CableConnectorPinCollection object can be accessed from the following locations:
- Collection lists
- CableConnector object has collection Pins.
Property List
Method List
- 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.)
- Item (index number)
- Returns the CableConnectorPin for the given index in the collection. (Returns a CableConnectorPin object.)
- Item (label string)
- Returns the CableConnectorPin for the given label in the collection. (Returns a CableConnectorPin object.)
- Items ()
- Returns a table of CableConnectorPin items. (Returns a UnsupportedType(List of CableConnectorPin) object.)
- SetPins (pinnames string)
- Modifies the connector pins from a list of pin names.
- 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.
- 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.
- Item (index number)
- Returns the CableConnectorPin for the given index in the collection.
- Input Parameters
- index(number)
- The index of the CableConnectorPin.
- Return
- CableConnectorPin
- The item in the collection
- Item (label string)
- Returns the CableConnectorPin for the given label in the collection.
- Input Parameters
- label(string)
- The label of the CableConnectorPin.
- Return
- CableConnectorPin
- The item in the collection
- Items ()
- Returns a table of CableConnectorPin items.
- Return
- UnsupportedType(List of CableConnectorPin)
- The list of items in the collection
- SetPins (pinnames string)
- Modifies the connector pins from a list of pin names.
- Input Parameters
- pinnames(string)
- A list of pin names.
- 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.