Gocator API
 All Classes Files Functions Variables Typedefs Macros Groups Pages
GoControl Class Reference

Description

Represents a set of sensor command connections (control, upgrade).

Inherits kObject.

Public Member Functions

kStatus GoControl_Backup (GoControl control, kByte **fileData, k32u *size, kAlloc allocator)
 Creates and downloads a backup of sensor files. More...
 
kStatus GoControl_BeginAlignment (GoControl control)
 Sends a alignment command to a sensor, but doesn't wait for the response. More...
 
kStatus GoControl_BeginExposureAutoSet (GoControl control, GoRole role)
 Sends an exposure auto set command to a sensor, but doesn't wait for the response. More...
 
kStatus GoControl_BeginStart (GoControl control)
 Sends a start command to a sensor with the currently selected input source, but doesn't wait for the response. More...
 
kStatus GoControl_BeginStop (GoControl control)
 Sends a stop command to a sensor, but doesn't wait for the response. More...
 
kStatus GoControl_BeginUpgrade (GoControl control, void *data, kSize size)
 Begins a sensor firmware upgrade. More...
 
kStatus GoControl_ChangeBuddy (GoControl control, kBool add, k32u buddyId)
 Assigns or removes a buddy sensor. More...
 
kStatus GoControl_ChangePassword (GoControl control, GoUser user, const kChar *password)
 Changes the password associated with the specified user account. More...
 
kStatus GoControl_ClearLog (GoControl control)
 Clears the sensor log file. More...
 
kStatus GoControl_ClearMeasurementStats (GoControl control)
 Clear the sensor's measurement statistics. More...
 
kStatus GoControl_ClearReplayData (GoControl control)
 Clear the sensor's replay data. More...
 
kStatus GoControl_Close (GoControl control)
 Closes all open command connections. More...
 
kStatus GoControl_Construct (GoControl *control, kAlloc allocator)
 Constructs a GoControl object. More...
 
kStatus GoControl_CopyFile (GoControl control, const kChar *source, const kChar *destination)
 Copies a file within the connected sensor. More...
 
kStatus GoControl_DeleteFile (GoControl control, const kChar *fileName)
 Deletes a file within the connected sensor. More...
 
kStatus GoControl_EndAlignment (GoControl control)
 Waits for a alignment response from a sensor. More...
 
kStatus GoControl_EndExposureAutoSet (GoControl control)
 Waits for a exposure auto set response from a sensor. More...
 
kStatus GoControl_EndStart (GoControl control)
 Waits for a start response from a sensor. More...
 
kStatus GoControl_EndStop (GoControl control)
 Waits for a stop response from a sensor. More...
 
kStatus GoControl_ExportBitmap (GoControl control, GoReplayExportSourceType type, GoDataSource source, const kChar *dstFileName)
 Export an intensity bitmap file to local storage. More...
 
kStatus GoControl_ExportCsv (GoControl control, const kChar *dstFileName)
 Export a CSV file to local storage. More...
 
kStatus GoControl_GetAlignmentReference (GoControl control, GoAlignmentRef *reference)
 Gets the alignment reference for a sensor. More...
 
kStatus GoControl_GetAutoStartEnabled (GoControl control, kBool *enabled)
 Returns the state of sensor AutoStart. More...
 
kStatus GoControl_GetDefaultJob (GoControl control, kChar *fileName, kSize capacity)
 Gets the name of the default configuration or template file to be loaded on boot. More...
 
kStatus GoControl_GetEncoder (GoControl control, k64s *encoder)
 Gets the current system encoder value. More...
 
kStatus GoControl_GetInputSource (GoControl control, GoInputSource *source)
 Gets the sensor's data input source. More...
 
kStatus GoControl_GetLoadedJob (GoControl control, kChar *fileName, kSize capacity, kBool *isModified)
 Gets the name of the loaded job file and whether it has been modified since loading. More...
 
