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 274 of file CNationalInstrumentsDAQ.h.

#include <mrpt/hwdrivers/CNationalInstrumentsDAQ.h>

Classes
struct	desc_ai_t
	Analog inputs. More...
struct	desc_ao_t
	Analog outputs. More...
struct	desc_ci_ang_encoder_t
	Counter: uses an angular encoder to measure angular position. More...
struct	desc_ci_count_edges_t
	Counter: period of a digital signal. More...
struct	desc_ci_lin_encoder_t
	Counter: uses a linear encoder to measure linear position. More...
struct	desc_ci_period_t
struct	desc_ci_pulse_width_t
	Counter: measure the width of a digital pulse. More...
struct	desc_co_pulses_t
	Output counter: digital pulses output. More...
struct	desc_di_t
	Digital inputs (di) More...
struct	desc_do_t
	Digital outs (do) More...

Public Member Functions
	TaskDescription ()

Public Attributes
bool	has_ai {false}
bool	has_ao {false}
bool	has_di {false}
bool	has_do {false}
bool	has_ci_period {false}
bool	has_ci_count_edges {false}
bool	has_ci_pulse_width {false}
bool	has_ci_lin_encoder {false}
bool	has_ci_ang_encoder {false}
bool	has_co_pulses {false}
double	samplesPerSecond {1000.0}
	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 {200000}
	(Default=0) From NI's docs: The number of samples the buffer can hold for each channel in the task. More...
uint32_t	samplesPerChannelToRead {1000}
	(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
struct mrpt::hwdrivers::CNationalInstrumentsDAQ::TaskDescription::desc_ao_t	ao
struct mrpt::hwdrivers::CNationalInstrumentsDAQ::TaskDescription::desc_di_t	di
struct mrpt::hwdrivers::CNationalInstrumentsDAQ::TaskDescription::desc_do_t	douts
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
struct mrpt::hwdrivers::CNationalInstrumentsDAQ::TaskDescription::desc_ci_pulse_width_t	ci_pulse_width
struct mrpt::hwdrivers::CNationalInstrumentsDAQ::TaskDescription::desc_ci_lin_encoder_t	ci_lin_encoder
struct mrpt::hwdrivers::CNationalInstrumentsDAQ::TaskDescription::desc_ci_ang_encoder_t	ci_ang_encoder
struct mrpt::hwdrivers::CNationalInstrumentsDAQ::TaskDescription::desc_co_pulses_t	co_pulses

Constructor & Destructor Documentation

TaskDescription()

CNationalInstrumentsDAQ::TaskDescription::TaskDescription ( )

default

Member Data Documentation

ai

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

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

ao

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

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

bufferSamplesPerChannel

uint32_t mrpt::hwdrivers::CNationalInstrumentsDAQ::TaskDescription::bufferSamplesPerChannel {200000}

(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 293 of file CNationalInstrumentsDAQ.h.

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

ci_ang_encoder

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

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

ci_count_edges

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

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

ci_lin_encoder

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

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

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(), and mrpt::hwdrivers::CNationalInstrumentsDAQ::loadConfig_sensorSpecific().

ci_pulse_width

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

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

co_pulses

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

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

di

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

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

douts

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

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

has_ai

bool mrpt::hwdrivers::CNationalInstrumentsDAQ::TaskDescription::has_ai {false}

Definition at line 278 of file CNationalInstrumentsDAQ.h.

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

has_ao

bool mrpt::hwdrivers::CNationalInstrumentsDAQ::TaskDescription::has_ao {false}

Definition at line 278 of file CNationalInstrumentsDAQ.h.

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

has_ci_ang_encoder

bool mrpt::hwdrivers::CNationalInstrumentsDAQ::TaskDescription::has_ci_ang_encoder {false}

Definition at line 281 of file CNationalInstrumentsDAQ.h.

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

has_ci_count_edges

bool mrpt::hwdrivers::CNationalInstrumentsDAQ::TaskDescription::has_ci_count_edges {false}

Definition at line 279 of file CNationalInstrumentsDAQ.h.

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

has_ci_lin_encoder

bool mrpt::hwdrivers::CNationalInstrumentsDAQ::TaskDescription::has_ci_lin_encoder {false}

Definition at line 280 of file CNationalInstrumentsDAQ.h.

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

has_ci_period

bool mrpt::hwdrivers::CNationalInstrumentsDAQ::TaskDescription::has_ci_period {false}

Definition at line 279 of file CNationalInstrumentsDAQ.h.

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

has_ci_pulse_width

bool mrpt::hwdrivers::CNationalInstrumentsDAQ::TaskDescription::has_ci_pulse_width {false}

Definition at line 280 of file CNationalInstrumentsDAQ.h.

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

has_co_pulses

bool mrpt::hwdrivers::CNationalInstrumentsDAQ::TaskDescription::has_co_pulses {false}

Definition at line 281 of file CNationalInstrumentsDAQ.h.

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

has_di

bool mrpt::hwdrivers::CNationalInstrumentsDAQ::TaskDescription::has_di {false}

Definition at line 278 of file CNationalInstrumentsDAQ.h.

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

has_do

bool mrpt::hwdrivers::CNationalInstrumentsDAQ::TaskDescription::has_do {false}

Definition at line 278 of file CNationalInstrumentsDAQ.h.

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

sampleClkSource

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

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

Definition at line 288 of file CNationalInstrumentsDAQ.h.

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

samplesPerChannelToRead

uint32_t mrpt::hwdrivers::CNationalInstrumentsDAQ::TaskDescription::samplesPerChannelToRead {1000}

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

Definition at line 296 of file CNationalInstrumentsDAQ.h.

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

samplesPerSecond

double mrpt::hwdrivers::CNationalInstrumentsDAQ::TaskDescription::samplesPerSecond {1000.0}

Sample clock config: samples per second.

Continuous (infinite) sampling is assumed.

Definition at line 285 of file CNationalInstrumentsDAQ.h.

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

taskLabel

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

(Default="task###")

Definition at line 298 of file CNationalInstrumentsDAQ.h.

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