OMSimulator’s documentation

Version: v2.1.1.post191-gf9c815c

Contents

• 1. Introduction
• 2. OMSimulator
  • 2.1. OMSimulator Flags
  • 2.2. Examples
• 3. OMSimulatorLib
  • 3.1. C-API
    • 3.1.1. RunFile
    • 3.1.2. activateVariant
    • 3.1.3. addBus
    • 3.1.4. addConnection
    • 3.1.5. addConnector
    • 3.1.6. addConnectorToBus
    • 3.1.7. addConnectorToTLMBus
    • 3.1.8. addExternalModel
    • 3.1.9. addResources
    • 3.1.10. addSignalsToResults
    • 3.1.11. addSubModel
    • 3.1.12. addSystem
    • 3.1.13. addTLMBus
    • 3.1.14. addTLMConnection
    • 3.1.15. compareSimulationResults
    • 3.1.16. copySystem
    • 3.1.17. delete
    • 3.1.18. deleteConnection
    • 3.1.19. deleteConnectorFromBus
    • 3.1.20. deleteConnectorFromTLMBus
    • 3.1.21. deleteResources
    • 3.1.22. doStep
    • 3.1.23. duplicateVariant
    • 3.1.24. export
    • 3.1.25. exportDependencyGraphs
    • 3.1.26. exportSSMTemplate
    • 3.1.27. exportSSVTemplate
    • 3.1.28. exportSnapshot
    • 3.1.29. extractFMIKind
    • 3.1.30. faultInjection
    • 3.1.31. freeMemory
    • 3.1.32. getBoolean
    • 3.1.33. getBus
    • 3.1.34. getComponentType
    • 3.1.35. getConnections
    • 3.1.36. getConnector
    • 3.1.37. getDirectionalDerivative
    • 3.1.38. getElement
    • 3.1.39. getElements
    • 3.1.40. getFMUInfo
    • 3.1.41. getFixedStepSize
    • 3.1.42. getInteger
    • 3.1.43. getModelState
    • 3.1.44. getReal
    • 3.1.45. getResultFile
    • 3.1.46. getSolver
    • 3.1.47. getStartTime
    • 3.1.48. getStopTime
    • 3.1.49. getString
    • 3.1.50. getSubModelPath
    • 3.1.51. getSystemType
    • 3.1.52. getTLMBus
    • 3.1.53. getTLMVariableTypes
    • 3.1.54. getTime
    • 3.1.55. getTolerance
    • 3.1.56. getVariableStepSize
    • 3.1.57. getVersion
    • 3.1.58. importFile
    • 3.1.59. importSnapshot
    • 3.1.60. initialize
    • 3.1.61. instantiate
    • 3.1.62. list
    • 3.1.63. listUnconnectedConnectors
    • 3.1.64. listVariants
    • 3.1.65. loadSnapshot
    • 3.1.66. newModel
    • 3.1.67. newResources
    • 3.1.68. referenceResources
    • 3.1.69. removeSignalsFromResults
    • 3.1.70. rename
    • 3.1.71. replaceSubModel
    • 3.1.72. reset
    • 3.1.73. setActivationRatio
    • 3.1.74. setBoolean
    • 3.1.75. setBusGeometry
    • 3.1.76. setCommandLineOption
    • 3.1.77. setConnectionGeometry
    • 3.1.78. setConnectorGeometry
    • 3.1.79. setElementGeometry
    • 3.1.80. setFixedStepSize
    • 3.1.81. setInteger
    • 3.1.82. setLogFile
    • 3.1.83. setLoggingCallback
    • 3.1.84. setLoggingInterval
    • 3.1.85. setLoggingLevel
    • 3.1.86. setMaxLogFileSize
    • 3.1.87. setReal
    • 3.1.88. setRealInputDerivative
    • 3.1.89. setResultFile
    • 3.1.90. setSolver
    • 3.1.91. setStartTime
    • 3.1.92. setStopTime
    • 3.1.93. setString
    • 3.1.94. setTLMBusGeometry
    • 3.1.95. setTLMConnectionParameters
    • 3.1.96. setTLMPositionAndOrientation
    • 3.1.97. setTLMSocketData
    • 3.1.98. setTempDirectory
    • 3.1.99. setTolerance
    • 3.1.100. setUnit
    • 3.1.101. setVariableStepSize
    • 3.1.102. setWorkingDirectory
    • 3.1.103. simulate
    • 3.1.104. simulate_realtime
    • 3.1.105. stepUntil
    • 3.1.106. terminate