kStatus GoControl_GetRecordingEnabled (GoControl control, kBool *enabled)
 Get's the sensor's recording state. More...
 
kStatus GoControl_GetScanMode (GoControl control, GoMode *mode)
 Gets the sensor's scan mode. More...
 
kStatus GoControl_GetSensorInfo (GoControl control, GoSensorInfo info)
 Gets current sensor state information. More...
 
kStatus GoControl_GetStates (GoControl control, GoStates *states)
 Retrieves a set of various sensor states. More...
 
kStatus GoControl_GetTimeStamp (GoControl control, k64u *time)
 Gets the current time stamp value(common among all synchronized sensors). More...
 
kStatus GoControl_GetUpgradeStatus (GoControl control, kBool *complete, kBool *succeeded, k32s *progress)
 Polls for upgrade status. More...
 
kBool GoControl_IsCompatible (GoControl control)
 Reports whether the GoControl object is compatible with the sensor firmware. More...
 
kBool GoControl_IsConnected (GoControl control)
 Reports whether the control object has been opened. More...
 
kStatus GoControl_Login (GoControl control, GoUser user, const kChar *password)
 Logs into the sensor using the specified user name and password. More...
 
kStatus GoControl_Open (GoControl control, kIpAddress address)
 Opens connections to the specified sensor IP address. More...
 
kStatus GoControl_PlaybackPosition (GoControl control, k32u *position, k32u *count)
 Get the current frame position in a replay. More...
 
kStatus GoControl_PlaybackSeek (GoControl control, k32u position)
 Seek to the specified frame position for a replay. More...
 
kStatus GoControl_PlaybackStep (GoControl control, GoSeekDirection direction)
 Advance one frame in a replay. More...
 
kVersion GoControl_ProtocolVersion (GoControl control)
 Gets the connected sensor's protocol version. More...
 
kStatus GoControl_ReadFile (GoControl control, const kChar *fileName, kByte **data, kSize *size, kAlloc allocator)
 Reads a file from the connected sensor. More...
 
kStatus GoControl_ReadFileList (GoControl control, kArrayList files, const kChar *extensionFilter)
 Reads the list of available sensor files. More...
 
kStatus GoControl_Reset (GoControl control)
 Reboots the main sensor and any connected buddy sensors. More...
 
kStatus GoControl_Restore (GoControl control, const kByte *fileData, k32u size)
 Restores a backup of sensor files. More...
 
kStatus GoControl_RestoreFactory (GoControl control, kBool restoreAddress)
 Restores factory default settings. More...
 
kStatus GoControl_ScheduleAnalog (GoControl control, k16u index, k64s target, k32s value)
 Schedules an analog output. More...
 
kStatus GoControl_ScheduleDigital (GoControl control, k16u index, k64s target, k8u value)
 Schedules a digital output. More...
 
kStatus GoControl_SetAlignmentReference (GoControl control, GoAlignmentRef reference)
 Sets the alignment reference for a sensor. More...
 
kStatus GoControl_SetAutoStartEnabled (GoControl control, kBool enable)
 Enable or disable sensor AutoStart. More...
 
kStatus GoControl_SetCancelHandler (GoControl control, kCallbackFx function, kPointer receiver)
 Sets an I/O cancellation query handler for this control object. More...
 
kStatus GoControl_SetDefaultJob (GoControl control, const kChar *fileName)
 Sets a default job file to be loaded on boot. More...
 
kStatus GoControl_SetInputSource (GoControl control, GoInputSource source)
 Sets the sensor's data input source. More...
 
kStatus GoControl_SetRecordingEnabled (GoControl control, kBool enable)
 Enables recording on the sensor. More...
 
kStatus GoControl_Simulate (GoControl control, kBool *isBufferValid)
 Simulate the current frame stored on the sensor's live replay buffer. More...
 
kStatus GoControl_Trigger (GoControl control)
 Sends a software trigger to the sensor. More...
 
