Gocator API
 All Classes Files Functions Variables Typedefs Macros Modules Pages
GoSensor Class Reference

Description

Represents a Gocator sensor.

Inheritance diagram for GoSensor:
Inheritance graph

Public Types

typedef kStatus(kCallGoSensorDataSetFx )(kPointer context, GoSensor sensor, GoDataSet dataSet)
 Defines the signature for a custom data message handler. More...
 

Public Member Functions

kStatus GoSensor_AddBuddy (GoSensor sensor, GoSensor buddy)
 Assigns a buddy sensor. More...
 
kStatus GoSensor_Address (GoSensor sensor, GoAddressInfo *info)
 Retrieves the sensor's network address settings. More...
 
kStatus GoSensor_Align (GoSensor sensor)
 Perform alignment using the configured alignment type and target. More...
 
kStatus GoSensor_AlignmentReference (GoSensor sensor, GoAlignmentRef *reference)
 Gets the alignment reference of the sensor. More...
 
GoAlignmentState GoSensor_AlignmentState (GoSensor sensor)
 Gets the alignment state of the sensor. More...
 
kBool GoSensor_AutoStartEnabled (GoSensor sensor)
 Gets the AutoStart enabled state currently used by the sensor. More...
 
kStatus GoSensor_Backup (GoSensor sensor, const kChar *destPath)
 Creates a backup of sensor files and downloads the backup to the specified location. More...
 
GoSensor GoSensor_Buddy (GoSensor sensor)
 Gets the buddy sensor. More...
 
k32u GoSensor_BuddyId (GoSensor sensor)
 Gets the buddy sensor's device ID. More...
 
kStatus GoSensor_Cancel (GoSensor sensor)
 Aborts ongoing sensor communication. More...
 
kStatus GoSensor_ChangePassword (GoSensor sensor, GoUser user, const kChar *password)
 Changes the password associated with the specified user account. More...
 
kStatus GoSensor_ClearAlignment (GoSensor sensor)
 Clears the current sensor alignment. More...
 
kStatus GoSensor_ClearLog (GoSensor sensor)
 Clears the log file (_live.log). More...
 
kStatus GoSensor_ClearMeasurementStats (GoSensor sensor)
 Resets the measurement statistics reported by the health channel. More...
 
kStatus GoSensor_ClearReplayData (GoSensor sensor)
 Clears the replay buffer. More...
 
kStatus GoSensor_Connect (GoSensor sensor)
 Creates a connection to the sensor. More...
 
kStatus GoSensor_CopyFile (GoSensor sensor, const kChar *sourceName, const kChar *destName)
 Copies a file within the connected sensor. More...
 
kStatus GoSensor_DefaultJob (GoSensor sensor, kChar *fileName, kSize capacity)
 Gets the name of the default job file to be loaded on boot. More...
 
kStatus GoSensor_DeleteFile (GoSensor sensor, const kChar *name)
 Deletes a file within the connected sensor. More...
 
kSize GoSensor_DirectoryFileCount (GoSensor sensor, const kChar *extensionFilter, const kChar *path, kBool isRecursive)
 Return the number of files contained in the specified path with an optional extension filter applied. More...
 
kStatus GoSensor_DirectoryFileNameAt (GoSensor sensor, const kChar *extensionFilter, const kChar *path, kBool isRecursive, kSize index, kChar *fileName, kSize capacity)
 Retrievesthe file name at the specified index for a given path and optional extension filter. More...
 
kStatus GoSensor_Disconnect (GoSensor sensor)
 Disconnects from the sensor. More...
 
kStatus GoSensor_DownloadFile (GoSensor sensor, const kChar *sourceName, const kChar *destPath)
 Downloads a file from the connected sensor. More...
 
kStatus GoSensor_EmitAnalog (GoSensor sensor, k16u index, k64s target, k32s value)
 Schedules an analog output. More...
 
kStatus GoSensor_EmitDigital (GoSensor sensor, k16u index, k64s target, k8u value)
 Schedules a digital output. More...
 
