CableProbe
A cable probe.
Example
application = cf.Application.getInstance() project = application:Load({FEKO_HOME..[[/shared/Resources/Automation/Cables.cfx]]}) -- Get an existing 'CableProbe' cableProbe = project.Contents.CableHarnesses["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)
Inheritance
The CableProbe object is derived from the Object object.
Usage locations
The CableProbe object can be accessed from the following locations:
- Methods
- CableProbeCollection collection has method Add(table).
- CableProbeCollection collection has method Add(CablePath).
- CableProbeCollection collection has method Item(number).
- CableProbeCollection collection has method Item(string).
Property List
- Label
- The object label. (Read/Write string)
- 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 ParametricExpression)
- PositionPercentage
- The percentage along the cable path if the LocationType is PercentageOnPath. (Read/Write ParametricExpression)
- ProbeType
- The type of the probe. (Read/Write CableProbeTypeEnum)
- Type
- The object type string. (Read only string)
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
- Label
- The object label.
- Type
- string
- Access
- Read/Write
- LocationType
- The location option for the probe.
- Type
- CableProbeLocationTypeEnum
- Access
- Read/Write
- Path
- The cable path that the probe is on.
- Type
- CablePath
- Access
- Read/Write
- PositionDistance
- The distance along the cable path if the LocationType is DistanceOnPath.
- Type
- ParametricExpression
- Access
- Read/Write
- PositionPercentage
- The percentage along the cable path if the LocationType is PercentageOnPath.
- Type
- ParametricExpression
- Access
- Read/Write
- ProbeType
- The type of the probe.
- Type
- CableProbeTypeEnum
- Access
- Read/Write
- Type
- The object type string.
- Type
- string
- Access
- Read only
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.