GEN DAQ API  4.0
Controlling GEN Series tethered Mainframes
GEN_DAQ_API.h File Reference

Header file for the GEN DAQ API. More...

#include <stddef.h>
#include <stdint.h>

Go to the source code of this file.

Typedefs

typedef uint32_t GHSConnectionHandle
 A unique identifier per mainframe connection. More...
 
typedef void * GHSSettingsPtr
 Pointer to a blob containing all mainframe settings. More...
 
typedef char GHSSlotID
 Identifier of the slot used to address recorders. Consists of a capital letter (e.g. 'A').
 
typedef enum GHSReturnValue GHSReturnValue
 All possible API return values. More...
 
typedef enum GHSAcquisitionState GHSAcquisitionState
 Acquisition states.
 
typedef enum GHSSyncStatus GHSSyncStatus
 Master timebase synchronization status values.
 
typedef enum GHSEnableDisable GHSEnableDisable
 Enable/Disable values used in various methods.
 
typedef enum GHSChannelType GHSChannelType
 Physical channel types.
 
typedef enum GHSStorageLocation GHSStorageLocation
 Storage locations.
 
typedef enum GHSUserMode GHSUserMode
 User modes.
 
typedef enum GHSTriggerMode GHSTriggerMode
 Trigger modes.
 
typedef enum GHSDirection GHSDirection
 Directions of level crossing detection.
 
typedef enum GHSSignalCoupling GHSSignalCoupling
 Signal coupling values.
 
typedef enum GHSInputCoupling GHSInputCoupling
 Input coupling values that define what signals from the input BNCs are passed on to the amplifier.
 
typedef enum GHSFilterType GHSFilterType
 Filter types.
 
typedef enum GHSAmplifierMode GHSAmplifierMode
 Amplifier modes.
 
typedef enum GHSExcitationType GHSExcitationType
 Excitation types.
 
typedef enum GHSSweepRecordingMode GHSSweepRecordingMode
 Sweep recording modes.
 
typedef enum GHSContinuousRecordingMode GHSContinuousRecordingMode
 Continuous recording modes.
 
typedef enum GHSTimerCounterMode GHSTimerCounterMode
 Timer/counter channel modes.
 
typedef enum GHSFunctionCallType GHSFunctionCallType
 Function call type.
 
typedef enum GHSRecordingDataSource GHSRecordingDataSource
 Recording data source.
 
typedef enum GHSTriggerArmState GHSTriggerArmState
 Trigger arm state.
 
typedef enum GHSSweepTriggerMode GHSSweepTriggerMode
 Sweep trigger mode.
 
typedef enum GHSAccess GHSAccess
 Client access (permission).
 

Enumerations

enum  GHSReturnValue {
  GHSReturnValue_Reserved = 0, GHSReturnValue_OK = 1, GHSReturnValue_NOK = 2, GHSReturnValue_EmptySlot = 3,
  GHSReturnValue_NullPtrArgument = 4, GHSReturnValue_InvalidSlotID = 5, GHSReturnValue_SystemNotIdle = 6, GHSReturnValue_SystemNotRecording = 7,
  GHSReturnValue_SystemNotPaused = 8, GHSReturnValue_InvalidSampleRate = 9, GHSReturnValue_InvalidHandle = 10, GHSReturnValue_APIMismatch = 11,
  GHSReturnValue_ConnectionFailed = 12, GHSReturnValue_InvalidIP = 13, GHSReturnValue_MainframeTimeout = 14, GHSReturnValue_InsufficientDiskSpace = 15,
  GHSReturnValue_CreateRecordingFailed = 16, GHSReturnValue_NoConnection = 17, GHSReturnValue_IncompatibleStorageLocation = 18, GHSReturnValue_RecordingNotFound = 19,
  GHSReturnValue_SystemNotInPreview = 20, GHSReturnValue_AlreadyConnected = 21, GHSReturnValue_InvalidRecordingName = 22, GHSReturnValue_InvalidChannelIndex = 23,
  GHSReturnValue_InvalidUserMode = 24, GHSReturnValue_InvalidChannelType = 25, GHSReturnValue_InvalidTriggerPosition = 26, GHSReturnValue_InvalidSweepMode = 27,
  GHSReturnValue_NoRecordersInMainframe = 28, GHSReturnValue_InvalidContinuousMode = 29, GHSReturnValue_InvalidModeForTriggerPosition = 30, GHSReturnValue_Adapted = 31,
  GHSReturnValue_InvalidUTF8Character = 32, GHSReturnValue_DuplicateChannelName = 33, GHSReturnValue_InvalidDataType = 34, GHSReturnValue_MethodNotFound = 35,
  GHSReturnValue_InvalidJSONFormat = 36, GHSReturnValue_UnkownErrorMessage = 37, GHSReturnValue_FieldBusError_NotConfigured = 38, GHSReturnValue_FieldBusError_FieldBusAlready_Enabled = 39,
  GHSReturnValue_FieldBusError_NullFieldBusRingBuffer = 40, GHSReturnValue_FieldBusError_InvalidFieldBusPacket = 41, GHSReturnValue_FieldBusError_NotConnected = 42, GHSReturnValue_FieldBusError_NoFormulasDeployed = 43,
  GHSReturnValue_FieldBusError_BufferSizeInvalid = 44, GHSReturnValue_FieldBusError_FieldBusNotSupported = 45, GHSReturnValue_CANBusNotFound = 46, GHSReturnValue_WriteAccessBlocked = 47,
  GHSReturnValue_InvalidCANMsgID = 48
}
 All possible API return values. More...
 
enum  GHSAcquisitionState {
  GHSAcquisitionState_Reserved = 0, GHSAcquisitionState_Recording = 1, GHSAcquisitionState_Pause = 2, GHSAcquisitionState_SavingData = 3,
  GHSAcquisitionState_Idle = 4, GHSAcquisitionState_Preview = 5
}
 Acquisition states. More...
 
enum  GHSSyncStatus {
  GHSSyncStatus_Reserved = 0, GHSSyncStatus_NotSynced = 1, GHSSyncStatus_Syncing = 2, GHSSyncStatus_Synced = 3,
  GHSSyncStatus_ReSyncing = 4, GHSSyncStatus_NoSignal = 5, GHSSyncStatus_CoarseSynced = 6, GHSSyncStatus_NoGMR1000 = 7,
  GHSSyncStatus_NoOTMC100 = 8
}
 Master timebase synchronization status values. More...
 
enum  GHSEnableDisable { GHS_Disable = 0, GHS_Enable = 1 }
 Enable/Disable values used in various methods. More...
 
