CD Get Time Response Data VI

Get Time Response Data (Input-Output Pair)

	Time Response Data contains information about the time response of a model. Refer to the Details section for more information about the time response data. Time is the uniformly-spaced time vector against which this VI plots the impulse, initial, or step response and the state trajectories. Outputs Data contains data about the time response of the outputs to the inputs. States Data contains data about the time response of the states to the inputs. For transfer function and zero-pole-gain models, this array is empty.
	Input determines the index number of each input for which you want to obtain data.
	Output determines the index number of each output for which you want to obtain data.
	error in describes error conditions that occur before this VI or function runs. The default is no error. If an error occurred before this VI or function runs, the VI or function passes the error in value to error out. This VI or function runs normally only if no error occurred before this VI or function runs. If an error occurs while this VI or function runs, it runs normally and sets its own error status in error out. Use the Simple Error Handler or General Error Handler VIs to display the description of the error code. Use exception control to treat what is normally an error as no error or to treat a warning as an error. Use error in and error out to check errors and to specify execution order by wiring error out from one node to error in of the next node. status is TRUE (X) if an error occurred before this VI or function ran or FALSE (checkmark) to indicate a warning or that no error occurred before this VI or function ran. The default is FALSE. code is the error or warning code. The default is 0. If status is TRUE, code is a nonzero error code. If status is FALSE, code is 0 or a warning code. source specifies the origin of the error or warning and is, in most cases, the name of the VI or function that produced the error or warning. The default is an empty string.
	Type of Response Data specifies the type of response data you obtain. 0 Outputs (default)—Specifies to obtain the time response of the input-output pair(s). 1 State—Specifies to obtain the time response of the input-state pair(s) for a state-space model. If you specify this Type of Response Data for a transfer function or zero-pole-gain model, this VI returns the time response data as an empty array.
	Time returns the time at which this VI generates the response data. Time is the uniformly-spaced time vector against which this VI plots the impulse, initial, or step response and the state trajectories.
	Response Data returns a vector that provides the time response data for the input-output pair you select.
	error out contains error information. If error in indicates that an error occurred before this VI or function ran, error out contains the same error information. Otherwise, it describes the error status that this VI or function produces. Right-click the error out front panel indicator and select Explain Error from the shortcut menu for more information about the error. status is TRUE (X) if an error occurred or FALSE (checkmark) to indicate a warning or that no error occurred. code is the error or warning code. If status is TRUE, code is a nonzero error code. If status is FALSE, code is 0 or a warning code. source describes the origin of the error or warning and is, in most cases, the name of the VI or function that produced the error or warning.

Get Time Response Data (Input-Output List)

