Main MRPT website > C++ reference for MRPT 1.9.9
List of all members | Classes | Public Member Functions | Public Attributes
mrpt::hwdrivers::CNationalInstrumentsDAQ::TaskDescription Struct Reference

Detailed Description

Each of the tasks to create in CNationalInstrumentsDAQ::initialize().

Refer to the docs on config file formats of mrpt::hwdrivers::CNationalInstrumentsDAQ to learn on the meaning of each field. Also, see National Instruments' DAQmx API docs online.

Definition at line 281 of file CNationalInstrumentsDAQ.h.

#include <mrpt/hwdrivers/CNationalInstrumentsDAQ.h>

Classes

struct  desc_ai_t
 
struct  desc_ao_t
 
struct  desc_ci_ang_encoder_t
 
struct  desc_ci_count_edges_t
 
struct  desc_ci_lin_encoder_t
 
struct  desc_ci_period_t
 
struct  desc_ci_pulse_width_t
 
struct  desc_co_pulses_t
 
struct  desc_di_t
 
struct  desc_do_t
 

Public Member Functions

 TaskDescription ()
 

Public Attributes

bool has_ai
 
bool has_ao
 
bool has_di
 
bool has_do
 
bool has_ci_period
 
bool has_ci_count_edges
 
bool has_ci_pulse_width
 
bool has_ci_lin_encoder
 
bool has_ci_ang_encoder
 
bool has_co_pulses
 
double samplesPerSecond
 Sample clock config: samples per second. More...
 
std::string sampleClkSource
 Sample clock source: may be empty (default value) for some channels. More...
 
uint32_t bufferSamplesPerChannel
 (Default=0) From NI's docs: The number of samples the buffer can hold for each channel in the task. More...
 
uint32_t samplesPerChannelToRead
 (Default=1000) The number of samples to grab at once from each channel. More...
 
std::string taskLabel
 (Default="task###") More...
 
struct mrpt::hwdrivers::CNationalInstrumentsDAQ::TaskDescription::desc_ai_t ai
 Analog inputs. More...
 
struct mrpt::hwdrivers::CNationalInstrumentsDAQ::TaskDescription::desc_ao_t ao
 Analog outputs. More...
 
struct mrpt::hwdrivers::CNationalInstrumentsDAQ::TaskDescription::desc_di_t di
 Digital inputs (di) More...
 
struct mrpt::hwdrivers::CNationalInstrumentsDAQ::TaskDescription::desc_do_t douts
 Digital outs (do) More...
 
struct mrpt::hwdrivers::CNationalInstrumentsDAQ::TaskDescription::desc_ci_period_t ci_period
 Counter: period of a digital signal. More...
 
struct mrpt::hwdrivers::CNationalInstrumentsDAQ::TaskDescription::desc_ci_count_edges_t ci_count_edges
 Counter: period of a digital signal. More...
 
struct mrpt::hwdrivers::CNationalInstrumentsDAQ::TaskDescription::desc_ci_pulse_width_t ci_pulse_width
 Counter: measure the width of a digital pulse. More...
 
struct mrpt::hwdrivers::CNationalInstrumentsDAQ::TaskDescription::desc_ci_lin_encoder_t ci_lin_encoder
 Counter: uses a linear encoder to measure linear position. More...
 
struct mrpt::hwdrivers::CNationalInstrumentsDAQ::TaskDescription::desc_ci_ang_encoder_t ci_ang_encoder
 Counter: uses an angular encoder to measure angular position. More...
 
struct mrpt::hwdrivers::CNationalInstrumentsDAQ::TaskDescription::desc_co_pulses_t co_pulses
 Output counter: digital pulses output. More...
 

Constructor & Destructor Documentation

◆ TaskDescription()

CNationalInstrumentsDAQ::TaskDescription::TaskDescription ( )

Definition at line 1000 of file CNationalInstrumentsDAQ.cpp.

Member Data Documentation

◆ ai

struct mrpt::hwdrivers::CNationalInstrumentsDAQ::TaskDescription::desc_ai_t mrpt::hwdrivers::CNationalInstrumentsDAQ::TaskDescription::ai

◆ ao

struct mrpt::hwdrivers::CNationalInstrumentsDAQ::TaskDescription::desc_ao_t mrpt::hwdrivers::CNationalInstrumentsDAQ::TaskDescription::ao

◆ bufferSamplesPerChannel

uint32_t mrpt::hwdrivers::CNationalInstrumentsDAQ::TaskDescription::bufferSamplesPerChannel

(Default=0) From NI's docs: The number of samples the buffer can hold for each channel in the task.

Zero indicates no buffer should be allocated. Use a buffer size of 0 to perform a hardware-timed operation without using a buffer.

Definition at line 299 of file CNationalInstrumentsDAQ.h.

Referenced by mrpt::hwdrivers::CNationalInstrumentsDAQ::initialize().

◆ ci_ang_encoder

struct mrpt::hwdrivers::CNationalInstrumentsDAQ::TaskDescription::desc_ci_ang_encoder_t mrpt::hwdrivers::CNationalInstrumentsDAQ::TaskDescription::ci_ang_encoder

Counter: uses an angular encoder to measure angular position.

Referenced by mrpt::hwdrivers::CNationalInstrumentsDAQ::grabbing_thread(), and mrpt::hwdrivers::CNationalInstrumentsDAQ::initialize().

◆ ci_count_edges

struct mrpt::hwdrivers::CNationalInstrumentsDAQ::TaskDescription::desc_ci_count_edges_t mrpt::hwdrivers::CNationalInstrumentsDAQ::TaskDescription::ci_count_edges