enum  GHSChannelType { GHSChannelType_Invalid = 0, GHSChannelType_Analog = 1, GHSChannelType_Event = 2, GHSChannelType_TimerCounter = 3 }
 Physical channel types. More...
 
enum  GHSStorageLocation { GHSStorageLocation_Reserved = 0, GHSStorageLocation_Remote = 1, GHSStorageLocation_Local1 = 2, GHSStorageLocation_Local2 = 3 }
 Storage locations. More...
 
enum  GHSUserMode { GHSUserMode_Reserved = 0, GHSUserMode_Sweeps = 1, GHSUserMode_Continuous = 2, GHSUserMode_Dual = 3 }
 User modes. More...
 
enum  GHSTriggerMode {
  GHSTriggerMode_Off = 0, GHSTriggerMode_Basic = 1, GHSTriggerMode_Dual = 2, GHSTriggerMode_Window = 3,
  GHSTriggerMode_DualWindow = 4, GHSTriggerMode_Sequential = 5, GHSTriggerMode_QualifierBasic = 6, GHSTriggerMode_QualifierDual = 7
}
 Trigger modes. More...
 
enum  GHSDirection { GHSDirection_RisingEdge = 0, GHSDirection_FallingEdge = 1 }
 Directions of level crossing detection. More...
 
enum  GHSSignalCoupling {
  GHSSigCpl_GND = 0, GHSSigCpl_DC = 1, GHSSigCpl_AC = 2, GHSSigCpl_DC_RMS = 3,
  GHSSigCpl_AC_RMS = 4, GHSSigCpl_DC_Frequency = 5, GHSSigCpl_AC_Frequency = 6, GHSSigCpl_DC_TrueRMS = 7,
  GHSSigCpl_AC_TrueRMS = 8, GHSSigCpl_DC_ExternalProbe = 9, GHSSigCpl_AC_ExternalProbe = 10, GHSSigCpl_Reference = 11,
  GHSSigCpl_ZeroReset = 12, GHSSigCpl_SinglePrecision = 13, GHSSigCpl_DoublePrecision = 14, GHSSigCpl_QuadPrecision = 15,
  GHSSigCpl_Charge = 16
}
 Signal coupling values. More...
 
enum  GHSInputCoupling {
  GHSInCpl_SingleEndedPositive = 0, GHSInCpl_SingleEndedNegative = 1, GHSInCpl_Differential = 2, GHSInCpl_Current = 3,
  GHSInCpl_FloatingDifferential = 4
}
 Input coupling values that define what signals from the input BNCs are passed on to the amplifier. More...
 
enum  GHSFilterType {
  GHSFilterType_Bessel = 0, GHSFilterType_Butterworth = 1, GHSFilterType_Elliptic = 2, GHSFilterType_FIR = 3,
  GHSFilterType_IIR = 4, GHSFilterType_Wideband = 5, GHSFilterType_Bessel_AA = 6, GHSFilterType_Butterworth_AA = 7,
  GHSFilterType_SigmaDeltaWB = 8, GHSFilterType_SigmaDelta = 9, GHSFilterType_BandPass = 10, GHSFilterType_FIR3dB = 11
}
 Filter types. More...
 
enum  GHSAmplifierMode {
  GHSAmplifierMode_None = -1, GHSAmplifierMode_Basic = 0, GHSAmplifierMode_Bridge = 1, GHSAmplifierMode_Icp = 2,
  GHSAmplifierMode_ThermoCouple = 3, GHSAmplifierMode_BasicSensor = 4, GHSAmplifierMode_Charge = 5, GHSAmplifierMode_Current4_20 = 6,
  GHSAmplifierMode_ThermoResistor = 7
}
 Amplifier modes. More...
 
enum  GHSExcitationType {
  GHSExcitationType_Voltage = 0, GHSExcitationType_Voltage_Sense = 1, GHSExcitationType_Current = 2, GHSExcitationType_Voltage_Strobed = 3,
  GHSExcitationType_Voltage_Sense_Strobed = 4, GHSExcitationType_Current_Strobed = 5
}
 Excitation types. More...
 
enum  GHSSweepRecordingMode { GHSSweepMode_Reserved = 0, GHSSweepMode_Normal = 1, GHSSweepMode_PreTrigger = 2 }
 Sweep recording modes. More...
 
enum  GHSContinuousRecordingMode {
  GHSContinuousRecordingMode_Reserved = 0, GHSContinuousRecordingMode_Standard = 1, GHSContinuousRecordingMode_Circular = 2, GHSContinuousRecordingMode_Limited = 3,
  GHSContinuousRecordingMode_StopOnTrigger = 4
}
 Continuous recording modes. More...
 
enum  GHSTimerCounterMode {
  GHSTimerCounterMode_RPMUniDirectional = 0, GHSTimerCounterMode_RPMBiDirectional = 1, GHSTimerCounterMode_RPMQuadrature = 2, GHSTimerCounterMode_FrequencyUniDirectional = 3,
  GHSTimerCounterMode_FrequencyBiDirectional = 4, GHSTimerCounterMode_FrequencyQuadrature = 5, GHSTimerCounterMode_CountUniDirectional = 6, GHSTimerCounterMode_CountBiDirectional = 7,
  GHSTimerCounterMode_CountQuadrature = 8, GHSTimerCounterMode_AngleQuadrature = 9, GHSTimerCounterMode_AngleQuadratureWithRefPos = 10, GHSTimerCounterMode_AngleUniDirectional = 11,
  GHSTimerCounterMode_AngleUniDirectionalWithRefPos = 12, GHSTimerCounterMode_AngleBiDirectional = 13, GHSTimerCounterMode_AngleBiDirectionalWithRefPos = 14
}
 Timer/counter channel modes. More...
 
enum  GHSFunctionCallType { GHS_NonBlockingCall = 0, GHS_BlockingCall = 1 }
 Function call type. More...
 
enum  GHSRecordingDataSource { GHSRecordingDataSource_SyncChannels = 0, GHSRecordingDataSource_SyncRealTimeFormulas = 1 }
 Recording data source. More...
 
enum  GHSTriggerArmState { GHSTriggerArmState_Disarmed = 0, GHSTriggerArmState_Armed = 1 }
 Trigger arm state. More...
 
enum  GHSSweepTriggerMode { GHSSweepTriggerMode_FirstTrigger = 0, GHSSweepTriggerMode_EveryTrigger = 1, GHSSweepTriggerMode_StopTrigger = 2 }
 Sweep trigger mode. More...
 
enum  GHSAccess { GHSAccess_ReadOnly = 0, GHSAccess_ReadWrite = 1 }
 Client access (permission). More...
 

