xxsimList

PURPOSE ^

list of library functions

SYNOPSIS ^

This is a script file.

DESCRIPTION ^

 list of library functions

 Basic 20-sim actions

 xxsimAddToPath               - Adds the xxsim folder to the path.
 xxsimList                    - Obtain this list with all currently supported scripting functions.
 xxsimConnect                 - Connects with 20-sim.
 xxsimDisconnect              - Disconnects from 20-sim.
 xxsimClose                   - Close 20-sim.
 xxsimGetVersion              - Get the version of 20-sim.
 xxsimSetScriptMode           - Sets or unsets 20-sim in scripting mode.

 Model actions

 xxsimNewModel                - Opens a new 20-sim model.
 xxsimOpenModel               - Opens a 20-sim model.
 xxsimSaveModel               - Saves the changes made to active 20-sim model.
 xxsimCloseModel              - Closes active 20-sim model.
 xxsimProcessModel            - Processes the active 20-sim model.
 xxsimGetActiveModel          - returns name and unique identifier of active model.
 xxsimSetActiveModel          - Sets one of the opened 20-sim models as active if no active model is choosen.
 xxsimGetModels               - Returns the list of opened 20-sim models.

 Submodel actions

 xxsimLinearizeModel          - Linearizes the subsystem between the supplied inputs and outputs.
 xxsimQueryImplementations    - Returns a list of submodels names with multiple implementation and their active implementation.
 xxsimGetImplementations      - Request the implementations of a particular submodel.
 xxsimSetImplementations      - Changes the implementation of one or more submodels.
 xxsimCopyStatesToInitials    - Copy the current states to the initial values of these states.
 xxsimGotoSubmodel            - Select the provided submodel in the tree and show its contents.
 xxsimReplaceSubmodel         - Replace an existing submodel with the version from the provided file.
 xxsimSaveSubmodel            - Saves the provided submodel to a separate file.
 xxsimGetSubmodelProperties   - Get submodel properties of a submodel (name, description, version, etc.).

 Parameter/Variable actions

 xxsimGetInitialValues        - Gets specified initial values.
 xxsimSetInitialValues        - Sets specified initial values.
 xxsimGetParameters           - Gets specified parameters.
 xxsimSetParameters           - Sets specified parameters.
 xxsimGetVariables            - Gets specified variables.
 xxsimSetVariables            - Sets specified variables.
 xxsimGetValue                - Get the value of a specific variable.
 xxsimGetLogValues            - Gets values which are logged using xxsimSetLogVariables.
 xxsimSetLogVariables         - Logs specified variables while running active model.
 xxsimWriteLogToCsv           - Writes logged variables to a comma separated value (csv) file.

 Simulator actions

 xxsimRun                     - Runs the active 20-sim model.
 xxsimSingleStep              - Runs the active 20-sim model.
 xxsimReplaceSubmodel         - Replace an existing submodel with the version from the provided file.
 xxsimClearAllRuns            - Clears all the runs.
 xxsimClearLastRun            - Clears only the last run.
 xxsimClearPreviousRuns       - Clears all runs except the last one.
 xxsimClearRun                - Clears one or more runs.
 xxsimStartSimulation         - Start the simulation.
 xxsimStopSimulation          - Stop the simulation.
 xxsimIsSimulating            - Checks if the simulation is active.
 xxsimSingleStep              - Executes a single simulation step for the active 20-sim model.
 xxsimQuerySettings           - Retrieves the settings of the active 20-sim model and tool session.
 xxsimSetSettings             - Changes the value of one or more 20-sim tool or model settings.
 xxsimOpenSimulator           - Open the simulator.
 xxsimCloseSimulator          - Close the simulator.

 Code Generation actions

 xxsimGetCCodeTargets         - Retrieves a list of C-Code targets.
 xxsimGenerateCCode           - Generates C-Code for the active model using the specified C-code target template.
 xxsimGetMatlabCodeTargets    - Retrieves the list with available Matlab M-code targets.
 xxsimGenerateMatlabCode      - Generates Matlab-Code using the specified target.

 Plotting actions

 xxsimSavePlotAsBitmap        - Save a plot or plot window as bitmap. Supported formats: png, bmp, jpg, gif.
 xxsimGetPlotWindows          - Returns all currently available plot windows that are present in the simulator by both name and ID.
 xxsimGetPlotIDFromName       - Find the corresponding plot ID for a certain window and plot name.
 xxsimGetPlotsFromWindow      - Get all currently available plots that are present in the specified window by both name and ID.
 xxsimGetPlotWindowIDFromName - Find the corresponding window ID for a certain window name.
 xxsimGetPlotWindows          - Get all currently available plot windows that are present in the simulator by both name and ID.
 xxsimGetCurveIDFromName      - Get the unique curve ID from the name of a curve.
 xxsimGetCurvesFromPlot       - Get all curves (names and unique IDs) from an existing plot.
 xxsimAddCurveToPlot          - Add a curve to an existing plot.
 xxsimAddPlotToWindow         - Add a plot to an existing plot window.
 xxsimAddPlotWindow           - Add a plot window.
 xxsimRemoveCurveFromPlot     - Remove an existing curve from an existing plot.
 xxsimRemovePlotFromWindow    - Remove an existing plot from an existing plot window.
 xxsimRemovePlotWindow        - Remove an existing plot window.
 xxsimHideCurve               - Hide or show a curve in a plot.
 xxsimHidePlot                - Hide or show a plot in a plot window.
 xxsimHidePlotWindow          - Hide or show a plot window.

 General actions

 xxsimGetMemoryUsage          - Get the memory usage of 20-sim.
 xxsimGetWindowSize           - Returns the current size of the last opened window.
 xxsimSetWindowSize           - Set the size of the last opened window.
 xxsimSetTimeout              - Change the connection and command time-out value.

 Author: Controllab Products B.V.
 email: info@controllab.nl
 Website: http://www.controllab.nl
 December 2017

