OMSimulator’s documentation¶
Version: v3.0.0.post161-g70b6a6d
Contents
- 1. Introduction
- 2. OMSimulator
- 3. OMSimulatorLib
- 4. C-API
- 4.1. RunFile
- 4.2. activateVariant
- 4.3. addBus
- 4.4. addConnection
- 4.5. addConnector
- 4.6. addConnectorToBus
- 4.7. addResources
- 4.8. addSignalsToResults
- 4.9. addSubModel
- 4.10. addSystem
- 4.11. compareSimulationResults
- 4.12. copySystem
- 4.13. delete
- 4.14. deleteConnection
- 4.15. deleteConnectorFromBus
- 4.16. deleteResources
- 4.17. doStep
- 4.18. duplicateVariant
- 4.19. export
- 4.20. exportDependencyGraphs
- 4.21. exportSSMTemplate
- 4.22. exportSSVTemplate
- 4.23. exportSnapshot
- 4.24. freeMemory
- 4.25. getBoolean
- 4.26. getBus
- 4.27. getComponentType
- 4.28. getConnections
- 4.29. getConnector
- 4.30. getDirectionalDerivative
- 4.31. getElement
- 4.32. getElements
- 4.33. getFMUInfo
- 4.34. getFixedStepSize
- 4.35. getInteger
- 4.36. getModelState
- 4.37. getReal
- 4.38. getResultFile
- 4.39. getSolver
- 4.40. getStartTime
- 4.41. getStopTime
- 4.42. getString
- 4.43. getSubModelPath
- 4.44. getSystemType
- 4.45. getTime
- 4.46. getTolerance
- 4.47. getVariableStepSize
- 4.48. getVersion
- 4.49. importFile
- 4.50. importSnapshot
- 4.51. initialize
- 4.52. instantiate
- 4.53. list
- 4.54. listUnconnectedConnectors
- 4.55. listVariants
- 4.56. loadSnapshot
- 4.57. newModel
- 4.58. newResources
- 4.59. referenceResources
- 4.60. removeSignalsFromResults
- 4.61. rename
- 4.62. replaceSubModel
- 4.63. reset
- 4.64. setActivationRatio
- 4.65. setBoolean
- 4.66. setBusGeometry
- 4.67. setCommandLineOption
- 4.68. setConnectionGeometry
- 4.69. setConnectorGeometry
- 4.70. setElementGeometry
- 4.71. setFixedStepSize
- 4.72. setInteger
- 4.73. setLogFile
- 4.74. setLoggingCallback
- 4.75. setLoggingInterval
- 4.76. setLoggingLevel
- 4.77. setMaxLogFileSize
- 4.78. setReal
- 4.79. setRealInputDerivative
- 4.80. setResultFile
- 4.81. setSolver
- 4.82. setStartTime
- 4.83. setStopTime
- 4.84. setString
- 4.85. setTempDirectory
- 4.86. setTolerance
- 4.87. setUnit
- 4.88. setVariableStepSize
- 4.89. setWorkingDirectory
- 4.90. simulate
- 4.91. simulate_realtime
- 4.92. stepUntil
- 4.93. terminate
- 5. OMSimulatorLua
- 5.1. Examples
- 5.2. activateVariant
- 5.3. addBus
- 5.4. addConnection
- 5.5. addConnector
- 5.6. addConnectorToBus
- 5.7. addResources
- 5.8. addSignalsToResults
- 5.9. addSubModel
- 5.10. addSystem
- 5.11. compareSimulationResults
- 5.12. copySystem
- 5.13. delete
- 5.14. deleteConnection
- 5.15. deleteConnectorFromBus
- 5.16. deleteResources
- 5.17. duplicateVariant
- 5.18. export
- 5.19. exportDependencyGraphs
- 5.20. exportSSMTemplate
- 5.21. exportSSVTemplate
- 5.22. exportSnapshot
- 5.23. freeMemory
- 5.24. getBoolean
- 5.25. getDirectionalDerivative
- 5.26. getFixedStepSize
- 5.27. getInteger
- 5.28. getModelState
- 5.29. getReal
- 5.30. getSolver
- 5.31. getStartTime
- 5.32. getStopTime
- 5.33. getString
- 5.34. getSystemType
- 5.35. getTime
- 5.36. getTolerance
- 5.37. getVariableStepSize
- 5.38. getVersion
- 5.39. importFile
- 5.40. importSnapshot
- 5.41. initialize
- 5.42. instantiate
- 5.43. list
- 5.44. listUnconnectedConnectors
- 5.45. listVariants
- 5.46. loadSnapshot
- 5.47. newModel
- 5.48. newResources
- 5.49. referenceResources
- 5.50. removeSignalsFromResults
- 5.51. rename
- 5.52. replaceSubModel
- 5.53. reset
- 5.54. setActivationRatio
- 5.55. setBoolean
- 5.56. setCommandLineOption
- 5.57. setFixedStepSize
- 5.58. setInteger
- 5.59. setLogFile
- 5.60. setLoggingInterval
- 5.61. setLoggingLevel
- 5.62. setMaxLogFileSize
- 5.63. setReal
- 5.64. setRealInputDerivative
- 5.65. setResultFile
- 5.66. setSolver
- 5.67. setStartTime
- 5.68. setStopTime
- 5.69. setString
- 5.70. setTempDirectory
- 5.71. setTolerance
- 5.72. setUnit
- 5.73. setVariableStepSize
- 5.74. setWorkingDirectory
- 5.75. simulate
- 5.76. simulate_realtime
- 5.77. stepUntil
- 5.78. terminate
- 6. OMSimulatorPython
- 6.1. Examples
- 6.2. Python Scripting Commands
- 6.3. activateVariant
- 6.4. addBus
- 6.5. addConnection
- 6.6. addConnector
- 6.7. addConnectorToBus
- 6.8. addResources
- 6.9. addSignalsToResults
- 6.10. addSubModel
- 6.11. addSystem
- 6.12. compareSimulationResults
- 6.13. copySystem
- 6.14. delete
- 6.15. deleteConnection
- 6.16. deleteConnectorFromBus
- 6.17. deleteResources
- 6.18. doStep
- 6.19. duplicateVariant
- 6.20. export
- 6.21. exportDependencyGraphs
- 6.22. exportSSMTemplate
- 6.23. exportSSVTemplate
- 6.24. exportSnapshot
- 6.25. freeMemory
- 6.26. getBoolean
- 6.27. getDirectionalDerivative
- 6.28. getFixedStepSize
- 6.29. getInteger
- 6.30. getReal
- 6.31. getResultFile
- 6.32. getSolver
- 6.33. getStartTime
- 6.34. getStopTime
- 6.35. getString
- 6.36. getSubModelPath
- 6.37. getSystemType
- 6.38. getTime
- 6.39. getTolerance
- 6.40. getVariableStepSize
- 6.41. getVersion
- 6.42. importFile
- 6.43. importSnapshot
- 6.44. initialize
- 6.45. instantiate
- 6.46. list
- 6.47. listUnconnectedConnectors
- 6.48. listVariants
- 6.49. loadSnapshot
- 6.50. newModel
- 6.51. newResources
- 6.52. referenceResources
- 6.53. removeSignalsFromResults
- 6.54. rename
- 6.55. replaceSubModel
- 6.56. reset
- 6.57. setBoolean
- 6.58. setCommandLineOption
- 6.59. setFixedStepSize
- 6.60. setInteger
- 6.61. setLogFile
- 6.62. setLoggingInterval
- 6.63. setLoggingLevel
- 6.64. setMaxLogFileSize
- 6.65. setReal
- 6.66. setRealInputDerivative
- 6.67. setResultFile
- 6.68. setSolver
- 6.69. setStartTime
- 6.70. setStopTime
- 6.71. setString
- 6.72. setTempDirectory
- 6.73. setTolerance
- 6.74. setUnit
- 6.75. setVariableStepSize
- 6.76. setWorkingDirectory
- 6.77. simulate
- 6.78. stepUntil
- 6.79. terminate
- 7. OMSimulatorPython3
- 7.1. Core Capabilities
- 7.2. Command Line Interface
- 7.3. Quick start Example
- 7.4. SSP
- 7.5. SSD
- 7.6. SSV
- 7.7. SSM
- 7.8. FMU
- 7.9. Component
- 7.10. addSystem
- 7.11. addConnector
- 7.12. addConnection
- 7.13. addResource
- 7.14. addComponent
- 7.15. addSSVReference
- 7.16. removeSSVReference
- 7.17. swapSSVReference
- 7.18. listSSVReference
- 7.19. exportSSVTemplate
- 7.20. exportSSVTemplate
- 7.21. setValue
- 7.22. getValue
- 7.23. mapParameter
- 7.24. duplicate and activate Variant
- 7.25. getVariant
- 7.26. listResource
- 7.27. deleteResource
- 7.28. delete
- 7.29. instantiate
- 7.30. setResultFile
- 7.31. initialize
- 7.32. Solver
- 7.33. simulate
- 7.34. terminate and delete
- 8. OpenModelicaScripting
- 8.1. Examples
- 8.2. OpenModelica Scripting Commands
- 8.3. addBus
- 8.4. addConnection
- 8.5. addConnector
- 8.6. addConnectorToBus
- 8.7. addSignalsToResults
- 8.8. addSubModel
- 8.9. addSystem
- 8.10. compareSimulationResults
- 8.11. copySystem
- 8.12. delete
- 8.13. deleteConnection
- 8.14. deleteConnectorFromBus
- 8.15. export
- 8.16. exportDependencyGraphs
- 8.17. exportSnapshot
- 8.18. freeMemory
- 8.19. getBoolean
- 8.20. getFixedStepSize
- 8.21. getInteger
- 8.22. getModelState
- 8.23. getReal
- 8.24. getSolver
- 8.25. getStartTime
- 8.26. getStopTime
- 8.27. getSubModelPath
- 8.28. getSystemType
- 8.29. getTime
- 8.30. getTolerance
- 8.31. getVariableStepSize
- 8.32. getVersion
- 8.33. importFile
- 8.34. importSnapshot
- 8.35. initialize
- 8.36. instantiate
- 8.37. list
- 8.38. listUnconnectedConnectors
- 8.39. loadSnapshot
- 8.40. newModel
- 8.41. removeSignalsFromResults
- 8.42. rename
- 8.43. reset
- 8.44. setBoolean
- 8.45. setCommandLineOption
- 8.46. setFixedStepSize
- 8.47. setInteger
- 8.48. setLogFile
- 8.49. setLoggingInterval
- 8.50. setLoggingLevel
- 8.51. setReal
- 8.52. setRealInputDerivative
- 8.53. setResultFile
- 8.54. setSolver
- 8.55. setStartTime
- 8.56. setStopTime
- 8.57. setTempDirectory
- 8.58. setTolerance
- 8.59. setVariableStepSize
- 8.60. setWorkingDirectory
- 8.61. simulate
- 8.62. stepUntil
- 8.63. terminate
- 9. Graphical Modelling
- 10. SSP Support