Reactis for C API V2022
API - Reactis for C (MATLAB Bindings):
Reactis Build Files
rcRsmOpen
Open an existing .rsm file or create a new .rsm file.
Syntax
rsmId = rcRsmOpen(rsmFileName)
Description
rsmId = rcRsmOpen(rsmFileName)
If file rsmFileName
exists, rcRsmOpen
opens the existing file.
If file rsmFileName
does not exist, this function creates an
empty .rsm
file which will be used to build a library.
rsmId
is a scalar integer valued double that identifies the
.rsm file when calling other rcRsm* API functions.
Examples
rsm = rcRsmOpen('cruise_lib.rsm');
See Also
rcRsmClose,
rcRsmSave
rcRsmSave
Save changes to an .rsm file.
Syntax
rcRsmSave(rsmId)
rcRsmSave(rsmId, fileName)
Description
rcRsmSave(rsmId)
writes any changes made to the .rsm file
to disk, using the same file name as used in the rcRsmOpen call that
opened the file.
rcRsmSave(rsmId, fileName)
writes any changes made to the
.rsm file to disk, using file name fileName.
See Also
rcRsmOpen,
rcRsmClose
rcRsmClose
Close an .rsm file.
Syntax
rcRsmClose(rsmId)
Description
rcRsmClose(rsmId)
closes the file identified by
rsmId. Any changes since the last call to rcRsmSave will be
discarded.
See Also
rcRsmOpen,
rcRsmSave
rcRsmGetSourceFiles
Get the list of source files contained in an .rsm file.
Syntax
files = rcRsmGetSourceFiles(rsmId)
Description
files = rcRsmGetSourceFiles(rsmId)
returns a cell array
containing the list of source files stored in the .rsm file identified by
rsmId.
See Also
rcRsmOpen,
rcRsmSetSourceFiles
rcRsmGetIncludeSearchPath
Get the included file search path contained in an .rsm file.
Syntax
dirs = rcRsmGetIncludeSearchPath(rsmId)
Description
dirs = rcRsmGetIncludeSearchPath(rsmId)
returns a cell
array containing the included file search path stored in the .rsm file
identified by rsmId.
See Also
rcRsmSetIncludeSearchPath
rcRsmGetLibraries
Get the list of source files contained in an .rsm file.
Syntax
names = rcRsmGetLibraries(rsmId)
Description
names = rcRsmGetLibraries(rsmId)
returns a cell array
containing the list of libraries stored in the .rsm file identified by
rsmId.
See Also
rcRsmSetLibraries
rcRsmGetDefines
Get the macro definitions contained in an .rsm file.
Syntax
defs = rcRsmGetDefines(rsmId)
Description
defs = rcRsmGetDefines(rsmId)
returns a cell array
containing the macro definitions stored in the .rsm file identified by
rsmId.
See Also
rcRsmSetDefines
rcRsmGetCoverageEnabled
Query whether coverage tracking is enabled for .rsm file.
Syntax
enabled = rcRsmGetCoverageEnabled(rsmId)
Description
enabled = rcRsmGetCoverageEnabled(rsmId)
returns a Boolean
value which is true if coverage tracking is enabled for the .rsm file
identified by rsmId and false otherwise.
See Also
rcRsmSetCoverageEnabled
rcRsmGetParameterValue
Get the value of a project-specific setting.
Syntax
value = rcRsmGetParameterValue(rsmId, paramName)
Description
value = rcRsmGetParameterValue(rsmId, paramName)
returns
the value of project-specific setting paramName from .rsm file
rsmId. Parameters of any data type may be queried by
rcRsmGetParameterValue. The return value is always a string. Valid
parameter names are listed in the Reactis Parameters section of the
API chapter in the Reactis for C User's Guide.
Examples
v = rcRsmGetParameterValue(rsm, 'OnIntegerOverflow');
See Also
rcRsmSetParameterValue
rcRsmSetSourceFiles
Set the list of source files contained in an .rsm file.
Syntax
name = rcRsmSetSourceFiles(rsmId,sourceFiles)
Description
name = rcRsmSetSourceFiles(rsmId,sourceFiles)
updates the
list of source files stored in the .rsm file identified by rsmId.
The changes are not saved until rcRsmSave is called.
See Also
rcRsmGetSourceFiles
rcRsmSetIncludeSearchPath
Set the included file search path contained in an .rsm file.
Syntax
rcRsmSetIncludeSearchPath(rsmId,directories)
Description
rcRsmSetIncludeSearchPath(rsmId,directories)
sets the
included file search path in the .rsm file identified by rsmId to
equal the list of the directories stored in directories. The
changes are not saved until rcRsmSave is called.
See Also
rcRsmGetIncludeSearchPath
rcRsmSetLibraries
Set the list of libraries contained in an .rsm file.
Syntax
rcRsmSetLibraries(rsmId,libraries)
Description
rcRsmSetLibraries(rsmId,libraries)
updates the list of
libraries stored in the .rsm file identified by rsmId to equal the
contents of the cell array libraries. The changes are not saved
until rcRsmSave is called.
See Also
rcRsmGetLibraries
rcRsmSetDefines
Set the macro definitions contained in an .rsm file.
Syntax
rcRsmSetDefines(rsmId,defines)
Description
rcRsmSetDefines(rsmId,defines)
sets the list of macro
definitions stored in the .rsm file identified by rsmId to equal
the contents of the cell array defines. Changes are not saved until
rcRsmSave is called.
See Also
rcRsmGetDefines
rcRsmSetCoverageEnabled
Enable or disable coverage tracking for .rsm file.
Syntax
rcRsmSetCoverageEnabled(rsmId,enabled)
Description
rcRsmSetCoverageEnabled(rsmId,enabled)
enables coverage
tracking for the .rsm file identified by rsmId if
enabled is true and disables coverage tracking if enabled
is false.
See Also
rcRsmGetCoverageEnabled
rcRsmSetParameterValue
Set the value of a program-specific setting.
Syntax
rcRsmSetParameterValue(rsmId, paramName, paramValue)
Description
rcRsmSetParameterValue(rsmId, paramName, paramValue)
sets
project-specific setting paramName to paramValue in the
.rsm file whose id matches rsmId.
Parameters of any data type may be set by rcRsmSetParameterValue but the
paramValue argument must be given as a string.
See Also
rcRsmGetParameterValue
rcRsmStub
Generate a C source file containing stub definitions.
Syntax
rcRsmStub(rsmId,cfile)
Description
rcRsmStub(rsmId,cfile)
generates a C source containing
stub definitions for variables and functions which are referenced but not
defined in the program constructed by the .rsm file identified by
rsmId. The stub definitions are stored in the file cfile.