niscopeobsolete.h

此为某测试平台的上位机软件部分

  to change) 
  *********************************************************/

#define NISCOPE_WARNMSG_HEATER_CIRCUIT_TEMPERATURE     "Onboard temperature stabilization circuit requires calibration."
#define NISCOPE_WARNMSG_INVALID_DATA                   "Data acquired during the acquisition is possibly invalid. May be caused by high frequency transients or input voltage exceeding the maximum for given range."
#define NISCOPE_WARNMSG_CHANNEL_OVERLOAD               "The 50 ohm protection on one or more channels has been disabled because of excess signal power."
#define NISCOPE_WARNMSG_AUTOSETUP_NO_SIGNAL            "Auto Setup was unable to find a signal."
#define NISCOPE_WARNMSG_PLL_UNLOCKED                   "The PLL is not locked."
#define NISCOPE_WARNMSG_PLL_UNLOCKED_AND_ADC_OVERLOAD  "The PLL is not locked and the ADC has an overload."
#define NISCOPE_WARNMSG_TIMESTAMP_ROLLOVER             "The timestamp counter has rolled over."
#define NISCOPE_WARNMSG_ADC_OVERLOAD                   "One or more channels has an ADC overload."
#define NISCOPE_ERRMSG_SOFTWARE_FAILURE                "Software failure occurred during operation."
#define NISCOPE_ERRMSG_HARDWARE_FAILURE                "Hardware failure occurred during operation."
#define NISCOPE_ERRMSG_INSUFFICIENT_MEMORY             "Insufficient on-board memory available to perform the acquisition."
#define NISCOPE_ERRMSG_INVALID_DATA                    "Data acquired during the acquisition is invalid."
#define NISCOPE_ERRMSG_GAIN_CAL_FAILURE                "Unable to perform gain calibration"
#define NISCOPE_ERRMSG_SINE_CAL_FAILURE                "Unable to acquire valid sine wave for calibration"
#define NISCOPE_ERRMSG_LIN_CAL_FAILURE                 "Unable to calculate linearity coefficients"
#define NISCOPE_ERRMSG_ADC_CAL_FAILURE                 "ADC exceeds linearity specs"
#define NISCOPE_ERRMSG_ACQ_IN_PROGRESS                 "A previous acquisition is still in progress. If you are attempting to change an attribute, note you can only change fetch attributes while an acquisition is still in progress."
#define NISCOPE_ERRMSG_DATA_NOT_AVAILABLE              "Data acquired during the acquisition is not available."
#define NISCOPE_ERRMSG_HEATER_CIRCUIT_CAL_FAILURE      "Unable to calibrate onboard temperature stablization circuit."
#define NISCOPE_ERRMSG_FLEXRES_CONFIG_CORRUPT          "The FlexRes configuration files are corrupt, please reinstall niScope software or contact National Instruments."
#define NISCOPE_ERRMSG_GAIN_OFFSET_CAL_FAILURE         "Unable to perform gain/offset calibration."
#define NISCOPE_ERRMSG_CREATE_THREAD                   "Acquisition thread could not be created."
#define NISCOPE_ERRMSG_WRONG_PASSWORD                  "Password in EEPROM does not match the given password."
#define NISCOPE_ERRMSG_INVALID_GAIN                    "Invalid gain specified. Use the gain constants defined in the calibration header file."
#define NISCOPE_ERRMSG_INVALID_CAL_SESSION             "This function requires an external calibration session. Call niScope_CalStart instead of niScope_init to get the proper session type."
#define NISCOPE_ERRMSG_BAD_MEASUREMENT                 "The specified waveform measurement is not allowed with this function."
#define NISCOPE_ERRMSG_BUFFER_NOT_ACQUIRED             "Requested buffer has not been acquired yet."
#define NISCOPE_ERRMSG_TRIGGER_HAS_NOT_OCCURRED        "The trigger has not occurred for the requested buffer, so data cannot be fetched relative to the trigger."
#define NISCOPE_ERRMSG_ILLEGAL_RELATIVE_TO             "Illegal relativeTo parameter."
#define NISCOPE_ERRMSG_DATA_OVERWRITTEN                "The requested data has been overwritten in memory so it is no longer available for fetching."
#define NISCOPE_ERRMSG_INVALID_TIMESTAMP_EVENT_TAG     "Invalid timestamp event tag."
#define NISCOPE_ERRMSG_TIMEOUT_TRANSFERRING_TIMESTAMPS "Timeout transferring timestamps."
#define NISCOPE_ERRMSG_TIMEOUT_CHECKING_STATUS         "Timeout checking status."
#define NISCOPE_ERRMSG_TIMEOUT_TRANSFERRING_DATA       "Timeout transferring data."
#define NISCOPE_ERRMSG_PLL_FAILURE                     "PLL failure."
#define NISCOPE_ERRMSG_PAR_TO_SER_CONV_FAILURE         "Parallel to serial convertor failure."
#define NISCOPE_ERRMSG_DMA_CONFIG_ERROR                "DMA config error."
#define NISCOPE_ERRMSG_ILLEGAL_USER_OFFSET             "The user offset specified is not valid."
#define NISCOPE_ERRMSG_NOT_A_SCOPE                     "The specified resource name is not assigned to an NI digitizer.  Verify the resource name in Measurement & Automation Explorer (MAX).  \
To use a DAQmx device with a DAQ::N style name (e.g. DAQ::1), rename the device in MAX to N (e.g. 1)."
#define NISCOPE_ERRMSG_TIMEOUT_CLEARING_TIO            "Timeout clearing TIO."
#define NISCOPE_ERRMSG_RIS_DID_NOT_COMPLETE            "RIS did not complete so data is not available."
#define NISCOPE_ERRMSG_INVALID_RIS_METHOD              "RIS method is invalid."
#define NISCOPE_ERRMSG_INVALID_RIS_NUM_AVERAGES        "RIS num averages attribute is invalid. It must be greater than 0."
#define NISCOPE_ERRMSG_ILLEGAL_DATATYPE                "Illegal data type parameter. See niScope.h for legal defined values."
#define NISCOPE_ERRMSG_ATTRIBUTES_DIFFER_BY_CHANNEL    "Getting a channel based attribute value failed because the queried channels have different values.  Please specify a channel when querying a channel based attribute."
#define NISCOPE_ERRMSG_TRIGGER_DELAY_INVALID_WITH_RIS  "The trigger delay parameter to the configure trigger function must be zero during RIS acquisitions."
#define NISCOPE_ERRMSG_INITIATE_NOT_CALLED             "An acquisition has not been initiated."
#define NISCOPE_ERRMSG_INVALID_FUNCTION_USE            "This function may not be used for fetching multiple waveforms."
#define NISCOPE_ERRMSG_HOLDOFF_DELAY_NONZERO           "Specifying either trigger holdoff or trigger delay is allowed, but not both."
#define NISCOPE_ERRMSG_CHANNEL_NAME_TOO_LONG           "The channel name is too long."
#define NISCOPE_ERRMSG_DIGITIZER_ALREADY_IN_USE        "The digitizer is being used by another application or process."
#define NISCOPE_ERRMSG_SIM_MODEL_NOT_SUPPORTED         "Simulation does not support the selected model and board type."
#define NISCOPE_ERRMSG_SPECIFICDLL_LOAD_FAILURE        "The specific niScopeDAQ or niScopeDMF dll could not be loaded."
#define NISCOPE_ERRMSG_SPECIFICDLL_GET_ADDRESS_FAILURE "An exported function address could not be obtained from the specific niScopeDAQ or niScopeDMF dll."
#define NISCOPE_ERRMSG_TRIGGER_TYPE_INVALID            "The configure trigger type is invalid or not supported"
#define NISCOPE_ERRMSG_INVALID_FETCH_PARAMETERS        "The fetch parameters are not valid."
#define NISCOPE_ERRMSG_EXT_CAL_NOT_COMPLETE            "Attempt to store calibration constants without completing all the necessary external calibration steps.Consult the calibration procedure. \
Verify that all necessary steps are performed before closing the external calibration session."
#define NISCOPE_ERRMSG_EXT_CAL_CONSTS_INVALID          "External calibration constants are invalid.  Perform an external calibration. Contact National Instruments if you need additional information."
#define NISCOPE_ERRMSG_INVALID_NUM_WAVEFORMS           "This function may not be used for fetching multiple waveforms."

