December 2011 | SOCET GXP | Software update

Using the SOCET GXP API Tester

Brian Roberts

Brian Roberts

SOCET GXP comes with an auxiliary program, the API Tester, to help SOCET GXP API developers interface with other applications.

Developers use the powerful API Tester to experiment with different API commands and options to discover how they function prior to coding. In addition to testing commands, the API Tester monitors API events in real time. This capability can greatly reduce the time it takes to debug complex event handling errors in client applications.

The API tester can be launched by either adding the executable, gxpapitest.exe, to the Workspace Manager as a custom menu item or from the command line with the command:

start_gxp.bat –exename gxpapitest.exe

API Tester start-up window

API Tester start-up window

Once launched, click the Connect button to connect the API Tester to SOCET GXP. Click the Commands button to open the Command Tester and/or the Manage/View Events button to view API events as they happen. The Command tester has two sections. The top section is divided into a series of tabs and shows data currently loaded into SOCET GXP. Use these options to select images, terrain, Multiports, etc., as input into the commands you would like to test. The bottom section groups individual commands into tabs based on function. For example, to display a loaded image into a Multiport, select the image from the Image Data tab at the top, then select the Multiport tab at the bottom. Various options are shown, each corresponding to different API methods for displaying the image in a Multiport.

API Tester Command Tester window

API Tester Command Tester window

The Manage/View Events window is divided into a series of tabs, one for each event type. As SOCET GXP API events are triggered, information about the event, including the order in which the event was triggered, data associated with the event, and the event queue ID are displayed in the appropriate tab. Event data can be cleared from individual or all tabs as needed. Event data is displayed for events triggered by SOCET GXP user interaction, client applications issuing commands to SOCET GXP, or through use of the API Tester’s Command Tester window. For more information on using the API Tester please contact a customer support representative.

API Tester Manage/View Events window

API Tester Manage/View Events window

Comments are closed.