The Input-Output List instance returns the time response data for multiple input-output pairs.

	Time Response Data contains information about the time response of a model. Refer to the Details section for more information about the time response data. Time is the uniformly-spaced time vector against which this VI plots the impulse, initial, or step response and the state trajectories. Outputs Data contains data about the time response of the outputs to the inputs. States Data contains data about the time response of the states to the inputs. For transfer function and zero-pole-gain models, this array is empty.
	Inputs specifies a list of index numbers of the inputs for which you want to obtain data. The index is zero-based.
	Outputs specifies a list of index numbers of the outputs for which you want to obtain data.
	error in describes error conditions that occur before this VI or function runs. The default is no error. If an error occurred before this VI or function runs, the VI or function passes the error in value to error out. This VI or function runs normally only if no error occurred before this VI or function runs. If an error occurs while this VI or function runs, it runs normally and sets its own error status in error out. Use the Simple Error Handler or General Error Handler VIs to display the description of the error code. Use exception control to treat what is normally an error as no error or to treat a warning as an error. Use error in and error out to check errors and to specify execution order by wiring error out from one node to error in of the next node. status is TRUE (X) if an error occurred before this VI or function ran or FALSE (checkmark) to indicate a warning or that no error occurred before this VI or function ran. The default is FALSE. code is the error or warning code. The default is 0. If status is TRUE, code is a nonzero error code. If status is FALSE, code is 0 or a warning code. source specifies the origin of the error or warning and is, in most cases, the name of the VI or function that produced the error or warning. The default is an empty string.
	Type of Response Data specifies the type of response data you obtain. 0 Outputs (default)—Specifies to obtain the time response of the input-output pair(s). 1 State—Specifies to obtain the time response of the input-state pair(s) for a state-space model. If you specify this Type of Response Data for a transfer function or zero-pole-gain model, this VI returns the time response data as an empty array.
	Time returns the time at which this VI generates the response data. Time is the uniformly-spaced time vector against which this VI plots the impulse, initial, or step response and the state trajectories.
	Response Data returns a matrix that provides the time response data for all the input-output pairs you select. The first element in the matrix is the response to the first input and first output. The second element is the response to the first input and second output. After listing all input-output pairs this VI associates with the first input, the matrix lists the input-output pairs that this VI associates with the second input, then third input, and so on until the matrix lists all responses.
	error out contains error information. If error in indicates that an error occurred before this VI or function ran, error out contains the same error information. Otherwise, it describes the error status that this VI or function produces. Right-click the error out front panel indicator and select Explain Error from the shortcut menu for more information about the error. status is TRUE (X) if an error occurred or FALSE (checkmark) to indicate a warning or that no error occurred. code is the error or warning code. If status is TRUE, code is a nonzero error code. If status is FALSE, code is 0 or a warning code. source describes the origin of the error or warning and is, in most cases, the name of the VI or function that produced the error or warning.

Get Time Response Data (Waveform Datatype)

The Waveform Datatype instance returns the time response data for an input-output pair in a waveform data type. You then can use the time response data with the Waveform VIs and functions.

	Time Response Data contains information about the time response of a model. Refer to the Details section for more information about the time response data. Time is the uniformly-spaced time vector against which this VI plots the impulse, initial, or step response and the state trajectories. Outputs Data contains data about the time response of the outputs to the inputs. States Data contains data about the time response of the states to the inputs. For transfer function and zero-pole-gain models, this array is empty.
	Input determines the index number of each input for which you want to obtain data.
	Output determines the index number of each output for which you want to obtain data.
	error in describes error conditions that occur before this VI or function runs. The default is no error. If an error occurred before this VI or function runs, the VI or function passes the error in value to error out. This VI or function runs normally only if no error occurred before this VI or function runs. If an error occurs while this VI or function runs, it runs normally and sets its own error status in error out. Use the Simple Error Handler or General Error Handler VIs to display the description of the error code. Use exception control to treat what is normally an error as no error or to treat a warning as an error. Use error in and error out to check errors and to specify execution order by wiring error out from one node to error in of the next node. status is TRUE (X) if an error occurred before this VI or function ran or FALSE (checkmark) to indicate a warning or that no error occurred before this VI or function ran. The default is FALSE. code is the error or warning code. The default is 0. If status is TRUE, code is a nonzero error code. If status is FALSE, code is 0 or a warning code. source specifies the origin of the error or warning and is, in most cases, the name of the VI or function that produced the error or warning. The default is an empty string.
	Type of Response Data specifies the type of response data you obtain. 0 Outputs (default)—Specifies to obtain the time response of the input-output pair(s). 1 State—Specifies to obtain the time response of the input-state pair(s) for a state-space model. If you specify this Type of Response Data for a transfer function or zero-pole-gain model, this VI returns the time response data as an empty array.
	WDT Data returns the time response data for the input-output pair you select. This VI starts the time response Y at time t0 and evaluates it at a sample time dt.
	error out contains error information. If error in indicates that an error occurred before this VI or function ran, error out contains the same error information. Otherwise, it describes the error status that this VI or function produces. Right-click the error out front panel indicator and select Explain Error from the shortcut menu for more information about the error. status is TRUE (X) if an error occurred or FALSE (checkmark) to indicate a warning or that no error occurred. code is the error or warning code. If status is TRUE, code is a nonzero error code. If status is FALSE, code is 0 or a warning code. source describes the origin of the error or warning and is, in most cases, the name of the VI or function that produced the error or warning.