/* Not recommended */
#define NISCOPE_ERROR_CODES_AND_MSGS \
{NISCOPE_WARN_HEATER_CIRCUIT_TEMPERATURE,          NISCOPE_WARNMSG_HEATER_CIRCUIT_TEMPERATURE},    \
{NISCOPE_WARN_INVALID_DATA,                        NISCOPE_WARNMSG_INVALID_DATA},                  \
{NISCOPE_WARN_CHANNEL_OVERLOAD,                    NISCOPE_WARNMSG_CHANNEL_OVERLOAD},              \
{NISCOPE_WARN_AUTOSETUP_NO_SIGNAL,                 NISCOPE_WARNMSG_AUTOSETUP_NO_SIGNAL},           \
{NISCOPE_WARN_PLL_UNLOCKED,                        NISCOPE_WARNMSG_PLL_UNLOCKED},                  \
{NISCOPE_WARN_PLL_UNLOCKED_AND_ADC_OVERLOAD,       NISCOPE_WARNMSG_PLL_UNLOCKED_AND_ADC_OVERLOAD}, \
{NISCOPE_WARN_TIMESTAMP_ROLLOVER,                  NISCOPE_WARNMSG_TIMESTAMP_ROLLOVER},            \
{NISCOPE_WARN_ADC_OVERLOAD,                        NISCOPE_WARNMSG_ADC_OVERLOAD},                  \
{NISCOPE_ERROR_SOFTWARE_FAILURE,                   NISCOPE_ERRMSG_SOFTWARE_FAILURE},               \
{NISCOPE_ERROR_HARDWARE_FAILURE,                   NISCOPE_ERRMSG_HARDWARE_FAILURE},               \
{NISCOPE_ERROR_INSUFFICIENT_MEMORY,                NISCOPE_ERRMSG_INSUFFICIENT_MEMORY},            \
{NISCOPE_ERROR_INVALID_DATA,                       NISCOPE_ERRMSG_INVALID_DATA},                   \
{NISCOPE_ERROR_GAIN_CAL_FAILURE,                   NISCOPE_ERRMSG_GAIN_CAL_FAILURE},               \
{NISCOPE_ERROR_SINE_CAL_FAILURE,                   NISCOPE_ERRMSG_SINE_CAL_FAILURE},               \
{NISCOPE_ERROR_LIN_CAL_FAILURE,                    NISCOPE_ERRMSG_LIN_CAL_FAILURE},                \
{NISCOPE_ERROR_ADC_CAL_FAILURE,                    NISCOPE_ERRMSG_ADC_CAL_FAILURE},                \
{NISCOPE_ERROR_ACQ_IN_PROGRESS,                    NISCOPE_ERRMSG_ACQ_IN_PROGRESS},                \
{NISCOPE_ERROR_DATA_NOT_AVAILABLE,                 NISCOPE_ERRMSG_DATA_NOT_AVAILABLE},             \
{NISCOPE_ERROR_HEATER_CIRCUIT_CAL_FAILURE,         NISCOPE_ERRMSG_HEATER_CIRCUIT_CAL_FAILURE},     \
{NISCOPE_ERROR_FLEXRES_CONFIG_CORRUPT,             NISCOPE_ERRMSG_FLEXRES_CONFIG_CORRUPT},         \
{NISCOPE_ERROR_GAIN_OFFSET_CAL_FAILURE,            NISCOPE_ERRMSG_GAIN_OFFSET_CAL_FAILURE},        \
{NISCOPE_ERROR_CREATE_THREAD,                      NISCOPE_ERRMSG_CREATE_THREAD},                  \
{NISCOPE_ERROR_WRONG_PASSWORD,                     NISCOPE_ERRMSG_WRONG_PASSWORD},                 \
{NISCOPE_ERROR_INVALID_GAIN,                       NISCOPE_ERRMSG_INVALID_GAIN},                   \
{NISCOPE_ERROR_INVALID_CAL_SESSION,                NISCOPE_ERRMSG_INVALID_CAL_SESSION},            \
{NISCOPE_ERROR_BAD_MEASUREMENT,                    NISCOPE_ERRMSG_BAD_MEASUREMENT},                \
{NISCOPE_ERROR_BUFFER_NOT_ACQUIRED,                NISCOPE_ERRMSG_BUFFER_NOT_ACQUIRED},            \
{NISCOPE_ERROR_TRIGGER_HAS_NOT_OCCURRED,           NISCOPE_ERRMSG_TRIGGER_HAS_NOT_OCCURRED},       \
{NISCOPE_ERROR_ILLEGAL_RELATIVE_TO,                NISCOPE_ERRMSG_ILLEGAL_RELATIVE_TO},            \
{NISCOPE_ERROR_DATA_OVERWRITTEN,                   NISCOPE_ERRMSG_DATA_OVERWRITTEN},               \
{NISCOPE_ERROR_INVALID_TIMESTAMP_EVENT_TAG,        NISCOPE_ERRMSG_INVALID_TIMESTAMP_EVENT_TAG},    \
{NISCOPE_ERROR_TIMEOUT_TRANSFERRING_TIMESTAMPS,    NISCOPE_ERRMSG_TIMEOUT_TRANSFERRING_TIMESTAMPS},\
{NISCOPE_ERROR_TIMEOUT_CHECKING_STATUS,            NISCOPE_ERRMSG_TIMEOUT_CHECKING_STATUS},        \
{NISCOPE_ERROR_TIMEOUT_TRANSFERRING_DATA,          NISCOPE_ERRMSG_TIMEOUT_TRANSFERRING_DATA},      \
{NISCOPE_ERROR_PLL_FAILURE,                        NISCOPE_ERRMSG_PLL_FAILURE},                    \
{NISCOPE_ERROR_PAR_TO_SER_CONV_FAILURE,            NISCOPE_ERRMSG_PAR_TO_SER_CONV_FAILURE},        \
{NISCOPE_ERROR_DMA_CONFIG_ERROR,                   NISCOPE_ERRMSG_DMA_CONFIG_ERROR},               \
{NISCOPE_ERROR_ILLEGAL_USER_OFFSET,                NISCOPE_ERRMSG_ILLEGAL_USER_OFFSET},            \
{NISCOPE_ERROR_NOT_A_SCOPE,                        NISCOPE_ERRMSG_NOT_A_SCOPE},                    \
{NISCOPE_ERROR_TIMEOUT_CLEARING_TIO,               NISCOPE_ERRMSG_TIMEOUT_CLEARING_TIO},           \
{NISCOPE_ERROR_RIS_DID_NOT_COMPLETE,               NISCOPE_ERRMSG_RIS_DID_NOT_COMPLETE},           \
{NISCOPE_ERROR_INVALID_RIS_METHOD,                 NISCOPE_ERRMSG_INVALID_RIS_METHOD},             \
{NISCOPE_ERROR_INVALID_RIS_NUM_AVERAGES,           NISCOPE_ERRMSG_INVALID_RIS_NUM_AVERAGES},       \
{NISCOPE_ERROR_ILLEGAL_DATATYPE,                   NISCOPE_ERRMSG_ILLEGAL_DATATYPE},               \
{NISCOPE_ERROR_ATTRIBUTES_DIFFER_BY_CHANNEL,       NISCOPE_ERRMSG_ATTRIBUTES_DIFFER_BY_CHANNEL},   \
{NISCOPE_ERROR_TRIGGER_DELAY_INVALID_WITH_RIS,     NISCOPE_ERRMSG_TRIGGER_DELAY_INVALID_WITH_RIS}, \
{NISCOPE_ERROR_INITIATE_NOT_CALLED,                NISCOPE_ERRMSG_INITIATE_NOT_CALLED},            \
{NISCOPE_ERROR_INVALID_FUNCTION_USE,               NISCOPE_ERRMSG_INVALID_FUNCTION_USE},           \
{NISCOPE_ERROR_HOLDOFF_DELAY_NONZERO,              NISCOPE_ERRMSG_HOLDOFF_DELAY_NONZERO},          \
{NISCOPE_ERROR_CHANNEL_NAME_TOO_LONG,              NISCOPE_ERRMSG_CHANNEL_NAME_TOO_LONG},          \
{NISCOPE_ERROR_DIGITIZER_ALREADY_IN_USE,           NISCOPE_ERRMSG_DIGITIZER_ALREADY_IN_USE},       \
{NISCOPE_ERROR_SIM_MODEL_NOT_SUPPORTED,            NISCOPE_ERRMSG_SIM_MODEL_NOT_SUPPORTED},        \
{NISCOPE_ERROR_SPECIFICDLL_LOAD_FAILURE,           NISCOPE_ERRMSG_SPECIFICDLL_LOAD_FAILURE},       \
{NISCOPE_ERROR_SPECIFICDLL_GET_ADDRESS_FAILURE,    NISCOPE_ERRMSG_SPECIFICDLL_GET_ADDRESS_FAILURE},\
{NISCOPE_ERROR_TRIGGER_TYPE_INVALID,               NISCOPE_ERRMSG_TRIGGER_TYPE_INVALID},           \
{NISCOPE_ERROR_INVALID_FETCH_PARAMETERS,           NISCOPE_ERRMSG_INVALID_FETCH_PARAMETERS},       \
{NISCOPE_ERROR_INVALID_NUM_WAVEFORMS,              NISCOPE_ERRMSG_INVALID_NUM_WAVEFORMS},          \
{NISCOPE_ERROR_EXT_CAL_NOT_COMPLETE,               NISCOPE_ERRMSG_EXT_CAL_NOT_COMPLETE},           \
{NISCOPE_ERROR_EXT_CAL_CONSTS_INVALID,             NISCOPE_ERRMSG_EXT_CAL_CONSTS_INVALID}