kStatus GoControl_WriteFile (GoControl control, const kChar *fileName, const kByte *data, k32u size)
 Writes a file to the connected sensor. More...
 

Member Function Documentation

kStatus GoControl_Backup ( GoControl  control,
kByte **  fileData,
k32u *  size,
kAlloc  allocator 
)

Creates and downloads a backup of sensor files.

Parameters
controlGoControl object.
fileDataReceives a pointer to a buffer containing the backup data.
sizeReceives the size of the allocated buffer.
allocatorMemory allocator, used to allocate the backup buffer (or kNULL for default).
Returns
Operation status.
kStatus GoControl_BeginAlignment ( GoControl  control)

Sends a alignment command to a sensor, but doesn't wait for the response.

Use the EndAlignment function to wait for the sensor's reply.

Parameters
controlGoControl object.
Returns
Operation status.
kStatus GoControl_BeginExposureAutoSet ( GoControl  control,
GoRole  role 
)

Sends an exposure auto set command to a sensor, but doesn't wait for the response.

Use the EndExposureAutoSet function to wait for the sensor's reply.

Parameters
controlGoControl object.
roleThe sensor's role.
Returns
Operation status.
kStatus GoControl_BeginStart ( GoControl  control)

Sends a start command to a sensor with the currently selected input source, but doesn't wait for the response.

Use the EndStart function to wait for the sensor's reply.

Parameters
controlGoControl object.
targetStart time or encoder value.
Returns
Operation status.
See also
GoControl_SetInputSource, GoControl_GetInputSource
kStatus GoControl_BeginStop ( GoControl  control)

Sends a stop command to a sensor, but doesn't wait for the response.

Use the EndStop function to wait for the sensor's reply.

Parameters
controlGoControl object.
Returns
Operation status.
kStatus GoControl_BeginUpgrade ( GoControl  control,
void *  data,
kSize  size 
)

Begins a sensor firmware upgrade.

Use the GetUpgradeStatus function to poll for upgrade completion.

Parameters
controlGoControl object.
dataPointer to buffer containing upgrade file.
sizeSize of upgrade file.
Returns
Operation status.
kStatus GoControl_ChangeBuddy ( GoControl  control,
kBool  add,
k32u  buddyId 
)

Assigns or removes a buddy sensor.

Parameters
controlGoControl object.
addkTRUE to add; kFALSE to remove.
buddyIdBuddy device id.
Returns
Operation status.
kStatus GoControl_ChangePassword ( GoControl  control,
GoUser  user,
const kChar *  password 
)

Changes the password associated with the specified user account.

Parameters
controlGoControl object.
userUser account.
passwordNew password.
Returns
Operation status.
kStatus GoControl_ClearLog ( GoControl  control)

Clears the sensor log file.

Parameters
controlGoControl object.
Returns
Operation status.
kStatus GoControl_ClearMeasurementStats ( GoControl  control)

Clear the sensor's measurement statistics.

Parameters
controlGoControl object.
Returns
Operation status.
kStatus GoControl_ClearReplayData ( GoControl  control)

Clear the sensor's replay data.

Parameters
controlGoControl object.
Returns
Operation status.
kStatus GoControl_Close ( GoControl  control)

Closes all open command connections.

Parameters
controlGoControl object.
Returns
Operation status.
kStatus GoControl_Construct ( GoControl control,
kAlloc  allocator 
)

Constructs a GoControl object.

Parameters
controlReceives constructed control object.
allocatorMemory allocator (or kNULL for default).
Returns
Operation status.
kStatus GoControl_CopyFile ( GoControl  control,
const kChar *  source,
const kChar *  destination 
)

Copies a file within the connected sensor.

Parameters
controlGoControl object.
sourceSource name for the file to be copied.
destinationDestination name for the file (maximum 63 characters).
Returns
Operation status.
kStatus GoControl_DeleteFile ( GoControl  control,
const kChar *  fileName 
)

Deletes a file within the connected sensor.

