Property Reference (Data Acquisition Toolbox)

Data Acquisition Toolbox

Analog Output Properties

Analog output properties are divided into two main categories: common properties and channel properties. Common properties apply to every channel contained by the analog output 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 output object. The common analog output properties are grouped into six functional categories as shown below.


Analog Output Basic Setup Properties
Channel	Contains all the channels associated with the device object as created with `addchannel`.
SampleRate	Specifies the sampling rate of the analog output device
TriggerType	Specifies the type of trigger to be issued


Analog Output Trigger Properties
TriggerTime	Indicates the observed times when triggers occurred


Analog Output Status Properties
Running	Indicates whether the hardware device and data acquisition engine are running
SamplesAvailable	Indicates the number of samples available per channel in the data acquisition engine
SamplesOutput	Indicates the number of samples per channel that have been sent to the hardware device
Sending	Indicates data is being output to the hardware device

Analog Output Hardware Configuration Properties

OutOfDataMode
Specifies the last value to write to the analog output device when data is no longer being sent.

ClockSource
Specifies which clock is used to govern the acquisition rate

Analog Output Hardware Configuration Properties
OutOfDataMode	Specifies the last value to write to the analog output device when data is no longer being sent.
ClockSource	Specifies which clock is used to govern the acquisition rate

Analog Output Action Properties

OutOFDataAction
Specifies the M-file to be executed when data is no longer sent to the analog output device

RuntimeErrorAction
Specifies the M-file to be executed when a runtime error has occurred

SamplesOutputAction
Specifies the M-file to be executed every time the number of samples specified by SamplesOutputActionCount are sent

SamplesOutputActionCount
Specifies the number of samples to output before the function specified by SamplesOutputAction 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 TimerAction callbacks

TriggerAction
Specifies the M-file to be executed just after a trigger occurs

Analog Output Action Properties
OutOFDataAction	Specifies the M-file to be executed when data is no longer sent to the analog output device
RuntimeErrorAction	Specifies the M-file to be executed when a runtime error has occurred
SamplesOutputAction	Specifies the M-file to be executed every time the number of samples specified by `SamplesOutputActionCount` are sent
SamplesOutputActionCount	Specifies the number of samples to output before the function specified by `SamplesOutputAction` 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 `TimerAction` callbacks
TriggerAction	Specifies the M-file to be executed just after a trigger occurs


Analog Output 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
MaxSamplesQueued	Specifies the maximum number of samples allowed in the analog output queue
Name	Contains the name of the device object
RepeatOutput	Specifies the number of times to send queued data to the analog output device
Tag	Stores a device object label
Timeout	Specifies the additional time to wait for a data block to be output
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 output channel properties are given below.


Analog Output General Properties
ChannelName	Specifies a descriptive channel name
DefaultChannelValue	Specifies the value to write to the analog output hardware device when data has stopped being sent
HwChannel	Specifies the hardware channel ID
Index	Indicates the MATLAB index number of a channel
OutputRange	Specifies the range of the D/A hardware
Parent	Contains the parent (device) object of the channel
Units	Specifies the engineering units
UnitsRange	Specifies the engineering units range of the data

[ Previous | Help Desk | Next ]