CableProbe

A cable probe.

Example

app = cf.GetApplication()
project = app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/Cables.cfx]])

-- Get an existing 'CableProbe'

cableProbe = project.Cables.Harnesses["CableHarness1"].Probes["CableProbe1"]

-- Change the 'CableProbe' to measure both current and voltage

cableProbe.ProbeType = cf.Enums.CableProbeTypeEnum.CurrentAndVoltage

-- Change the 'CableProbe' to be positioned at a specified distance

properties = {}
properties.LocationType = cf.Enums.CableProbeLocationTypeEnum.DistanceOnPath
properties.PositionDistance = 3
cableProbe:SetProperties(properties)

Property List

Label
LocationType
The location option for the probe. (Read/Write CableProbeLocationTypeEnum)
Path
The cable path that the probe is on. (Read/Write CablePath)
PositionDistance
The distance along the cable path if the LocationType is DistanceOnPath. (Read/Write Expression)
PositionPercentage
The percentage along the cable path if the LocationType is PercentageOnPath. (Read/Write Expression)
ProbeType
The type of the probe. (Read/Write CableProbeTypeEnum)
Type
The object type string. (Read only string)

Method List

Delete ()
Deletes the cable probe from the harness.
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 table)
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

Label
The object label.
Type
string
Access
LocationType
The location option for the probe.
Type
CableProbeLocationTypeEnum
Access
Path
The cable path that the probe is on.
Type
CablePath
Access
PositionDistance
The distance along the cable path if the LocationType is DistanceOnPath.
Type
Expression
Access
PositionPercentage
The percentage along the cable path if the LocationType is PercentageOnPath.
Type
Expression
Access
ProbeType
The type of the probe.
Type
CableProbeTypeEnum
Access
Type
The object type string.
Type
string
Access

Method Details

Delete ()
Deletes the cable probe from the harness.
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 properties table.
SetProperties (properties table)
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(table)
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
The default properties table.