/*********************************************************
  Functions reserved for class driver use only.
  End-users should not call these functions.
  *********************************************************/
ViStatus _VI_FUNC  niScope_IviInit (ViRsrc resourceName,
                                    ViBoolean IDQuery,
                                    ViBoolean reset,
                                    ViSession vi);

ViStatus _VI_FUNC  niScope_IviClose (ViSession vi);


   //- Obsolete Inherent Instrument Attributes and functions
   //- These attributes and functions have been deprecated and may not
   //  be supported in future versions of this driver.
// use NISCOPE_ATTR_QUERY_INSTRUMENT_STATUS instead
#define NISCOPE_ATTR_QUERY_INSTR_STATUS       NISCOPE_ATTR_QUERY_INSTRUMENT_STATUS
// use NISCOPE_ATTR_SPECIFIC_DRIVER_PREFIX instead
#define NISCOPE_ATTR_SPECIFIC_PREFIX          NISCOPE_ATTR_SPECIFIC_DRIVER_PREFIX
// use NISCOPE_ATTR_CHANNEL_COUNT instead
#define NISCOPE_ATTR_NUM_CHANNELS             NISCOPE_ATTR_CHANNEL_COUNT
// use NISCOPE_ATTR_SPECIFIC_DRIVER_REVISION instead
#define NISCOPE_ATTR_DRIVER_REVISION          NISCOPE_ATTR_SPECIFIC_DRIVER_REVISION
// use NISCOPE_ATTR_IO_RESOURCE_DESCRIPTOR instead
#define NISCOPE_ATTR_RESOURCE_DESCRIPTOR NISCOPE_ATTR_IO_RESOURCE_DESCRIPTOR

