neMESYS SDK  20150729
Volume an Flow Units

Configure, select and query volume and flow unit parameters. More...

Functions

NCS_Func long __stdcall NCS_GetActiveFlowUnit (ncs_hdl hDevice, unsigned char DosingUnit)
 Get identifier of active flow unit. More...
 
NCS_Func long __stdcall NCS_GetActiveVolumeUnit (ncs_hdl hDevice, unsigned char DosingUnit)
 Get identifier of active svolume unit. More...
 
NCS_Func long __stdcall NCS_GetFlowUnitString (ncs_hdl hDevice, unsigned char FlowUnitId, char *pUnitStringShort, unsigned char MaxStringShortSize, char *pUnitStringLong, unsigned char MaxStringLongSize)
 Get string for certain flow unit. More...
 
NCS_Func long __stdcall NCS_GetNumberOfFlowUnits (ncs_hdl hDevice)
 Get number of supported flow units (i.e. More...
 
NCS_Func long __stdcall NCS_GetNumberOfVolumeUnits (ncs_hdl hDevice)
 Get number of supported volume units (i.e. More...
 
NCS_Func long __stdcall NCS_GetVolumeUnitString (ncs_hdl hDevice, unsigned char VolUnitId, char *pUnitStringShort, unsigned char MaxStringShortSize, char *pUnitStringLong, unsigned char MaxStringLongSize)
 Get string for certain volume unit. More...
 
NCS_Func long __stdcall NCS_SetActiveFlowUnit (ncs_hdl hDevice, unsigned char DosingUnit, unsigned char FlowUnit)
 Set active flow unit for single device. More...
 
NCS_Func long __stdcall NCS_SetActiveVolumeUnit (ncs_hdl hDevice, unsigned char DosingUnit, unsigned char VolUnit)
 Set active volume unit for single device. More...
 

Detailed Description

Configure, select and query volume and flow unit parameters.

This group defines a set of functions for configuration of flow rate units and volume units.

Function Documentation

NCS_Func long __stdcall NCS_GetActiveFlowUnit ( ncs_hdl  hDevice,
unsigned char  DosingUnit 
)

Get identifier of active flow unit.

Parameters
[in]hDeviceValid device handle
[in]DosingUnitIndex of neMESYS pump from 0 to number of pumps - 1
Returns
Active flow unit (>= 0) or error code (< 0)
NCS_Func long __stdcall NCS_GetActiveVolumeUnit ( ncs_hdl  hDevice,
unsigned char  DosingUnit 
)

Get identifier of active svolume unit.

Parameters
[in]hDeviceValid device handle
[in]DosingUnitIndex of neMESYS pump from 0 to number of pumps - 1
Returns
Active volume unit (>= 0) or error code (< 0)
NCS_Func long __stdcall NCS_GetFlowUnitString ( ncs_hdl  hDevice,
unsigned char  FlowUnitId,
char *  pUnitStringShort,
unsigned char  MaxStringShortSize,
char *  pUnitStringLong,
unsigned char  MaxStringLongSize 
)

Get string for certain flow unit.

Parameters
[in]hDeviceValid device handle
[in]FlowUnitIdIdentifier of flow unit (0 - NumberOfFlowUnits - 1)
[out]pUnitStringShortPointer of buffer that stores short unit strins (i.e. nl/s, ml/min...)
[in]MaxStringShortSizeSize of buffer pUnitStringShort
[out]pUnitStringLongPointer of buffer that stores long unit string (i.e. Nanolitres/Second, Millilitres/Minute...)
[in]MaxStringLongSizeSize of buffer pUnitStringLong
Returns
Error code - ERR_NOERR indicates success
NCS_Func long __stdcall NCS_GetNumberOfFlowUnits ( ncs_hdl  hDevice)

Get number of supported flow units (i.e.

nl/s, µl/s, ml/min ...).

Parameters
[in]hDeviceValid device handle
Returns
Number of flow units (> 0) or error code (< 0)
NCS_Func long __stdcall NCS_GetNumberOfVolumeUnits ( ncs_hdl  hDevice)

Get number of supported volume units (i.e.

nl, µl, ml...).

Parameters
[in]hDeviceValid device handle
Returns
Number of flow units (> 0) or error code (< 0)
NCS_Func long __stdcall NCS_GetVolumeUnitString ( ncs_hdl  hDevice,
unsigned char  VolUnitId,
char *  pUnitStringShort,
unsigned char  MaxStringShortSize,
char *  pUnitStringLong,
unsigned char  MaxStringLongSize 
)

Get string for certain volume unit.

Parameters
[in]hDeviceValid device handle
[in]VolUnitIdIdentifier of volume unit (0 - NumberOfVolumeUnits - 1)
[out]pUnitStringShortPointer of buffer that stores short unit strins (i.e. nl, min...)
[in]MaxStringShortSizeSize of buffer pUnitStringShort
[out]pUnitStringLongPointer of buffer that stores long unit string (i.e. Nanolitres, Millilitres ...)
[in]MaxStringLongSizeSize of buffer pUnitStringLong
Returns
Error code - ERR_NOERR indicates success
NCS_Func long __stdcall NCS_SetActiveFlowUnit ( ncs_hdl  hDevice,
unsigned char  DosingUnit,
unsigned char  FlowUnit 
)

Set active flow unit for single device.

Parameters
[in]hDeviceValid device handle
[in]DosingUnitIndex of neMESYS pump from 0 to number of pumps - 1
[in]FlowUnitFlow unit to set as active flow unit
Returns
Error code - ERR_NOERR indicates success
NCS_Func long __stdcall NCS_SetActiveVolumeUnit ( ncs_hdl  hDevice,
unsigned char  DosingUnit,
unsigned char  VolUnit 
)

Set active volume unit for single device.

Parameters
[in]hDeviceValid device handle
[in]DosingUnitIndex of neMESYS pump from 0 to number of pumps - 1
[in]VolUnitVolume unit to set as active volume unit
Returns
Error code - ERR_NOERR indicates success