Functions

GHSReturnValue GHSConnect (const char *ipAddress, unsigned short portno, GHSConnectionHandle *conHandle, uint32_t *serverAPIVersion)
 Establishes a connection to the mainframe. More...
 
GHSReturnValue GHSDisconnect (GHSConnectionHandle conHandle)
 Disconnects from a connected mainframe. More...
 
uint32_t GHSGetClientAPIVersion (void)
 Returns the API version number of this client. More...
 
GHSReturnValue GHSGetCurrentAccess (GHSConnectionHandle conHandle, GHSAccess *access)
 Returns the current access permissions for this client. More...
 
GHSReturnValue GHSStartPreview (GHSConnectionHandle conHandle)
 Starts preview mode. More...
 
GHSReturnValue GHSStopPreview (GHSConnectionHandle conHandle)
 Stops preview mode. More...
 
GHSReturnValue GHSStartRecording (GHSConnectionHandle conHandle)
 Starts a recording on local storage. More...
 
GHSReturnValue GHSPauseRecording (GHSConnectionHandle conHandle)
 Pauses a started recording. More...
 
GHSReturnValue GHSResumeRecording (GHSConnectionHandle conHandle)
 Resumes a paused recording. More...
 
GHSReturnValue GHSStopRecording (GHSConnectionHandle conHandle)
 Stops a started recording. More...
 
GHSReturnValue GHSTrigger (GHSConnectionHandle conHandle)
 Issues a trigger. More...
 
GHSReturnValue GHSGetAcquisitionState (GHSConnectionHandle conHandle, GHSAcquisitionState *state)
 Returns the Acquisition State of the Mainframe. More...
 
GHSReturnValue GHSGetAcquisitionTime (GHSConnectionHandle conHandle, double *acquisitionTime)
 Retrieves the current acquisition time relative to the start of acquistion. More...
 
GHSReturnValue GHSGetAcquisitionStartTime (GHSConnectionHandle conHandle, int *year, int *day, double *seconds)
 Retrieves the absolute time of the start of acquisition. More...
 
GHSReturnValue GHSIdentify (GHSConnectionHandle conHandle, GHSEnableDisable enabled)
 Enable or disable the identification sound of the connected mainframe. More...
 
GHSReturnValue GHSGetDiskSpace (GHSConnectionHandle conHandle, double *total, double *available)
 Get total and available mainframe internal disk space. More...
 
GHSReturnValue GHSGetSyncStatus (GHSConnectionHandle conHandle, GHSSyncStatus *syncStatus)
 Determine the mainframe sync status. More...
 
GHSReturnValue GHSGetSlotCount (GHSConnectionHandle conHandle, int *slotCount)
 Retrieve the number of slots in the mainframe. More...
 
GHSReturnValue GHSGetUserMode (GHSConnectionHandle conHandle, GHSUserMode *userMode)
 Retrieve the user mode. More...
 
GHSReturnValue GHSSetUserMode (GHSConnectionHandle conHandle, GHSUserMode userMode)
 Set the user mode. More...
 
GHSReturnValue GHSGetMainframeInformation (GHSConnectionHandle conHandle, char **mainframeType, char **mainframeName, char **serialNumber, char **firmwareVersion)
 Determine type, name, serial number and firmware version information for the connected mainframe. More...
 
GHSReturnValue GHSGetStorageLocation (GHSConnectionHandle conHandle, GHSStorageLocation *storageLocation)
 Retrieve the storage location. More...
 
GHSReturnValue GHSSetStorageLocation (GHSConnectionHandle conHandle, GHSStorageLocation storageLocation)
 Set the storage location. More...
 
GHSReturnValue GHSGetRecordingName (GHSConnectionHandle conHandle, const char **recordingBaseName, int *recordingIndex)
 Retrieve the recording base name and recording index of the last recording file. More...
 
GHSReturnValue GHSSetRecordingName (GHSConnectionHandle conHandle, const char *recordingBaseName, int recordingIndex)
 Set the recording base name and recording index for the next recording file. More...
 
GHSReturnValue GHSSetRecordingBaseName (GHSConnectionHandle conHandle, const char *recordingBaseName)
 Sets the recording base name. More...
 
GHSReturnValue GHSDeleteLastRecording (GHSConnectionHandle conHandle)
 Deletes the most recent recording from local mainframe storage. More...
 
GHSReturnValue GHSDeleteAllRecordings (GHSConnectionHandle conHandle)
 Deletes all recordings from local mainframe storage. More...
 
GHSReturnValue GHSGetHighLowRateStorageEnabled (GHSConnectionHandle conHandle, GHSRecordingDataSource source, GHSSlotID slotID, GHSEnableDisable *highRateEnabled, GHSEnableDisable *lowRateEnabled)
 Retrieve storage enabled status of high and low rate data for the specified recording data source. More...
 
GHSReturnValue GHSSetHighLowRateStorageEnabled (GHSConnectionHandle conHandle, GHSRecordingDataSource source, GHSSlotID slotID, GHSEnableDisable highRateEnabled, GHSEnableDisable lowRateEnabled)
 Enable/disable storage of high and low rate data for the specified recording data source. More...
 
GHSReturnValue GHSGetCurrentSettings (GHSConnectionHandle conHandle, GHSSettingsPtr *blob, size_t *blobSize)
 Retrieves the current mainframe settings as a blob. More...
 
GHSReturnValue GHSSetCurrentSettings (GHSConnectionHandle conHandle, GHSSettingsPtr blob, size_t blobSize)
 Applies the mainframe settings contained in the input argument. More...
 
GHSReturnValue GHSFreeSettings (GHSSettingsPtr blob)
 Frees the resources allocated for the settings blob. More...
 
GHSReturnValue GHSPersistCurrentSettings (GHSConnectionHandle conHandle)
 Persists the current mainframe settings. More...
 
GHSReturnValue GHSApplyPersistedSettings (GHSConnectionHandle conHandle)
 A mainframe might contain persisted settings (being applied upon boot). This method re-applies these settings. More...
 
GHSReturnValue GHSGetRecorderInformation (GHSConnectionHandle conHandle, GHSSlotID slotID, char **recorderType, char **recorderName, char **serialNumber, char **firmwareVersion)
 Determine type, name, serial number and firmware version information for a recorder. More...
 
GHSReturnValue GHSGetRecorderEnabled (GHSConnectionHandle conHandle, GHSSlotID slotID, GHSEnableDisable *enabled)
 Determine if recorder is enabled or disabled. More...
 
