Functions for various dosing tasks. More...

Functions
NCS_Func long __stdcall	NCS_DoseVolume (ncs_hdl hDevice, unsigned char DosingUnit, double pVolume, double pFlowRate)
	Doses a defined volume with a defined flow rate. More...

NCS_Func long __stdcall	NCS_DoseVolumeEx (ncs_hdl hDevice, unsigned char DosingUnit, double pVolume, TVolUnitId VolUnit, double pFlowRate, TFlowUnitId FlowUnit)
	Doses a defined volume with a defined flow rate. More...

NCS_Func long __stdcall	NCS_EmergencyStopAllUnits (ncs_hdl hDevice)
	Performs quick stop for all dosing units. More...

NCS_Func long __stdcall	NCS_EmptySyringe (ncs_hdl hDevice, unsigned char DosingUnit, double *pFlowRate)
	Eympties syringe by moving pusher to lower limit of dosing unit. More...

NCS_Func long __stdcall	NCS_EmptySyringeEx (ncs_hdl hDevice, unsigned char DosingUnit, double *pFlowRate, TFlowUnitId FlowUnit)
	Eympties syringe by moving pusher to lower limit of dosing unit. More...

NCS_Func long __stdcall	NCS_GenerateFlow (ncs_hdl hDevice, unsigned char DosingUnit, double *pFlowRate)
	Generate define fluid stream until dosing unit reaches its limits. More...

NCS_Func long __stdcall	NCS_GenerateFlowEx (ncs_hdl hDevice, unsigned char DosingUnit, double *pFlowRate, TFlowUnitId FlowUnit)
	Generate define fluid stream until dosing unit reaches its limits. More...

NCS_Func long __stdcall	NCS_RefillSyringe (ncs_hdl hDevice, unsigned char DosingUnit, double *pFlowRate)
	Refills syringe by moving pusher to upper limit of dosing unit. More...

NCS_Func long __stdcall	NCS_RefillSyringeEx (ncs_hdl hDevice, unsigned char DosingUnit, double *pFlowRate, TFlowUnitId FlowUnit)
	Refills syringe by moving pusher to upper limit of dosing unit. More...

NCS_Func long __stdcall	NCS_SetSyringeLevel (ncs_hdl hDevice, unsigned char DosingUnit, double pVolume, double pFlowRate)
	Moves the pusher until syringe content reaches a certain level. More...

NCS_Func long __stdcall	NCS_SetSyringeLevelEx (ncs_hdl hDevice, unsigned char DosingUnit, double pVolume, TVolUnitId VolUnit, double pFlowRate, TFlowUnitId FlowUnit)
	Moves the pusher until syringe content reaches a certain level. More...

NCS_Func long __stdcall	NCS_Stop (ncs_hdl hDevice, unsigned char DosingUnit)
	Stop dosing of single unit. More...

NCS_Func long __stdcall	NCS_StopAllUnits (ncs_hdl hDevice)
	Stops movement of all dosing units. More...

Detailed Description

Functions for various dosing tasks.

This group defines all required functions for execution of different dosing tasks like dosing a certain volume or generating a continuous flow.

Function Documentation

NCS_Func long __stdcall NCS_DoseVolume	(	ncs_hdl	hDevice,
		unsigned char	DosingUnit,
		double *	pVolume,
		double *	pFlowRate
	)

Doses a defined volume with a defined flow rate.

It is possible to dispense and aspirate using this function. To dispense a certain volume, use positive flow rate values. To aspirate a certain volume use negative flow rate values.

Parameters

[in]	hDevice	Valid device handle
[in]	DosingUnit	Index of neMESYS pump from 0 to number of pumps - 1
[in,out]	pVolume	Points to buffer with volume value to dose. The volume value has to be in active volume unit format. On return the this buffer contains the realizable volume value.
[in,out]	pFlowRate	Points to buffer with flow rate value. The flow rate value has to be in active flow rate unit format. On return the this buffer contains the realizable volume value. Negative values = aspirate, positive values = dispense

Return values

