1 programming interface definitions – Metrohm 846 Driver Toolbox User Manual
Page 28
3.1 Programming interface definitions
24
Dosing Interface USB Toolbox, Annex
public static final void dosStop(int ifNo, int msbNo) throws DosIntFace846Exception{
int nReturnstate = DosIntFace846.callStop(ifNo, msbNo);
if (nReturnstate != 0)
throw new DosInt-
Face846Exception(DosIntFace846Exception.getErrorString(nReturnstate), nReturnstate);
}
/**
* Holds the current Dosino action. The held action can be continued or finally stopped.
*
* @param ifNo Dosing Interface [1... ?]
* @param msbNo Dosino at MSB [1... 4]
* @throws DosIntFace846Exception
*/
public static final void dosHold(int ifNo, int msbNo) throws DosIntFace846Exception{
int nReturnstate = DosIntFace846.callHold(ifNo, msbNo);
if (nReturnstate != 0)
throw new DosInt-
Face846Exception(DosIntFace846Exception.getErrorString(nReturnstate), nReturnstate);
}
/**
* Continue a held Dosino action.
*
* @param ifNo Dosing Interface [1... ?]
* @param msbNo Dosino at MSB [1... 4]
* @throws DosIntFace846Exception
*/
public static final void dosCont(int ifNo, int msbNo) throws DosIntFace846Exception{
int nReturnstate = DosIntFace846.callCont(ifNo, msbNo);
if (nReturnstate != 0)
throw new DosInt-
Face846Exception(DosIntFace846Exception.getErrorString(nReturnstate), nReturnstate);
}
/**
* Prepares a Dosing Unit for further use. A "Prep" cycle includes emptying the dosing
cylinder and rinsing and
* filling the tubings in one automated process.
*
* @param ifNo Dosing Interface [1... ?]
* @param msbNo Dosino at MSB [1... 4]
* @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 duPrep(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.callPrep(ifNo, msbNo, inPort, inVolume, inRate,
outPort, outVolume, outRate,
specPort, specVolume, specRate);
if (nReturnstate != 0)
throw new DosInt-
Face846Exception(DosIntFace846Exception.getErrorString(nReturnstate), nReturnstate);
}
/**
* Empties the Buret Unit. Dosing cylinder and tubings are emptied in one automated
process.
*
* @param ifNo Dosing Interface [1... ?]
* @param msbNo Dosino at MSB [1... 4]