GHSReturnValue GHSSetRecorderEnabled (GHSConnectionHandle conHandle, GHSSlotID slotID, GHSEnableDisable enabled)
 Enable or disable a recorder. More...
 
GHSReturnValue GHSGetChannelCount (GHSConnectionHandle conHandle, GHSSlotID slotID, int *channelCount)
 Retrieve the number of channels for a recorder. More...
 
GHSReturnValue GHSGetSampleRate (GHSConnectionHandle conHandle, GHSSlotID slotID, double *sampleRate)
 Determine the sample rate for a recorder. More...
 
GHSReturnValue GHSSetSampleRate (GHSConnectionHandle conHandle, GHSSlotID slotID, double sampleRate)
 Set the sample rate for a recorder. More...
 
GHSReturnValue GHSGetChannelType (GHSConnectionHandle conHandle, GHSSlotID slotID, int channelIndex, GHSChannelType *channelType)
 Determine the type of a channel. More...
 
GHSReturnValue GHSGetChannelName (GHSConnectionHandle conHandle, GHSSlotID slotID, int channelIndex, char **channelName)
 Determine the name of a channel. More...
 
GHSReturnValue GHSSetChannelName (GHSConnectionHandle conHandle, GHSSlotID slotID, int channelIndex, const char *channelName)
 Set the name for a channel. More...
 
GHSReturnValue GHSGetChannelStorageEnabled (GHSConnectionHandle conHandle, GHSSlotID slotID, int channelIndex, GHSEnableDisable *enabled)
 Determine if storage is enabled or disabled for a channel. More...
 
GHSReturnValue GHSSetChannelStorageEnabled (GHSConnectionHandle conHandle, GHSSlotID slotID, int channelIndex, GHSEnableDisable enabled)
 Enable or disable storage for a channel. More...
 
GHSReturnValue GHSGetTriggerSettings (GHSConnectionHandle conHandle, GHSSlotID slotID, int channelIndex, GHSTriggerMode *triggerMode, double *primaryLevel, double *secondaryLevel, double *hysteresis, GHSDirection *direction)
 Determine the trigger settings for an analog channel. More...
 
GHSReturnValue GHSSetTriggerSettings (GHSConnectionHandle conHandle, GHSSlotID slotID, int channelIndex, GHSTriggerMode triggerMode, double primaryLevel, double secondaryLevel, double hysteresis, GHSDirection direction)
 Set the trigger settings for an analog channel. More...
 
GHSReturnValue GHSGetSignalCoupling (GHSConnectionHandle conHandle, GHSSlotID slotID, int channelIndex, GHSSignalCoupling *signalCoupling)
 Determine the signal coupling for an analog channel. More...
 
GHSReturnValue GHSSetSignalCoupling (GHSConnectionHandle conHandle, GHSSlotID slotID, int channelIndex, GHSSignalCoupling signalCoupling)
 Set the signal coupling for an analog channel. More...
 
GHSReturnValue GHSGetInputCoupling (GHSConnectionHandle conHandle, GHSSlotID slotID, int channelIndex, GHSInputCoupling *inputCoupling)
 Determine the input coupling for an analog channel. More...
 
GHSReturnValue GHSSetInputCoupling (GHSConnectionHandle conHandle, GHSSlotID slotID, int channelIndex, GHSInputCoupling inputCoupling)
 Set the input coupling for an analog channel. More...
 
GHSReturnValue GHSGetSpanAndOffset (GHSConnectionHandle conHandle, GHSSlotID slotID, int channelIndex, double *span, double *offset)
 Determine the span and offset for an analog channel. More...
 
GHSReturnValue GHSSetSpanAndOffset (GHSConnectionHandle conHandle, GHSSlotID slotID, int channelIndex, double span, double offset)
 Set Span and offset for analog channels. More...
 
GHSReturnValue GHSGetFilterTypeAndFrequency (GHSConnectionHandle conHandle, GHSSlotID slotID, int channelIndex, GHSFilterType *filterType, double *frequency)
 Determine the filter type and frequency for an analog channel. More...
 
GHSReturnValue GHSSetFilterTypeAndFrequency (GHSConnectionHandle conHandle, GHSSlotID slotID, int channelIndex, GHSFilterType filterType, double frequency)
 Set the filter type and frequency for an analog channel. More...
 
GHSReturnValue GHSGetExcitation (GHSConnectionHandle conHandle, GHSSlotID slotID, int channelIndex, GHSExcitationType *excitationType, double *excitationValue)
 Determine the excitation type and value for an analog channel. More...
 
GHSReturnValue GHSSetExcitation (GHSConnectionHandle conHandle, GHSSlotID slotID, int channelIndex, GHSExcitationType excitationType, double excitationValue)
 Set the excitation type and value for an analog channel. More...
 
GHSReturnValue GHSGetAmplifierMode (GHSConnectionHandle conHandle, GHSSlotID slotID, int channelIndex, GHSAmplifierMode *amplifierMode)
 Determine the amplifier mode for an analog channel. More...
 
GHSReturnValue GHSSetAmplifierMode (GHSConnectionHandle conHandle, GHSSlotID slotID, int channelIndex, GHSAmplifierMode amplifierMode)
 Set the amplifier mode for an analog channel. More...
 
GHSReturnValue GHSGetTechnicalUnits (GHSConnectionHandle conHandle, GHSSlotID slotID, int channelIndex, char **units, double *multiplier, double *offset)
 Determine the technical units, unit multiplier and unit offset for an analog channel. More...
 
GHSReturnValue GHSSetTechnicalUnits (GHSConnectionHandle conHandle, GHSSlotID slotID, int channelIndex, const char *units, double multiplier, double offset)
 Set the technical units, unit multiplier and unit offset for an analog channel. More...
 
GHSReturnValue GHSGetAutoRange (GHSConnectionHandle conHandle, GHSSlotID slotID, int channelIndex, GHSEnableDisable *autoRangeEnabled, double *autoRangeTime)
 Determine the auto range enable and time settings. More...
 
GHSReturnValue GHSSetAutoRange (GHSConnectionHandle conHandle, GHSSlotID slotID, int channelIndex, GHSEnableDisable autoRangeEnabled, double autoRangeTime)
 Set Auto range settings for analog channels. More...
 
GHSReturnValue GHSCmdAutoRangeNow (GHSConnectionHandle conHandle, GHSSlotID slotID, int channelIndex, double autoRangeTime)
 Command a single shot for auto range. More...
 
