1 programming interface definitions – Metrohm 846 Driver Toolbox User Manual
Page 29

3.1 Programming interface definitions
Dosing Interface USB Toolbox, Annex
25
* @param inPort Filling port [1... 4]
* @param inVolume Fill tube volume [0... 20000 mm^3]
* @param inRate Filling rate [0.01... 166 mL/min]
* @param outPort Output port 1 [1... 4]
* @param outVolume Dosing tube volume on Output port 1 [0... 20000 mm^3]
* @param outRate Dosing rate on Output port 1 [0.01... 166 mL/min]
* @param specPort Output port 2 [1... 4]
* @param specVolume Dosing tube volume on Output port 2 [0... 20000 mm^3]
* @param specRate Dosing rate on Output port 1 [0.01... 166 mL/min]
* @throws DosIntFace846Exception
*/
public static final void duEmpty(int ifNo, int msbNo, int inPort, float inVolume, float
inRate,
int outPort, float outVolume, float outRate,
int specPort, float specVolume, float specRate) throws DosIntFace846Exception{
int nReturnstate = DosIntFace846.callEmpty(ifNo, msbNo, inPort, inVolume, inRate,
outPort, outVolume, outRate,
specPort, specVolume, specRate);
if (nReturnstate != 0)
throw new DosInt-
Face846Exception(DosIntFace846Exception.getErrorString(nReturnstate), nReturnstate);
}
/**
* Reads casual error messages which occur during Dosino actions.
*
* @param ifNo Dosing Interface [1... ?]
* @param msbNo Dosino at MSB [1... 4]
* @param errorNumber Error number [0... 9]
* @return error code as return value [GGG-CCC-K-III], G = group, C = code, K = class, I =
index (1...4 or 255)
* @throws DosIntFace846Exception
*/
public static final String getInterfaceError(int ifNo, int msbNo, int errorNumber) throws
DosIntFace846Exception{
errorCode = "";
int nReturnstate = DosIntFace846.callInterfaceError(ifNo, msbNo, errorNumber);
if (nReturnstate == 0)
return errorCode;
else
throw new DosInt-
Face846Exception(DosIntFace846Exception.getErrorString(nReturnstate), nReturnstate);
}
/**
* Reads the stop condition of a Dosino action.
*
* @param ifNo Dosing Interface [1... ?]
* @param msbNo Dosino at MSB [1... 4]
* @return Stop type of the last action
* @throws DosIntFace846Exception
*/
public static final int getStopType(int ifNo, int msbNo) throws DosIntFace846Exception{
stopType = 0;
int nReturnstate = DosIntFace846.callStopType(ifNo, msbNo);
if (nReturnstate == 0)
return stopType;
else
throw new DosInt-
Face846Exception(DosIntFace846Exception.getErrorString(nReturnstate), nReturnstate);
}
/**
* Reads the serial number of a Dosing Interface. The serial number can be used as a
unique identifier of an instrument.
*
* @param ifNo Dosing Interface [1... ?]
* @return Serial number of Dosing Interface
* @throws DosIntFace846Exception