GpibDeviceServer Class Commands
Name
Input type
Output type
Level
Description
State DEV_VOID DEV_STATE OPERATOR This command gets the device state (stored in its device_state data member) and returns it to the caller.
Status DEV_VOID CONST_DEV_STRING OPERATOR This command gets the device status (stored in its device_status data member) and returns it to the caller.
Write DEV_STRING DEV_VOID OPERATOR This command send a string to the device. Throws devFailed on error.
Read DEV_VOID DEV_STRING OPERATOR This command reads a string from a gpib device. Throws an DevFailed exception on error
Close DEV_VOID DEV_VOID EXPERT Close a previously opened gpib device.
Throws exception on error.
ReadLongString DEV_LONG DEV_STRING EXPERT For most gpib device the read command is enough to talk with the device. In certain case,
the gpibDevice returns a very big string, which is larger than the read buffer. For concret
example, on :CALC:DATA? command, the hp3588 returns 400 strings representing a
spectrum, for a total size> 4Kbytes. This method reads these sort of long string.
For efficiency, its better to use the read command instead of readLongString. This method
is provided for exceptionnal case. Throws DevFailed on error.
GetName DEV_VOID DEV_STRING EXPERT Return the gpib device name, as define on the gpib Driver (see them with ibconf tool).
Throws DevFailed on error
Local DEV_VOID DEV_VOID EXPERT Set the gpib device in local mode. Throws DevFailed on error.
Remote DEV_VOID DEV_VOID EXPERT Set the gpib device in remote mode. This command is here for compatibility, since
network access to a gpib Device, will automatically turn it to remote mode.
Throws DevFailed on error.
Getiberr DEV_VOID DEV_LONG EXPERT This command returns last gpib device error code (lib gpib iberr).
Throws DevFailed on error.
Getibsta DEV_VOID DEV_LONG EXPERT This command returns last gpib device state code (lib gpib ibsta).
Throws DevFailed on error.
Getibcnt DEV_VOID DEV_ULONG EXPERT This command returns last gpib device count var (lib gpib ibcnt).
Throws DevFailed on error.
Clear DEV_VOID DEV_VOID EXPERT This command clears the gpib device. Throws DevFailed exception on error.
SetTimeOut DEV_SHORT DEV_VOID EXPERT This command set Time Out value for the gpib device.
Warning these values are predefined, cf gpibDevice.h
accepted value are [0-15]. Throws DevFailed exception on error.
BCsendIFC DEV_VOID DEV_VOID EXPERT This commands send IFC to the gpib Board0.
So the board becomes Controller In Charge and devices are cleared.
All commands beginning with`BC` are Board Commands.
Throws DevFailed exception on error.
BCclr DEV_LONG DEV_VOID EXPERT This command clears a specified device.
Throws DevFailed exception on error.
GetDeviceID DEV_VOID DEV_LONG EXPERT This command return internal gpib device ID.
This is usefull for board command using this ID to acces devices, as BCclr cmd.
Throws DevFailed exception on error.
BCllo DEV_LONG DEV_VOID EXPERT This command send a local lockout to the specified device.
Throws DevFailed exception on error.
BCcmd DEV_STRING DEV_VOID EXPERT Send a GPIB command message.
This method is not used to transmit programming instruction to devices
this kind of instructions are transmitted with the read / write methods.
As done in write method, cmd automatically append EOS, as defined with
setEOS method.
Open DEV_VOID DEV_VOID EXPERT This command opens a gpib device using the gpibDeviceAddress property.
This command should not be used since gpib device is open on device server initialisation.
Its provided in case of problem to do it manually. Throws DevFailed exception on error.
This command is allowed on fault to accept reconnection.
OpenByName DEV_VOID DEV_VOID EXPERT This command opens a gpib device using the gpibDeviceName property.
This command should not be used since gpib device is opened on device server initialisation.
Its provided in case of problem to do it manually. Throws DevFailed exception on error.
This command is allowed on fault to accept reconnection.
BCGetConnectedDeviceList DEV_VOID DEVVAR_STRINGARRAY EXPERT This command returns the string array :

+ primary address + secondary address for 1st device found

+ primary address + secondary address for 2d device found
ect ....
ex:
HEWLETT-PACKARD,3589A,3343A00642,A.00.03 PAD=6 SAD=0
Trigger DEV_VOID DEV_VOID EXPERT This command sends a trigger signal to the GPIB device.
If the device was previously set up, it can make its measurment, and send it on the bus.
Measure is now get with a read command.
WriteRead DEV_STRING DEV_STRING OPERATOR This command perform a write on the GPIB device, and then perform a read to
get the answer, before returning it.
Config DEVVAR_LONGARRAY DEV_VOID EXPERT index 0 of input array is the GPIB option to modify.
index 1 is the new value to associate to this option.
BCConfig DEVVAR_LONGARRAY DEV_VOID EXPERT Same method than Config, but sent on gpib Board instead of GPIB device.
SendBinData DEVVAR_CHARARRAY DEV_VOID OPERATOR This command send an array of binary data to the device through the GPIB bus.
Throws devFailed on error.
ReceiveBinData DEV_LONG DEVVAR_CHARARRAY OPERATOR This command reads an array of binary data from a gpib device.
Up to 65536 bytes. In generaly, a Gpib device can send or receive 64Ko.
Throws an DevFailed exception on error