1 programming interface definitions – Metrohm 846 Driver Toolbox User Manual
Page 25
3.1 Programming interface definitions
Dosing Interface USB Toolbox, Annex
21
*
* @param ifNo Dosing Interface [1... ?]
* @param msbNo Dosino at MSB [1... 4]
* @return Volume 0; 2; 5; 10; 20; 50 mL, Cylinder volume = 0 means: no Dosing Unit
mounted!
* @throws DosIntFace846Exception
*/
public static final int getCylVolume(int ifNo, int msbNo) throws DosIntFace846Exception{
dosinoVolume = 0;
int nReturnstate = DosIntFace846.callCylVolume(ifNo, msbNo);
if (nReturnstate == 0)
return dosinoVolume;
else
throw new DosInt-
Face846Exception(DosIntFace846Exception.getErrorString(nReturnstate), nReturnstate);
}
/**
* Turns the valve disk to the selected port. The turning direction is chosen
* according to "Move". If "Move" is set to protected mode, the Port specified
* in "NotOver" will not be crossed. Otherwise this parameter is ignored.
*
* @param ifNo Dosing Interface [1... ?]
* @param msbNo Dosino at MSB [1... 4]
* @param port Target Dosino port [1... 4]
* @param move Turning direction of the valve disk [eCockMove]
* @param notOver protected Dosino port [1... 4]
* @throws DosIntFace846Exception
*/
public static final void duCock(int ifNo, int msbNo, int port, int move, int notOver)
throws DosIntFace846Exception{
int nReturnstate = DosIntFace846.callCock(ifNo, msbNo, port, move, notOver);
if (nReturnstate != 0)
throw new DosInt-
Face846Exception(DosIntFace846Exception.getErrorString(nReturnstate), nReturnstate);
}
/**
* Moves the piston of the Dosino to zero position and initializes the drive.
*
* @param ifNo Dosing Interface [1... ?]
* @param msbNo Dosino at MSB [1... 4]
* @param revRate Filling rate of piston [0.01...166mL/min]
* @throws DosIntFace846Exception
*/
public static final void zeroAdjust(int ifNo, int msbNo, float revRate) throws DosInt-
Face846Exception{
int nReturnstate = DosIntFace846.callZeroAdjust(ifNo, msbNo, revRate);
if (nReturnstate != 0)
throw new DosInt-
Face846Exception(DosIntFace846Exception.getErrorString(nReturnstate), nReturnstate);
}
/**
* Eliminate slack of piston coupling.
* This function can be used, when the direction of the piston movement is about to be
changed.
*
* @param ifNo Dosing Interface [1... ?]
* @param msbNo Dosino at MSB [1... 4]
* @param direction Direction of the desired piston movement [eDirection]
* @throws DosIntFace846Exception
*/
public static final void adjust (int ifNo, int msbNo, int direction) throws DosInt-
Face846Exception{
int nReturnstate = DosIntFace846.callAdjust (ifNo, msbNo, direction);
if (nReturnstate != 0)
throw new DosInt-
Face846Exception(DosIntFace846Exception.getErrorString(nReturnstate), nReturnstate);
}
/**