// do not use
#define NISCOPE_ATTR_DRIVER_MAJOR_VERSION     IVI_ATTR_DRIVER_MAJOR_VERSION
#define NISCOPE_ATTR_DRIVER_MINOR_VERSION     IVI_ATTR_DRIVER_MINOR_VERSION
#define NISCOPE_ATTR_ENGINE_MAJOR_VERSION     IVI_ATTR_ENGINE_MAJOR_VERSION
#define NISCOPE_ATTR_ENGINE_MINOR_VERSION     IVI_ATTR_ENGINE_MINOR_VERSION
#define NISCOPE_ATTR_ENGINE_REVISION          IVI_ATTR_ENGINE_REVISION
#define NISCOPE_ATTR_IO_SESSION               IVI_ATTR_IO_SESSION
#define NISCOPE_ATTR_DEFER_UPDATE             IVI_ATTR_DEFER_UPDATE
#define NISCOPE_ATTR_RETURN_DEFERRED_VALUES   IVI_ATTR_RETURN_DEFERRED_VALUES
#define NISCOPE_ATTR_PRIMARY_ERROR            IVI_ATTR_PRIMARY_ERROR
#define NISCOPE_ATTR_SECONDARY_ERROR          IVI_ATTR_SECONDARY_ERROR
#define NISCOPE_ATTR_ERROR_ELABORATION        IVI_ATTR_ERROR_ELABORATION

   // Obsolete Specific Attributes.
