MatlabInterface Object

The MatlabInterface is used to establish communications between MATLAB and FreeFlyer. See the Matlab Guide for more information.

Available In Editions:

Timing Precision Mode

This page describes functionality in millisecond timing precision mode. Millisecond timing precision mode is deprecated and will be removed in a future release. We recommend that you migrate your Mission Plans to nanosecond timing precision mode.

Name	Description	Attributes
AdditionalSearchPaths	Additional search paths that will be added to the MATLAB search paths for the session of the MATLAB execution.	Type: StringArray Access: Read/Write
DeclaredName	The name of the object as declared.	Type: String Access: Read-Only
DLLPath	The full path to where the MATLAB executable is located (For example, C:\MATLAB\bin).	Type: String Access: Read/Write
IsOpen	Returns 1 if the MatlabInterface object is open.	Type: Variable Access: Read-Only
Name	The name displayed for this object in output windows such as views, plots, and reports.	Type: String Access: Read/Write
NumberAdditionalSearchPaths	Number of additional search paths to use to locate .m files to execute through the MATLAB interface.	Type: Variable Access: Read/Write
ObjectId	The unique identifier for the object.	Type: Variable Access: Read-Only
ObjectType	The type of the object.	Type: String Access: Read-Only
ScriptExecutionLog	The filename used for tracing and logging communication between FreeFlyer and MATLAB. This can be useful for debugging problems with the interface.	Type: String Access: Read/Write
SharedInstanceFlag	When this property is enabled the MATLAB application opened by FreeFlyer may be shared with other applications that are interfacing with MATLAB.	Type: Variable Access: Read/Write

Name	Description
ClearSavedStates	Clears previous saved states for this object.
GetFromFile	Load the object state from the specified FreeFlyer object file.
GetFromString	Load the object state from the specified string.
PutToFile	Convert the object state to FreeFlyer object xml and write to a file.
PutToString	Convert the object state to FreeFlyer object xml and return as a string.
ReferenceEquals	Returns 1 if the argument refers to the calling object and 0 otherwise.
Restore	Restore an object's state from a previously saved state.
Save	Save the object's state so that it can be restored later.

MatlabInterface Object

Description

Available In Editions:

Timing Precision Mode