Base class for some ECU Definition objects.
| Property | Description |
|---|
axes
| Array of the object's axes, elements are of type EcuItem. |
axisCount
| The number of axes this object has (0 for options/channels, 1 for tables, 2 for maps). |
description
| Description text for the object, normally displayed in the Descriptions view. |
isConvertibleToReal
| 'true' if the value of this object has a conversion from raw (internal) to real (physical). |
name
| The name of the object - e.g. 'Fuel' for the Fuel Map. |
outputValue
| Interpolated output value. For tables / maps this is the linearly interpolated value at the current axes position. For options / channels this is the current value. |
siteCount
| The total number of sites in the object. |
typeName
| The internal type name of the object - e.g. 'Table' or 'Map'. |
units
| The physical units of 'real' values in the object. |
dependencyCount
| Number of sub-object dependencies. |
displayIdentifier
| Display Identifier of this item. |
ginIndex
| Index of this item within the EcuItemCollection for the object type in ECU Definition. |
identifier
| Identifier of this item. |
isIgnoredInCompareAndConvert
| 'true' if this object is not used in Compare / Convert Calibration operations, typically because it is aliased with another value at the same address. |
longIdentifier
| Long Identifier of this item. |
address
| Address of the object within the calibration data. |
elementSizeBytes
| Number of bytes occupied by each individual site in the object. |
hasEnumeration
| 'true' if the object has an Enumeration list (named discrete values). |
isBit
| 'true' if the object corresponds to a single bit (e.g. an on/off Option). |
isReadOnly
| 'true' if the value of the object may only be read and not written. |
isSigned
| 'true' if the raw value is signed (2's complement). |
maxRaw
| Maximum raw (ECU internal) value. |
maxReal
| Maximum real (scaled in physical units) value |
minRaw
| Minimum raw (ECU internal) value. |
minReal
| Minimum real (scaled in physical units) value |
profileCount
| Number of 'profiles' defined for this object. |
| Method | Description |
|---|
getAttribute(name)
| Get value of attribute with the given name |
getAxisChannel(index)
| Get the channel (if any) for the given axis of the object. |
getAxisPosition(index)
| Get the floating point position for the current input channel value for the given axis of the object. |
getRaw(axes)
| Get the raw (internal) value at the specified site. 'axes' is an array of the [x,y] site in the object. Can be omitted for objects without axes (e.g. Options). The array can be passed inline - e.g. getRaw({2, 4}). |
getReal(axes)
| Get the real (scaled to physical units) value at the specified site. |
getString(axes)
| Get a textual representation of the value at the specified site. |
getText(axes)
| Get a textual representation of the value at the specified site. Alias of getString. |
hasAttribute(name)
| Determine of object has an attribute with the given name |
rawFromReal(value, axes)
| Convert a real value to a raw value, given the scaling function for the site specified by 'axes'. |
realFromRaw(value, axes)
| Convert a raw value to a real value, given the scaling function for the site specified by 'axes'. |
rescale(multiplier, offset)
| Rescale the real value of all sites in the object by the given multiplier and offset. |
setRaw(value, axes)
| Set the raw (internal) value at the specified site. |
setReal(value, axes)
| Set the real (scaled to physical units) value at the specified site. |
setString(value, axes)
| Set the textual value at the specified site. |
setText(value, axes)
| Set the textual value at the specified site. Alias of setString. |