GHSReturnValue GHSGetChannelCalibrationInformation (GHSConnectionHandle conHandle, GHSSlotID slotID, int channelIndex, char **calibrationDateTime, char **verificationDateTime, char **powerVerificationDateTime, char **calibrationLab, char **verificationLab, char **powerVerificationLab)
 Retrieve calibration information for an analog channel. More...
 
GHSReturnValue GHSGetTimerCounterMode (GHSConnectionHandle conHandle, GHSSlotID slotID, int channelIndex, GHSTimerCounterMode *mode)
 Determine the mode for a timer/counter channel. More...
 
GHSReturnValue GHSSetTimerCounterMode (GHSConnectionHandle conHandle, GHSSlotID slotID, int channelIndex, GHSTimerCounterMode mode)
 Set the mode for a timer/counter channel. More...
 
GHSReturnValue GHSGetTimerCounterGateTime (GHSConnectionHandle conHandle, GHSSlotID slotID, int channelIndex, double *gateTime)
 Determine the gate time for a timer/counter channel. More...
 
GHSReturnValue GHSSetTimerCounterGateTime (GHSConnectionHandle conHandle, GHSSlotID slotID, int channelIndex, double gateTime)
 Set the gate time for a timer/counter channel. More...
 
GHSReturnValue GHSGetTimerCounterRange (GHSConnectionHandle conHandle, GHSSlotID slotID, int channelIndex, double *lowerValue, double *upperValue)
 Determine the range for a timer/counter channel. More...
 
GHSReturnValue GHSSetTimerCounterRange (GHSConnectionHandle conHandle, GHSSlotID slotID, int channelIndex, double lowerValue, double upperValue)
 Set the range for a timer/counter channel. More...
 
GHSReturnValue GHSGetSweepRecordingMode (GHSConnectionHandle conHandle, GHSSlotID slotID, GHSSweepRecordingMode *sweepRecordingMode)
 Determine the sweep recording mode for a recorder. More...
 
GHSReturnValue GHSSetSweepRecordingMode (GHSConnectionHandle conHandle, GHSSlotID slotID, GHSSweepRecordingMode sweepRecordingMode)
 Sets the sweep recording mode for a recorder. More...
 
GHSReturnValue GHSGetSweepLength (GHSConnectionHandle conHandle, GHSSlotID slotID, int64_t *numberOfSamples)
 Determine the sweep length in samples for a recorder. More...
 
GHSReturnValue GHSSetSweepLength (GHSConnectionHandle conHandle, GHSSlotID slotID, int64_t numberOfSamples)
 Sets the sweep length in samples for a recorder. More...
 
GHSReturnValue GHSGetNumberOfSweeps (GHSConnectionHandle conHandle, GHSSlotID slotID, int *numberOfSweeps)
 Determine the number of sweeps for a recorder. More...
 
GHSReturnValue GHSSetNumberOfSweeps (GHSConnectionHandle conHandle, GHSSlotID slotID, int numberOfSweeps)
 Sets the number of sweeps for a recorder. More...
 
GHSReturnValue GHSGetTriggerPosition (GHSConnectionHandle conHandle, GHSSlotID slotID, double *triggerPosition)
 Determine the trigger position percentage for a recorder. More...
 
GHSReturnValue GHSSetTriggerPosition (GHSConnectionHandle conHandle, GHSSlotID slotID, double triggerPosition)
 Sets the trigger position percentage for a recorder. More...
 
GHSReturnValue GHSGetSweepStretchEnabled (GHSConnectionHandle conHandle, GHSSlotID slotID, GHSEnableDisable *enabled)
 Determine if sweep stretch is enabled or disabled for a recorder. More...
 
GHSReturnValue GHSSetSweepStretchEnabled (GHSConnectionHandle conHandle, GHSSlotID slotID, GHSEnableDisable enabled)
 Enable or disable sweep stretch for a recorder. More...
 
GHSReturnValue GHSGetTriggerArmEnabled (GHSConnectionHandle conHandle, GHSEnableDisable *enabled)
 Retrieve trigger arm enabled status for a recorder. When enabled, triggers must be armed explicitly before they will be accepted. More...
 
GHSReturnValue GHSSetTriggerArmEnabled (GHSConnectionHandle conHandle, GHSEnableDisable enabled)
 Enable or disable trigger arm. When enabled, triggers must be armed explicitly before they will be accepted. More...
 
GHSReturnValue GHSCmdTriggerArm (GHSConnectionHandle conHandle)
 Arm the trigger, so that the next trigger will be accepted. After the next trigger occurred, triggers are disarmed automatically and need to be armed explicitly again using this function. More...
 
GHSReturnValue GHSGetTriggerArmState (GHSConnectionHandle conHandle, GHSTriggerArmState *state)
 Retrieve the current trigger arm state. This function can be used to synchronize CmdTriggerArm function calls with the user application. More...
 
GHSReturnValue GHSGetSweepTriggerMode (GHSConnectionHandle conHandle, GHSSlotID slotID, GHSSweepTriggerMode *mode)
 Gets the sweep trigger mode for a recorder. More...
 
GHSReturnValue GHSSetSweepTriggerMode (GHSConnectionHandle conHandle, GHSSlotID slotID, GHSSweepTriggerMode mode)
 Sets the sweep trigger mode for a recorder. More...
 
GHSReturnValue GHSGetTimeoutTriggerEnabled (GHSConnectionHandle conHandle, GHSEnableDisable *enabled)
 Retrieve the timeout trigger enabled status. More...
 
GHSReturnValue GHSSetTimeoutTriggerEnabled (GHSConnectionHandle conHandle, GHSEnableDisable enabled)
 Enables or disables timeout triggers. More...
 
GHSReturnValue GHSGetTimeoutTriggerTime (GHSConnectionHandle conHandle, double *time)
 Retrieve the timeout trigger time. More...
 
GHSReturnValue GHSSetTimeoutTriggerTime (GHSConnectionHandle conHandle, double time)
 Sets the timeout trigger time. More...
 
GHSReturnValue GHSGetContinuousRecordingMode (GHSConnectionHandle conHandle, GHSSlotID slotID, GHSContinuousRecordingMode *continuousMode)
 Determine the continuous recording mode for a recorder. More...
 
GHSReturnValue GHSSetContinuousRecordingMode (GHSConnectionHandle conHandle, GHSSlotID slotID, GHSContinuousRecordingMode continuousMode)
 Set the continuous recording mode for a recorder. More...
 
GHSReturnValue GHSGetContinuousTimeSpan (GHSConnectionHandle conHandle, GHSSlotID slotID, double *timeSpan)
 Determine the continuous recording time span for a recorder. More...
 
