RTW.getBuildDir

Get build folder information from model build information

collapse all in page

Syntax

RTW.getBuildDir(model)
folderStruct = RTW.getBuildDir(model)

Description

RTW.getBuildDir(model) displays build folder information for model.

If the model is closed, the function opens and then closes the model, leaving it in its original state. If the model is large and closed, the RTW.getBuildDir function can take longer to execute.

example

folderStruct = RTW.getBuildDir(model) returns a structure containing build folder information.

You can use this function in automated scripts to determine the build folder in which the generated code for a model is placed.

This function can return build folder information for protected models.

example

Examples

collapse all

Display build folder information for the model 'sldemo_fuelsys'.

openExample('sldemo_fuelsys');
RTW.getBuildDir('sldemo_fuelsys')

ans = 

              BuildDirectory: 'C:\work\modelref\sldemo_fuelsys_ert_rtw'
                 CacheFolder: 'C:\work\modelref'
               CodeGenFolder: 'C:\work\modelref'
            RelativeBuildDir: 'sldemo_fuelsys_ert_rtw'
              BuildDirSuffix: '_ert_rtw'
  ModelRefRelativeRootSimDir: 'slprj\sim'
  ModelRefRelativeRootTgtDir: 'slprj\ert'
    ModelRefRelativeBuildDir: 'slprj\ert\sldemo_fuelsys'
      ModelRefRelativeSimDir: 'slprj\sim\sldemo_fuelsys'
      ModelRefRelativeHdlDir: 'slprj\hdl\sldemo_fuelsys'
           ModelRefDirSuffix: ''
           SharedUtilsSimDir: 'slprj\sim\_sharedutils'
           SharedUtilsTgtDir: 'slprj\ert\_sharedutils'

Return a structure my_folderStruct that contains build folder information for the model 'MyModel'.

>> my_folderStruct = RTW.getBuildDir('MyModel')


my_folderStruct = 

              BuildDirectory: 'H:\MyModel_ert_rtw'
                 CacheFolder: 'H:\'
               CodeGenFolder: 'H:\'
            RelativeBuildDir: 'MyModel_ert_rtw'
              BuildDirSuffix: '_ert_rtw'
  ModelRefRelativeRootSimDir: 'slprj\sim'
  ModelRefRelativeRootTgtDir: 'slprj\ert'
    ModelRefRelativeBuildDir: 'slprj\ert\MyModel'
      ModelRefRelativeSimDir: 'slprj\sim\MyModel'
      ModelRefRelativeHdlDir: 'slprj\hdl\MyModel'
           ModelRefDirSuffix: ''
           SharedUtilsSimDir: 'slprj\sim\_sharedutils'
           SharedUtilsTgtDir: 'slprj\ert\_sharedutils'

Input Arguments

collapse all

Model for which to get the build folder.

Example: 'sldemo_fuelsys'

Output Arguments

collapse all

Structure that provides build folder information through these character vector fields:

  • BuildDirectory — Fully qualified path to build folder for model.

  • CacheFolder — Simulation cache folder, which is the root folder for model build artifacts that the simulation uses.

  • CodeGenFolder — Code generation folder, which is the root folder for generated production code.

  • RelativeBuildDir — Build folder path relative to the code generation folder.

  • BuildDirSuffix — Suffix appended to model name to create build folder.

  • ModelRefRelativeRootSimDir — Root model reference target simulation folder, relative to the simulation cache folder.

  • ModelRefRelativeRootTgtDir — Root model reference target build folder, relative to the code generation folder.

  • ModelRefRelativeBuildDir — Model reference target build folder, relative to the code generation folder.

  • ModelRefRelativeSimDir — Model reference target simulation folder, relative to the simulation cache folder.

  • ModelRefRelativeHdlDir — Model reference target HDL folder, relative to the code generation folder.

  • ModelRefDirSuffix — Suffix appended to system target file name to create model reference build folder.

  • SharedUtilsSimDir — Shared utility folder for simulation, relative to the simulation cache folder.

  • SharedUtilsTgtDir — Shared utility folder for code generation, relative to the code generation folder.

Example: folderstruct = RTW.getBuildDir('MyModel')

Version History

Introduced in R2008b

See Also

Topics