• 4. OMSimulatorLua
  • 4.1. Examples
  • 4.2. Lua Scripting Commands
    • 4.2.1. activateVariant
    • 4.2.2. addBus
    • 4.2.3. addConnection
    • 4.2.4. addConnector
    • 4.2.5. addConnectorToBus
    • 4.2.6. addConnectorToTLMBus
    • 4.2.7. addExternalModel
    • 4.2.8. addResources
    • 4.2.9. addSignalsToResults
    • 4.2.10. addSubModel
    • 4.2.11. addSystem
    • 4.2.12. addTLMBus
    • 4.2.13. addTLMConnection
    • 4.2.14. compareSimulationResults
    • 4.2.15. copySystem
    • 4.2.16. delete
    • 4.2.17. deleteConnection
    • 4.2.18. deleteConnectorFromBus
    • 4.2.19. deleteConnectorFromTLMBus
    • 4.2.20. deleteResources
    • 4.2.21. duplicateVariant
    • 4.2.22. export
    • 4.2.23. exportDependencyGraphs
    • 4.2.24. exportSSMTemplate
    • 4.2.25. exportSSVTemplate
    • 4.2.26. exportSnapshot
    • 4.2.27. faultInjection
    • 4.2.28. freeMemory
    • 4.2.29. getBoolean
    • 4.2.30. getDirectionalDerivative
    • 4.2.31. getFixedStepSize
    • 4.2.32. getInteger
    • 4.2.33. getModelState
    • 4.2.34. getReal
    • 4.2.35. getSolver
    • 4.2.36. getStartTime
    • 4.2.37. getStopTime
    • 4.2.38. getString
    • 4.2.39. getSystemType
    • 4.2.40. getTime
    • 4.2.41. getTolerance
    • 4.2.42. getVariableStepSize
    • 4.2.43. getVersion
    • 4.2.44. importFile
    • 4.2.45. importSnapshot
    • 4.2.46. initialize
    • 4.2.47. instantiate
    • 4.2.48. list
    • 4.2.49. listUnconnectedConnectors
    • 4.2.50. listVariants
    • 4.2.51. loadSnapshot
    • 4.2.52. newModel
    • 4.2.53. newResources
    • 4.2.54. referenceResources
    • 4.2.55. removeSignalsFromResults
    • 4.2.56. rename
    • 4.2.57. replaceSubModel
    • 4.2.58. reset
    • 4.2.59. setActivationRatio
    • 4.2.60. setBoolean
    • 4.2.61. setCommandLineOption
    • 4.2.62. setFixedStepSize
    • 4.2.63. setInteger
    • 4.2.64. setLogFile
    • 4.2.65. setLoggingInterval
    • 4.2.66. setLoggingLevel
    • 4.2.67. setMaxLogFileSize
    • 4.2.68. setReal
    • 4.2.69. setRealInputDerivative
    • 4.2.70. setResultFile
    • 4.2.71. setSolver
    • 4.2.72. setStartTime
    • 4.2.73. setStopTime
    • 4.2.74. setString
    • 4.2.75. setTLMPositionAndOrientation
    • 4.2.76. setTLMSocketData
    • 4.2.77. setTempDirectory
    • 4.2.78. setTolerance
    • 4.2.79. setUnit
    • 4.2.80. setVariableStepSize
    • 4.2.81. setWorkingDirectory
    • 4.2.82. simulate
    • 4.2.83. simulate_realtime
    • 4.2.84. stepUntil
    • 4.2.85. terminate
• 5. OMSimulatorPython
  • 5.1. Examples
  • 5.2. Python Scripting Commands
    • 5.2.1. activateVariant
    • 5.2.2. addBus
    • 5.2.3. addConnection
    • 5.2.4. addConnector
    • 5.2.5. addConnectorToBus
    • 5.2.6. addConnectorToTLMBus
    • 5.2.7. addExternalModel
    • 5.2.8. addResources
    • 5.2.9. addSignalsToResults
    • 5.2.10. addSubModel
    • 5.2.11. addSystem
    • 5.2.12. addTLMBus
    • 5.2.13. addTLMConnection
    • 5.2.14. compareSimulationResults
    • 5.2.15. copySystem
    • 5.2.16. delete
    • 5.2.17. deleteConnection
    • 5.2.18. deleteConnectorFromBus
    • 5.2.19. deleteConnectorFromTLMBus
    • 5.2.20. deleteResources
    • 5.2.21. doStep
    • 5.2.22. duplicateVariant
    • 5.2.23. export
    • 5.2.24. exportDependencyGraphs
    • 5.2.25. exportSSMTemplate
    • 5.2.26. exportSSVTemplate
    • 5.2.27. exportSnapshot
    • 5.2.28. faultInjection
    • 5.2.29. freeMemory
    • 5.2.30. getBoolean
    • 5.2.31. getDirectionalDerivative
    • 5.2.32. getFixedStepSize
    • 5.2.33. getInteger
    • 5.2.34. getReal
    • 5.2.35. getResultFile
    • 5.2.36. getSolver
    • 5.2.37. getStartTime
    • 5.2.38. getStopTime
    • 5.2.39. getString
    • 5.2.40. getSubModelPath
    • 5.2.41. getSystemType
    • 5.2.42. getTime
    • 5.2.43. getTolerance
    • 5.2.44. getVariableStepSize
    • 5.2.45. getVersion
    • 5.2.46. importFile
    • 5.2.47. importSnapshot
    • 5.2.48. initialize
    • 5.2.49. instantiate
    • 5.2.50. list
    • 5.2.51. listUnconnectedConnectors
    • 5.2.52. listVariants
    • 5.2.53. loadSnapshot
    • 5.2.54. newModel
    • 5.2.55. newResources
    • 5.2.56. referenceResources
    • 5.2.57. removeSignalsFromResults
    • 5.2.58. rename
    • 5.2.59. replaceSubModel
    • 5.2.60. reset
    • 5.2.61. setBoolean
    • 5.2.62. setCommandLineOption
    • 5.2.63. setFixedStepSize
    • 5.2.64. setInteger
    • 5.2.65. setLogFile
    • 5.2.66. setLoggingInterval
    • 5.2.67. setLoggingLevel
    • 5.2.68. setMaxLogFileSize
    • 5.2.69. setReal
    • 5.2.70. setRealInputDerivative
    • 5.2.71. setResultFile
    • 5.2.72. setSolver
    • 5.2.73. setStartTime
    • 5.2.74. setStopTime
    • 5.2.75. setString
    • 5.2.76. setTempDirectory
    • 5.2.77. setTolerance
    • 5.2.78. setUnit
    • 5.2.79. setVariableStepSize
    • 5.2.80. setWorkingDirectory
    • 5.2.81. simulate
    • 5.2.82. stepUntil
    • 5.2.83. terminate
  • 5.3. Example: Pi
