DSRemoteConnect_Documented.h

Go to the documentation of this file.

 
#pragma once
 
#ifdef DSREMOTECONNECT_EXPORTS
#define DSREMOTECONNECT_API __declspec(dllexport)
#else
#define DSREMOTECONNECT_API __declspec(dllimport)
#endif
 
#include "DSXInstance.h"
#ifdef __clang__ 
    #include "DSXNETInstance.h"
#endif
 
#ifndef __clang__
    #include "DSXDCOMInstance.h"
    #include "DSXNETInstance.h"
#endif
 
const std::string VER_DSREMOTE = "1.1.3.24";
 
typedef DSXInstance* DSXInstanceHandle;
 
typedef ChannelInstance* ChannelInstanceHandle;
 
// ============================================================================
// @defgroup core_functions Core Instance Management
// @brief Functions for creating, connecting, and managing DSX instances
// @{
// ============================================================================
 
extern "C" DSREMOTECONNECT_API int dsconGetVersion(char* version, size_t len);
 
extern "C" DSREMOTECONNECT_API int dsconCreateInstance(DSXInstanceHandle* handle, int connectionType);
 
extern "C" DSREMOTECONNECT_API int dsconConnect(DSXInstanceHandle handle, char* connectionString);
 
extern "C" DSREMOTECONNECT_API int dsconDestroyInstance(DSXInstanceHandle handle);
 
extern "C" DSREMOTECONNECT_API int dsconDisconnect(DSXInstanceHandle handle);
 
 // end of core_functions group
 
// ============================================================================
// @defgroup setup_functions Setup and Configuration Management  
// @brief Functions for loading setups and configuring the measurement environment
// @{
// ============================================================================
 
extern "C" DSREMOTECONNECT_API int dsconLoadSetup(DSXInstanceHandle handle, char* fileName);
 
extern "C" DSREMOTECONNECT_API int dsconSetAppWindowVisible(DSXInstanceHandle handle, bool visible);
 
extern "C" DSREMOTECONNECT_API int dsconSetBufferSize(DSXInstanceHandle handle, int bufferSize);
 
 // end of setup_functions group
 
// ============================================================================
// @defgroup channel_discovery Channel Discovery and Enumeration
// @brief Functions for discovering and enumerating available measurement channels
// @{
// ============================================================================
 
extern "C" DSREMOTECONNECT_API int dsconGetChannelCount(DSXInstanceHandle handle, size_t* count);
 
extern "C" DSREMOTECONNECT_API int dsconEnumerateChannels(DSXInstanceHandle handle, ChannelIdList* channelIdList, size_t* count);
 
extern "C" DSREMOTECONNECT_API int dsconFreeEnumerateChannels(DSXInstanceHandle handle, ChannelIdList* channelIdList);
 
extern "C" DSREMOTECONNECT_API int dsconInitChannelIdEnum(DSXInstanceHandle handle);
 
extern "C" DSREMOTECONNECT_API int dsconGetNextChannelId(DSXInstanceHandle handle, ChannelID id);
 
extern "C" DSREMOTECONNECT_API int dsconGetNextChannelIdSize(DSXInstanceHandle handle, int* size);
 
 // end of channel_discovery group
 
// ============================================================================
// @defgroup channel_management Channel Instance Management
// @brief Functions for creating and managing channel instances
// @{
// ============================================================================
 
extern "C" DSREMOTECONNECT_API int dsconCreateChannelInstance(DSXInstanceHandle handle, ChannelID id, ChannelInstanceHandle* chInstance);
 
extern "C" DSREMOTECONNECT_API int dsconCreateChannelInstanceByName(DSXInstanceHandle handle, char* chName, ChannelInstanceHandle* chInstance);
 
extern "C" DSREMOTECONNECT_API int dsconFreeChannelInstance(ChannelInstanceHandle chInstance);
 
 // end of channel_management group
 
// ============================================================================
// @defgroup channel_properties Channel Properties and Information
// @brief Functions for querying channel properties and metadata
// @{
// ============================================================================
 
extern "C" DSREMOTECONNECT_API int dsconChannelGetName(ChannelInstanceHandle channel, char* name, size_t len);
 
extern "C" DSREMOTECONNECT_API int dsconGetSampleRate(ChannelInstanceHandle handle, double* sampleRate);
 
extern "C" DSREMOTECONNECT_API int dsconGetChannelType(ChannelInstanceHandle handle, int* chType);
 
extern "C" DSREMOTECONNECT_API int dsconIsChannelControl(ChannelInstanceHandle handle, bool* result);
 
extern "C" DSREMOTECONNECT_API int dsconGetChUnit(ChannelInstanceHandle handle, char* resultUnit, size_t len);
 
extern "C" DSREMOTECONNECT_API int dsconChannelSetTransferred(ChannelInstanceHandle handle, bool transferred);
 
 // end of channel_properties group
 
// ============================================================================
// @defgroup measurement_control Measurement Control
// @brief Functions for controlling measurement sessions
// @{
// ============================================================================
 
extern "C" DSREMOTECONNECT_API int dsconIsInAqusition(DSXInstanceHandle handle, bool* value);
 
extern "C" DSREMOTECONNECT_API int dsconStartMeasurement(DSXInstanceHandle handle);
 
extern "C" DSREMOTECONNECT_API int dsconStopMeasurement(DSXInstanceHandle handle);
 
 // end of measurement_control group
 
// ============================================================================
// @defgroup data_acquisition Data Reading and Writing
// @brief Functions for reading measurement data and writing control values
// @{
// ============================================================================
 
extern "C" DSREMOTECONNECT_API int dsconBeginRead(DSXInstanceHandle handle, double* startTime, double* endTime);
 
extern "C" DSREMOTECONNECT_API int dsconChannelReadScalarData(ChannelInstanceHandle handle, double** data, double** timestamps, size_t* count);
 
extern "C" DSREMOTECONNECT_API int dsconChannelReadScalarData_2(ChannelInstanceHandle handle, double* data, double* timestamps, size_t* count);
 
extern "C" DSREMOTECONNECT_API int dsconChannelReadScalarData_2abs(ChannelInstanceHandle handle, double* data, double* timestamps, size_t* count);
 
extern "C" DSREMOTECONNECT_API int dsconControlChannelWriteData(ChannelInstanceHandle handle, double data);
 
extern "C" DSREMOTECONNECT_API int dsconEndRead(DSXInstanceHandle handle);
 
 // end of data_acquisition group