FireSync API
 All Classes Files Functions Variables Typedefs Friends Macros Modules Pages
kLdCalLookup.h
1 #ifndef k_LD_CAL_LOOKUP_H
2 #define k_LD_CAL_LOOKUP_H
3 
4 #include <kFireSync/kFsDef.h>
5 #include <kFireSync/kNodeDef.h>
6 #include <kFireSync/Utils/kLdCal.h>
7 
14 //typedef kObject kLdCalLookup; --forward-declared in kFsDef.x.h
15 
26 kFsFx(kStatus) kLdCalLookup_Construct(kLdCalLookup* lookup, kLdCal cal, kAlloc alloc);
27 
42 kFsFx(kStatus) kLdCalLookup_SetPowerCompensationInfo(kLdCalLookup lookup, k64f tempDeltaCoeff);
43 
52 kFsFx(kStatus) kLdCalLookup_PowerCompensationInfo(kLdCalLookup lookup, k64f* tempDeltaCoeff);
53 
65 kFsFx(kStatus) kLdCalLookup_SetLimitCompensationInfo(kLdCalLookup lookup, k64f tempDeltaCoeff);
66 
75 kFsFx(kStatus) kLdCalLookup_LimitCompensationInfo(kLdCalLookup lookup, k64f* tempDeltaCoeff);
76 
84 kFsFx(kBool) kLdCalLookup_HasLimit(kLdCalLookup lookup);
85 
93 kFsFx(k64f) kLdCalLookup_MinIntensity(kLdCalLookup lookup);
94 
108 kFsFx(kStatus) kLdCalLookup_InputToPower(kLdCalLookup lookup, kSize input, k64f temperature, k64f* power);
109 
132 kFsFx(kStatus) kLdCalLookup_PowerToInput(kLdCalLookup lookup, k64f power, k64f temperature, kSize* input, k64f* expectedPower);
133 
147 kFsFx(kStatus) kLdCalLookup_InputToLimit(kLdCalLookup lookup, kSize input, k64f temperature, k64f* limit);
148 
171 kFsFx(kStatus) kLdCalLookup_LimitToInput(kLdCalLookup lookup, k64f limit, k64f temperature, kSize* input, k64f* expectedLimit);
172 
188 kFsFx(kStatus) kLdCalLookup_CompensatePowerInput(kLdCalLookup lookup, kSize calInput, k64f intensity, k64f temperature, kSize* compensatedInput);
189 
204 kFsFx(kStatus) kLdCalLookup_CompensateLimitInput(kLdCalLookup lookup, kSize calInput, k64f temperature, kSize* compensatedInput);
205 
206 #include <kFireSync/Utils/kLdCalLookup.x.h>
207 
208 
209 #endif
kLdCalLookup::kLdCalLookup_CompensateLimitInput
kStatus kLdCalLookup_CompensateLimitInput(kLdCalLookup lookup, kSize calInput, k64f temperature, kSize *compensatedInput)
Calculates the limit input value required to produce optical power that's equivalent to specified cal...
kLdCalLookup::kLdCalLookup_InputToPower
kStatus kLdCalLookup_InputToPower(kLdCalLookup lookup, kSize input, k64f temperature, k64f *power)
Calculates optical power at a specific set point input value and driver temperature.
kLdCalLookup::kLdCalLookup_CompensatePowerInput
kStatus kLdCalLookup_CompensatePowerInput(kLdCalLookup lookup, kSize calInput, k64f intensity, k64f temperature, kSize *compensatedInput)
Calculates the power set point input value required to produce optical power that's equivalent to spe...
kLdCalLookup::kLdCalLookup_LimitCompensationInfo
kStatus kLdCalLookup_LimitCompensationInfo(kLdCalLookup lookup, k64f *tempDeltaCoeff)
Queries temperature compensation properties for the current limit.
kLdCalLookup::kLdCalLookup_PowerToInput
kStatus kLdCalLookup_PowerToInput(kLdCalLookup lookup, k64f power, k64f temperature, kSize *input, k64f *expectedPower)
Calculates the set point input expected to produce specified optical power at the specified temperatu...
kLdCalLookup::kLdCalLookup_SetPowerCompensationInfo
kStatus kLdCalLookup_SetPowerCompensationInfo(kLdCalLookup lookup, k64f tempDeltaCoeff)
Configures temperature compensation properties for the power set point.
kNodeDef.h
Essential declarations related to FireSync nodes.
kLdCalLookup::kLdCalLookup_SetLimitCompensationInfo
kStatus kLdCalLookup_SetLimitCompensationInfo(kLdCalLookup lookup, k64f tempDeltaCoeff)
Configures temperature compensation properties for the current limit.
kLdCalLookup::kLdCalLookup_Construct
kStatus kLdCalLookup_Construct(kLdCalLookup *lookup, kLdCal cal, kAlloc alloc)
Constructs a kLdCalLookup object.
kLdCalLookup::kLdCalLookup_LimitToInput
kStatus kLdCalLookup_LimitToInput(kLdCalLookup lookup, k64f limit, k64f temperature, kSize *input, k64f *expectedLimit)
Calculates the current limit input expected to produce specified optical power at the specified tempe...
kFsDef.h
Essential API declarations for the kFireSync library.
kLdCalLookup::kLdCalLookup_MinIntensity
k64f kLdCalLookup_MinIntensity(kLdCalLookup lookup)
Reports the minimum valid intensity value supported by the calibration.
kLdCal
Class cal for the kLdCal class.
kLdCalLookup::kLdCalLookup_HasLimit
kBool kLdCalLookup_HasLimit(kLdCalLookup lookup)
Queries whether limit power has a calibration record and is thus configurable.
kLdCalLookup
Class object for the kLdCalLookup class.
kLdCalLookup::kLdCalLookup_PowerCompensationInfo
kStatus kLdCalLookup_PowerCompensationInfo(kLdCalLookup lookup, k64f *tempDeltaCoeff)
Queries temperature compensation properties for the power set point.
kLdCalLookup::kLdCalLookup_InputToLimit
kStatus kLdCalLookup_InputToLimit(kLdCalLookup lookup, kSize input, k64f temperature, k64f *limit)
Calculates optical power at a specific current limit input value and driver temperature.