RTW.getBuildDir

Get build folder information from model build information

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.

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.

Examples

Display Build Folder Information

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'

Get Build Folder Information

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

model — Model object or name for which to get the build folders

object | 'modelName'

Model for which to get the build folder, specified as an object or a character vector representing the model name.

Example: 'sldemo_fuelsys'

Output Arguments

folderStruct — Structure with field values that provide build folder information

struct

Structure with fields that provides build folder information.

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

BuildDirectory — Character vector specifying fully qualified path to build folder for model

character vector

CacheFolder — Character vector specifying root folder in which to place model build artifacts used for simulation

character vector

CodeGenFolder — Character vector specifying root folder in which to place code generation files

character vector

RelativeBuildDir — Character vector specifying build folder relative to the current working folder (pwd)

character vector

BuildDirSuffix — Character vector specifying suffix appended to model name to create build folder

character vector

ModelRefRelativeRootSimDir — Character vector specifying the relative root folder for the model reference target simulation folder

character vector

ModelRefRelativeRootTgtDir — Character vector specifying the relative root folder for the model reference target build folder

character vector

ModelRefRelativeBuildDir — Character vector specifying model reference target build folder relative to current working folder (pwd)

character vector

ModelRefRelativeSimDir — Character vector specifying model reference target simulation folder relative to current working folder (pwd)

character vector

ModelRefRelativeHdlDir — Character vector specifying model reference target HDL folder relative to current working folder (pwd)

character vector

ModelRefDirSuffix — Character vector specifying suffix appended to system target file name to create model reference build folder

character vector

SharedUtilsSimDir — Character vector specifying the shared utility folder for simulation

character vector

SharedUtilsTgtDir — Character vector specifying the shared utility folder for code generation

character vector

Version History

Introduced in R2008b