CD Read Model from File VI

Control Design VI and Function

previous page next page
CD Read Model from File VI

Owning Palette: Model Construction VIs

Installed With: Control Design and Simulation Module

Opens a file the Write Model to File VI created and reads all the records in the file. Each record contains a separate model. To retrieve all records in the file, all the models must be in the same model representation. You must manually select the polymorphic instance to use.

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

 Place on the block diagram  Find on the Functions palette

CD Read Model from File (State-Space)

File Path (dialog if empty) specifies the file path to the model location.
Offset (records:0) specifies in bytes how far below the start of the file to start reading from the file. The default is 0.
Records to Read (-1, all) determines from which record to read the file. If you set Records to Read (-1, all) to –1, the CD Read Model from File VI returns all the records in the file. The default is –1.
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.
new file path returns the path to the file.
First State-Space Model in Record returns the first state-space model in the record.
State-Space Model returns all the models in the file if Records to Read is –1. To access and modify the data in the model, use the Model Information VIs.
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.
Mark after Read (records) is the location of the file mark after the VI reads the records. It points to the character (record) in the file following the last character read.

CD Read Model from File (Transfer Function)

File Path (dialog if empty) specifies the file path to the model location.
Offset (records:0) specifies in bytes how far below the start of the file to start reading from the file. The default is 0.
Records to Read (-1, all) determines from which record to read the file. If you set Records to Read (-1, all) to –1, the CD Read Model from File VI returns all the records in the file. The default is –1.
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.
new file path returns the path to the file.
First Transfer Function Model in Record returns the first transfer function model in the record.
Transfer Function Model returns all the models in the file if Records to Read is –1. To access and modify the data in the model, use the Model Information VIs.
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.
Mark after Read (records) is the location of the file mark after the VI reads the records. It points to the character (record) in the file following the last character read.

CD Read Model from File (Zero-Pole-Gain)

File Path (dialog if empty) specifies the file path to the model location.
Offset (records:0) specifies in bytes how far below the start of the file to start reading from the file. The default is 0.
Records to Read (-1, all) determines from which record to read the file. If you set Records to Read (-1, all) to –1, the CD Read Model from File VI returns all the records in the file. The default is –1.
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.
new file path returns the path to the file.
First Zero-Pole-Gain Model in Record returns the first zero-pole-gain model in the record.
Zero-Pole-Gain Model returns all the models in the file if Records to Read is –1. To access and modify the data in the model, use the Model Information VIs.
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.
Mark after Read (records) is the location of the file mark after the VI reads the records. It points to the character (record) in the file following the last character read.
previous page start next page