ERR_NOERR	indicates success
-ERR_PERM	Movement not permitted because target position is outside of syringe or device limits

NCS_Func long __stdcall NCS_DoseVolumeEx	(	ncs_hdl	hDevice,
		unsigned char	DosingUnit,
		double *	pVolume,
		TVolUnitId	VolUnit,
		double *	pFlowRate,
		TFlowUnitId	FlowUnit
	)

Doses a defined volume with a defined flow rate.

Extended version of the NCS_DoseVolume() with parameters for volume and flow rate units. It is possible to dispense and aspirate using this function. To dispense a certain volume, use positive flow rate values. To aspirate a certain volume use negative flow rate values.

Parameters

[in]	hDevice	Valid device handle
[in]	DosingUnit	Index of neMESYS pump from 0 to number of pumps - 1
[in,out]	pVolume	Points to buffer with volume value to dose. On return the this buffer contains the realizable volume value.
[in]	VolUnit	Valid volume unit
[in,out]	pFlowRate	Points to buffer with flow rate value. On return the this buffer contains the realizable volume value. Negative values = aspirate, positive values = dispense
[in]	FlowUnit	Valid flow unit

Return values

ERR_NOERR	indicates success
-ERR_PERM	Movement not permitted because target position is outside of syringe or device limits

NCS_Func long __stdcall NCS_EmergencyStopAllUnits ( ncs_hdl hDevice )

Performs quick stop for all dosing units.

Use this function only if you have a serious error or problem.

Parameters

[in] hDevice Valid device handle

Returns: Error code - ERR_NOERR indicates success

NCS_Func long __stdcall NCS_EmptySyringe	(	ncs_hdl	hDevice,
		unsigned char	DosingUnit,
		double *	pFlowRate
	)

Eympties syringe by moving pusher to lower limit of dosing unit.

Parameters

[in]	hDevice	Valid device handle
[in]	DosingUnit	Index of neMESYS pump from 0 to number of pumps - 1
[in,out]	pFlowRate	Points to buffer with flow rate value. The flow rate value has to be in active flow rate unit format.

Returns: Error code - ERR_NOERR indicates success

NCS_Func long __stdcall NCS_EmptySyringeEx	(	ncs_hdl	hDevice,
		unsigned char	DosingUnit,
		double *	pFlowRate,
		TFlowUnitId	FlowUnit
	)

Eympties syringe by moving pusher to lower limit of dosing unit.

Extended version of the NCS_EmptySyringe() with parameters for flow rate units.

Parameters

[in]	hDevice	Valid device handle
[in]	DosingUnit	Index of neMESYS pump from 0 to number of pumps - 1
[in,out]	pFlowRate	Points to buffer with flow rate value. The flow rate value has to be in active flow rate unit format.
[in]	FlowUnit	Flow unit for value in pFlowRate

Returns: Error code - ERR_NOERR indicates success

NCS_Func long __stdcall NCS_GenerateFlow	(	ncs_hdl	hDevice,
		unsigned char	DosingUnit,
		double *	pFlowRate
	)

Generate define fluid stream until dosing unit reaches its limits.

You can dispense by providing positive flow rate values and aspirate by providing negative flow rate values.

Parameters

[in]	hDevice	Valid device handle
[in]	DosingUnit	Index of neMESYS pump from 0 to number of pumps - 1
[in,out]	pFlowRate	Points to buffer with flow rate value. The flow rate value has to be in active flow rate unit format.

Return values

ERR_NOERR	indicates success
-ERR_PERM	Movement not permitted because target position is outside of syringe or device limits

NCS_Func long __stdcall NCS_GenerateFlowEx	(	ncs_hdl	hDevice,
		unsigned char	DosingUnit,
		double *	pFlowRate,
		TFlowUnitId	FlowUnit
	)

Generate define fluid stream until dosing unit reaches its limits.

Extended version of the NCS_GenerateFlow() with parameters for volume and flow rate units. You can dispense by providing positive flow rate values and aspirate by providing negative flow rate values.

Parameters