• 6. OpenModelicaScripting
  • 6.1. Examples
  • 6.2. OpenModelica Scripting Commands
    • 6.2.1. addBus
    • 6.2.2. addConnection
    • 6.2.3. addConnector
    • 6.2.4. addConnectorToBus
    • 6.2.5. addConnectorToTLMBus
    • 6.2.6. addExternalModel
    • 6.2.7. addSignalsToResults
    • 6.2.8. addSubModel
    • 6.2.9. addSystem
    • 6.2.10. addTLMBus
    • 6.2.11. addTLMConnection
    • 6.2.12. compareSimulationResults
    • 6.2.13. copySystem
    • 6.2.14. delete
    • 6.2.15. deleteConnection
    • 6.2.16. deleteConnectorFromBus
    • 6.2.17. deleteConnectorFromTLMBus
    • 6.2.18. export
    • 6.2.19. exportDependencyGraphs
    • 6.2.20. exportSnapshot
    • 6.2.21. extractFMIKind
    • 6.2.22. faultInjection
    • 6.2.23. freeMemory
    • 6.2.24. getBoolean
    • 6.2.25. getFixedStepSize
    • 6.2.26. getInteger
    • 6.2.27. getModelState
    • 6.2.28. getReal
    • 6.2.29. getSolver
    • 6.2.30. getStartTime
    • 6.2.31. getStopTime
    • 6.2.32. getSubModelPath
    • 6.2.33. getSystemType
    • 6.2.34. getTime
    • 6.2.35. getTolerance
    • 6.2.36. getVariableStepSize
    • 6.2.37. getVersion
    • 6.2.38. importFile
    • 6.2.39. importSnapshot
    • 6.2.40. initialize
    • 6.2.41. instantiate
    • 6.2.42. list
    • 6.2.43. listUnconnectedConnectors
    • 6.2.44. loadSnapshot
    • 6.2.45. newModel
    • 6.2.46. removeSignalsFromResults
    • 6.2.47. rename
    • 6.2.48. reset
    • 6.2.49. setBoolean
    • 6.2.50. setCommandLineOption
    • 6.2.51. setFixedStepSize
    • 6.2.52. setInteger
    • 6.2.53. setLogFile
    • 6.2.54. setLoggingInterval
    • 6.2.55. setLoggingLevel
    • 6.2.56. setReal
    • 6.2.57. setRealInputDerivative
    • 6.2.58. setResultFile
    • 6.2.59. setSolver
    • 6.2.60. setStartTime
    • 6.2.61. setStopTime
    • 6.2.62. setTLMPositionAndOrientation
    • 6.2.63. setTLMSocketData
    • 6.2.64. setTempDirectory
    • 6.2.65. setTolerance
    • 6.2.66. setVariableStepSize
    • 6.2.67. setWorkingDirectory
    • 6.2.68. simulate
    • 6.2.69. stepUntil
    • 6.2.70. terminate
• 7. Graphical Modelling
  • 7.1. New SSP Model
  • 7.2. Add System
  • 7.3. Add SubModel
  • 7.4. Simulate
  • 7.5. Dual Mass Oscillator Example
• 8. SSP Support
  • 8.1. Bus Connections
  • 8.2. TLM Systems
  • 8.3. TLM Connections

Indices and tables

• Index
• Search Page