niHWS Get Wfm Attribute

NI-HWS LabVIEW

previous page next page

JavaScript is disabled. Details

niHWS Get Wfm Attribute

Retrieves a particular attribute of a waveform. The instances of this polymorphic VI correspond to the type of attribute you want to retrieve.

Use the pull-down menu to select an instance of this VI.

Get String

Retrieves text attributes that apply to the waveform specified by the waveform reference.

waveform reference in is a reference to the waveform. Waveforms are identified by reference for purposes of setting and getting waveform attributes and reading and writing data.

attribute ID specifies the waveform attribute to retrieve.

Note	A general-purpose text field for any information pertaining to the waveform.
X Axis Label	A general-purpose text field intended for labeling the x-axis of a waveform data plot.
Y Axis Label	A general-purpose text field intended for labeling the y-axis of a waveform data plot.
X Axis Units	A general-purpose text field intended for denoting the units of the x-axis.
Y Axis Units	A general-purpose text field intended for denoting the units of the y-axis.
Waveform Name	A read-only attribute that is the same as that returned by the niHWS Get Wfm Name VI.
Valid Signals	The list of bits, or signals, in the samples of a digital waveform that are valid. For example, "0,3,6" means that only bits 0, 3, and 6 of each unsigned long digital sample contain valid digital data. A hyphen may be used to denote an inclusive range of consecutive signals. For example, "2-5" is equivalent to "2, 3, 4, 5". A semicolon may be used to specify valid signals on multiple devices in a 2D waveform. For example, "0-3;0,6,2" would mean bits 0 through 3 on the first row, and bits 0, 6, and 2 on the second row.
Timestamp	A string in the form hour:minutes:seconds:fractional seconds followed by AM or PM MM/DD/YYYY. Intended to serve as the time the waveform was originally acquired.

error in (no error) can accept error information wired from VIs previously called. Use this information to decide if any functionality should be bypassed in the event of errors from other VIs.

The pop-up option Explain Error (or Explain Warning) gives more information about the error displayed.

	status is either TRUE (X) for an error, or FALSE (checkmark) for no error or a warning. The pop-up option Explain Error (or Explain Warning) gives more information about the error displayed.
	code identifies the error or warning. The pop-up option Explain Error (or Explain Warning) gives more information about the error displayed.
	source describes the origin of the error or warning. The pop-up option Explain Error (or Explain Warning) gives more information about the error displayed.

waveform reference out is the copy of waveform reference in you use for input into the next NI-HWS VI in your program.

attribute value is the current setting of the attribute specified by attribute ID.

error out passes error or warning information out of a VI to be used by other VIs.

The pop-up option Explain Error (or Explain Warning) gives more information about the error displayed.

	status is either TRUE (X) for an error, or FALSE (checkmark) for no error or a warning. The pop-up option Explain Error (or Explain Warning) gives more information about the error displayed.
	code identifies the error or warning. The pop-up option Explain Error (or Explain Warning) gives more information about the error displayed.
	source describes the origin of the error or warning. The pop-up option Explain Error (or Explain Warning) gives more information about the error displayed.

Get I32

Retrieves integer attributes that apply to the waveform specified by the waveform reference.

waveform reference in is a reference to the waveform. Waveforms are identified by reference for purposes of setting and getting waveform attributes and reading and writing data.

attribute ID specifies the waveform attribute to retrieve.

Y Axis Datatype	A read-only attribute that returns the type of integer or floating-point data that the waveform is stored as. Defined Values: I8 = 0 I16 = 1 I32 = 2 DBL = 3 U32 = 4 WDT = 5 U8 = 6 U16 = 7
IO Type	A read-only attribute that returns the type of the waveform as either analog (0), digital (1), or unknown (2).
Scaling Type	A read-only attribute that returns the only currently supported scaling type of polynomial (0).
Waveform Size	A read-only attribute that returns the total number of samples in a waveform. For digital 2D files with multiple rows, this attribute refers to the number of samples per row.
Number of Rows	A read-only attribute that returns the number of rows in the waveform.
Number of Signals	A read-only attribute that returns the number of signals in the waveform.

error in (no error) can accept error information wired from VIs previously called. Use this information to decide if any functionality should be bypassed in the event of errors from other VIs.

The pop-up option Explain Error (or Explain Warning) gives more information about the error displayed.

	status is either TRUE (X) for an error, or FALSE (checkmark) for no error or a warning. The pop-up option Explain Error (or Explain Warning) gives more information about the error displayed.
	code identifies the error or warning. The pop-up option Explain Error (or Explain Warning) gives more information about the error displayed.
	source describes the origin of the error or warning. The pop-up option Explain Error (or Explain Warning) gives more information about the error displayed.

waveform reference out is the copy of waveform reference in you use for input into the next NI-HWS VI in your program.

attribute value is the current setting of the attribute specified by attribute ID

error out passes error or warning information out of a VI to be used by other VIs.

The pop-up option Explain Error (or Explain Warning) gives more information about the error displayed.

	status is either TRUE (X) for an error, or FALSE (checkmark) for no error or a warning. The pop-up option Explain Error (or Explain Warning) gives more information about the error displayed.
	code identifies the error or warning. The pop-up option Explain Error (or Explain Warning) gives more information about the error displayed.
	source describes the origin of the error or warning. The pop-up option Explain Error (or Explain Warning) gives more information about the error displayed.

Get DBL

Retrieves floating point attributes that apply to the waveform specified by the waveform reference.

waveform reference in is a reference to the waveform. Waveforms are identified by reference for purposes of setting and getting waveform attributes and reading and writing data.

attribute ID specifies the waveform attribute to retrieve.

X Axis Start	The X value for the first point in the waveform. The Scope Soft Front Panel stores relativeInitialX in this attribute, for example.
X Axis Increment	The period between samples in the waveform. The rate of the Sample clock used to capture the waveform is the reciprocal of the X Axis Increment.
Y Axis Minimum	The minimum value of the y-axis.
Y Axis Maximum	The maximum value of the y-axis.

error in (no error) can accept error information wired from VIs previously called. Use this information to decide if any functionality should be bypassed in the event of errors from other VIs.

The pop-up option Explain Error (or Explain Warning) gives more information about the error displayed.

	status is either TRUE (X) for an error, or FALSE (checkmark) for no error or a warning. The pop-up option Explain Error (or Explain Warning) gives more information about the error displayed.
	code identifies the error or warning. The pop-up option Explain Error (or Explain Warning) gives more information about the error displayed.
	source describes the origin of the error or warning. The pop-up option Explain Error (or Explain Warning) gives more information about the error displayed.

waveform reference out is the copy of waveform reference in you use for input into the next NI-HWS VI in your program.

attribute value is the current setting of the attribute specified by attribute ID.

error out passes error or warning information out of a VI to be used by other VIs.

The pop-up option Explain Error (or Explain Warning) gives more information about the error displayed.

	status is either TRUE (X) for an error, or FALSE (checkmark) for no error or a warning. The pop-up option Explain Error (or Explain Warning) gives more information about the error displayed.
	code identifies the error or warning. The pop-up option Explain Error (or Explain Warning) gives more information about the error displayed.
	source describes the origin of the error or warning. The pop-up option Explain Error (or Explain Warning) gives more information about the error displayed.

previous page start next page