Enables use of MATLAB Compiler and build of MEX-files. More...

#include "CMakeParseArguments.cmake"
#include "/CommonTools.cmake"
#include "/UtilitiesTools.cmake"

Include dependency graph for MatlabTools.cmake:

This graph shows which files directly or indirectly include this file:

Functions
macro	basis_add_mcc_options ()
	Add global MATLAB Compiler (mcc) options to CMake cache. More...

function	basis_add_mcc_target (in TARGET_NAME, in ARGN)
	Add MATLAB Compiler target. More...

function	basis_add_mex_file (in TARGET_NAME, in ARGN)
	Add MEX-file target. More...

macro	basis_add_mex_options ()
	Add global MATLAB MEX-script options to CMake cache. More...

function	basis_build_mcc_target (in TARGET_UID)
	Add custom command for build of MATLAB Compiler target. More...

function	basis_build_mex_file (in TARGET_UID)
	Add custom command for build of MEX-file. More...

function	basis_create_addpaths_mfile ()
	This function writes a MATLAB M-file with addpath() statements. More...

function	basis_generate_matlab_executable (in OUTPUT_FILE, in ARGN)
	Generate MATLAB wrapper executable. More...

function	basis_get_full_matlab_version (out VERSION)
	Determine version of MATLAB installation. More...

function	basis_get_matlab_release (out ARGV1)
	Get release version of MATLAB installation. More...

function	basis_get_matlab_version (out ARGV1)
	Get version of MATLAB installation. More...

function	basis_mexext (out ARGN)
	Determine extension of MEX-files for this architecture. More...

macro	basis_write_addpaths_mfile (in MFILE, in ARGN)
	This function writes a MATLAB M-file with addpath() statements. More...

Variables
cmake	__BASIS_MATLABTOOLS_INCLUDED

option	BASIS_COMPILE_MATLAB = ON
	Enable/Disable compilation of MATLAB sources if the MATLAB Compiler is available. More...

cmake	BUILD_CMD

cmake	BUILD_LOG

cmake	BUILD_MFILE

cmake	BUILD_OUTPUT

cmake	BUILD_OUTPUTS

cmake	BUILD_SCRIPT

cmake	CC

cmake	CFLAGS

cmake	CXX

cmake	CXXFLAGS

cmake	LD

cmake	LDFLAGS

cmake	LINK_DIR

cmake	LINK_LIB

Detailed Description

Enables use of MATLAB Compiler and build of MEX-files.

Definition in file MatlabTools.cmake.

Function Documentation

§ basis_generate_matlab_executable()

function basis_generate_matlab_executable	(	in	OUTPUT_FILE,
		in	ARGN
	)

Generate MATLAB wrapper executable.

This function writes a Bash script on Unix or a Windows Command script on Windows platforms which execute the specified MATLAB command using the -r option of the matlab executable and the -nodesktop and -nosplash options. It is used by the build scripts generated by the basis_build_mcc_target() in order to build an executable from MATLAB source files without the use of the MATLAB Compiler. In this case, the MATLAB source files are simply copied to the installation directory and the wrapper script written by this function used to execute the main function with the command-line arguments passed on to this executable.

Parameters

[in]	OUTPUT_FILE	Name of the output executable file.
[in]	ARGN	The remaining options

DESTINATION dir	Installation destination. (default: directory of `OUTPUT_FILE`)
COMMAND name	Name of the MATLAB command to execute, i.e., the name of the main function.
STARTUP mfile	Absolute path of a startup M-file.
MATLABPATH dir1[ dir2...]	List of directories to be added to the MATLAB search path.
OPTIONS opt1[ opt2...]	Additional options to pass on to the `matlab` executable.

Returns: Nothing.

Variable Documentation

§ __BASIS_MATLABTOOLS_INCLUDED

cmake __BASIS_MATLABTOOLS_INCLUDED

Definition at line 20 of file MatlabTools.cmake.

§ BUILD_CMD

cmake BUILD_CMD

Definition at line 1422 of file MatlabTools.cmake.

§ BUILD_LOG

cmake BUILD_LOG

Definition at line 1424 of file MatlabTools.cmake.

§ BUILD_MFILE

cmake BUILD_MFILE

Definition at line 1428 of file MatlabTools.cmake.

§ BUILD_OUTPUT

cmake BUILD_OUTPUT

Definition at line 1425 of file MatlabTools.cmake.

§ BUILD_OUTPUTS

cmake BUILD_OUTPUTS

Definition at line 1426 of file MatlabTools.cmake.

§ BUILD_SCRIPT

cmake BUILD_SCRIPT

Definition at line 1423 of file MatlabTools.cmake.

§ CC

cmake CC

Definition at line 1295 of file MatlabTools.cmake.

§ CFLAGS

cmake CFLAGS

Definition at line 1298 of file MatlabTools.cmake.

§ CXX

cmake CXX

Definition at line 1304 of file MatlabTools.cmake.

§ CXXFLAGS

cmake CXXFLAGS

Definition at line 1307 of file MatlabTools.cmake.

§ LD

cmake LD

Definition at line 1313 of file MatlabTools.cmake.

§ LDFLAGS

cmake LDFLAGS

Definition at line 1291 of file MatlabTools.cmake.

§ LINK_DIR

cmake LINK_DIR

Definition at line 1368 of file MatlabTools.cmake.

§ LINK_LIB

cmake LINK_LIB

Definition at line 1394 of file MatlabTools.cmake.

Functions

Variables