[in]	hDevice	Valid device handle
[in]	DosingUnit	Index of neMESYS pump from 0 to number of pumps - 1
[in,out]	pFlowRate	Points to buffer with flow rate value. The flow rate value has to be in active flow rate unit format.
[in]	FlowUnit	Flow unit for value in pFlowRate

Return values

ERR_NOERR	indicates success
-ERR_PERM	Movement not permitted because target position is outside of syringe or device limits

NCS_Func long __stdcall NCS_RefillSyringe	(	ncs_hdl	hDevice,
		unsigned char	DosingUnit,
		double *	pFlowRate
	)

Refills syringe by moving pusher to upper limit of dosing unit.

Parameters

[in]	hDevice	Valid device handle
[in]	DosingUnit	Index of neMESYS pump from 0 to number of pumps - 1
[in,out]	pFlowRate	Points to buffer with flow rate value. The flow rate value has to be in active flow rate unit format.

Returns: Error code - ERR_NOERR indicates success

NCS_Func long __stdcall NCS_RefillSyringeEx	(	ncs_hdl	hDevice,
		unsigned char	DosingUnit,
		double *	pFlowRate,
		TFlowUnitId	FlowUnit
	)

Refills syringe by moving pusher to upper limit of dosing unit.

Extended version of the NCS_RefillSyrine() with parameters for flow rate units.

Parameters

[in]	hDevice	Valid device handle
[in]	DosingUnit	Index of neMESYS pump from 0 to number of pumps - 1
[in,out]	pFlowRate	Points to buffer with flow rate value. The flow rate value has to be in active flow rate unit format.
[in]	FlowUnit	Flow unit for value in pFlowRate

Returns: Error code - ERR_NOERR indicates success

NCS_Func long __stdcall NCS_SetSyringeLevel	(	ncs_hdl	hDevice,
		unsigned char	DosingUnit,
		double *	pVolume,
		double *	pFlowRate
	)

Moves the pusher until syringe content reaches a certain level.

Parameters

[in]	hDevice	Valid device handle
[in]	DosingUnit	Index of neMESYS pump from 0 to number of pumps - 1
[in,out]	pVolume	Points to buffer with volume value. The value defines the volume of reagent in the syringe. The volume value has to be in active volume unit format. On return the this buffer contains the realizable volume value.
[in,out]	pFlowRate	Points to buffer with flow rate value. The flow rate value has to be in active flow rate unit format. On return the this buffer contains the realizable volume value.

Return values

ERR_NOERR	indicates success
-ERR_PERM	Movement not permitted because target position is outside of syringe or device limits

NCS_Func long __stdcall NCS_SetSyringeLevelEx	(	ncs_hdl	hDevice,
		unsigned char	DosingUnit,
		double *	pVolume,
		TVolUnitId	VolUnit,
		double *	pFlowRate,
		TFlowUnitId	FlowUnit
	)

Moves the pusher until syringe content reaches a certain level.

Extended version of the NCS_SetSyringeLevel() with parameters for volume and flow rate units.

Parameters

[in]	hDevice	Valid device handle
[in]	DosingUnit	Index of neMESYS pump from 0 to number of pumps - 1
[in,out]	pVolume	Points to buffer with volume value to dose. On return the this buffer contains the realizable volume value.
[in]	VolUnit	Valid volume unit
[in,out]	pFlowRate	Points to buffer with flow rate value. On return the this buffer contains the realizable volume value.
[in]	FlowUnit	Valid flow unit

Return values

ERR_NOERR	indicates success
-ERR_PERM	Movement not permitted because target position is outside of syringe or device limits

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

Stop dosing of single unit.

Parameters

[in]	hDevice	Valid device handle
[in]	DosingUnit	Index of neMESYS pump from 0 to number of pumps - 1

Returns: Error code - ERR_NOERR indicates success

NCS_Func long __stdcall NCS_StopAllUnits ( ncs_hdl hDevice )

Stops movement of all dosing units.

Parameters

[in] hDevice Valid device handle

Returns: Error code - ERR_NOERR indicates success