DCSModulesAPI  1.0.0
DCS sub project containing all the control modules as libraries.
Classes | Typedefs | Enumerations | Functions
DCS::DAQ Namespace Reference

Exposes DAQ functionalities of the API to the end user. More...

Classes

struct  ChannelLimits
 Channel measurement numeric limits. More...
 
struct  InternalChannel
 
struct  InternalTask
 
struct  InternalVoltageData
 
struct  PDetectEventData
 

Typedefs

typedef void * TaskHandle
 
typedef DCS::i32(* NIDataCallback) (TaskHandle taskHandle, DCS::i32 everyNsamplesEventType, DCS::u32 nSamples, void *callbackData)
 
typedef DCS::i32(* NIErrorCallback) (TaskHandle taskHandle, DCS::i32 status, void *callbackData)
 

Enumerations

enum  ChannelType { ChannelType::None, ChannelType::Voltage, ChannelType::Counter }
 Classifies a channel type of the DAQ. More...
 
enum  ChannelRef {
  ChannelRef::None = 0, ChannelRef::Default = -1, ChannelRef::SingleEnded = 10083, ChannelRef::NoRefSingleEnded = 10078,
  ChannelRef::Differential = 10106, ChannelRef::PseudoDifferential = 12529
}
 Classifies a channel reference connector for the DAQ. More...
 

Functions

DCS_API void Init ()
 Initializes the Acquisition API.
 
DCS_API void Terminate ()
 Cleans up the Acquisition API.
 
DCS_API void NewAIVChannel (DCS::Utils::BasicString name, DCS::Utils::BasicString channel_name, ChannelRef ref, ChannelLimits lim)
 Creates a new voltage channel to add to the acquisition stage. More...
 
DCS_API void DeleteAIVChannel (DCS::Utils::BasicString name)
 Deletes an existing voltage channel from the acquisition stage. More...
 
DCS_API void StartAIAcquisition (DCS::f64 samplerate)
 Starts the AI (Analog Input) data acquisition. More...
 
DCS_API void StopAIAcquisition ()
 Stops the AI (Analog Input) data acquisition. More...
 
DCS_REGISTER_EVENT DCS_API void PeakDetectWithAngleEvent ()
 
DCS_REGISTER_EVENT DCS::i32 VoltageEvent (TaskHandle taskHandle, DCS::i32 everyNsamplesEventType, DCS::u32 nSamples, void *callbackData)
 
DCS_INTERNAL_TEST void CreateTask (InternalTask *t, const char *name)
 
DCS_INTERNAL_TEST void SetupTask (InternalTask *t, const char *clk_source, DCS::f64 clk, DCS::u64 num_samp, NIDataCallback func)
 
DCS_INTERNAL_TEST void AddTaskChannel (InternalTask *t, const char *channel_name, ChannelType type, ChannelRef ref, ChannelLimits lims, const char *virtual_channel_name=nullptr)
 
DCS_INTERNAL_TEST void StartTask (InternalTask *t)
 
DCS_INTERNAL_TEST void StopTask (InternalTask *t)
 
DCS_INTERNAL_TEST void ClearTask (InternalTask *t)
 
DCS_INTERNAL_TEST DCS::DAQ::InternalVoltageData GetLastIVD ()
 

Detailed Description

Exposes DAQ functionalities of the API to the end user.

Enumeration Type Documentation

enum DCS::DAQ::ChannelRef
strong

Classifies a channel reference connector for the DAQ.

Enumerator
None 

No reference. Will cause an error if used.

Default 

Let DAQmx use the default reference for the current channel.

SingleEnded 

Use referenced single ended signal.

NoRefSingleEnded 

Use unreferenced single ended signal.

Differential 

Use differential signal.

PseudoDifferential 

Use pseudo-differential signal. See here for more info.

enum DCS::DAQ::ChannelType
strong

Classifies a channel type of the DAQ.

Enumerator
None 

No channel.

Voltage 

A voltage channel.

Counter 

A counter channel. Freq out for outputs.