Counter: period of a digital signal.

Referenced by mrpt::hwdrivers::CNationalInstrumentsDAQ::initialize().

◆ ci_lin_encoder

struct mrpt::hwdrivers::CNationalInstrumentsDAQ::TaskDescription::desc_ci_lin_encoder_t mrpt::hwdrivers::CNationalInstrumentsDAQ::TaskDescription::ci_lin_encoder

Counter: uses a linear encoder to measure linear position.

Referenced by mrpt::hwdrivers::CNationalInstrumentsDAQ::initialize().

◆ ci_period

struct mrpt::hwdrivers::CNationalInstrumentsDAQ::TaskDescription::desc_ci_period_t mrpt::hwdrivers::CNationalInstrumentsDAQ::TaskDescription::ci_period

Counter: period of a digital signal.

Referenced by mrpt::hwdrivers::CNationalInstrumentsDAQ::initialize().

◆ ci_pulse_width

struct mrpt::hwdrivers::CNationalInstrumentsDAQ::TaskDescription::desc_ci_pulse_width_t mrpt::hwdrivers::CNationalInstrumentsDAQ::TaskDescription::ci_pulse_width

Counter: measure the width of a digital pulse.

Referenced by mrpt::hwdrivers::CNationalInstrumentsDAQ::initialize().

◆ co_pulses

struct mrpt::hwdrivers::CNationalInstrumentsDAQ::TaskDescription::desc_co_pulses_t mrpt::hwdrivers::CNationalInstrumentsDAQ::TaskDescription::co_pulses

Output counter: digital pulses output.

Referenced by mrpt::hwdrivers::CNationalInstrumentsDAQ::initialize().

◆ di

struct mrpt::hwdrivers::CNationalInstrumentsDAQ::TaskDescription::desc_di_t mrpt::hwdrivers::CNationalInstrumentsDAQ::TaskDescription::di

Digital inputs (di)

Referenced by mrpt::hwdrivers::CNationalInstrumentsDAQ::initialize().

◆ douts

struct mrpt::hwdrivers::CNationalInstrumentsDAQ::TaskDescription::desc_do_t mrpt::hwdrivers::CNationalInstrumentsDAQ::TaskDescription::douts

◆ has_ai

bool mrpt::hwdrivers::CNationalInstrumentsDAQ::TaskDescription::has_ai

◆ has_ao

bool mrpt::hwdrivers::CNationalInstrumentsDAQ::TaskDescription::has_ao

◆ has_ci_ang_encoder

bool mrpt::hwdrivers::CNationalInstrumentsDAQ::TaskDescription::has_ci_ang_encoder

◆ has_ci_count_edges

bool mrpt::hwdrivers::CNationalInstrumentsDAQ::TaskDescription::has_ci_count_edges

◆ has_ci_lin_encoder

bool mrpt::hwdrivers::CNationalInstrumentsDAQ::TaskDescription::has_ci_lin_encoder

◆ has_ci_period

bool mrpt::hwdrivers::CNationalInstrumentsDAQ::TaskDescription::has_ci_period

◆ has_ci_pulse_width

bool mrpt::hwdrivers::CNationalInstrumentsDAQ::TaskDescription::has_ci_pulse_width

◆ has_co_pulses

bool mrpt::hwdrivers::CNationalInstrumentsDAQ::TaskDescription::has_co_pulses

◆ has_di

bool mrpt::hwdrivers::CNationalInstrumentsDAQ::TaskDescription::has_di

◆ has_do

bool mrpt::hwdrivers::CNationalInstrumentsDAQ::TaskDescription::has_do

◆ sampleClkSource

std::string mrpt::hwdrivers::CNationalInstrumentsDAQ::TaskDescription::sampleClkSource

Sample clock source: may be empty (default value) for some channels.

Definition at line 294 of file CNationalInstrumentsDAQ.h.

Referenced by mrpt::hwdrivers::CNationalInstrumentsDAQ::initialize().

◆ samplesPerChannelToRead

uint32_t mrpt::hwdrivers::CNationalInstrumentsDAQ::TaskDescription::samplesPerChannelToRead

(Default=1000) The number of samples to grab at once from each channel.

Definition at line 302 of file CNationalInstrumentsDAQ.h.

Referenced by mrpt::hwdrivers::CNationalInstrumentsDAQ::grabbing_thread(), and mrpt::hwdrivers::CNationalInstrumentsDAQ::initialize().

◆ samplesPerSecond

double mrpt::hwdrivers::CNationalInstrumentsDAQ::TaskDescription::samplesPerSecond

Sample clock config: samples per second.

Continuous (infinite) sampling is assumed.

Definition at line 291 of file CNationalInstrumentsDAQ.h.

Referenced by mrpt::hwdrivers::CNationalInstrumentsDAQ::grabbing_thread(), and mrpt::hwdrivers::CNationalInstrumentsDAQ::initialize().

◆ taskLabel

std::string mrpt::hwdrivers::CNationalInstrumentsDAQ::TaskDescription::taskLabel

(Default="task###")

Definition at line 304 of file CNationalInstrumentsDAQ.h.

Referenced by mrpt::hwdrivers::CNationalInstrumentsDAQ::grabbing_thread().




Page generated by Doxygen 1.8.14 for MRPT 1.9.9 Git: ad3a9d8ae Tue May 1 23:10:22 2018 -0700 at lun oct 28 00:14:14 CET 2019