Get Time Response Data (All Input-Output)

The All Input-Output instance returns the time response data for all input-output pairs.

	Time Response Data contains information about the time response of a model. Refer to the Details section for more information about the time response data. Time is the uniformly-spaced time vector against which this VI plots the impulse, initial, or step response and the state trajectories. Outputs Data contains data about the time response of the outputs to the inputs. States Data contains data about the time response of the states to the inputs. For transfer function and zero-pole-gain models, this array is empty.
	error in describes error conditions that occur before this VI or function runs. The default is no error. If an error occurred before this VI or function runs, the VI or function passes the error in value to error out. This VI or function runs normally only if no error occurred before this VI or function runs. If an error occurs while this VI or function runs, it runs normally and sets its own error status in error out. Use the Simple Error Handler or General Error Handler VIs to display the description of the error code. Use exception control to treat what is normally an error as no error or to treat a warning as an error. Use error in and error out to check errors and to specify execution order by wiring error out from one node to error in of the next node. status is TRUE (X) if an error occurred before this VI or function ran or FALSE (checkmark) to indicate a warning or that no error occurred before this VI or function ran. The default is FALSE. code is the error or warning code. The default is 0. If status is TRUE, code is a nonzero error code. If status is FALSE, code is 0 or a warning code. source specifies the origin of the error or warning and is, in most cases, the name of the VI or function that produced the error or warning. The default is an empty string.
	Time returns the time at which this VI generates the response data. Time is the uniformly-spaced time vector against which this VI plots the impulse, initial, or step response and the state trajectories.
	Outputs Data returns data about the time response of the outputs to the inputs. Refer to the Details section for more information about the Outputs Data.
	States Data returns data about the time response of the states to the inputs. For transfer function and zero-pole-gain models, this array is empty. Refer to the Details section for more information about the States Data.
	error out contains error information. If error in indicates that an error occurred before this VI or function ran, error out contains the same error information. Otherwise, it describes the error status that this VI or function produces. Right-click the error out front panel indicator and select Explain Error from the shortcut menu for more information about the error. status is TRUE (X) if an error occurred or FALSE (checkmark) to indicate a warning or that no error occurred. code is the error or warning code. If status is TRUE, code is a nonzero error code. If status is FALSE, code is 0 or a warning code. source describes the origin of the error or warning and is, in most cases, the name of the VI or function that produced the error or warning.
	Response Data returns the type of response data you obtain. 0 bode-magnitude 1 bode-phase 2 nichols 3 nyquist 4 singular values 5 step 6 impulse 7 initial 8 simulation

CD Get Time Response Data Details

The Time Response Data data type contains information about the time response of all the input-output pairs in the model. You can use this VI to customize how you want to view this information. The following explanation describes how to view and understand the time response data.

The Time is an array of timestamps this VI records at a certain interval. The Outputs Data is a three-dimensional array with three index displays. The first index display is the index number of the inputs. The third index display is the index number of the outputs. The data that Outputs Data displays is based on the input-output pair these two index displays specify. The second index display is the index number of the response data. This index display is relative to the index display of the Time. The indexes are zero-based.

For example, consider the following Time Response Data.

If you want to know the time response at t = 1, set the index display for Outputs Data equal to the index display for Time. In this example, the index display is equal to 5. The Outputs Data then indicates that for the input-output pair (1, 0), the response at that time is 0.74.

This VI organizes the States Data the same as Outputs Data. The only difference is the third index display, which is the index number of the states. The data that States Data displays is based on the input-state pair the first and third index displays specify.