Property Reference (Data Acquisition Toolbox)

Data Acquisition Toolbox

Analog Input Properties

Analog input properties are divided into two main categories: common properties and channel properties. Common properties apply to every channel contained by the analog input object, while channel properties can be configured for individual channels. Starting on page 7-12, these properties are listed alphabetically.

Note:
Depending on the hardware device you are using, additional properties and values may be present. Device-specific values associated with base properties are given in this chapter, while device-specific properties are given in Appendix A.

Common Properties

Common properties apply to all channels contained by the analog input object. The common analog input properties are grouped into seven functional categories as shown below.


Analog Input Basic Setup Properties
Channel	Contains all the channels associated with the device object as created with `addchannel`
SamplesPerTrigger	Specifies the number of samples to acquire per channel for each trigger issued
SampleRate	Specifies the samples per second of the analog input hardware device
TriggerType	Specifies the type of trigger to be issued


Analog Input Logging Properties
LogFileName	Specifies the name of the disk file that data and events are written to
LoggingMode	Specifies where data is logged
LogToDiskMode	Specifies if data and events are saved in one disk file or multiple disk files


Analog Input Trigger Properties
TriggerChannel	Contains the hardware channels serving as trigger sources
TriggerCondition	Specifies the condition to be satisfied before a trigger is issued
TriggerConditionValue	Specifies the value of a trigger condition
TriggerDelay	Specifies the delay value for data logging
TriggerDelayUnits	Specifies the trigger delay as samples or seconds
TriggerRepeat	Specifies the number of times to repeat the trigger
TriggerTime	Indicates the observed absolute times when triggers occurred

Analog Input Status Properties

Logging
Indicates whether data is logged to memory and/or a disk file

Running
Indicates whether the device object and data acquisition engine are running

SamplesAcquired
Indicates the number of samples acquired per channel

SamplesAvailable
Indicates the number of samples available per channel in the data acquisition engine

Analog Input Status Properties
Logging	Indicates whether data is logged to memory and/or a disk file
Running	Indicates whether the device object and data acquisition engine are running
SamplesAcquired	Indicates the number of samples acquired per channel
SamplesAvailable	Indicates the number of samples available per channel in the data acquisition engine

Analog Input Hardware Configuration Properties

ChannelSkew
Specifies the time, in seconds, between consecutive scanned hardware channels

ChannelSkewMode
Specifies the hardware-specific channel skew

ClockSource
Specifies which clock is used to govern the acquisition rate

InputType
Specifies the hardware channel configuration, e.g., single-ended, differential, or AC-Coupled

Analog Input Hardware Configuration Properties
ChannelSkew	Specifies the time, in seconds, between consecutive scanned hardware channels
ChannelSkewMode	Specifies the hardware-specific channel skew
ClockSource	Specifies which clock is used to govern the acquisition rate
InputType	Specifies the hardware channel configuration, e.g., single-ended, differential, or AC-Coupled


Analog Input Action Properties
DataMissedAction	Specifies the M-file to be executed when data is missed
InputOverRangeAction	Specifies the M-file to be executed when an input channel exceeds its valid range
RuntimeErrorAction	Specifies the M-file be executed when a runtime error occurs
SamplesAcquiredAction	Specifies the M-file to be executed every time the number of samples specified by `SamplesAcquiredActionCount` are acquired
SamplesAcquiredActionCount	Specifies the number of samples to acquire for each channel group member before the M-file specified by `SamplesAcquiredAction` is executed
StartAction	Specifies the M-file to be executed just before the hardware device and data acquisition engine start
StopAction	Specifies the M-file to be executed just after the hardware device and data acquisition engine stop
TimerAction	Specifies the M-file to be executed after the time specified by `TimerPeriod` has passed
TimerPeriod	Specifies the time, in seconds, between calls to `TimerAction`
TriggerAction	Specifies the M-file to be executed just after a trigger occurs


Analog Input General Purpose Properties
BufferingConfig	Specifies the per-channel allocated memory
BufferingMode	Specifies if memory is automatically by the engine or manually
EventLog	Contains information related to certain events that occur for a device object
Name	Contains the name of the device object
Tag	Stores a device object label
Timeout	Specifies the additional time to wait for a data block to fill
Type	Indicates the device object type
UserData	Stores data that you want to associate with the device object

Channel Properties

Channel properties can be set on a per-channel basis. The analog input channel properties are given below.


Analog Input Channel Properties
ChannelName	Specifies a descriptive channel name
HwChannel	Specifies the hardware channel ID
Index	Indicates the MATLAB index number of a channel
InputRange	Specifies the range of data input to the analog input hardware device
Parent	Contains the parent (device) object of the channel
SensorRange	Specifies the range of data you expect from your sensor
Units	Specifies the engineering units
UnitsRange	Specifies the engineering units range of the data input into MATLAB

[ Previous | Help Desk | Next ]