kStatus GoSensor_EnableAutoStart (GoSensor sensor, kBool enable)
 Sets the AutoStart enabled state of the sensor. More...
 
kStatus GoSensor_EnableData (GoSensor sensor, kBool enable)
 Enables or disables the sensor's data channel. More...
 
kStatus GoSensor_EnableRecording (GoSensor sensor, kBool enable)
 Sets the recording state of the sensor. More...
 
kStatus GoSensor_Encoder (GoSensor sensor, k64s *encoder)
 Gets the current encoder count. More...
 
kStatus GoSensor_ExportBitmap (GoSensor sensor, GoReplayExportSourceType type, GoDataSource source, const kChar *dstFileName)
 Exports the current frame of a replay in the form of a bitmap. More...
 
kStatus GoSensor_ExportCsv (GoSensor sensor, const kChar *dstFileName)
 Exports replay data in CSV format. More...
 
kStatus GoSensor_ExposureAutoSet (GoSensor sensor, GoRole role)
 Perform an exposure auto set. More...
 
GoFamily GoSensor_Family (GoSensor sensor)
 Returns an enumerator value representing the current sensor's family. More...
 
kSize GoSensor_FileCount (GoSensor sensor)
 Gets the number of files available from the connected sensor. More...
 
kBool GoSensor_FileExists (GoSensor sensor, const kChar *name)
 Checks whether the specified file is present on the sensor. More...
 
kStatus GoSensor_FileNameAt (GoSensor sensor, kSize index, kChar *name, kSize capacity)
 Gets the file name at the specified index. More...
 
kVersion GoSensor_FirmwareVersion (GoSensor sensor)
 Gets the sensor's firmware version. More...
 
kBool GoSensor_HasBuddy (GoSensor sensor)
 Reports whether a buddy had been assigned. More...
 
k32u GoSensor_Id (GoSensor sensor)
 Gets the device identifier associated with this sensor. More...
 
GoInputSource GoSensor_InputSource (GoSensor sensor)
 Gets the input source currently used by the sensor. More...
 
kBool GoSensor_IsConnected (GoSensor sensor)
 Reports whether the the sensor is currently connected. More...
 
kStatus GoSensor_LoadedJob (GoSensor sensor, kChar *fileName, kSize capacity, kBool *changed)
 Gets the name of the loaded job file and whether it has been modified since loading. More...
 
kStatus GoSensor_LogIn (GoSensor sensor, GoUser user, const kChar *password)
 Logs into the sensor using the specified user name and password. More...
 
kStatus GoSensor_Model (GoSensor sensor, kChar *model, kSize capacity)
 Gets the model number associated with this sensor. More...
 
GoOutput GoSensor_Output (GoSensor sensor)
 Gets the output module, used for output configuration. More...
 
kStatus GoSensor_PartMatchCreateModel (GoSensor sensor, const kChar *name)
 Creates a part matching model based on the current part data. More...
 
kStatus GoSensor_PartMatchDetectModelEdges (GoSensor sensor, const kChar *name, k16u sensitivity)
 Detect the edges of the specified part model. More...
 
GoPartModel GoSensor_PartMatchModel (GoSensor sensor, const kChar *name)
 Returns a handle to a part model based on a given name. More...
 
GoPartModel GoSensor_PartMatchModelAt (GoSensor sensor, kSize index)
 Returns a handle to a part model based on a given index. More...
 
kSize GoSensor_PartMatchModelCount (GoSensor sensor)
 Returns the number of part match models present in the currently loaded job. More...
 
kStatus GoSensor_PlaybackPosition (GoSensor sensor, kSize *position, kSize *count)
 Gets the current replay frame position. More...
 
kStatus GoSensor_PlaybackSeek (GoSensor sensor, kSize position)
 Sets the current frame position for a replay. More...
 
kStatus GoSensor_PlaybackStep (GoSensor sensor, GoSeekDirection direction)
 Advances one frame from the current replay position. More...
 