Parameters
controlGoControl object.
fileNameName of the file to be deleted.
Returns
Operation status.
kStatus GoControl_EndAlignment ( GoControl  control)

Waits for a alignment response from a sensor.

Call this function sometime after calling BeginAlignment.

Parameters
controlGoControl object.
Returns
Operation status.
kStatus GoControl_EndExposureAutoSet ( GoControl  control)

Waits for a exposure auto set response from a sensor.

Call this function sometime after calling BeginExposureAutoSet.

Parameters
controlGoControl object.
Returns
Operation status.
kStatus GoControl_EndStart ( GoControl  control)

Waits for a start response from a sensor.

Call this function sometime after calling BeginStart.

Parameters
controlGoControl object.
Returns
Operation status.
kStatus GoControl_EndStop ( GoControl  control)

Waits for a stop response from a sensor.

Call this function sometime after calling BeginStop.

Parameters
controlGoControl object.
Returns
Operation status.
kStatus GoControl_ExportBitmap ( GoControl  control,
GoReplayExportSourceType  type,
GoDataSource  source,
const kChar *  dstFileName 
)

Export an intensity bitmap file to local storage.

Parameters
controlGoControl object.
typeThe type of data to export.
sourceThe data source to obtain data from.
dstFileNameThe destination file name.
Returns
Operation status.
kStatus GoControl_ExportCsv ( GoControl  control,
const kChar *  dstFileName 
)

Export a CSV file to local storage.

Parameters
controlGoControl object.
dstFileNameThe destination file name.
Returns
Operation status.
kStatus GoControl_GetAlignmentReference ( GoControl  control,
GoAlignmentRef *  reference 
)

Gets the alignment reference for a sensor.

Parameters
controlGoControl object.
referenceAlignment reference.
Returns
Operation status.
kStatus GoControl_GetAutoStartEnabled ( GoControl  control,
kBool *  enabled 
)

Returns the state of sensor AutoStart.

Parameters
enabledA pointer to store the boolean state of sensor AutoStart. kTRUE if enabled and kFALSE if disabled.
Returns
Operation status.
kStatus GoControl_GetDefaultJob ( GoControl  control,
kChar *  fileName,
kSize  capacity 
)

Gets the name of the default configuration or template file to be loaded on boot.

Parameters
controlGoControl object.
extensionType of file ("cfg", "rec", or "prof").
fileNameReceives name of the default file.
capacityName buffer capacity.
Returns
Operation status.
kStatus GoControl_GetEncoder ( GoControl  control,
k64s *  encoder 
)

Gets the current system encoder value.

Parameters
controlGoControl object.
encoderReceives encoder value.
Returns
Operation status.
kStatus GoControl_GetInputSource ( GoControl  control,
GoInputSource *  source 
)

Gets the sensor's data input source.

Parameters
controlGoControl object.
inputSourceReceives the data source used by the sensor.
Returns
Operation status.
kStatus GoControl_GetLoadedJob ( GoControl  control,
kChar *  fileName,
kSize  capacity,
kBool *  isModified 
)

Gets the name of the loaded job file and whether it has been modified since loading.

Parameters
controlGoControl object.
extensionFile extension; identifies type of file (e.g. "cfg").
fileNameReceives name of the loaded file.
capacityName buffer capacity.
isModifiedReceives the status of whether the file has changed.
Returns
Operation status.
kStatus GoControl_GetRecordingEnabled ( GoControl  control,
kBool *  enabled 
)

Get's the sensor's recording state.

Parameters
controlGoControl object.
enabledReceives the recording state.
Returns
Operation status.
kStatus GoControl_GetScanMode ( GoControl  control,
GoMode *  mode 
)

Gets the sensor's scan mode.

Parameters
controlGoControl object.
modeReceives the scan mode.
Returns
Operation status.
kStatus GoControl_GetSensorInfo ( GoControl  control,
GoSensorInfo  info 
)

Gets current sensor state information.

