Documentation of paraoptsave

Global Index (all files) (short | long) | Local contents | Local Index (files in subdir) (short | long)

Function Synopsis

Result = paraoptsave(ParaOpt, FileName, FilePath, FileType)

Help text

 SAVE a PARAOPTions structure to a text or matlab file

 This function saves a PARAOPTIONS structure to a readable and 
 editable format:  text format file or matlab m-file function.

 If creating a m-file:
 A fully functional matlab m-file is created and the correct syntax
 calls to paraoptset are included for recreating the given options.
 
 If creating a text file:
 A text parameter file is created using the following syntax.
 - tbd. 

 The main use for the text parameter file is in compiled programs,
 where the interpretation of m-parameter-files is not possible (the
 parameter file can not be included at compile time, it will/must be 
 changed before/during/after run time).

 This function is used for:
  - saving parameters defined by paraoptset to 

 Syntax:  Result = paraoptsave(ParaOpt, FileName, FilePath)

 Input parameter:
    ParaOpt   - Structure with ParaOptions
    FileName  - String containing name of file to save to
    FilePath  - (optional) String containing path to file
    FileType  - (optional) String defining the type of parameter file
                             only the first letter is checked
                             'm': m-file
                             't': txt-file

 Output parameter:
    Result    - indicates the result of the operation

 Examples:




 See also: paraoptset, paraoptload, prprintf

Cross-Reference Information