GHSReturnValue GHSSetContinuousTimeSpan (GHSConnectionHandle conHandle, GHSSlotID slotID, double timeSpan)
 Set the continuous recording time span for a recorder. More...
 
GHSReturnValue GHSGetContinuousLeadOutTime (GHSConnectionHandle conHandle, GHSSlotID slotID, double *leadOutTime)
 Determine the continuous recording lead out time for a recorder. More...
 
GHSReturnValue GHSSetContinuousLeadOutTime (GHSConnectionHandle conHandle, GHSSlotID slotID, double leadOutTime)
 Sets the continuous recording lead out time for a recorder. More...
 
GHSReturnValue GHSInitiateFieldBusDataTransfer (GHSConnectionHandle conHandle, int *updateRate, int *dataCount)
 Opens a new connection for the field bus data, and waits for client to connect. Once the client connects, if the acquisition state is active, data is sent to the client. Otherwise nothing is sent. More...
 
GHSReturnValue GHSStopFieldBusDataTransfer (GHSConnectionHandle conHandle)
 Closes the socket dedicated for the field bus data and stops transfering data. The ring buffer allocated for the transfer data is deleted. More...
 
GHSReturnValue GHSGetFieldBusDataCount (GHSConnectionHandle conHandle, int *dataCount)
 Gets the number of data that are configured to be sent through the field bus, excluding the timestamp. More...
 
GHSReturnValue GHSGetFieldBusDataNameAndUnit (GHSConnectionHandle conHandle, int dataIndex, char **dataName, char **dataUnit)
 Gets the name of specific field bus data value, by giving the index of the data value. The number of data values can be retrieved by GHSGetFieldBusDataCount(). In case of no formulas (or reserved values acquisition state and latency) published, an error code is returned: GHSReturnValue_FieldBusError_NoFormulasDeployed. More...
 
GHSReturnValue GHSReadNextSnapshot (GHSConnectionHandle conHandle, GHSFunctionCallType callType, double *timestamp, float *values, int *overrun)
 Retrieves the next snapshot in the buffer. The timestamp is grid aligned - as specified by the 'updateRate' argument of the GHSInitiateFieldBusDataTransfer() method. More...
 
GHSReturnValue GHSReceiveFieldBusData (GHSConnectionHandle conHandle)
 Used to retrieve the FieldBus data from the new socket connection and write on the buffer. Can be used in a thread, if so mutual exclusion should be used with GHSStopFieldBusDataTransfer. This function should be used in a loop if continuous delivery of Async Data is desired. More...
 
GHSReturnValue GHSRequestFieldBusSnapshot (GHSConnectionHandle conHandle, double *timestamp, int *dataCount, float *data)
 Request a single snapshot of the field bus data. In this case the timestamp received is not grid aligned. If the system is not acquiring the method returns an error code:GHSReturnValue_SystemNotRecording In case of no formulas you get the error return code back:GHSReturnValue_FieldBusError_NotConfigured if the field bus is already enabled then this method is not allowed.An error return code is returned:FieldBusError_UnavailableFunctionality. More...
 
GHSReturnValue GHSGetCANAcqControl (GHSConnectionHandle conHandle, GHSEnableDisable *enabled, int *busID, int *msgID)
 Get the current setup of CAN acquisition control. More...
 
GHSReturnValue GHSSetCANAcqControl (GHSConnectionHandle conHandle, GHSEnableDisable enabled, int busID, int msgID)
 Set up CAN acquisition control. More...
 

Detailed Description

Header file for the GEN DAQ API.

Author
HBM Netherlands B.V.
Date
25 September 2018 All functions supported by this API are present in this header-file and in this file only.

HBM is committed to keep this API stable and downwards compatible as long as this is technically feasible. HBM reserves the right to change the internal implementation and therefore no rights can be derived from the implementation.


Typedef Documentation

◆ GHSConnectionHandle

typedef uint32_t GHSConnectionHandle

A unique identifier per mainframe connection.

It is used by all API calls to distinguish between mainframes.

◆ GHSReturnValue

All possible API return values.

This enumeration will be extended and/or changed as the API grows.

◆ GHSSettingsPtr

typedef void* GHSSettingsPtr

Pointer to a blob containing all mainframe settings.

The internal structure of this blob is undefined.

Enumeration Type Documentation

◆ GHSAccess

enum GHSAccess

Client access (permission).

Enumerator
GHSAccess_ReadOnly 

Client has read-only access.

GHSAccess_ReadWrite 

Client has read and write access.

◆ GHSAcquisitionState

Acquisition states.

Enumerator
GHSAcquisitionState_Reserved 

Reserved to distinguish zero initialized GHSAcquisitionState. Should never be returned.

GHSAcquisitionState_Recording 

Mainframe is recording.

GHSAcquisitionState_Pause 

Mainframe is in pause state.

GHSAcquisitionState_SavingData 

Mainframe stopped recording but data is not saved yet.

GHSAcquisitionState_Idle 

Mainframe is idle and ready to be put into other states.

GHSAcquisitionState_Preview 

Mainframe is in preview state.

◆ GHSAmplifierMode

Amplifier modes.

Enumerator
GHSAmplifierMode_None 

No amplifier mode. Should never be returned.

GHSAmplifierMode_Basic 

Differential voltage amplifier mode.

GHSAmplifierMode_Bridge 

Bridge amplifier mode.

GHSAmplifierMode_Icp 

Accelerometer (ICP) amplifier mode.

GHSAmplifierMode_ThermoCouple 

Thermo couple amplifier mode.

GHSAmplifierMode_BasicSensor 

Differential voltage amplifier mode with excitation.

GHSAmplifierMode_Charge 

Charge amplifier mode.

GHSAmplifierMode_Current4_20 

4..20mA current amplifier mode.

GHSAmplifierMode_ThermoResistor 

Resistance type temperature sensor amplifier mode.

◆ GHSChannelType

Physical channel types.

Enumerator
GHSChannelType_Invalid 

Reserved to distinguish zero initialized GHSChannelType. Should never be returned.

GHSChannelType_Analog 

Analog Channel.

GHSChannelType_Event 

Event Channel.

GHSChannelType_TimerCounter 

Timer Counter Channel.

◆ GHSContinuousRecordingMode

Continuous recording modes.

Enumerator
GHSContinuousRecordingMode_Reserved 

Reserved to distinguish zero initialized GHSContinuousRecordingMode. Should never be returned.

GHSContinuousRecordingMode_Standard 

Continuous acquisition without a specific stop condition.

GHSContinuousRecordingMode_Circular 

Data is acquired in a circular buffer of specified length.

GHSContinuousRecordingMode_Limited 

