Functions for configuration of pump parameters and pump SI units.
|
LCP_Func long LCP_CALL | LCP_GetFlowRateMax (dev_hdl hPump, double *FlowRateMax) |
| Get maximum flow rate that is realizable with current dosing unit configuration. More...
|
|
LCP_Func long LCP_CALL | LCP_GetFlowUnit (dev_hdl hPump, int *pPrefix, int *pVolumeUnit, int *pTimeUnit) |
| Queries the current flow unit used for passing flow values. More...
|
|
LCP_Func long LCP_CALL | LCP_GetVolumeUnit (dev_hdl hPump, int *pPrefix, int *pVolumeUnit) |
| Queries the current volume unit used for all dosage functions. More...
|
|
LCP_Func long LCP_CALL | LCP_SetFlowUnit (dev_hdl hPump, int Prefix, int VolumeUnit, int TimeUnit) |
| Sets the flow unit for a certain pump. More...
|
|
LCP_Func long LCP_CALL | LCP_SetVolumeUnit (dev_hdl hPump, int Prefix, int VolumeUnit) |
| This function sets the default volume unit. More...
|
|
◆ LCP_GetFlowRateMax()
LCP_Func long LCP_CALL LCP_GetFlowRateMax |
( |
dev_hdl |
hPump, |
|
|
double * |
FlowRateMax |
|
) |
| |
Get maximum flow rate that is realizable with current dosing unit configuration.
The maximum flow rate depends on the mechanical configuration of the dosing unit (gear) and on the syringe configuration. If larger syringes are used then larger flow rates are realizable.
- Parameters
-
[in] | hPump | A valid syringe pump handle |
[out] | FlowRateMax | Returns the maximum flow rate in configured SI unit |
- Returns
- Error code - ERR_NOERR indicates success
- Examples:
- capi_nemesys_test.cpp, and capi_pressure_control_test.cpp.
◆ LCP_GetFlowUnit()
LCP_Func long LCP_CALL LCP_GetFlowUnit |
( |
dev_hdl |
hPump, |
|
|
int * |
pPrefix, |
|
|
int * |
pVolumeUnit, |
|
|
int * |
pTimeUnit |
|
) |
| |
Queries the current flow unit used for passing flow values.
- Parameters
-
[in] | hPump | A valid syringe pump handle |
[out] | pPrefix | Returns the prefix of the flow unit (see Prefix Constants) |
[out] | pVolumeUnit | Returns the volume unit (numerator) of the velocity unit (i.e. LITRES - see Volume SI Units) |
[out] | pTimeUnit | Returns the time unit (denominator) of the flow unit. (i.e. PER_SECOND - see Time Units) |
- Returns
- Error code - ERR_NOERR indicates success
- See also
- LCP_SetFlowUnit()
◆ LCP_GetVolumeUnit()
LCP_Func long LCP_CALL LCP_GetVolumeUnit |
( |
dev_hdl |
hPump, |
|
|
int * |
pPrefix, |
|
|
int * |
pVolumeUnit |
|
) |
| |
Queries the current volume unit used for all dosage functions.
- Parameters
-
[in] | hPump | A valid syringe pump handle |
[out] | pPrefix | Returns the prefix of the SIunit (i.e MILLI - see Prefix Constants) |
[out] | pVolumeUnit | Returns the volume unit identifier (i.e. LITRES - see Volume SI Units) |
- Returns
- Error code - ERR_NOERR indicates success
- See also
- LCP_SetVolumeUnit()
◆ LCP_SetFlowUnit()
LCP_Func long LCP_CALL LCP_SetFlowUnit |
( |
dev_hdl |
hPump, |
|
|
int |
Prefix, |
|
|
int |
VolumeUnit, |
|
|
int |
TimeUnit |
|
) |
| |
◆ LCP_SetVolumeUnit()
LCP_Func long LCP_CALL LCP_SetVolumeUnit |
( |
dev_hdl |
hPump, |
|
|
int |
Prefix, |
|
|
int |
VolumeUnit |
|
) |
| |
This function sets the default volume unit.
All parameters of subsequent dosing function calls are given in this new unit. Example to select milliliters as volume unit. Example:
- Parameters
-
[in] | hPump | A valid syringe pump handle |
[in] | Prefix | The prefix of the SIunit (i.e MILLI - see Prefix Constants) |
[in] | VolumeUnit | The volume unit identifier (i.e. LITRES - see Volume SI Units) |
- Returns
- Error code - ERR_NOERR indicates success
- See also
- LCP_GetVolumeUnit()
- Examples:
- capi_nemesys_test.cpp, and Pump_CAPI_Init.cpp.