CROSS-REFERENCE INFORMATION ^

This function calls: This function is called by:

SOURCE CODE ^

0001 % list of library functions
0002 %
0003 % Basic 20-sim actions
0004 %
0005 % xxsimAddToPath               - Adds the xxsim folder to the path.
0006 % xxsimList                    - Obtain this list with all currently supported scripting functions.
0007 % xxsimConnect                 - Connects with 20-sim.
0008 % xxsimDisconnect              - Disconnects from 20-sim.
0009 % xxsimClose                   - Close 20-sim.
0010 % xxsimGetVersion              - Get the version of 20-sim.
0011 % xxsimSetScriptMode           - Sets or unsets 20-sim in scripting mode.
0012 %
0013 % Model actions
0014 %
0015 % xxsimNewModel                - Opens a new 20-sim model.
0016 % xxsimOpenModel               - Opens a 20-sim model.
0017 % xxsimSaveModel               - Saves the changes made to active 20-sim model.
0018 % xxsimCloseModel              - Closes active 20-sim model.
0019 % xxsimProcessModel            - Processes the active 20-sim model.
0020 % xxsimGetActiveModel          - returns name and unique identifier of active model.
0021 % xxsimSetActiveModel          - Sets one of the opened 20-sim models as active if no active model is choosen.
0022 % xxsimGetModels               - Returns the list of opened 20-sim models.
0023 %
0024 % Submodel actions
0025 %
0026 % xxsimLinearizeModel          - Linearizes the subsystem between the supplied inputs and outputs.
0027 % xxsimQueryImplementations    - Returns a list of submodels names with multiple implementation and their active implementation.
0028 % xxsimGetImplementations      - Request the implementations of a particular submodel.
0029 % xxsimSetImplementations      - Changes the implementation of one or more submodels.
0030 % xxsimCopyStatesToInitials    - Copy the current states to the initial values of these states.
0031 % xxsimGotoSubmodel            - Select the provided submodel in the tree and show its contents.
0032 % xxsimReplaceSubmodel         - Replace an existing submodel with the version from the provided file.
0033 % xxsimSaveSubmodel            - Saves the provided submodel to a separate file.
0034 % xxsimGetSubmodelProperties   - Get submodel properties of a submodel (name, description, version, etc.).
0035 %
0036 % Parameter/Variable actions
0037 %
0038 % xxsimGetInitialValues        - Gets specified initial values.
0039 % xxsimSetInitialValues        - Sets specified initial values.
0040 % xxsimGetParameters           - Gets specified parameters.
0041 % xxsimSetParameters           - Sets specified parameters.
0042 % xxsimGetVariables            - Gets specified variables.
0043 % xxsimSetVariables            - Sets specified variables.
0044 % xxsimGetValue                - Get the value of a specific variable.
0045 % xxsimGetLogValues            - Gets values which are logged using xxsimSetLogVariables.
0046 % xxsimSetLogVariables         - Logs specified variables while running active model.
0047 % xxsimWriteLogToCsv           - Writes logged variables to a comma separated value (csv) file.
0048 %
0049 % Simulator actions
0050 %
0051 % xxsimRun                     - Runs the active 20-sim model.
0052 % xxsimSingleStep              - Runs the active 20-sim model.
0053 % xxsimReplaceSubmodel         - Replace an existing submodel with the version from the provided file.
0054 % xxsimClearAllRuns            - Clears all the runs.
0055 % xxsimClearLastRun            - Clears only the last run.
0056 % xxsimClearPreviousRuns       - Clears all runs except the last one.
0057 % xxsimClearRun                - Clears one or more runs.
0058 % xxsimStartSimulation         - Start the simulation.
0059 % xxsimStopSimulation          - Stop the simulation.
0060 % xxsimIsSimulating            - Checks if the simulation is active.
0061 % xxsimSingleStep              - Executes a single simulation step for the active 20-sim model.
0062 % xxsimQuerySettings           - Retrieves the settings of the active 20-sim model and tool session.
0063 % xxsimSetSettings             - Changes the value of one or more 20-sim tool or model settings.
0064 % xxsimOpenSimulator           - Open the simulator.
0065 % xxsimCloseSimulator          - Close the simulator.
0066 %
0067 % Code Generation actions
0068 %
0069 % xxsimGetCCodeTargets         - Retrieves a list of C-Code targets.
0070 % xxsimGenerateCCode           - Generates C-Code for the active model using the specified C-code target template.
0071 % xxsimGetMatlabCodeTargets    - Retrieves the list with available Matlab M-code targets.
0072 % xxsimGenerateMatlabCode      - Generates Matlab-Code using the specified target.
0073 %
0074 % Plotting actions
0075 %
0076 % xxsimSavePlotAsBitmap        - Save a plot or plot window as bitmap. Supported formats: png, bmp, jpg, gif.
0077 % xxsimGetPlotWindows          - Returns all currently available plot windows that are present in the simulator by both name and ID.
0078 % xxsimGetPlotIDFromName       - Find the corresponding plot ID for a certain window and plot name.
0079 % xxsimGetPlotsFromWindow      - Get all currently available plots that are present in the specified window by both name and ID.
0080 % xxsimGetPlotWindowIDFromName - Find the corresponding window ID for a certain window name.
0081 % xxsimGetPlotWindows          - Get all currently available plot windows that are present in the simulator by both name and ID.
0082 % xxsimGetCurveIDFromName      - Get the unique curve ID from the name of a curve.
0083 % xxsimGetCurvesFromPlot       - Get all curves (names and unique IDs) from an existing plot.
0084 % xxsimAddCurveToPlot          - Add a curve to an existing plot.
0085 % xxsimAddPlotToWindow         - Add a plot to an existing plot window.
0086 % xxsimAddPlotWindow           - Add a plot window.
0087 % xxsimRemoveCurveFromPlot     - Remove an existing curve from an existing plot.
0088 % xxsimRemovePlotFromWindow    - Remove an existing plot from an existing plot window.
0089 % xxsimRemovePlotWindow        - Remove an existing plot window.
0090 % xxsimHideCurve               - Hide or show a curve in a plot.
0091 % xxsimHidePlot                - Hide or show a plot in a plot window.
0092 % xxsimHidePlotWindow          - Hide or show a plot window.
0093 %
0094 % General actions
0095 %
0096 % xxsimGetMemoryUsage          - Get the memory usage of 20-sim.
0097 % xxsimGetWindowSize           - Returns the current size of the last opened window.
0098 % xxsimSetWindowSize           - Set the size of the last opened window.
0099 % xxsimSetTimeout              - Change the connection and command time-out value.
0100 %
0101 % Author: Controllab Products B.V.
0102 % email: info@controllab.nl
0103 % Website: http://www.controllab.nl
0104 % December 2017
0105 help xxsimList

Generated on Fri 19-Jan-2018 15:01:54