Stop after specified total time is acquired.

GHSContinuousRecordingMode_StopOnTrigger 

Stop when a trigger occurs.

◆ GHSDirection

Directions of level crossing detection.

Enumerator
GHSDirection_RisingEdge 

Rising edge level crossing detection direction.

GHSDirection_FallingEdge 

Falling edge level crossing detection direction.

◆ GHSEnableDisable

Enable/Disable values used in various methods.

Enumerator
GHS_Disable 

Disable.

GHS_Enable 

Enable.

◆ GHSExcitationType

Excitation types.

Enumerator
GHSExcitationType_Voltage 

Voltage excitation type.

GHSExcitationType_Voltage_Sense 

Voltage sense excitation type.

GHSExcitationType_Current 

Current excitation type.

GHSExcitationType_Voltage_Strobed 

Voltage strobed excitation type.

GHSExcitationType_Voltage_Sense_Strobed 

Voltage sense stobed excitation type.

GHSExcitationType_Current_Strobed 

Current strobed excitation type.

◆ GHSFilterType

Filter types.

Enumerator
GHSFilterType_Bessel 

Bessel filter.

GHSFilterType_Butterworth 

Butterworth filter.

GHSFilterType_Elliptic 

Elliptic filter.

GHSFilterType_FIR 

FIR filter.

GHSFilterType_IIR 

IIR filter.

GHSFilterType_Wideband 

Wideband filter.

GHSFilterType_Bessel_AA 

Bessel AA filter.

GHSFilterType_Butterworth_AA 

Butterworth AA filter.

GHSFilterType_SigmaDeltaWB 

Sigma delta wide band filter.

GHSFilterType_SigmaDelta 

Sigma delta filter.

GHSFilterType_BandPass 

Band pass filter.

GHSFilterType_FIR3dB 

FIR 3dB filter.

◆ GHSFunctionCallType

Function call type.

Enumerator
GHS_NonBlockingCall 

The function call doe not block execution.

GHS_BlockingCall 

The function call blocks execution.

◆ GHSInputCoupling

Input coupling values that define what signals from the input BNCs are passed on to the amplifier.

Enumerator
GHSInCpl_SingleEndedPositive 

Measure the voltage on the +input.

GHSInCpl_SingleEndedNegative 

Measure the voltage on the -input.

GHSInCpl_Differential 

Measure the difference between +input and -input.

GHSInCpl_Current 

Measure the current flowing from +input to -input.

GHSInCpl_FloatingDifferential 

Measure the difference between +input and -input without having a connection to ground.

◆ GHSRecordingDataSource

Recording data source.

Enumerator
GHSRecordingDataSource_SyncChannels 

Synchronous recorder channels.

GHSRecordingDataSource_SyncRealTimeFormulas 

Synchronous real-time formulas.

◆ GHSReturnValue

All possible API return values.

This enumeration will be extended and/or changed as the API grows.

Enumerator
GHSReturnValue_Reserved 

Reserved to distinguish zero initialized GHSReturnValues. Should never be returned.

GHSReturnValue_OK 

Function call succeeded.

GHSReturnValue_NOK 

Undefined error occurred.

GHSReturnValue_EmptySlot 

The slot referred to does not contain a recorder.

GHSReturnValue_NullPtrArgument 

Passed pointer is a null pointer.

GHSReturnValue_InvalidSlotID 

The slot referred to does not exist on this mainframe.

GHSReturnValue_SystemNotIdle 

Preview or recording can not be started because the system is not idle.

GHSReturnValue_SystemNotRecording 

Recording can not be paused or stopped because the system is not recording. FieldBus is also not available.

GHSReturnValue_SystemNotPaused 

Recording can not be resumed because the system is not paused.

GHSReturnValue_InvalidSampleRate 

Sample-rate is not supported by this recorder.

GHSReturnValue_InvalidHandle 

The connection-handle does not refer to a valid connected mainframe.

GHSReturnValue_APIMismatch 

The client API (with this header file) is incompatible with the version on the server.

GHSReturnValue_ConnectionFailed 

A connection could not be established with the provided IP and Port number.

GHSReturnValue_InvalidIP 

The ipAddress provided is not formatted properly. ("127.0.0.1")

GHSReturnValue_MainframeTimeout 

The API call did not complete in time on the mainframe.

GHSReturnValue_InsufficientDiskSpace 

The mainframe disk is full.

GHSReturnValue_CreateRecordingFailed 

The mainframe could not create a recording.

GHSReturnValue_NoConnection 

Connection was broken or client not logged on.

GHSReturnValue_IncompatibleStorageLocation 

The mainframe is not configured for local storage.

GHSReturnValue_RecordingNotFound 

The indicated recording could not be found.

GHSReturnValue_SystemNotInPreview 

Preview can not be stopped because the system is not in preview.

GHSReturnValue_AlreadyConnected 

A connection could not be established because there was already a connection.

GHSReturnValue_InvalidRecordingName 

The recording name was not valid.

GHSReturnValue_InvalidChannelIndex 

The channel referred to does not exist on this recorder.

GHSReturnValue_InvalidUserMode 

The user mode reffered to does not exist.

GHSReturnValue_InvalidChannelType 

The channel specified has a type that is not supported for this method.

GHSReturnValue_InvalidTriggerPosition 

The trigger position percentage is not valid.

GHSReturnValue_InvalidSweepMode 

The sweep mode referred to does not exist.

GHSReturnValue_NoRecordersInMainframe 

There are no recorders in the mainframe.

GHSReturnValue_InvalidContinuousMode 

The continuous recording mode referred to does not exist.

GHSReturnValue_InvalidModeForTriggerPosition 

The current sweep mode does not support setting the trigger position.

GHSReturnValue_Adapted 

The setter method succeeded but the value has been adapted.

GHSReturnValue_InvalidUTF8Character 

An invalid UTF-8 character was found.

GHSReturnValue_DuplicateChannelName 

Duplicate channel name within a recorder.

GHSReturnValue_InvalidDataType 

Unsupported data type in the method.

GHSReturnValue_MethodNotFound 

Method is not defined in the Mainframe side.

GHSReturnValue_InvalidJSONFormat 

Invalid JSON Format received in the Mainframe side.

GHSReturnValue_UnkownErrorMessage 

Undefined Error Message.

GHSReturnValue_FieldBusError_NotConfigured 

FieldBusError: Field bus is not configured to publish any data.

GHSReturnValue_FieldBusError_FieldBusAlready_Enabled 

FieldBusError: Requesting snapshot not available when fieldbus is already enabled.

GHSReturnValue_FieldBusError_NullFieldBusRingBuffer 

