simwb.rtobj

Syntax

rtobj = simwb.rtobj(rthostenvname)

Arguments

rthostenvname

Name of the real-time host environment object that you wish to link with the real-time host object.

Description

The Real-Time Host Object represents the real-time host computer running the Simulation Workbench server process. Using the Real-Time Host Object properties and methods you can connect to the Simulation Workbench server. Once connected to the real-time host, you can load and start a test session, get and set values of RTDB variables, automatically create and upload a RTDB for a Simulink model, and much more.

Property Summary

Property	Description	Writable
RTHostName	Name of real-time host environment linked to this object.	No
Connected	Connection status with the real-time host.	No
RTWStruct	Structure for SimWB compliant code generation.	Yes
RTWStruct.modelname	Name of the Simulink model for creating a new RTDB or for generating SimWB compliant code.	Yes
RTWStruct.rtdb	Name of the RTDB for creating a new RTDB or for generating SimWB compliant code.	Yes
RTWStruct.systemtargetfile	Name of the SimWB system target file used for code generation.	Yes
RTWStruct.SWprefix	SWprefix option used for creating a new RTDB or for generating SimWB compliant code.	Yes
Project	Selected Project.	Yes

Method Summary

Method	Description
checkCompliance	Check Simulink model compliance with RTDB
connect	Connect MATLAB to the real-time host Simulation Workbench server.
creatRTDB	Create RTDB for a Simulink model.
disconnect	Disconnect connection between MATLAB and real-time host Simulation Workbench server.
getConfigRTDBName	Get name of configuration RTDB.
getConfigRTDBVarList	Get list of RTDB variables present in the configuration RTDB.
getCurrentSession	Get name of the session currently loaded on the real-time host.
getCurrentTest	Get name of the test currently loaded on the real-time host.
getEnv	Get environment object linked with the real-time host object.
getProjectList	Get sorted list of projects on real-time host.
getRTDBItemValue	Get value of RTDB item present in shared memory.
getRTDBList	Get list of RTDB's present on the real-time host.
getRTDBParamValue	Get value of RTDB parameter present in shared memory.
getSessionList	Get list of sessions present in a test.
getSharedMemRTDBName	Get name of RTDB present in shared memory.
getSharedMemRTDBVarList	Get details on items, parameters, and signals present in shared memory RTDB.
getTestList	Get list of tests present on the real-time host.
getTestStatus	Get status of the test that is currently loaded on the real-time host.
loadConfigRTDB	Load RTDB into configuration memory.
projectCreate	Create specified project directory on real-time host..
releaseRTDB	Unload RTDB from the server.
resetOperatorOverride	Reset operator override flag for RTDB items.
rtwBuild	Generate SimWB compliant code for Simulink model.
setRTDBItemValue	Set value of RTDB item present in shared memory.
setRTDBParamValue	Set value of RTDB parameter present in shared memory.
startTestSession	Start a test session.
stopTestSession	Stop currently running test session.
testSetModelInputs	Connect input of one model to output of another model for a given test.
uploadHardwareDB	Upload hardware mappings for RTDB to the real-time host.
uploadRTDB	Upload RTDB to the real-time host.