Parameters
controlGoControl object.
infoReceives sensor information.
Returns
Operation status.
kStatus GoControl_GetStates ( GoControl  control,
GoStates states 
)

Retrieves a set of various sensor states.

Parameters
controlGoControl object.
statesA struct of current sensor states.
Returns
Operation status.
kStatus GoControl_GetTimeStamp ( GoControl  control,
k64u *  time 
)

Gets the current time stamp value(common among all synchronized sensors).

Parameters
controlGoControl object.
timeReceives the time stamp value.
Returns
Operation status.
kStatus GoControl_GetUpgradeStatus ( GoControl  control,
kBool *  complete,
kBool *  succeeded,
k32s *  progress 
)

Polls for upgrade status.

Parameters
controlGoControl object.
completeReceives boolean indicating upgrade completion.
succeededIf complete, receives boolean indicating whether upgrade was successful.
progressIf not complete, receives integer percentage indicating progress.
Returns
Operation status.
kBool GoControl_IsCompatible ( GoControl  control)

Reports whether the GoControl object is compatible with the sensor firmware.

Compatibility is determined by comparing the major protocol version reported by the sensor with the major protocol version supported by this library. If the major versions match, then compatibility is established.

Parameters
controlGoControl object.
Returns
kTRUE if compatible; kFALSE otherwise.
kBool GoControl_IsConnected ( GoControl  control)

Reports whether the control object has been opened.

Parameters
controlGoControl object.
Returns
kTRUE if connected; kFALSE otherwise.
kStatus GoControl_Login ( GoControl  control,
GoUser  user,
const kChar *  password 
)

Logs into the sensor using the specified user name and password.

Parameters
controlGoControl object.
userUser account.
passwordUser password.
Returns
Operation status.
kStatus GoControl_Open ( GoControl  control,
kIpAddress  address 
)

Opens connections to the specified sensor IP address.

The Open function immediately opens a control connection. Later, while in the open state, if an upgrade command is given, an upgrade connection will be established automatically at that time.

Parameters
controlGoControl object.
addressSensor IP address.
Returns
Operation status.
kStatus GoControl_PlaybackPosition ( GoControl  control,
k32u *  position,
k32u *  count 
)

Get the current frame position in a replay.

Parameters
controlGoControl object.
positionReplay frame position.
countReplay frame count.
Returns
Operation status.
kStatus GoControl_PlaybackSeek ( GoControl  control,
k32u  position 
)

Seek to the specified frame position for a replay.

Parameters
controlGoControl object.
positionReplay frame position.
Returns
Operation status.
kStatus GoControl_PlaybackStep ( GoControl  control,
GoSeekDirection  direction 
)

Advance one frame in a replay.

Parameters
controlGoControl object.
directionThe direction to seek.
Returns
Operation status.
kVersion GoControl_ProtocolVersion ( GoControl  control)

Gets the connected sensor's protocol version.

Parameters
controlGoControl object.
Returns
Protocol version.
kStatus GoControl_ReadFile ( GoControl  control,
const kChar *  fileName,
kByte **  data,
kSize *  size,
kAlloc  allocator 
)

Reads a file from the connected sensor.

Parameters
controlGoControl object.
fileNameName of remote file to be read.
dataReceives a pointer to a buffer containing the file data.
sizeReceives the size of the allocated buffer.
allocatorMemory allocator, used to allocate the file buffer (or kNULL for default).
Returns
Operation status.
kStatus GoControl_ReadFileList ( GoControl  control,
kArrayList  files,
const kChar *  extensionFilter 
)

Reads the list of available sensor files.

Parameters
controlGoControl object.
filesList to be populated with file names (kArrayList<kText64>).
extensionFilterCan be used to filter the file list: "cfg", "rec", "prof", "xml", or null for all.
Returns
Operation status.
kStatus GoControl_Reset ( GoControl  control)

Reboots the main sensor and any connected buddy sensors.

