Documentation

This is machine translation

Translated by Microsoft
Mouseover text to see original. Click the button below to return to the English verison of the page.

Note: This page has been translated by MathWorks. Please click here
To view all translated materals including this page, select Japan from the country navigator on the bottom of this page.

Functions

Alphabetical List By Category
add_block Add block to model
add_exec_event_listener Register listener for block method execution event
add_line Add line to Simulink model
add_param Add parameter to Simulink system
addFile Add file to Simulink Project
addFolderIncludingChildFiles Add folder and child files to Simulink Project
addLabel Attach label to Simulink Project file
addPath Add folder to path of Simulink project
addReference Add referenced project to Simulink project
addShortcut Add shortcut to Simulink project
addterms Add terminators to unconnected ports in model
attachConfigSet Associate configuration set or configuration reference with model
attachConfigSetCopy Copy configuration set or configuration reference and associate it with model
bdclose Close any or all Simulink system windows unconditionally
bdIsDirty Whether block diagram has unsaved changes
bdIsLibrary Whether block diagram is a library
bdIsLoaded Whether block diagram is in memory
bdroot Return name of top-level Simulink system
close Close Simulink Project
close_system Close Simulink system window or block dialog box
closeDialog Close configuration parameters dialog
coder.allowpcode Control code generation from protected MATLAB files
coder.BuildConfig Build context during code generation
coder.BuildConfig.getHardwareImplementation Get handle of copy of hardware implementation object
coder.BuildConfig.getStdLibInfo Get standard library information
coder.BuildConfig.getTargetLang Get target code generation language
coder.BuildConfig.getToolchainInfo Returns handle of copy of toolchain information object
coder.BuildConfig.isCodeGenTarget Determine if build configuration represents specified target
coder.BuildConfig.isMatlabHostTarget Determine if hardware implementation object target is MATLAB host computer
coder.ceval Call external C/C++ function
coder.cinclude Include header file in generated code
coder.const Fold expressions into constants in generated code
coder.cstructname Name structure in generated code
coder.ExternalDependency Interface to external code
coder.ExternalDependency.getDescriptiveName Return descriptive name for external dependency
coder.ExternalDependency.isSupportedContext Determine if build context supports external dependency
coder.ExternalDependency.updateBuildInfo Update build information
coder.extrinsic Declare extrinsic function or functions
coder.ignoreConst Prevent use of constant value of expression for function specializations
coder.inline Control inlining in generated code
coder.load Load compile-time constants from MAT-file or ASCII file into caller workspace
coder.nullcopy Declare uninitialized variables
coder.opaque Declare variable in generated code
coder.ref Pass argument by reference
coder.rref Pass argument by reference as read-only input
coder.screener Determine if function is suitable for code generation
coder.target Determine if code generation target is specified target
coder.unroll Unroll for-loop by making a copy of the loop body for each loop iteration
coder.updateBuildInfo Update build information object RTW.BuildInfo
coder.varsize Declare variable-size array
coder.wref Pass argument as write-only reference
convertToSlDataset Convert contents of MAT-file to Simulink.SimulationData.Dataset object
createCategory Create category of Simulink Project labels
createInputDataset Generate dataset object for root-level Inport blocks in model
createLabel Define Simulink Project label
delete_block Delete blocks from Simulink system
delete_line Delete line from Simulink system
delete_param Delete system parameter added via add_param command
dependencies.fileDependencyAnalysis Find model file dependencies
dependencies.toolboxDependencyAnalysis Find toolbox dependencies
detachConfigSet Dissociate configuration set or configuration reference from model
disableimplicitsignalresolution Convert model to use only explicit signal resolution
dlinmod Extract discrete-time linear state-space model around operating point
docblock Get or set editor invoked by Simulink DocBlock
enumeration Display class enumeration members and names
eventData Provide information about block method execution events
export Export Simulink Project to zip
find Access and display values of simulation results
find_mdlrefs Find Model blocks and referenced models at all levels or at top level only
find_system Find systems, blocks, lines, ports, and annotations
findCategory Get Simulink Project category of labels
findFile Get Simulink Project file by name
findLabel Get Simulink Project file label
fixdt Create Simulink.NumericType object describing fixed-point or floating-point data type
fixpt_evenspace_cleanup Modify breakpoints of lookup table to have even spacing
fixpt_interp1 Implement 1-D lookup table
fixpt_look1_func_approx Optimize fixed-point approximation of nonlinear function by interpolating lookup table data points
fixpt_look1_func_plot Plot fixed-point approximation function for lookup table
fixpt_set_all Set property for each fixed-point block in subsystem
fixptbestexp Exponent that gives best precision for fixed-point representation of value
fixptbestprec Determine maximum precision available for fixed-point representation of value
float Create Simulink.NumericType object describing floating-point data type
frameedit Edit print frames for Simulink and Stateflow block diagrams
fxptdlg Start Fixed-Point Tool
gcb Get path name of current block
gcbh Get handle of current block
gcs Get pathname of current system
get Access and display values of simulation results
get_param Get parameter names and values
getActiveConfigSet Get model's active configuration set or configuration reference
getBlockSimState Access SimState of individual Stateflow Chart, MATLAB Function, or S-function block
getCallbackAnnotation Get information about annotation
getConfigSet Get one of model's configuration sets or configuration references
getConfigSets Get names of all of model's configuration sets or configuration references
getfullname Get pathname of block or line
getInitialState Return initial state data of block diagram
getInputString Create comma-separated list of variables to map
getRootInportMap Create custom object to map signals to root-level inports
getSimulinkBlockHandle Get block handle from block path
getSlRootInportMap Create custom object to map signals to root-level inports using Simulink mapping mode
getVariable Get value of variable from workspace
hasVariable Determine if variable exists in workspace
hdllib Display blocks that are compatible with HDL code generation
hilite_system Highlight block, signal line, port, or annotation
in.applyToModel Apply changes to the model specified through a SimulationInput object, in
in.ExternalInput Set external inputs for a simulation through SimulationInput object, in
in.InitialState Set initial state to be used for a specific simulation through SimulationInput object, in
in.PostSimFcn Specify a MATLAB function to run after each simulation is complete through SimulationInput object, in
in.PreSimFcn Specify a MATLAB function to run before start of each simulation through SimulationInput object, in
in.setBlockParameter Set block parameters to be used for a specific simulation through SimulationInput object, in
in.setModelParameter Set model parameters to be used for a specific simulation through SimulationInput object, in
in.setVariable Set variables for a simulation through SimulationInput object, in
in.validate Validate the contents of the SimulationInput object, in
isLoaded Determine if Simulink Project is loaded
legacy_code Use Legacy Code Tool
libinfo Get information about library blocks referenced by model
LibraryBrowser.LibraryBrowser2 Simulink Library Browser
linmod Extract continuous-time linear state-space model around operating point
linmod2 Extract continuous-time linear state-space model around operating point
linmodv5 Extract continuous-time linear state-space model around operating point
listModifiedFiles List modified files in Simulink project
listRequiredFiles Get project file dependencies
load_system Invisibly load Simulink model
matlab.io.datastore.SimulationDatastore Datastore for inputs and outputs of Simulink models
matlab.io.saveVariablesToScript Save workspace variables to MATLAB script
matlab.system.display.Action Custom button
matlab.system.display.Header Header for System objects properties
matlab.system.display.Icon Custom icon image
matlab.system.display.Section Property group section for System objects
matlab.system.display.SectionGroup Section group for System objects
matlab.system.mixin.CustomIcon Custom icon mixin class
matlab.system.mixin.Nondirect Nondirect feedthrough mixin class
matlab.system.mixin.Propagates Signal characteristics propagation mixin class
model Execute particular phase of simulation of model
modeladvisor Open Model Advisor
ModelAdvisor.Preferences Set Model Advisor window preferences by specifying which folders and tabs to display
new_system Create Simulink model or library in memory
num2fixpt Convert number to nearest value representable by specified fixed-point data type
open_system Open Simulink model, library, subsystem, or block dialog box
openDialog Open configuration parameters dialog
orient Paper orientation for printing or saving
parsim Simulate dynamic system in parallel or serial
performanceadvisor Open Performance Advisor
print Print figure or save to specific file format
refreshSourceControl Update source control status of Simulink project files
reload Reload Simulink Project
removeCategory Remove Simulink Project category of labels
removeFile Remove file from Simulink Project
removeLabel Remove label from Simulink Project
removePath Remove folder from Simulink project path
removeReference Add folder to Simulink project path
removeShortcut Remove shortcut from Simulink project
replace_block Replace blocks in Simulink model
save_system Save Simulink system
set_param Set system and block parameter values
setActiveConfigSet Specify model's active configuration set or configuration reference
setBlockSimState Set SimState of individual Stateflow Chart, MATLAB Function, or S-function block
sfix Create Simulink.NumericType object describing signed fixed-point data type
sfrac Create Simulink.NumericType object describing signed fractional data type
signalbuilder Create and access Signal Builder blocks
sim Simulate dynamic system
simplot Redirects to the Simulation Data Inspector
simulink Open Simulink Start Page
Simulink.AliasType Create alias for signal and parameter data type
Simulink.Annotation Specify properties of model annotation
Simulink.architecture.add Add tasks or triggers to selected architecture of model
Simulink.architecture.config Create or convert configuration for concurrent execution
Simulink.architecture.delete Delete triggers and tasks from selected architecture of model
Simulink.architecture.find_system Find objects under architecture object
Simulink.architecture.get_param Get configuration parameters of architecture objects
Simulink.architecture.importAndSelect Import and select target architecture for concurrent execution environment for model
Simulink.architecture.profile Generate profile report for model configured for concurrent execution
Simulink.architecture.register Add custom target architecture to concurrent execution target architecture selector
Simulink.architecture.set_param Set architecture object properties
Simulink.Block.getSampleTimes Return sample time information for a block
Simulink.BlockCompDworkData Provide postcompilation information about block's DWork vector
Simulink.BlockCompInputPortData Provide postcompilation information about block input port
Simulink.BlockCompOutputPortData Provide postcompilation information about block output port
Simulink.BlockData Provide run-time information about block-related data, such as block parameters
Simulink.BlockDiagram.addBusToVector Convert virtual bus signals into vector signals by adding Bus to Vector blocks
Simulink.BlockDiagram.buildRapidAcceleratorTarget Build Rapid Accelerator target for model and return run-time parameter set
Simulink.BlockDiagram.copyContentsToSubsystem Copy contents of block diagram to empty subsystem
Simulink.BlockDiagram.createSubsystem Create subsystem containing specified set of blocks
Simulink.BlockDiagram.deleteContents Delete contents of block diagram
Simulink.BlockDiagram.expandSubsystem Expand subsystem contents to containing model level
Simulink.BlockDiagram.getChecksum Return checksum of model
Simulink.BlockDiagram.getInitialState Return initial state data of block diagram
Simulink.BlockDiagram.getSampleTimes Return all sample times associated with model
Simulink.BlockDiagram.loadActiveConfigSet Load, associate, and activate configuration set with model
Simulink.BlockDiagram.propagateConfigSet Propagate top model configuration reference to referenced models
Simulink.BlockDiagram.restoreConfigSet Restore model configuration for converted models
Simulink.BlockDiagram.saveActiveConfigSet Save active configuration set of model
Simulink.BlockPortData Describe block input or output port
Simulink.BlockPreCompInputPortData Provide precompilation information about block input port
Simulink.BlockPreCompOutputPortData Provide precompilation information about block output port
Simulink.Breakpoint Store and share data for a breakpoint set, configure the data for ASAP2 and AUTOSAR code generation
Simulink.Bus Specify properties of bus signal
Simulink.Bus.cellToObject Convert cell array containing bus information to bus objects
Simulink.Bus.createMATLABStruct Create MATLAB structures using same hierarchy and attributes as bus signals
Simulink.Bus.createObject Create bus objects from blocks or MATLAB structures
Simulink.Bus.objectToCell Use bus objects to create cell array containing bus information
Simulink.Bus.save Save bus objects in MATLAB file
Simulink.BusElement Describe element of bus signal
Simulink.CoderInfo Specify information needed to generate code for signal or parameter data
Simulink.ConfigSet Access model configuration set
Simulink.ConfigSetRef Link model to configuration set stored independently of any model
Simulink.createFromTemplate Create model or project from template
Simulink.data.assigninGlobal Modify variable values in context of Simulink model
Simulink.data.Dictionary Configure data dictionary
Simulink.data.dictionary.cleanupWorkerCache Restore defaults after parallel simulation with data dictionary
Simulink.data.dictionary.closeAll Close all connections to all open data dictionaries
Simulink.data.dictionary.create Create new data dictionary and create Simulink.data.Dictionary object
Simulink.data.dictionary.Entry Configure data dictionary entry
Simulink.data.dictionary.EnumTypeDefinition Store enumerated type definition in data dictionary
Simulink.data.dictionary.getOpenDictionaryPaths Return file names and paths of open data dictionaries
Simulink.data.dictionary.open Open data dictionary for editing
Simulink.data.dictionary.Section Configure data dictionary section
Simulink.data.dictionary.setupWorkerCache Enable parallel simulation with data dictionary
Simulink.data.evalinGlobal Evaluate MATLAB expression in context of Simulink model
Simulink.data.existsInGlobal Check existence of variable in context of Simulink model
Simulink.data.getEnumTypeInfo Get information about enumerated data type
Simulink.defaultModelTemplate Set or get default model template
Simulink.defineIntEnumType Define enumerated data type
Simulink.dialog.Control Create instances of dialog control
Simulink.DualScaledParameter Specify name, value, units, and other properties of Simulink dual-scaled parameter
Simulink.exportToTemplate Create template from model or project
Simulink.exportToVersion Export model or library for use in previous version of Simulink
Simulink.findTemplates Find model or project templates with specified properties
Simulink.findVars Analyze relationship between variables and blocks in models
Simulink.getFileChecksum Checksum of file
Simulink.getSuppressedDiagnostics Return Simulink.SuppressedDiagnostic objects associated with a block, subsystem, or model
Simulink.GlobalDataTransfer Configure concurrent execution data transfers
Simulink.HMI.InstrumentedSignals Access streamed signals in model
Simulink.HMI.SignalSpecification Information required to stream a single signal
Simulink.importExternalCTypes Generate Simulink representations of custom data types defined by C or C++ code
Simulink.LookupTable Store and share lookup table and breakpoint data, configure the data for ASAP2 and AUTOSAR code generation
Simulink.lookuptable.Breakpoint Configure breakpoint set data for lookup table object
Simulink.lookuptable.StructTypeInfo Configure settings for structure type that lookup table object uses in the generated code
Simulink.lookuptable.Table Configure table data for lookup table object
Simulink.Mask Control masks programmatically
Simulink.MaskParameter Control mask parameters programmatically
Simulink.MDLInfo Extract model file information without loading block diagram into memory
Simulink.MDLInfo.getDescription Extract model file description without loading block diagram into memory
Simulink.MDLInfo.getMetadata Extract model file metadata without loading block diagram into memory
Simulink.ModelAdvisor Run Model Advisor from MATLAB file
Simulink.ModelDataLogs.convertToDataset Convert logging data from Simulink.ModelDataLogs format to Simulink.SimulationData.Dataset format
Simulink.ModelWorkspace Describe model workspace
Simulink.MSFcnRunTimeBlock Get run-time information about Level-2 MATLAB S-function block
Simulink.NumericType Specify floating point, integer, or fixed point data type
Simulink.Parameter Store, share, and configure block parameter values
Simulink.restoreDiagnostic Restore diagnostic warnings to a specific block, subsystem, or model
Simulink.RunTimeBlock Allow Level-2 MATLAB S-function and other MATLAB programs to get information about block while simulation is running
Simulink.SampleTime Object containing sample time information
Simulink.sdi.addToRun Add data to existing run
Simulink.sdi.clear Clear all data from the Simulation Data Inspector
Simulink.sdi.clearPreferences Clear preference changes in the Simulation Data Inspector
Simulink.sdi.close Close the Simulation Data Inspector
Simulink.sdi.compareRuns Compare data between two simulation runs
Simulink.sdi.compareSignals Compare data from two signals
Simulink.sdi.copyRun Create a copy of a run
Simulink.sdi.copyRunViewSettings Copy signal line style and color specifications from one run to another run
Simulink.sdi.createRun Create a run in the Simulation Data Inspector
Simulink.sdi.createRunOrAddToStreamedRun Create a single run for all simulation outputs
Simulink.sdi.deleteRun Delete a run from the Simulation Data Inspector
Simulink.sdi.deleteSignal Delete a signal from the Simulation Data Inspector
Simulink.sdi.DiffRunResult Results from comparing two simulation runs
Simulink.sdi.DiffSignalResult Results from comparing two signals
Simulink.sdi.exportRun Create a Simulink.SimulationData.Dataset object of the data in the specified run
Simulink.sdi.getAllRunIDs Get all run identifiers within the Simulation Data Inspector
Simulink.sdi.getRun Get a Simulink.sdi.Run object containing simulation output data
Simulink.sdi.getRunCount Get the number of runs in the Simulation Data Inspector
Simulink.sdi.getRunIDByIndex Get the run ID corresponding to the specified run index
Simulink.sdi.getRunNamingRule Get the run naming rule for Simulation Data Inspector runs
Simulink.sdi.getSignal Get a Simulink.sdi.Signal object for the specified signal in the Simulation Data Inspector
Simulink.sdi.importDataFromWorkers Import data from Parallel Computing Toolbox workers
Simulink.sdi.isValidRunID Determine if run ID is valid
Simulink.sdi.load Load a saved Simulation Data Inspector session or view
Simulink.sdi.markSignalForStreaming Turn streaming on or off for a signal
Simulink.sdi.report Generate a Simulation Data Inspector report
Simulink.sdi.resetRunNamingRule Reset the Simulation Data Inspector run naming rule to the default
Simulink.sdi.Run Manages signal data and metadata of simulation run
Simulink.sdi.save Save current Simulation Data Inspector session
Simulink.sdi.setRunNamingRule Specify a run naming rule
Simulink.sdi.setRunOverwrite Enable overwrite run mode for a Simulation Data Inspector run
Simulink.sdi.setSubPlotLayout Set layout of subplots
Simulink.sdi.setTableGrouping Change grouping hierarchy of signals in Inspect pane
Simulink.sdi.Signal Manages signal time series data and metadata
Simulink.sdi.view Open the Simulation Data Inspector
Simulink.Signal Specify attributes of signal
Simulink.SimState.ModelSimState Access SimState snapshot data
Simulink.SimulationData.BlockPath Fully specified Simulink block path
Simulink.SimulationData.createStructOfTimeseries Create a structure with MATLAB timeseries object leaf nodes
Simulink.SimulationData.Dataset Create Simulink.SimulationData.Dataset object
Simulink.SimulationData.DatasetRef Create Simulink.SimulationData.DatasetRef object
Simulink.SimulationData.DatasetRef.getAsDatastore Get matlab.io.datastore.SimulationDatastore representation of element from referenced Dataset object
Simulink.SimulationData.DatasetRef.getDatasetVariableNames List names of Dataset variables in MAT-file
Simulink.SimulationData.DataStoreMemory Container for data store logging information
Simulink.SimulationData.forEachTimeseries Call function on each timeseries object
Simulink.SimulationData.LoggingInfo Signal logging override settings
Simulink.SimulationData.ModelLoggingInfo Signal logging override settings for a model
Simulink.SimulationData.Signal Container for signal logging information
Simulink.SimulationData.SignalLoggingInfo Signal logging override settings for signal
Simulink.SimulationData.signalLoggingSelector Open Signal Logging Selector
Simulink.SimulationData.State State logging element
Simulink.SimulationData.Unit Store units for simulation data
Simulink.SimulationData.Unit.setName Specify name of logging data units
Simulink.SimulationData.updateDatasetFormatLogging Convert model and its referenced models to use Dataset format for signal logging
Simulink.SimulationInput Creates SimulationInput objects to make changes to a model for multiple or individual simulations
Simulink.SimulationMetadata Access metadata of simulation runs
Simulink.SimulationOutput Access object values of simulation results
Simulink.SubSystem.convertToModelReference Convert subsystem to model reference
Simulink.SubSystem.copyContentsToBlockDiagram Copy contents of subsystem to empty block diagram
Simulink.SubSystem.deleteContents Delete contents of subsystem
Simulink.SubSystem.getChecksum Return checksum of nonvirtual subsystem
Simulink.suppressDiagnostic Suppress a diagnostic warning from a specific block
Simulink.SuppressedDiagnostic Suppress diagnostic warnings from a specified block
Simulink.VariableUsage Store information about the relationship between variables and blocks in models
Simulink.Variant Specify conditions that control variant selection
Simulink.VariantConfigurationData Class representing a variant configurations data object
Simulink.WorkspaceVar Contains information about workspace variables and blocks that use them
simulinkproject Open Simulink Project and get project object
sint Create Simulink.NumericType object describing signed integer data type
slbuild Build standalone executable or model reference target for model; except where noted, this function requires a Simulink Coder license
slCharacterEncoding Change MATLAB character set encoding
sldebug Start simulation in debug mode
sldiagnostics Display diagnostic information about Simulink system
sldiscmdl Discretize model that contains continuous blocks
slIsFileChangedOnDisk Determine whether model has changed since it was loaded
slLibraryBrowser Open Simulink Library Browser
slmdldiscui Open Model Discretizer GUI
slprofreport Regenerate profiler report from data, ProfileData, saved from previous run
slproject.create Create blank Simulink project
slproject.getCurrentProjects List all top-level Simulink projects
slproject.loadProject Load Simulink project
slreplace_mux In legacy models, replace with Bus Creator blocks Mux blocks used to create buses
slupdate Replace blocks from previous releases with latest versions
start_simulink Start Simulink without opening any windows
trim Find trim point of dynamic system
tunablevars2parameterobjects Create Simulink parameter objects from tunable parameters
ufix Create Simulink.NumericType object describing unsigned fixed-point data type
ufrac Create Simulink.NumericType object describing unsigned fractional data type
uint Create Simulink.NumericType object describing unsigned integer data type
unpack Extract signal logging objects from signal logs and write them into MATLAB workspace
upgradeadvisor Open Upgrade Advisor
view_mdlrefs Display graph of model reference dependencies
who List names of top-level data logging objects in Simulink ModelDataLogs data log
whos List names and types of top-level data logging objects in Simulink ModelDataLogs data log
Was this topic helpful?