FireSync API
 All Classes Files Functions Variables Typedefs Friends Macros Modules Pages
kLdCal.h
1 #ifndef K_LD_CAL_H
2 #define K_LD_CAL_H
3 
4 #include <kFireSync/kFsDef.h>
5 #include <kFireSync/kNodeDef.h>
6 
13 //typedef kObject kLdCal; --forward-declared in kFsDef.x.h
14 
24 kFsFx(kStatus) kLdCal_FileName(kSize index, kChar* fileName, kSize capacity);
25 
38 kFsFx(kStatus) kLdCal_BackupFileName(kSize index, kChar* fileName, kSize capacity);
39 
48 kFsFx(kStatus) kLdCal_Construct(kLdCal* cal, kAlloc alloc);
49 
58 kFsFx(kStatus) kLdCal_Save(kLdCal cal, const kChar *path);
59 
69 kFsFx(kStatus) kLdCal_Load(kLdCal *cal, const kChar *path, kAlloc alloc);
70 
79 kFsFx(kStatus) kLdCal_SaveStream(kLdCal cal, kStream stream);
80 
90 kFsFx(kStatus) kLdCal_LoadStream(kLdCal *cal, kStream stream, kAlloc alloc);
91 
100 kFsFx(kStatus) kLdCal_SetSensorId(kLdCal cal, kSize sensorId);
101 
109 kFsFx(kSize) kLdCal_SensorId(kLdCal cal);
110 
119 kFsFx(kStatus) kLdCal_SetTimestamp(kLdCal cal, const kChar* timestamp);
120 
128 kFsFx(const kChar*) kLdCal_Timestamp(kLdCal cal);
129 
138 kFsFx(kStatus) kLdCal_SetStationId(kLdCal cal, const kChar* stationId);
139 
147 kFsFx(const kChar*) kLdCal_StationId(kLdCal cal);
148 
159 kFsFx(kStatus) kLdCal_SetDriverIndex(kLdCal cal, kSize index);
160 
168 kFsFx(kSize) kLdCal_DriverIndex(kLdCal cal);
169 
179 
188 
198 
207 
216 kFsFx(kStatus) kLdCal_SetDriverVersion(kLdCal cal, kVersion version);
217 
226 
235 kFsFx(kStatus) kLdCal_SetDriverTemperature(kLdCal cal, k64f temperature);
236 
245 
254 kFsFx(kStatus) kLdCal_SetDriverId(kLdCal cal, kSize driverId);
255 
263 kFsFx(kSize) kLdCal_DriverId(kLdCal cal);
264 
276 kFsFx(kStatus) kLdCal_SetDriverIdLabel(kLdCal cal, const kChar* label);
277 
285 kFsFx(const kChar*) kLdCal_DriverIdLabel(kLdCal cal);
286 
296 
307 
317 
328 
338 
349 
359 
370 
380 kFsFx(kStatus) kLdCal_SetPowerInputInfo(kLdCal cal, kSize begin, kSize step);
381 
391 kFsFx(kStatus) kLdCal_PowerInputInfo(kLdCal cal, kSize* begin, kSize* step);
392 
402 kFsFx(kStatus) kLdCal_SetLimitInputInfo(kLdCal cal, kSize begin, kSize step);
403 
413 kFsFx(kStatus) kLdCal_LimitInputInfo(kLdCal cal, kSize* begin, kSize* step);
414 
428 kFsFx(kStatus) kLdCal_SetPowerOutput(kLdCal cal, kArray1 powerMap);
429 
437 kFsFx(kArray1) kLdCal_PowerOutput(kLdCal cal);
438 
453 kFsFx(kStatus) kLdCal_SetLimitOutput(kLdCal cal, kArray1 limitMap);
454 
465 kFsFx(kArray1) kLdCal_LimitOutput(kLdCal cal);
466 
467 #include <kFireSync/Utils/kLdCal.x.h>
468 
469 #endif
kSize kLdCal_PowerInputDevice(kLdCal cal)
Gets the power set point input (in device units) programmed to the laser driver.
kStatus kLdCal_SetTimestamp(kLdCal cal, const kChar *timestamp)
Sets the calibration timestamp.
kStatus kLdCal_Save(kLdCal cal, const kChar *path)
Saves the calibration record to local storage under the specified path.
kSize kLdCal_SensorId(kLdCal cal)
Gets the serial number.
kStatus kLdCal_SetDriverIndex(kLdCal cal, kSize index)
Sets the light driver index.
kArray1 kLdCal_PowerOutput(kLdCal cal)
Gets the calibration mapping for driver set point.
kStatus kLdCal_SetLimitInputDevice(kLdCal cal, kSize input)
Sets the current limit input (in device units) programmed to the laser driver.
kStatus kLdCal_SetDriverIdLabel(kLdCal cal, const kChar *label)
Sets the formatted laser driver id.
kStatus kLdCal_SetDriverVersion(kLdCal cal, kVersion version)
Sets the driver version.
kStatus kLdCal_SetLimitOutput(kLdCal cal, kArray1 limitMap)
Sets the calibration mapping for the driver current limit.
kStatus kLdCal_Load(kLdCal *cal, const kChar *path, kAlloc alloc)
Loads the calibration record from local storage.
kSize kLdCal_DriverId(kLdCal cal)
Gets the driver serial number.
kStatus kLdCal_SetLimitInputInfo(kLdCal cal, kSize begin, kSize step)
Defines the range of the input values for the current limit to optical power map specified via kLdCal...
kStatus kLdCal_SetDriverModel(kLdCal cal, kLightModel model)
Sets the driver model.
kStatus kLdCal_LoadStream(kLdCal *cal, kStream stream, kAlloc alloc)
Loads the calibration record from a stream.
kStatus kLdCal_PowerInputInfo(kLdCal cal, kSize *begin, kSize *step)
Queries the range of the input values for the set point to the optical power map specified via kLdCal...
Essential declarations related to FireSync nodes.
kStatus kLdCal_SetSensorId(kLdCal cal, kSize sensorId)
Sets the sensor serial number.
const kChar * kLdCal_StationId(kLdCal cal)
Gets the calibration station Id.
kStatus kLdCal_SetPowerInputInfo(kLdCal cal, kSize begin, kSize step)
Defines the range of the input values for the set point to optical power map specified via kLdCal_Set...
kStatus kLdCal_SetDriverTemperature(kLdCal cal, k64f temperature)
Sets the driver temperature (degrees Celsius).
kArray1 kLdCal_LimitOutput(kLdCal cal)
Gets the calibration mapping for driver set point.
kSize kLdCal_LimitInputDevice(kLdCal cal)
Gets the current limit input (in device units) programmed to the laser driver.
kStatus kLdCal_SetPowerInputDevice(kLdCal cal, kSize input)
Sets the power set point input (in device units) programmed to the laser driver.
kSize kLdCal_PowerInputDefault(kLdCal cal)
Gets the power set point input (in device units) to be used at device startup.
kLightModel kLdCal_DriverModel(kLdCal cal)
Queries driver model.
kLightDiodeModel kLdCal_DiodeModel(kLdCal cal)
Queries diode model.
Essential API declarations for the kFireSync library.
kSize kLdCal_DriverIndex(kLdCal cal)
Gets the light driver index.
kStatus kLdCal_FileName(kSize index, kChar *fileName, kSize capacity)
Generates the default calibration file name based on the index of the laser driver.
kStatus kLdCal_BackupFileName(kSize index, kChar *fileName, kSize capacity)
Generates the backup calibration file name based on the index of the laser driver.
k64f kLdCal_DriverTemperature(kLdCal cal)
Gets the driver temperature.
kStatus kLdCal_SetPowerOutput(kLdCal cal, kArray1 powerMap)
Sets the calibration mapping for the driver power set point.
kStatus kLdCal_SetStationId(kLdCal cal, const kChar *stationId)
Sets the calibration station Id (e.g.
const kChar * kLdCal_Timestamp(kLdCal cal)
Gets the calibration timestamp.
kStatus kLdCal_LimitInputInfo(kLdCal cal, kSize *begin, kSize *step)
Queries the range of the input values for the current limit to the optical power map specified via kL...
kStatus kLdCal_Construct(kLdCal *cal, kAlloc alloc)
Constructs a kLdCal cal.
kStatus kLdCal_SetPowerInputDefault(kLdCal cal, kSize input)
Sets the power set point input (in device units) to be used at device startup.
kStatus kLdCal_SetLimitInputDefault(kLdCal cal, kSize input)
Sets the current limit input (in device units) to be used at device startup.
Class cal for the kLdCal class.
Represents supported light device types.
const kChar * kLdCal_DriverIdLabel(kLdCal cal)
Gets the formatted driver serial number.
kVersion kLdCal_DriverVersion(kLdCal cal)
Gets the driver version.
Represents supported light diode types.
kStatus kLdCal_SaveStream(kLdCal cal, kStream stream)
Saves the calibration record to a stream.
kSize kLdCal_LimitInputDefault(kLdCal cal)
Gets the current limit input (in device units) to be used at device startup.
kStatus kLdCal_SetDiodeModel(kLdCal cal, kLightDiodeModel model)
Sets the diode model.
kStatus kLdCal_SetDriverId(kLdCal cal, kSize driverId)
Sets the driver serial number.