CD Draw Zero-Pole-Gain Equation VI

Control Design VI and Function

previous page next page
CD Draw Zero-Pole-Gain Equation VI

Owning Palette: Model Construction VIs

Installed With: Control Design and Simulation Module

Displays the zero-pole-gain equation of the model. The data type you wire to the State-Space Model input determines the polymorphic instance to use.

Note  Real-time targets do not support this VI.

Details  

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

 Place on the block diagram  Find on the Functions palette

CD Draw Zero-Pole-Gain Equation (State-Space)

Format Coefficients specifies how to format the resulting equation. You can enter any of the LabVIEW format specifier syntax elements. The default value is %#_g, which removes trailing zeros and specifies that LabVIEW uses fractional or scientific notation depending on the exponent of the number.
display format specifies the format in which this VI displays the equation.

0Standard
1Engineering
2Time Constant
3Power 1/z
State-Space Model contains a mathematical representation of and information about the system for which this VI draws an equation.
Output (row) specifies the index number of the output row from which to draw the zero-pole-gain matrix. The index is zero-based. The default is –1, which draws all outputs.
Input (column) specifies the index number of the input column from which to draw the zero-pole-gain matrix. The index is zero-based. The default is –1, which draws all inputs.
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.
Origin specifies the upper-left position of the equation this VI draws.
x specifies the x-coordinate of the origin. The default value is 10.
y specifies the y-coordinate of the origin. The default value is 10.
Function Name specifies the function this VI draws. For example, if you enter H, this VI displays H(s)= for continuous equations and H(z)= for discrete equations.
Equation draws a picture of the model equation this VI defines.
Draw Area Size specifies the size of the area in the picture control this VI uses to draw the model equation.
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.

CD Draw Zero-Pole-Gain Equation (Transfer Function)

Format Coefficients specifies how to format the resulting equation. You can enter any of the LabVIEW format specifier syntax elements. The default value is %#_g, which removes trailing zeros and specifies that LabVIEW uses fractional or scientific notation depending on the exponent of the number.
display format specifies the format in which this VI displays the equation.

0Standard
1Engineering
2Time Constant
3Power 1/z
Transfer Function Model contains a mathematical representation of and information about the system for which this VI draws an equation.
Output (row) specifies the index number of the output row from which to draw the zero-pole-gain matrix. The index is zero-based. The default is –1, which draws all outputs.
Input (column) specifies the index number of the input column from which to draw the zero-pole-gain matrix. The index is zero-based. The default is –1, which draws all inputs.
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.
Origin specifies the upper-left position of the equation this VI draws.
x specifies the x-coordinate of the origin. The default value is 10.
y specifies the y-coordinate of the origin. The default value is 10.
Function Name specifies the function this VI draws. For example, if you enter H, this VI displays H(s)= for continuous equations and H(z)= for discrete equations.
Equation draws a picture of the model equation this VI defines.
Draw Area Size specifies the size of the area in the picture control this VI uses to draw the model equation.
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.

CD Draw Zero-Pole-Gain Equation (Zero-Pole-Gain)

Format Coefficients specifies how to format the resulting equation. You can enter any of the LabVIEW format specifier syntax elements. The default value is %#_g, which removes trailing zeros and specifies that LabVIEW uses fractional or scientific notation depending on the exponent of the number.
display format specifies the format in which this VI displays the equation.

0Standard
1Engineering
2Time Constant
3Power 1/z
Zero-Pole-Gain Model contains a mathematical representation of and information about the system for which this VI draws an equation.
Output (row) specifies the index number of the output row from which to draw the zero-pole-gain matrix. The index is zero-based. The default is –1, which draws all outputs.
Input (column) specifies the index number of the input column from which to draw the zero-pole-gain matrix. The index is zero-based. The default is –1, which draws all inputs.
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.
Origin specifies the upper-left position of the equation this VI draws.
x specifies the x-coordinate of the origin. The default value is 10.
y specifies the y-coordinate of the origin. The default value is 10.
Function Name specifies the function this VI draws. For example, if you enter H, this VI displays H(s)= for continuous equations and H(z)= for discrete equations.
Equation draws a picture of the model equation this VI defines.
Draw Area Size specifies the size of the area in the picture control this VI uses to draw the model equation.
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.

CD Draw Zero-Pole-Gain Equation Details

This VI does not display the delay information in the zero-pole-gain equation of the model. Refer to the LabVIEW Control Design User Manual for more information about delays.

previous page start next page