DFD Save to File VI

Digital Filter Design VIs and Functions

previous page next page
DFD Save to File VI

Owning Palette: Utilities VIs

Installed With: Digital Filter Design Toolkit

Saves a filter into a file. Wire data to the filter in input to determine the polymorphic instance to use or manually select the instance. Use the DFD Load from File VI to load the filter from the file.

Example

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

 Place on the block diagram  Find on the Functions palette

DFD Save Filter to File

filter in specifies the input filter.
file path in specifies the path to the file in which you want to save the filter. The default file extension is .fds. You can use any other file extension for the file. If file path in is empty (default) or <Not A Path>, this VI displays a dialog box from which you can select a file. This VI returns an error if you specify a file path that does not exist or if you click the Cancel button on the dialog box. Use the DFD Load from File VI to load the filter from the file.
start path is the path name to the initially displayed directory or folder in the file dialog. The default value is <Not A Path>, which is the path to the last directory or folder shown in the file dialog.
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 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.
filter out returns the filter in unchanged.
file path out returns the path to the file to which this VI saved the filter.
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.

DFD Save MRate Filter to File

multirate filter in specifies the input multirate filter. You cannot specify a multistage multirate filter for this input.
file path in specifies the path to the file in which you want to save the multirate filter. The default file extension is .mfs. You can use any other file extension for the multirate file. If file path in is empty (default) or <Not A Path>, this VI displays a dialog box from which you can select a file. This VI returns an error if you specify a file path that does not exist or if you click the Cancel button on the dialog box. Use the DFD Load from File VI to load the multirate filter from the file.
start path is the path name to the initially displayed directory or folder in the file dialog. The default value is <Not A Path>, which is the path to the last directory or folder shown in the file dialog.
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 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.
multirate filter out returns the multirate filter in unchanged.
file path out returns the path to the file to which this VI saved the multirate filter.
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.

Example

Refer to the Save and Load Filter VI in the labview\examples\Digital Filter Design\Getting Started\Apply Filters directory for an example of using the DFD Save to File VI.

 Open example  Browse related examples

previous page start next page