FieldBusError: FieldBusRing Buffer handle is null.

GHSReturnValue_FieldBusError_InvalidFieldBusPacket 

FieldBusError: FieldBus Packet is of an invalid size.

GHSReturnValue_FieldBusError_NotConnected 

FieldBusError: FieldBus is not connected.

GHSReturnValue_FieldBusError_NoFormulasDeployed 

There are no formulas deployed for FieldBus(excluding timestamp)

GHSReturnValue_FieldBusError_BufferSizeInvalid 

The size for the allocated buffer is not enough.

GHSReturnValue_FieldBusError_FieldBusNotSupported 

Field bus is not supported in this mainframe.

GHSReturnValue_CANBusNotFound 

The specified CAN bus could not be found.

GHSReturnValue_WriteAccessBlocked 

Error for Write access.

GHSReturnValue_InvalidCANMsgID 

The specified CAN message ID is invalid.

◆ GHSSignalCoupling

Signal coupling values.

Enumerator
GHSSigCpl_GND 

Ground the input.

GHSSigCpl_DC 

Measure directly.

GHSSigCpl_AC 

Measure AC component.

GHSSigCpl_DC_RMS 

Measure RMS without offset correction.

GHSSigCpl_AC_RMS 

Measure RMS of AC component.

GHSSigCpl_Reference 

Reference voltage or reference signal.

GHSSigCpl_ZeroReset 

Quadrature counter reset.

GHSSigCpl_SinglePrecision 

Quadradure single precision.

GHSSigCpl_DoublePrecision 

Quadradure double precision.

GHSSigCpl_QuadPrecision 

Quadradure precision.

◆ GHSStorageLocation

Storage locations.

Enumerator
GHSStorageLocation_Reserved 

Reserved to distinguish zero initialized GHSStorageLocation. Should never be returned.

GHSStorageLocation_Remote 

PC storage.

GHSStorageLocation_Local1 

Storage on local disk #1 (like SCSI or SATA).

GHSStorageLocation_Local2 

Storage on local disk #2 (like SCSI or SATA).

◆ GHSSweepRecordingMode

Sweep recording modes.

Enumerator
GHSSweepMode_Reserved 

Reserved to distinguish zero initialized GHSSweepRecordingMode. Should never be returned.

GHSSweepMode_Normal 

Normal sweep recording mode.

GHSSweepMode_PreTrigger 

Pre-trigger sweep recording mode.

◆ GHSSweepTriggerMode

Sweep trigger mode.

Enumerator
GHSSweepTriggerMode_FirstTrigger 

Create a sweep recording for the first trigger only.

GHSSweepTriggerMode_EveryTrigger 

Create a sweep recording for all triggers.

GHSSweepTriggerMode_StopTrigger 

Create a sweep recording on a stop trigger.

◆ GHSSyncStatus

Master timebase synchronization status values.

Enumerator
GHSSyncStatus_Reserved 

Reserved to distinguish zero initialized GHSSyncStatus. Should never be returned.

GHSSyncStatus_NotSynced 

Not yet in sync with external signal: both master.

GHSSyncStatus_Syncing 

PLL is busy locking the phase of the master.

GHSSyncStatus_Synced 

PLL phase is locked and accurate.

GHSSyncStatus_ReSyncing 

PLL phase was lost and a restart is not allowed now.

GHSSyncStatus_NoSignal 

No external 1PPS pulse was received for some time.

GHSSyncStatus_CoarseSynced 

PLL is coarse synced.

GHSSyncStatus_NoGMR1000 

We are not synced to GMR1000 PTP master.

GHSSyncStatus_NoOTMC100 

We are not synced to a OTMC100 PTP master.

◆ GHSTimerCounterMode

Timer/counter channel modes.

Enumerator
GHSTimerCounterMode_RPMUniDirectional 

Uni-directional RPM timer/counter channel mode.

GHSTimerCounterMode_RPMBiDirectional 

Bi-directional RPM timer/counter channel mode.

GHSTimerCounterMode_RPMQuadrature 

Quadrature RPM timer/counter channel mode.

GHSTimerCounterMode_FrequencyUniDirectional 

Uni-directional frequency timer/counter channel mode.

GHSTimerCounterMode_FrequencyBiDirectional 

Bi-directional frequency timer/counter channel mode.

GHSTimerCounterMode_FrequencyQuadrature 

Quadrature frequency timer/counter channel mode.

GHSTimerCounterMode_CountUniDirectional 

Uni-directional count timer/counter channel mode.

GHSTimerCounterMode_CountBiDirectional 

Bi-directional count timer/counter channel mode.

GHSTimerCounterMode_CountQuadrature 

Quadrature count timer/counter channel mode.

GHSTimerCounterMode_AngleQuadrature 

Quadrature angle timer/counter channel mode.

GHSTimerCounterMode_AngleQuadratureWithRefPos 

Quadrature angle timer/counter channel mode with reference position.

GHSTimerCounterMode_AngleUniDirectional 

Uni-directional angle timer/counter channel mode.

GHSTimerCounterMode_AngleUniDirectionalWithRefPos 

Uni-directional angle timer/counter channel mode with reference position.

GHSTimerCounterMode_AngleBiDirectional 

Bi-directional angle timer/counter channel mode.

GHSTimerCounterMode_AngleBiDirectionalWithRefPos 

Bi-directional angle timer/counter channel mode with reference position.

◆ GHSTriggerArmState

Trigger arm state.

Enumerator
GHSTriggerArmState_Disarmed 

Triggers are disarmed.

GHSTriggerArmState_Armed 

Triggers are armed.

◆ GHSTriggerMode

Trigger modes.

Enumerator
GHSTriggerMode_Off 

No trigger mode.

GHSTriggerMode_Basic 

Basic trigger mode.

GHSTriggerMode_Dual 

Dual trigger mode.

GHSTriggerMode_Window 

Window trigger mode.

GHSTriggerMode_DualWindow 

Dual window trigger mode.

GHSTriggerMode_Sequential 

Sequential trigger mode.

GHSTriggerMode_QualifierBasic 

Use primary trigger level as qualifier.

GHSTriggerMode_QualifierDual 

Use both trigger levels as qualifiers.

◆ GHSUserMode

User modes.

Enumerator
GHSUserMode_Reserved 

Reserved to distinguish zero initialized GHSUserMode. Should never be returned.

GHSUserMode_Sweeps 

Acquire a single, triggered event.

GHSUserMode_Continuous 

Acquire a continuous stream of data.

GHSUserMode_Dual 

Acquire a continuous stream of data with triggered events.