// use NISCOPE_ATTR_MAX_INPUT_FREQUENCY instead
#define NISCOPE_ATTR_BANDWIDTH                IVISCOPE_ATTR_BANDWIDTH
#define NISCOPE_ATTR_TRIGGER_OUTPUT_EVENT     (IVI_SPECIFIC_PUBLIC_ATTR_BASE + 10L)  /* ViInt32              */
#define NISCOPE_ATTR_TRIGGER_OUTPUT_SOURCE    (IVI_SPECIFIC_PUBLIC_ATTR_BASE + 11L)  /* ViString             */
#define NISCOPE_ATTR_EXPORT_SAMP_CLK_OUTPUT_TERM         (IVI_SPECIFIC_PUBLIC_ATTR_BASE + 91)   /* ViString   */

   /*- Every line called by configure trigger output can have a different event -*/
#define NISCOPE_ATTR_RTSI0_TRIGGER_OUTPUT_EVENT       (IVI_SPECIFIC_PUBLIC_ATTR_BASE + 54L) /* ViInt32  */
#define NISCOPE_ATTR_RTSI1_TRIGGER_OUTPUT_EVENT       (IVI_SPECIFIC_PUBLIC_ATTR_BASE + 55L) /* ViInt32  */
#define NISCOPE_ATTR_RTSI2_TRIGGER_OUTPUT_EVENT       (IVI_SPECIFIC_PUBLIC_ATTR_BASE + 56L) /* ViInt32  */
#define NISCOPE_ATTR_RTSI3_TRIGGER_OUTPUT_EVENT       (IVI_SPECIFIC_PUBLIC_ATTR_BASE + 57L) /* ViInt32  */
#define NISCOPE_ATTR_RTSI4_TRIGGER_OUTPUT_EVENT       (IVI_SPECIFIC_PUBLIC_ATTR_BASE + 58L) /* ViInt32  */
#define NISCOPE_ATTR_RTSI5_TRIGGER_OUTPUT_EVENT       (IVI_SPECIFIC_PUBLIC_ATTR_BASE + 59L) /* ViInt32  */
#define NISCOPE_ATTR_RTSI6_TRIGGER_OUTPUT_EVENT       (IVI_SPECIFIC_PUBLIC_ATTR_BASE + 60L) /* ViInt32  */
#define NISCOPE_ATTR_PFI1_TRIGGER_OUTPUT_EVENT        (IVI_SPECIFIC_PUBLIC_ATTR_BASE + 61L) /* ViInt32  */
#define NISCOPE_ATTR_PFI2_TRIGGER_OUTPUT_EVENT        (IVI_SPECIFIC_PUBLIC_ATTR_BASE + 62L) /* ViInt32  */
#define NISCOPE_ATTR_STAR_TRIGGER_OUTPUT_EVENT        (IVI_SPECIFIC_PUBLIC_ATTR_BASE + 63L) /* ViInt32  */

// Obsolete Specific Values
// NISCOPE_ATTR_TRIGGER_OUTPUT_EVENT / ConfigureTriggerOutput values
#define NISCOPE_VAL_NO_EVENT                          0
#define NISCOPE_VAL_STOP_TRIGGER_EVENT                1 
#define NISCOPE_VAL_START_TRIGGER_EVENT               2 

/*- NISCOPE_ATTR_MAX_INPUT_FREQUENCY Values -*/
#define NISCOPE_VAL_FULL_BANDWIDTH                    0.0

/****************************************************************************
 *---------------------------- End Include File ----------------------------*
 ****************************************************************************/

#endif /* __NISCOPE_HEADER_OBSOLETE */