kVersion GoSensor_ProtocolVersion (GoSensor sensor)
 Gets the sensor's protocol version. More...
 
kBool GoSensor_RecordingEnabled (GoSensor sensor)
 Gets the recording state of the sensor. More...
 
kStatus GoSensor_Refresh (GoSensor sensor)
 Refreshes sensor state. More...
 
GoSensorInfo GoSensor_RemoteInfoAt (GoSensor sensor, kSize index)
 Gets the remote sensor information at the given index. More...
 
kSize GoSensor_RemoteInfoCount (GoSensor sensor)
 Gets the count of remote sensor information held by the sensor. More...
 
kStatus GoSensor_RemoveBuddy (GoSensor sensor)
 Removes the current buddy sensor. More...
 
kStatus GoSensor_Reset (GoSensor sensor, kBool wait)
 Reboots the main sensor and any connected buddy sensors. More...
 
kStatus GoSensor_Restore (GoSensor sensor, const kChar *sourcePath)
 Restores a backup of sensor files. More...
 
kStatus GoSensor_RestoreDefaults (GoSensor sensor, kBool restoreAddress)
 Restores factory default settings. More...
 
GoRole GoSensor_Role (GoSensor sensor)
 Gets the sensor's current role within the system. More...
 
GoMode GoSensor_ScanMode (GoSensor sensor)
 Gets the sensor's scan mode. More...
 
kStatus GoSensor_ScheduledStart (GoSensor sensor, k64s value)
 Starts the sensor at a scheduled value relating to the current time or encoder value as reported by the sensor. More...
 
kStatus GoSensor_SetAddress (GoSensor sensor, const GoAddressInfo *info, kBool wait)
 Configures a sensor's network address settings. More...
 
kStatus GoSensor_SetAlignmentReference (GoSensor sensor, GoAlignmentRef reference)
 Sets the alignment reference of the sensor. More...
 
kStatus GoSensor_SetDataHandler (GoSensor sensor, GoSensorDataSetFx function, kPointer context)
 Sets the data callback function to be used upon receipt of data. More...
 
kStatus GoSensor_SetDefaultJob (GoSensor sensor, const kChar *fileName)
 Sets a default job file to be loaded on boot. More...
 
kStatus GoSensor_SetInputSource (GoSensor sensor, GoInputSource source)
 Sets the input source of the sensor. More...
 
GoSetup GoSensor_Setup (GoSensor sensor)
 Gets the GoSetup instance associated with the sensor. More...
 
kStatus GoSensor_Simulate (GoSensor sensor, kBool *isBufferValid)
 Simulates the current frame in the live recording buffer. More...
 
kStatus GoSensor_Start (GoSensor sensor)
 Starts the sensor. More...
 
GoState GoSensor_State (GoSensor sensor)
 Reports the current state of the sensor. More...
 
kStatus GoSensor_States (GoSensor sensor, GoStates *states)
 Reports the current states of the sensor. More...
 
kStatus GoSensor_Stop (GoSensor sensor)
 Stops the sensor. More...
 
kStatus GoSensor_Timestamp (GoSensor sensor, k64u *time)
 Gets the current time stamp (common among all synchronized sensors). More...
 
GoTools GoSensor_Tools (GoSensor sensor)
 Gets the sensor's tools module, used for measurement configuration. More...
 
GoTransform GoSensor_Transform (GoSensor sensor)
 Gets the transform module, used for transformation configuration. More...
 
kStatus GoSensor_Trigger (GoSensor sensor)
 Sends a software trigger to the sensor. More...
 
kStatus GoSensor_Upgrade (GoSensor sensor, const kChar *sourcePath, GoUpgradeFx onUpdate, kPointer context)
 Upgrades sensor firmware. More...
 
kStatus GoSensor_UploadFile (GoSensor sensor, const kChar *sourcePath, const kChar *destName)
 Uploads a file to the connected sensor. More...
 
GoUser GoSensor_User (GoSensor sensor)
 Reports the user account associated with the current user. More...
 

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