Parameters
controlGoControl object.
Returns
Operation status.
kStatus GoControl_Restore ( GoControl  control,
const kByte *  fileData,
k32u  size 
)

Restores a backup of sensor files.

Parameters
controlGoControl object.
fileDataPointer to a buffer containing the backup data to be restored.
sizeSize of the backup buffer.
Returns
Operation status.
kStatus GoControl_RestoreFactory ( GoControl  control,
kBool  restoreAddress 
)

Restores factory default settings.

Parameters
controlGoControl object.
restoreAddresskTRUE to restore the factory default IP address; False otherwise.
Returns
Operation status.
kStatus GoControl_ScheduleAnalog ( GoControl  control,
k16u  index,
k64s  target,
k32s  value 
)

Schedules an analog output.

Parameters
controlGoControl object.
indexThe analog output index.
targetThe time or position target (us or mm), depending on the configured domain. Ignored if scheduling disabled.
valueThe value of the scheduled output (mA).
Returns
Operation status.
kStatus GoControl_ScheduleDigital ( GoControl  control,
k16u  index,
k64s  target,
k8u  value 
)

Schedules a digital output.

Parameters
controlGoControl object.
indexThe digital output index.
targetThe time or position target (us or mm), depending on the configured domain. Ignored if scheduling disabled or pulsed mode enabled.
valueThe value of scheduled output (0-Low or 1-High). Ignored if pulsed mode enabled.
Returns
Operation status.
kStatus GoControl_SetAlignmentReference ( GoControl  control,
GoAlignmentRef  reference 
)

Sets the alignment reference for a sensor.

Parameters
controlGoControl object.
referenceAlignment reference.
Returns
Operation status.
kStatus GoControl_SetAutoStartEnabled ( GoControl  control,
kBool  enable 
)

Enable or disable sensor AutoStart.

Parameters
enablekTRUE to enable AutoStart, kFALSE to disable it.
Returns
Operation status.
kStatus GoControl_SetCancelHandler ( GoControl  control,
kCallbackFx  function,
kPointer  receiver 
)

Sets an I/O cancellation query handler for this control object.

The I/O cancellation query handler will be polled periodically when I/O is blocked for a non-negligible amount of time. If the cancellation handler returns kERROR_ABORT, ongoing communication will be terminated.

Parameters
controlControl object.
functionI/O cancellation callback function (or kNULL to unregister).
receiverReceiver argument for callback.
Returns
Operation status.
kStatus GoControl_SetDefaultJob ( GoControl  control,
const kChar *  fileName 
)

Sets a default job file to be loaded on boot.

Parameters
controlGoControl object.
fileNameName of the default file.
Returns
Operation status.
kStatus GoControl_SetInputSource ( GoControl  control,
GoInputSource  source 
)

Sets the sensor's data input source.

Parameters
controlGoControl object.
inputSourceThe input source to set.
Returns
Operation status.
kStatus GoControl_SetRecordingEnabled ( GoControl  control,
kBool  enable 
)

Enables recording on the sensor.

Parameters
controlGoControl object.
enableEnable or disable recording.
Returns
Operation status.
kStatus GoControl_Simulate ( GoControl  control,
kBool *  isBufferValid 
)

Simulate the current frame stored on the sensor's live replay buffer.

Parameters
controlGoControl object.
isBufferValidRepresents whether the specified data input source contained valid data to simulate against.
Returns
Operation status.
kStatus GoControl_Trigger ( GoControl  control)

Sends a software trigger to the sensor.

Parameters
controlGoControl object.
Returns
Operation status.
kStatus GoControl_WriteFile ( GoControl  control,
const kChar *  fileName,
const kByte *  data,
k32u  size 
)

Writes a file to the connected sensor.

Parameters
controlGoControl object.
fileNameName of remote file to be written.
dataPointer to buffer containing the file data.
sizeSize of the file.
Returns
Operation status.

The documentation for this class was generated from the following file: