CableProbeCollection
A collection of cable probes.
Example
app = cf.GetApplication() project = app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/Cables.cfx]]) -- Get an existing 'CableHarness' and 'CablePath' cableHarness = project.Cables.Harnesses["CableHarness1"] cablePath = project.Cables.Paths["CablePath1"] -- Create a new 'CableProbe' cableProbe = cableHarness.Probes:Add(cablePath) -- Query the number of probes on 'CableHarness' numberOfCableProbes = #cableHarness.Probes
Usage locations (collections)
The following objects contain the CableProbeCollection collection:
Property List
Method List
- Add (path CablePath)
- Adds a new cable probe along a cable path. (Returns a CableProbe object.)
- Add (properties table)
- Adds a new cable probe along a cable path using table of properties. (Returns a CableProbe object.)
- Contains (label string)
- Checks if the collection contains an item with the given label. (Returns a boolean object.)
- Item (index number)
- Returns the CableProbe at the given index. (Returns a CableProbe object.)
- Item (label string)
- Returns the CableProbe with the given label. (Returns a CableProbe object.)
- Items ()
- Returns a table of CableProbe. (Returns a List of CableProbe object.)
- UniqueName (label string)
- Generates a unique name base of of the provided base name.If the base name already exists in the collection, a digit will be appended until a valid name is generated. (Returns a boolean object.)
Index List
- [number]
- Returns the CableProbe at the given index in the collection. (Read CableProbe)
- [string]
- Returns the CableProbe with the given name in the collection. (Read CableProbe)
Property Details
Method Details
- Add (path CablePath)
- Adds a new cable probe along a cable path.
- Input Parameters
- path(CablePath)
- The cable path to apply the probe on.
- Return
- CableProbe
- The new cable probe.
- Add (properties table)
- Adds a new cable probe along a cable path using table of properties.
- Input Parameters
- properties(table)
- The table of properties defining the cable probe.
- Return
- CableProbe
- The new cable probe.
- Contains (label string)
- Checks if the collection contains an item with the given label.
- Item (index number)
- Returns the CableProbe at the given index.
- Input Parameters
- index(number)
- The index of the CableProbe.
- Return
- CableProbe
- The CableProbe at the given index.
- Item (label string)
- Returns the CableProbe with the given label.
- Input Parameters
- label(string)
- The label of the CableProbe.
- Return
- CableProbe
- The CableProbe with the given label.
- Items ()
- Returns a table of CableProbe.
- Return
- List of CableProbe
- A table of CableProbe.
- UniqueName (label string)
- Generates a unique name base of of the provided base name.If the base name already exists in the collection, a digit will be appended until a valid name is generated.