FireSync API
 All Classes Files Functions Variables Typedefs Friends Macros Modules Pages
kLdModel.h
1 #ifndef K_LD_MODEL_H
2 #define K_LD_MODEL_H
3 
4 #include <kFireSync/kFsDef.h>
5 #include <kFireSync/kNodeDef.h>
6 
7 typedef enum
8 {
9  kLD_MODEL_TEMPERATURE_REFERENCE_NONE = 0,
10  kLD_MODEL_TEMPERATURE_REFERENCE_INTERNAL = 1,
11  kLD_MODEL_TEMPERATURE_REFERENCE_EXTERNAL = 2,
12  kLD_MODEL_TEMPERATURE_REFERENCE_CPU = 3
13 } kLdModelTempReference;
14 
33 //typedef kObject kLdModel; --forward-declared in kFsDef.x.h
34 
44 kFsFx(kStatus) kLdModel_FileName(kSize index, kChar* fileName, kSize capacity);
45 
64 kFsFx(kStatus) kLdModel_Construct(kLdModel* model, kLightModel lightModel, kLightDiodeModel diodeModel, kBool tolerateUnknown, kAlloc alloc);
65 
75 kFsFx(kStatus) kLdModel_Load(kLdModel *model, const kChar *path, kAlloc alloc);
76 
86 kFsFx(kStatus) kLdModel_LoadStream(kLdModel *model, kStream stream, kAlloc alloc);
87 
96 
105 
113 kFsFx(kBool) kLdModel_PowerEnabled(kLdModel model);
114 
122 kFsFx(kBool) kLdModel_LimitEnabled(kLdModel model);
123 
135 kFsFx(kStatus) kLdModel_OutputRange(kLdModel model, k64f* outputMin, k64f* outputMax);
136 
148 kFsFx(kStatus) kLdModel_TempRange(kLdModel model, k64f* tempMin, k64f* tempMax);
149 
164 kFsFx(kLdModelTempReference) kLdModel_TempReference(kLdModel model);
165 
176 
186 
197 
207 
218 
228 kFsFx(k32u) kLdModel_PrimeCount(kLdModel model);
229 
239 kFsFx(k64u) kLdModel_PrimeExposure(kLdModel model);
240 
241 #include <kFireSync/Utils/kLdModel.x.h>
242 
243 #endif
kLightModel kLdModel_LightModel(kLdModel model)
Returns the light model enumerator corresponding to this object.
kStatus kLdModel_PowerCompensationCoeff(kLdModel model, k64f *coeff)
Returns the temperature compensation coefficient needed for accurate power set point compensation at ...
kBool kLdModel_PowerCompensated(kLdModel model)
Specifies whether power set point requires active temperature compensation.
kBool kLdModel_PowerEnabled(kLdModel model)
Specifies whether power set point is configurable for the queried laser driver model.
kBool kLdModel_LimitEnabled(kLdModel model)
Specifies if power current limit is configurable for the queried laser driver model.
k32u kLdModel_PrimeCount(kLdModel model)
Reports the number of priming exposures that should be run at acquisition startup.
kStatus kLdModel_OutputRange(kLdModel model, k64f *outputMin, k64f *outputMax)
Specifies maximum optical power range (in mW), which is safely configurable for this laser driver...
Essential declarations related to FireSync nodes.
kStatus kLdModel_TempRange(kLdModel model, k64f *tempMin, k64f *tempMax)
Specifies maximum operating temperature range of the driver, in degrees C.
k64f kLdModel_TempReferenceTolerance(kLdModel model)
Specifies the maximum allowable deviation, in degrees C, between the driver temperature and the refer...
kStatus kLdModel_FileName(kSize index, kChar *fileName, kSize capacity)
Generates the default file name based on the index of the laser driver.
Essential API declarations for the kFireSync library.
kBool kLdModel_LimitCompensated(kLdModel model)
Specifies whether power current limit requires active temperature compensation.
kLdModelTempReference kLdModel_TempReference(kLdModel model)
Specifies the temperature reference probe, which (if available) must be used to determine if the lase...
kStatus kLdModel_Construct(kLdModel *model, kLightModel lightModel, kLightDiodeModel diodeModel, kBool tolerateUnknown, kAlloc alloc)
Constructs a kLdModel model.
kStatus kLdModel_LoadStream(kLdModel *model, kStream stream, kAlloc alloc)
Loads the model object from a stream.
k64u kLdModel_PrimeExposure(kLdModel model)
Reports the amount of time required for one light priming exposure.
kStatus kLdModel_LimitCompensationCoeff(kLdModel model, k64f *coeff)
Returns the temperature compensation coefficient needed for accurate power current limit compensation...
Represents supported light device types.
kStatus kLdModel_Load(kLdModel *model, const kChar *path, kAlloc alloc)
Loads the model object from local storage at the specified path.
kLdModel class is intended to facilitate behaviour configuration of the low level FireSync software w...
Represents supported light diode types.
kLightDiodeModel kLdModel_DiodeModel(kLdModel model)
Returns the diode model enumerator corresponding to this object.