Campbell Scientific TDRSDK Software Developement Kit - Manual (Page 9)

TDRSDK Software Development Kit for TDR100
5
3.2 Commands to retrieve TDR100 waveform parameter values
The waveform parameter values are (1) relative propagation velocity, Vp, (2)
waveform averaging, (3) number of data points in waveform, (4) distance to
beginning of waveform, (5) length of waveform window, (6) probe rod length,
(7) probe offset, and (8) cell constant or Kp.
When a ‘request’ command is issued, Callback or State Machine is used to
determine if requested data is available. When Callback or State Machine is
satisfied the data is written to the DLL. A ‘get’ command is then used to get
the data from the DLL to the API.
8. ReqSettings
Allows calling application to request current TDR100 parameter settings. If no
error occurred, current settings will be available from the DLL, and can be
retrieved using the GetSetting (#9) API call after you receive a call back or get
a state 100. Result: Settings values are sent by the TDR100 to the DLL.
int ReqSettings
Parameters: None
Return Codes: 0 = Success
1 = Failure
9. GetSetting
Allows calling application to get TDR100 parameter settings stored in DLL.
This command, if successful, will return a record containing a setting. This
command must be called repeatedly to get all 9 settings.
int GetSetting(int recNbr, float Fval)
Parameters: recNbr: number counting from 1 in a data structure.
Fval: Pointer to a floating point value.
Return Codes: 0 = Success
1 = Failure
3.3 Commands for setting TDR100 parameters
10. SetVpSetting
Allows calling application to set the TDR100 relative propagation velocity, Vp.
When transaction is complete, the call-back procedure will be called (if
required), or the state machine can be queried until non-zero state is obtained.
int SetVpSetting(float fValue)
Parameters: fValue: Float, value with which to set TDR100 Vp setting.
Return Code: 0 = Success
1 = Failure