documentation v1.0.0
diff --git a/content/html/.buildinfo b/content/html/.buildinfo index 880c6c0..304bd5a 100644 --- a/content/html/.buildinfo +++ b/content/html/.buildinfo
@@ -1,4 +1,4 @@ # Sphinx build info version 1 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done. -config: 5c5322868eeb0d158b34023bd1eccbf2 +config: 7831d05765ff8610f4ccfac5873cd537 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/content/html/_downloads/13db75188596730e5b909e7eb9b658b0/PrepareDocCustom.cmake b/content/html/_downloads/13db75188596730e5b909e7eb9b658b0/PrepareDocCustom.cmake index 0f42a6e..12c0acf 100644 --- a/content/html/_downloads/13db75188596730e5b909e7eb9b658b0/PrepareDocCustom.cmake +++ b/content/html/_downloads/13db75188596730e5b909e7eb9b658b0/PrepareDocCustom.cmake
@@ -18,7 +18,6 @@ # # Currently supported PLACEHOLDERS # - @OP_REL_ROOT@ => relative path to root of the openpass repository -# - @OP_REL_GUI@ => resolves to @OP_REL_ROOT@/gui # - @OP_REL_SIM@ => resolves to @OP_REL_ROOT@/sim # - @CUSTOM_REL_SIM@ => relative path to the "custom" root (.) @@ -36,7 +35,6 @@ # Placeholder for conf.py: no initial '/' => real relative paths set(OP_REL_ROOT ../${target}/deps/os) # relative path to the openPASS open source code, with prefix '../${target}' pointing to the custom repository root if this file is located at <root>/doc - set(OP_REL_GUI ${OP_REL_ROOT}/gui) # relative path to gui root set(OP_REL_SIM ${OP_REL_ROOT}/sim) # relative path to simulation root set(CUSTOM_REL_SIM ../${target}) # relative path to the custom repository root (here, equal to custom sim root) @@ -46,7 +44,6 @@ # Placeholder for RST files: use initial '/' => sphinx style for "from source" # Override old one, because we want to use the same placeholder in both contexts set(OP_REL_ROOT /${OP_REL_ROOT}) - set(OP_REL_GUI /${OP_REL_GUI}) set(OP_REL_SIM /${OP_REL_SIM}) set(CUSTOM_REL_SIM /${CUSTOM_REL_SIM})
diff --git a/content/html/_downloads/29dd021e0bdb423fc1a0b9b1d8df02f7/launch.json b/content/html/_downloads/29dd021e0bdb423fc1a0b9b1d8df02f7/launch.json index da44f31..d555aa7 100644 --- a/content/html/_downloads/29dd021e0bdb423fc1a0b9b1d8df02f7/launch.json +++ b/content/html/_downloads/29dd021e0bdb423fc1a0b9b1d8df02f7/launch.json
@@ -32,10 +32,10 @@ "name": "opsimulation", "type": "cppdbg", "request": "launch", - "program": "C:\\OpenPASS\\bin\\core\\opSimulation.exe", + "program": "C:\\openPASS\\bin\\core\\opSimulation.exe", "args": [], "stopAtEntry": false, - "cwd": "C:\\OpenPASS\\bin\\core", + "cwd": "C:\\openPASS\\bin\\core", "environment": [ { "name": "PATH",
diff --git a/content/html/_downloads/631d97fb2e9fb8f8491268ef3e6ec616/settings.json b/content/html/_downloads/631d97fb2e9fb8f8491268ef3e6ec616/settings.json index 2528213..91a8180 100644 --- a/content/html/_downloads/631d97fb2e9fb8f8491268ef3e6ec616/settings.json +++ b/content/html/_downloads/631d97fb2e9fb8f8491268ef3e6ec616/settings.json
@@ -8,9 +8,8 @@ "cmake.configureArgs": [ "-DCMAKE_INSTALL_PREFIX=/openPASS/bin/core", // Adjust paths depending on your system - "-DCMAKE_PREFIX_PATH=${workspaceRoot}/deps/thirdParty/linux64/FMILibrary;${workspaceRoot}/deps/thirdParty/linux64/osi;${workspaceRoot}/deps/thirdParty/linux64/minizip", + "-DCMAKE_PREFIX_PATH=${workspaceFolder}/deps/thirdParty/linux64/minizip;${workspaceFolder}/deps/thirdParty/linux64/FMILibrary;${workspaceFolder}/deps/thirdParty/linux64/protobuf-shared;${workspaceFolder}/deps/thirdParty/linux64/protobuf;${workspaceFolder}/deps/thirdParty/linux64/boost;${workspaceFolder}/deps/thirdParty/linux64/zlib;${workspaceFolder}/deps/thirdParty/linux64/osi;${workspaceFolder}/deps/thirdParty/linux64/units;${workspaceFolder}/deps/thirdParty/linux64/googletest;${workspaceFolder}/deps/thirdParty/linux64/scenario_api;${workspaceFolder}/deps/thirdParty/linux64/openScenario.v1_0.API;${workspaceFolder}/deps/thirdParty/linux64/openScenarioEngine/release", "-DUSE_CCACHE=ON", - "-DWITH_GUI=OFF", "-DWITH_SIMCORE=ON", "-DWITH_TESTS=ON", "-DWITH_DOC=OFF", @@ -30,5 +29,14 @@ // // Enforce usage of .clang-format of modified code "editor.formatOnSave": true, - "editor.formatOnSaveMode": "modifications" -} \ No newline at end of file + "editor.formatOnSaveMode": "modifications", + // EOL and whitespace enforcement + "editor.detectIndentation": true, + "editor.insertSpaces": true, + "editor.renderFinalNewline": "dimmed", + "editor.renderWhitespace": "all", + "editor.trimAutoWhitespace": true, + "files.insertFinalNewline": true, + "files.trimFinalNewlines": true, + "files.trimTrailingWhitespace": true +}
diff --git a/content/html/_downloads/8789748ec2bbe8f70ec8c0763329bc98/VehicleModelsCatalog.xosc b/content/html/_downloads/8789748ec2bbe8f70ec8c0763329bc98/VehicleModelsCatalog.xosc new file mode 100644 index 0000000..0f6f264 --- /dev/null +++ b/content/html/_downloads/8789748ec2bbe8f70ec8c0763329bc98/VehicleModelsCatalog.xosc
@@ -0,0 +1,548 @@ +<?xml version='1.0' encoding='UTF-8'?> +<OpenSCENARIO> + <FileHeader revMajor="1" revMinor="0" date="2020-06-26T00:17:00" description="openPASS vehicle models" author="in-tech GmbH"/> + <Catalog name="VehicleCatalog"> + <Vehicle model3d="car_bmw_i3" mass="1320.0" name="car_bmw_i3" vehicleCategory="car"> + <Properties> + <Property name="AirDragCoefficient" value="0.3"/> + <Property name="AxleRatio" value="1.0"/> + <Property name="DecelerationFromPowertrainDrag" value="0.5"/> + <Property name="FrictionCoefficient" value="1.0"/> + <Property name="FrontSurface" value="2.38"/> + <Property name="GearRatio1" value="9.665"/> + <Property name="MaximumEngineSpeed" value="6000.0"/> + <Property name="MaximumEngineTorque" value="250.0"/> + <Property name="MinimumEngineSpeed" value="900.0"/> + <Property name="MinimumEngineTorque" value="-54.0"/> + <Property name="MomentInertiaPitch" value="0.0"/> + <Property name="MomentInertiaRoll" value="0.0"/> + <Property name="MomentInertiaYaw" value="0.0"/> + <Property name="NumberOfGears" value="1"/> + <Property name="SensorPosition/FrontCenter/Height" value="0.66"/> + <Property name="SensorPosition/FrontCenter/Lateral" value="0.0"/> + <Property name="SensorPosition/FrontCenter/Longitudinal" value="3.26"/> + <Property name="SensorPosition/FrontCenter/Pitch" value="0.0"/> + <Property name="SensorPosition/FrontCenter/Roll" value="0.0"/> + <Property name="SensorPosition/FrontCenter/Yaw" value="0.0"/> + <Property name="SensorPosition/FrontLeft/Height" value="0.82"/> + <Property name="SensorPosition/FrontLeft/Lateral" value="0.68"/> + <Property name="SensorPosition/FrontLeft/Longitudinal" value="2.98"/> + <Property name="SensorPosition/FrontLeft/Pitch" value="0.0"/> + <Property name="SensorPosition/FrontLeft/Roll" value="0.0"/> + <Property name="SensorPosition/FrontLeft/Yaw" value="1.134464"/> + <Property name="SensorPosition/FrontRight/Height" value="0.82"/> + <Property name="SensorPosition/FrontRight/Lateral" value="-0.68"/> + <Property name="SensorPosition/FrontRight/Longitudinal" value="2.98"/> + <Property name="SensorPosition/FrontRight/Pitch" value="0.0"/> + <Property name="SensorPosition/FrontRight/Roll" value="0.0"/> + <Property name="SensorPosition/FrontRight/Yaw" value="-1.134464"/> + <Property name="SensorPosition/FrontWindow/Height" value="1.45"/> + <Property name="SensorPosition/FrontWindow/Lateral" value="0.0"/> + <Property name="SensorPosition/FrontWindow/Longitudinal" value="1.9"/> + <Property name="SensorPosition/FrontWindow/Pitch" value="0.0"/> + <Property name="SensorPosition/FrontWindow/Roll" value="0.0"/> + <Property name="SensorPosition/FrontWindow/Yaw" value="0.0"/> + <Property name="SensorPosition/RearLeft/Height" value="0.64"/> + <Property name="SensorPosition/RearLeft/Lateral" value="0.64"/> + <Property name="SensorPosition/RearLeft/Longitudinal" value="-0.49"/> + <Property name="SensorPosition/RearLeft/Pitch" value="0.0"/> + <Property name="SensorPosition/RearLeft/Roll" value="0.0"/> + <Property name="SensorPosition/RearLeft/Yaw" value="2.146755"/> + <Property name="SensorPosition/RearRight/Height" value="0.64"/> + <Property name="SensorPosition/RearRight/Lateral" value="-0.64"/> + <Property name="SensorPosition/RearRight/Longitudinal" value="-0.49"/> + <Property name="SensorPosition/RearRight/Pitch" value="0.0"/> + <Property name="SensorPosition/RearRight/Roll" value="0.0"/> + <Property name="SensorPosition/RearRight/Yaw" value="-2.146755"/> + <Property name="SensorPosition/RearWindow/Height" value="1.39"/> + <Property name="SensorPosition/RearWindow/Lateral" value="0.0"/> + <Property name="SensorPosition/RearWindow/Longitudinal" value="-0.21"/> + <Property name="SensorPosition/RearWindow/Pitch" value="0.0"/> + <Property name="SensorPosition/RearWindow/Roll" value="0.0"/> + <Property name="SensorPosition/RearWindow/Yaw" value="3.141592"/> + <Property name="SensorPosition/SideLeft/Height" value="0.3"/> + <Property name="SensorPosition/SideLeft/Lateral" value="0.8"/> + <Property name="SensorPosition/SideLeft/Longitudinal" value="1.2"/> + <Property name="SensorPosition/SideLeft/Pitch" value="0.0"/> + <Property name="SensorPosition/SideLeft/Roll" value="0.0"/> + <Property name="SensorPosition/SideLeft/Yaw" value="1.570796"/> + <Property name="SensorPosition/SideRight/Height" value="0.3"/> + <Property name="SensorPosition/SideRight/Lateral" value="-0.8"/> + <Property name="SensorPosition/SideRight/Longitudinal" value="1.2"/> + <Property name="SensorPosition/SideRight/Pitch" value="0.0"/> + <Property name="SensorPosition/SideRight/Roll" value="0.0"/> + <Property name="SensorPosition/SideRight/Yaw" value="-1.570796"/> + <Property name="SteeringRatio" value="10.7"/> + </Properties> + <BoundingBox> + <Center x="1.25" y="0.0" z="0.84"/> + <Dimensions width="2.04" length="3.96" height="1.68"/> + </BoundingBox> + <Performance maxSpeed="41.67" maxAcceleration="9.80665" maxDeceleration="9.80665"/> + <Axles> + <FrontAxle maxSteering="0.5282" wheelDiameter="0.682" trackWidth="1.8" positionX="2.52" positionZ="0.341"/> + <RearAxle maxSteering="0.0" wheelDiameter="0.682" trackWidth="1.8" positionX="0.0" positionZ="0.341"/> + </Axles> + </Vehicle> + <Vehicle model3d="car_bmw_3" mass="1525.0" name="car_bmw_3" vehicleCategory="car"> + <Properties> + <Property name="AirDragCoefficient" value="0.3"/> + <Property name="AxleRatio" value="2.813"/> + <Property name="DecelerationFromPowertrainDrag" value="0.5"/> + <Property name="FrictionCoefficient" value="1.0"/> + <Property name="FrontSurface" value="2.2"/> + <Property name="GearRatio1" value="5.0"/> + <Property name="GearRatio2" value="3.2"/> + <Property name="GearRatio3" value="2.143"/> + <Property name="GearRatio4" value="1.72"/> + <Property name="GearRatio5" value="1.314"/> + <Property name="GearRatio6" value="1.0"/> + <Property name="GearRatio7" value="0.822"/> + <Property name="GearRatio8" value="0.64"/> + <Property name="MaximumEngineSpeed" value="6000.0"/> + <Property name="MaximumEngineTorque" value="270.0"/> + <Property name="MinimumEngineSpeed" value="900.0"/> + <Property name="MinimumEngineTorque" value="-54.0"/> + <Property name="MomentInertiaPitch" value="0.0"/> + <Property name="MomentInertiaRoll" value="0.0"/> + <Property name="MomentInertiaYaw" value="0.0"/> + <Property name="NumberOfGears" value="8"/> + <Property name="SensorPosition/FrontCenter/Height" value="0.56"/> + <Property name="SensorPosition/FrontCenter/Lateral" value="0.0"/> + <Property name="SensorPosition/FrontCenter/Longitudinal" value="3.71"/> + <Property name="SensorPosition/FrontCenter/Pitch" value="0.0"/> + <Property name="SensorPosition/FrontCenter/Roll" value="0.0"/> + <Property name="SensorPosition/FrontCenter/Yaw" value="0.0"/> + <Property name="SensorPosition/FrontLeft/Height" value="0.68"/> + <Property name="SensorPosition/FrontLeft/Lateral" value="0.78"/> + <Property name="SensorPosition/FrontLeft/Longitudinal" value="3.33"/> + <Property name="SensorPosition/FrontLeft/Pitch" value="0.0"/> + <Property name="SensorPosition/FrontLeft/Roll" value="0.0"/> + <Property name="SensorPosition/FrontLeft/Yaw" value="1.134464"/> + <Property name="SensorPosition/FrontRight/Height" value="0.68"/> + <Property name="SensorPosition/FrontRight/Lateral" value="-0.78"/> + <Property name="SensorPosition/FrontRight/Longitudinal" value="3.33"/> + <Property name="SensorPosition/FrontRight/Pitch" value="0.0"/> + <Property name="SensorPosition/FrontRight/Roll" value="0.0"/> + <Property name="SensorPosition/FrontRight/Yaw" value="-1.134464"/> + <Property name="SensorPosition/FrontWindow/Height" value="1.27"/> + <Property name="SensorPosition/FrontWindow/Lateral" value="0.0"/> + <Property name="SensorPosition/FrontWindow/Longitudinal" value="1.82"/> + <Property name="SensorPosition/FrontWindow/Pitch" value="0.0"/> + <Property name="SensorPosition/FrontWindow/Roll" value="0.0"/> + <Property name="SensorPosition/FrontWindow/Yaw" value="0.0"/> + <Property name="SensorPosition/RearLeft/Height" value="0.65"/> + <Property name="SensorPosition/RearLeft/Lateral" value="0.675"/> + <Property name="SensorPosition/RearLeft/Longitudinal" value="-0.65"/> + <Property name="SensorPosition/RearLeft/Pitch" value="0.0"/> + <Property name="SensorPosition/RearLeft/Roll" value="0.0"/> + <Property name="SensorPosition/RearLeft/Yaw" value="2.146755"/> + <Property name="SensorPosition/RearRight/Height" value="0.65"/> + <Property name="SensorPosition/RearRight/Lateral" value="-0.75"/> + <Property name="SensorPosition/RearRight/Longitudinal" value="-0.65"/> + <Property name="SensorPosition/RearRight/Pitch" value="0.0"/> + <Property name="SensorPosition/RearRight/Roll" value="0.0"/> + <Property name="SensorPosition/RearRight/Yaw" value="-2.146755"/> + <Property name="SensorPosition/RearWindow/Height" value="1.31"/> + <Property name="SensorPosition/RearWindow/Lateral" value="0.0"/> + <Property name="SensorPosition/RearWindow/Longitudinal" value="0.16"/> + <Property name="SensorPosition/RearWindow/Pitch" value="0.0"/> + <Property name="SensorPosition/RearWindow/Roll" value="0.0"/> + <Property name="SensorPosition/RearWindow/Yaw" value="3.141592"/> + <Property name="SensorPosition/SideLeft/Height" value="0.21"/> + <Property name="SensorPosition/SideLeft/Lateral" value="0.81"/> + <Property name="SensorPosition/SideLeft/Longitudinal" value="1.21"/> + <Property name="SensorPosition/SideLeft/Pitch" value="0.0"/> + <Property name="SensorPosition/SideLeft/Roll" value="0.0"/> + <Property name="SensorPosition/SideLeft/Yaw" value="1.570796"/> + <Property name="SensorPosition/SideRight/Height" value="0.21"/> + <Property name="SensorPosition/SideRight/Lateral" value="-0.81"/> + <Property name="SensorPosition/SideRight/Longitudinal" value="1.21"/> + <Property name="SensorPosition/SideRight/Pitch" value="0.0"/> + <Property name="SensorPosition/SideRight/Roll" value="0.0"/> + <Property name="SensorPosition/SideRight/Yaw" value="-1.570796"/> + <Property name="SteeringRatio" value="10.7"/> + </Properties> + <BoundingBox> + <Center x="1.285" y="0.0" z="0.72"/> + <Dimensions width="1.96" length="4.63" height="1.44"/> + </BoundingBox> + <Performance maxSpeed="69.44" maxAcceleration="9.80665" maxDeceleration="9.80665"/> + <Axles> + <FrontAxle maxSteering="0.5012" wheelDiameter="0.634" trackWidth="1.8" positionX="2.81" positionZ="0.317"/> + <RearAxle maxSteering="0.0" wheelDiameter="0.634" trackWidth="1.8" positionX="0.0" positionZ="0.317"/> + </Axles> + </Vehicle> + <Vehicle model3d="car_bmw_7_1" mass="1845.0" name="car_bmw_7_1" vehicleCategory="car"> + <Properties> + <Property name="AirDragCoefficient" value="0.3"/> + <Property name="AxleRatio" value="3.077"/> + <Property name="DecelerationFromPowertrainDrag" value="0.5"/> + <Property name="FrictionCoefficient" value="1.0"/> + <Property name="FrontSurface" value="2.42"/> + <Property name="GearRatio1" value="5.0"/> + <Property name="GearRatio2" value="3.2"/> + <Property name="GearRatio3" value="2.143"/> + <Property name="GearRatio4" value="1.72"/> + <Property name="GearRatio5" value="1.314"/> + <Property name="GearRatio6" value="1.0"/> + <Property name="GearRatio7" value="0.822"/> + <Property name="GearRatio8" value="0.64"/> + <Property name="MaximumEngineSpeed" value="6000.0"/> + <Property name="MaximumEngineTorque" value="450.0"/> + <Property name="MinimumEngineSpeed" value="900.0"/> + <Property name="MinimumEngineTorque" value="-54.0"/> + <Property name="MaximumEnginePower" value="200000.0"/> + <Property name="MomentInertiaPitch" value="0.0"/> + <Property name="MomentInertiaRoll" value="0.0"/> + <Property name="MomentInertiaYaw" value="0.0"/> + <Property name="NumberOfGears" value="8"/> + <Property name="SensorPosition/FrontCenter/Height" value="0.6"/> + <Property name="SensorPosition/FrontCenter/Lateral" value="0.0"/> + <Property name="SensorPosition/FrontCenter/Longitudinal" value="4.16"/> + <Property name="SensorPosition/FrontCenter/Pitch" value="0.0"/> + <Property name="SensorPosition/FrontCenter/Roll" value="0.0"/> + <Property name="SensorPosition/FrontCenter/Yaw" value="0.0"/> + <Property name="SensorPosition/FrontLeft/Height" value="0.77"/> + <Property name="SensorPosition/FrontLeft/Lateral" value="0.84"/> + <Property name="SensorPosition/FrontLeft/Longitudinal" value="3.75"/> + <Property name="SensorPosition/FrontLeft/Pitch" value="0.0"/> + <Property name="SensorPosition/FrontLeft/Roll" value="0.0"/> + <Property name="SensorPosition/FrontLeft/Yaw" value="1.134464"/> + <Property name="SensorPosition/FrontRight/Height" value="0.77"/> + <Property name="SensorPosition/FrontRight/Lateral" value="-0.84"/> + <Property name="SensorPosition/FrontRight/Longitudinal" value="3.75"/> + <Property name="SensorPosition/FrontRight/Pitch" value="0.0"/> + <Property name="SensorPosition/FrontRight/Roll" value="0.0"/> + <Property name="SensorPosition/FrontRight/Yaw" value="-1.134464"/> + <Property name="SensorPosition/FrontWindow/Height" value="1.36"/> + <Property name="SensorPosition/FrontWindow/Lateral" value="0.0"/> + <Property name="SensorPosition/FrontWindow/Longitudinal" value="2.05"/> + <Property name="SensorPosition/FrontWindow/Pitch" value="0.0"/> + <Property name="SensorPosition/FrontWindow/Roll" value="0.0"/> + <Property name="SensorPosition/FrontWindow/Yaw" value="0.0"/> + <Property name="SensorPosition/RearLeft/Height" value="0.73"/> + <Property name="SensorPosition/RearLeft/Lateral" value="0.84"/> + <Property name="SensorPosition/RearLeft/Longitudinal" value="-0.75"/> + <Property name="SensorPosition/RearLeft/Pitch" value="0.0"/> + <Property name="SensorPosition/RearLeft/Roll" value="0.0"/> + <Property name="SensorPosition/RearLeft/Yaw" value="2.146755"/> + <Property name="SensorPosition/RearRight/Height" value="0.73"/> + <Property name="SensorPosition/RearRight/Lateral" value="-0.84"/> + <Property name="SensorPosition/RearRight/Longitudinal" value="-0.475"/> + <Property name="SensorPosition/RearRight/Pitch" value="0.0"/> + <Property name="SensorPosition/RearRight/Roll" value="0.0"/> + <Property name="SensorPosition/RearRight/Yaw" value="-2.146755"/> + <Property name="SensorPosition/RearWindow/Height" value="1.41"/> + <Property name="SensorPosition/RearWindow/Lateral" value="0.0"/> + <Property name="SensorPosition/RearWindow/Longitudinal" value="0.26"/> + <Property name="SensorPosition/RearWindow/Pitch" value="0.0"/> + <Property name="SensorPosition/RearWindow/Roll" value="0.0"/> + <Property name="SensorPosition/RearWindow/Yaw" value="3.141592"/> + <Property name="SensorPosition/SideLeft/Height" value="0.23"/> + <Property name="SensorPosition/SideLeft/Lateral" value="0.9"/> + <Property name="SensorPosition/SideLeft/Longitudinal" value="1.34"/> + <Property name="SensorPosition/SideLeft/Pitch" value="0.0"/> + <Property name="SensorPosition/SideLeft/Roll" value="0.0"/> + <Property name="SensorPosition/SideLeft/Yaw" value="1.570796"/> + <Property name="SensorPosition/SideRight/Height" value="0.23"/> + <Property name="SensorPosition/SideRight/Lateral" value="-0.9"/> + <Property name="SensorPosition/SideRight/Longitudinal" value="1.34"/> + <Property name="SensorPosition/SideRight/Pitch" value="0.0"/> + <Property name="SensorPosition/SideRight/Roll" value="0.0"/> + <Property name="SensorPosition/SideRight/Yaw" value="-1.570796"/> + <Property name="SteeringRatio" value="10.7"/> + </Properties> + <BoundingBox> + <Center x="1.46" y="0.0" z="0.755"/> + <Dimensions width="2.18" length="5.26" height="1.51"/> + </BoundingBox> + <Performance maxSpeed="69.44" maxAcceleration="9.80665" maxDeceleration="9.80665"/> + <Axles> + <FrontAxle maxSteering="0.5226" wheelDiameter="0.682" trackWidth="1.8" positionX="3.22" positionZ="0.341"/> + <RearAxle maxSteering="0.0" wheelDiameter="0.682" trackWidth="1.8" positionX="0.0" positionZ="0.341"/> + </Axles> + </Vehicle> + <Vehicle model3d="car_bmw_7_2" mass="1900.0" name="car_bmw_7_2" vehicleCategory="car"> + <Properties> + <Property name="AirDragCoefficient" value="0.3"/> + <Property name="AxleRatio" value="3.077"/> + <Property name="DecelerationFromPowertrainDrag" value="0.5"/> + <Property name="FrictionCoefficient" value="1.0"/> + <Property name="FrontSurface" value="2.42"/> + <Property name="GearRatio1" value="4.714"/> + <Property name="GearRatio2" value="3.143"/> + <Property name="GearRatio3" value="2.106"/> + <Property name="GearRatio4" value="1.667"/> + <Property name="GearRatio5" value="1.285"/> + <Property name="GearRatio6" value="1.0"/> + <Property name="GearRatio7" value="0.839"/> + <Property name="GearRatio8" value="0.667"/> + <Property name="MaximumEngineSpeed" value="6000.0"/> + <Property name="MaximumEngineTorque" value="450.0"/> + <Property name="MinimumEngineSpeed" value="900.0"/> + <Property name="MinimumEngineTorque" value="-54.0"/> + <Property name="MaximumEnginePower" value="200000.0"/> + <Property name="MomentInertiaPitch" value="0.0"/> + <Property name="MomentInertiaRoll" value="0.0"/> + <Property name="MomentInertiaYaw" value="1300.0"/> + <Property name="NumberOfGears" value="8"/> + <Property name="SensorPosition/FrontCenter/Height" value="0.55"/> + <Property name="SensorPosition/FrontCenter/Lateral" value="0.0"/> + <Property name="SensorPosition/FrontCenter/Longitudinal" value="4.2"/> + <Property name="SensorPosition/FrontCenter/Pitch" value="0.0"/> + <Property name="SensorPosition/FrontCenter/Roll" value="0.0"/> + <Property name="SensorPosition/FrontCenter/Yaw" value="0.0"/> + <Property name="SensorPosition/FrontLeft/Height" value="0.75"/> + <Property name="SensorPosition/FrontLeft/Lateral" value="0.86"/> + <Property name="SensorPosition/FrontLeft/Longitudinal" value="3.84"/> + <Property name="SensorPosition/FrontLeft/Pitch" value="0.0"/> + <Property name="SensorPosition/FrontLeft/Roll" value="0.0"/> + <Property name="SensorPosition/FrontLeft/Yaw" value="1.134464"/> + <Property name="SensorPosition/FrontRight/Height" value="0.75"/> + <Property name="SensorPosition/FrontRight/Lateral" value="-0.86"/> + <Property name="SensorPosition/FrontRight/Longitudinal" value="3.84"/> + <Property name="SensorPosition/FrontRight/Pitch" value="0.0"/> + <Property name="SensorPosition/FrontRight/Roll" value="0.0"/> + <Property name="SensorPosition/FrontRight/Yaw" value="-1.134464"/> + <Property name="SensorPosition/FrontWindow/Height" value="1.34"/> + <Property name="SensorPosition/FrontWindow/Lateral" value="0.0"/> + <Property name="SensorPosition/FrontWindow/Longitudinal" value="2.09"/> + <Property name="SensorPosition/FrontWindow/Pitch" value="0.0"/> + <Property name="SensorPosition/FrontWindow/Roll" value="0.0"/> + <Property name="SensorPosition/FrontWindow/Yaw" value="0.0"/> + <Property name="SensorPosition/RearLeft/Height" value="0.69"/> + <Property name="SensorPosition/RearLeft/Lateral" value="0.79"/> + <Property name="SensorPosition/RearLeft/Longitudinal" value="-0.84"/> + <Property name="SensorPosition/RearLeft/Pitch" value="0.0"/> + <Property name="SensorPosition/RearLeft/Roll" value="0.0"/> + <Property name="SensorPosition/RearLeft/Yaw" value="2.146755"/> + <Property name="SensorPosition/RearRight/Height" value="0.69"/> + <Property name="SensorPosition/RearRight/Lateral" value="-0.79"/> + <Property name="SensorPosition/RearRight/Longitudinal" value="-0.84"/> + <Property name="SensorPosition/RearRight/Pitch" value="0.0"/> + <Property name="SensorPosition/RearRight/Roll" value="0.0"/> + <Property name="SensorPosition/RearRight/Yaw" value="-2.146755"/> + <Property name="SensorPosition/RearWindow/Height" value="1.38"/> + <Property name="SensorPosition/RearWindow/Lateral" value="0.0"/> + <Property name="SensorPosition/RearWindow/Longitudinal" value="0.28"/> + <Property name="SensorPosition/RearWindow/Pitch" value="0.0"/> + <Property name="SensorPosition/RearWindow/Roll" value="0.0"/> + <Property name="SensorPosition/RearWindow/Yaw" value="3.141592"/> + <Property name="SensorPosition/SideLeft/Height" value="0.24"/> + <Property name="SensorPosition/SideLeft/Lateral" value="0.91"/> + <Property name="SensorPosition/SideLeft/Longitudinal" value="1.46"/> + <Property name="SensorPosition/SideLeft/Pitch" value="0.0"/> + <Property name="SensorPosition/SideLeft/Roll" value="0.0"/> + <Property name="SensorPosition/SideLeft/Yaw" value="1.570796"/> + <Property name="SensorPosition/SideRight/Height" value="0.24"/> + <Property name="SensorPosition/SideRight/Lateral" value="-0.91"/> + <Property name="SensorPosition/SideRight/Longitudinal" value="1.46"/> + <Property name="SensorPosition/SideRight/Pitch" value="0.0"/> + <Property name="SensorPosition/SideRight/Roll" value="0.0"/> + <Property name="SensorPosition/SideRight/Yaw" value="-1.570796"/> + <Property name="SteeringRatio" value="10.7"/> + </Properties> + <BoundingBox> + <Center x="1.485" y="0.0" z="0.745"/> + <Dimensions width="2.16" length="5.27" height="1.49"/> + </BoundingBox> + <Performance maxSpeed="69.44" maxAcceleration="9.80665" maxDeceleration="9.80665"/> + <Axles> + <FrontAxle maxSteering="0.5279" wheelDiameter="0.682" trackWidth="1.8" positionX="3.25" positionZ="0.341"/> + <RearAxle maxSteering="0.0" wheelDiameter="0.682" trackWidth="1.8" positionX="0.0" positionZ="0.341"/> + </Axles> + </Vehicle> + <Vehicle model3d="car_mini_cooper" mass="1235.0" name="car_mini_cooper" vehicleCategory="car"> + <Properties> + <Property name="AirDragCoefficient" value="0.3"/> + <Property name="AxleRatio" value="3.789"/> + <Property name="DecelerationFromPowertrainDrag" value="0.5"/> + <Property name="FrictionCoefficient" value="1.0"/> + <Property name="FrontSurface" value="2.07"/> + <Property name="GearRatio1" value="4.154"/> + <Property name="GearRatio2" value="2.45"/> + <Property name="GearRatio3" value="1.557"/> + <Property name="GearRatio4" value="1.09"/> + <Property name="GearRatio5" value="0.843"/> + <Property name="GearRatio6" value="0.675"/> + <Property name="GearRatio7" value="0.547"/> + <Property name="MaximumEngineSpeed" value="6000.0"/> + <Property name="MaximumEngineTorque" value="220.0"/> + <Property name="MinimumEngineSpeed" value="900.0"/> + <Property name="MinimumEngineTorque" value="-54.0"/> + <Property name="MomentInertiaPitch" value="0.0"/> + <Property name="MomentInertiaRoll" value="0.0"/> + <Property name="MomentInertiaYaw" value="0.0"/> + <Property name="NumberOfGears" value="7"/> + <Property name="SensorPosition/FrontCenter/Height" value="0.57"/> + <Property name="SensorPosition/FrontCenter/Lateral" value="0.0"/> + <Property name="SensorPosition/FrontCenter/Longitudinal" value="3.22"/> + <Property name="SensorPosition/FrontCenter/Pitch" value="0.0"/> + <Property name="SensorPosition/FrontCenter/Roll" value="0.0"/> + <Property name="SensorPosition/FrontCenter/Yaw" value="0.0"/> + <Property name="SensorPosition/FrontLeft/Height" value="0.65"/> + <Property name="SensorPosition/FrontLeft/Lateral" value="0.65"/> + <Property name="SensorPosition/FrontLeft/Longitudinal" value="3.05"/> + <Property name="SensorPosition/FrontLeft/Pitch" value="0.0"/> + <Property name="SensorPosition/FrontLeft/Roll" value="0.0"/> + <Property name="SensorPosition/FrontLeft/Yaw" value="1.134464"/> + <Property name="SensorPosition/FrontRight/Height" value="0.65"/> + <Property name="SensorPosition/FrontRight/Lateral" value="-0.65"/> + <Property name="SensorPosition/FrontRight/Longitudinal" value="3.05"/> + <Property name="SensorPosition/FrontRight/Pitch" value="0.0"/> + <Property name="SensorPosition/FrontRight/Roll" value="0.0"/> + <Property name="SensorPosition/FrontRight/Yaw" value="-1.134464"/> + <Property name="SensorPosition/FrontWindow/Height" value="1.28"/> + <Property name="SensorPosition/FrontWindow/Lateral" value="0.0"/> + <Property name="SensorPosition/FrontWindow/Longitudinal" value="1.83"/> + <Property name="SensorPosition/FrontWindow/Pitch" value="0.0"/> + <Property name="SensorPosition/FrontWindow/Roll" value="0.0"/> + <Property name="SensorPosition/FrontWindow/Yaw" value="0.0"/> + <Property name="SensorPosition/RearLeft/Height" value="0.6"/> + <Property name="SensorPosition/RearLeft/Lateral" value="0.7"/> + <Property name="SensorPosition/RearLeft/Longitudinal" value="-0.35"/> + <Property name="SensorPosition/RearLeft/Pitch" value="0.0"/> + <Property name="SensorPosition/RearLeft/Roll" value="0.0"/> + <Property name="SensorPosition/RearLeft/Yaw" value="2.146755"/> + <Property name="SensorPosition/RearRight/Height" value="0.6"/> + <Property name="SensorPosition/RearRight/Lateral" value="-0.7"/> + <Property name="SensorPosition/RearRight/Longitudinal" value="-0.35"/> + <Property name="SensorPosition/RearRight/Pitch" value="0.0"/> + <Property name="SensorPosition/RearRight/Roll" value="0.0"/> + <Property name="SensorPosition/RearRight/Yaw" value="-2.146755"/> + <Property name="SensorPosition/RearWindow/Height" value="1.33"/> + <Property name="SensorPosition/RearWindow/Lateral" value="0.0"/> + <Property name="SensorPosition/RearWindow/Longitudinal" value="-0.08"/> + <Property name="SensorPosition/RearWindow/Pitch" value="0.0"/> + <Property name="SensorPosition/RearWindow/Roll" value="0.0"/> + <Property name="SensorPosition/RearWindow/Yaw" value="3.141592"/> + <Property name="SensorPosition/SideLeft/Height" value="0.26"/> + <Property name="SensorPosition/SideLeft/Lateral" value="0.81"/> + <Property name="SensorPosition/SideLeft/Longitudinal" value="1.06"/> + <Property name="SensorPosition/SideLeft/Pitch" value="0.0"/> + <Property name="SensorPosition/SideLeft/Roll" value="0.0"/> + <Property name="SensorPosition/SideLeft/Yaw" value="1.570796"/> + <Property name="SensorPosition/SideRight/Height" value="0.26"/> + <Property name="SensorPosition/SideRight/Lateral" value="-0.81"/> + <Property name="SensorPosition/SideRight/Longitudinal" value="1.06"/> + <Property name="SensorPosition/SideRight/Pitch" value="0.0"/> + <Property name="SensorPosition/SideRight/Roll" value="0.0"/> + <Property name="SensorPosition/SideRight/Yaw" value="-1.570796"/> + <Property name="SteeringRatio" value="10.7"/> + </Properties> + <BoundingBox> + <Center x="1.35" y="0.0" z="0.71"/> + <Dimensions width="1.89" length="3.8" height="1.42"/> + </BoundingBox> + <Performance maxSpeed="58.33" maxAcceleration="9.80665" maxDeceleration="9.80665"/> + <Axles> + <FrontAxle maxSteering="0.4766" wheelDiameter="0.59" trackWidth="1.8" positionX="2.48" positionZ="0.295"/> + <RearAxle maxSteering="0.0" wheelDiameter="0.59" trackWidth="1.8" positionX="0.0" positionZ="0.295"/> + </Axles> + </Vehicle> + <Vehicle model3d="bus" mass="25000.0" name="bus" vehicleCategory="truck"> + <Properties> + <Property name="AirDragCoefficient" value="0.8"/> + <Property name="AxleRatio" value="4.0"/> + <Property name="DecelerationFromPowertrainDrag" value="1.0"/> + <Property name="FrictionCoefficient" value="1.0"/> + <Property name="FrontSurface" value="9.0"/> + <Property name="GearRatio1" value="6.316"/> + <Property name="GearRatio2" value="4.554"/> + <Property name="GearRatio3" value="3.269"/> + <Property name="GearRatio4" value="2.352"/> + <Property name="GearRatio5" value="1.692"/> + <Property name="GearRatio6" value="1.217"/> + <Property name="GearRatio7" value="0.876"/> + <Property name="GearRatio8" value="0.630"/> + <Property name="MaximumEngineSpeed" value="2500.0"/> + <Property name="MaximumEngineTorque" value="1400.0"/> + <Property name="MinimumEngineSpeed" value="600.0"/> + <Property name="MinimumEngineTorque" value="-140.0"/> + <Property name="MomentInertiaPitch" value="0.0"/> + <Property name="MomentInertiaRoll" value="0.0"/> + <Property name="MomentInertiaYaw" value="0.0"/> + <Property name="NumberOfGears" value="8"/> + <Property name="SteeringRatio" value="15.0"/> + </Properties> + <BoundingBox> + <Center x="2.815" y="0.0" z="1.92"/> + <Dimensions width="2.91" length="13.23" height="3.84"/> + </BoundingBox> + <Performance maxSpeed="33.33" maxAcceleration="9.80665" maxDeceleration="9.80665"/> + <Axles> + <FrontAxle maxSteering="0.6972" wheelDiameter="0.808" trackWidth="1.8" positionX="6.64" positionZ="0.404"/> + <RearAxle maxSteering="0.0" wheelDiameter="0.808" trackWidth="1.8" positionX="0.0" positionZ="0.404"/> + </Axles> + </Vehicle> + <Vehicle model3d="truck" mass="30000.0" name="truck" vehicleCategory="truck"> + <Properties> + <Property name="AirDragCoefficient" value="0.8"/> + <Property name="AxleRatio" value="4.0"/> + <Property name="DecelerationFromPowertrainDrag" value="1.0"/> + <Property name="FrictionCoefficient" value="1.0"/> + <Property name="FrontSurface" value="9.0"/> + <Property name="GearRatio1" value="6.316"/> + <Property name="GearRatio2" value="4.554"/> + <Property name="GearRatio3" value="3.269"/> + <Property name="GearRatio4" value="2.352"/> + <Property name="GearRatio5" value="1.692"/> + <Property name="GearRatio6" value="1.217"/> + <Property name="GearRatio7" value="0.876"/> + <Property name="GearRatio8" value="0.630"/> + <Property name="MaximumEngineSpeed" value="2500.0"/> + <Property name="MaximumEngineTorque" value="1400.0"/> + <Property name="MinimumEngineSpeed" value="600.0"/> + <Property name="MinimumEngineTorque" value="-140.0"/> + <Property name="MomentInertiaPitch" value="0.0"/> + <Property name="MomentInertiaRoll" value="0.0"/> + <Property name="MomentInertiaYaw" value="0.0"/> + <Property name="NumberOfGears" value="8"/> + <Property name="SteeringRatio" value="15.0"/> + </Properties> + <BoundingBox> + <Center x="2.685" y="0.0" z="1.74"/> + <Dimensions width="3.16" length="8.83" height="3.48"/> + </BoundingBox> + <Performance maxSpeed="25.0" maxAcceleration="9.80665" maxDeceleration="9.80665"/> + <Axles> + <FrontAxle maxSteering="0.4352" wheelDiameter="0.808" trackWidth="1.8" positionX="4.36" positionZ="0.404"/> + <RearAxle maxSteering="0.0" wheelDiameter="0.808" trackWidth="1.8" positionX="0.0" positionZ="0.404"/> + </Axles> + </Vehicle> + <Vehicle model3d="bicycle" mass="90.0" name="bicycle" vehicleCategory="bicycle"> + <Properties> + <Property name="AirDragCoefficient" value="0.3"/> + <Property name="AxleRatio" value="3.0"/> + <Property name="DecelerationFromPowertrainDrag" value="0.5"/> + <Property name="FrictionCoefficient" value="1.0"/> + <Property name="FrontSurface" value="1.9"/> + <Property name="GearRatio1" value="4.350"/> + <Property name="GearRatio2" value="2.496"/> + <Property name="GearRatio3" value="1.665"/> + <Property name="GearRatio4" value="1.230"/> + <Property name="GearRatio5" value="1.0"/> + <Property name="GearRatio6" value="0.851"/> + <Property name="MaximumEngineSpeed" value="6000.0"/> + <Property name="MaximumEngineTorque" value="540.0"/> + <Property name="MinimumEngineSpeed" value="900.0"/> + <Property name="MinimumEngineTorque" value="-54.0"/> + <Property name="MomentInertiaPitch" value="0.0"/> + <Property name="MomentInertiaRoll" value="0.0"/> + <Property name="MomentInertiaYaw" value="0.0"/> + <Property name="NumberOfGears" value="6"/> + <Property name="SteeringRatio" value="10.7"/> + </Properties> + <BoundingBox> + <Center x="0.175" y="0.0" z="0.9325"/> + <Dimensions width="0.5" length="1.89" height="1.865"/> + </BoundingBox> + <Performance maxSpeed="10.0" maxAcceleration="9.80665" maxDeceleration="9.80665"/> + <Axles> + <FrontAxle maxSteering="1.5708" wheelDiameter="0.636" trackWidth="0.1" positionX="1.04" positionZ="0.318"/> + <RearAxle maxSteering="0.0" wheelDiameter="0.636" trackWidth="0.1" positionX="0.0" positionZ="0.318"/> + </Axles> + </Vehicle> + </Catalog> +</OpenSCENARIO>
diff --git a/content/html/_downloads/bc0ffd4f4913ee64271fcfbe312d1f55/VehicleModelsCatalog.xosc b/content/html/_downloads/bc0ffd4f4913ee64271fcfbe312d1f55/VehicleModelsCatalog.xosc deleted file mode 100644 index bfab9f3..0000000 --- a/content/html/_downloads/bc0ffd4f4913ee64271fcfbe312d1f55/VehicleModelsCatalog.xosc +++ /dev/null
@@ -1,356 +0,0 @@ -<?xml version='1.0' encoding='UTF-8'?> -<OpenSCENARIO> - <FileHeader revMajor="1" revMinor="0" date="2020-06-26T00:17:00" description="openPASS vehicle models" author="in-tech GmbH"/> - <Catalog name="VehicleCatalog"> - <Vehicle name="car_bmw_i3" vehicleCategory="car"> - <Properties> - <Property name="AirDragCoefficient" value="0.3"/> - <Property name="AxleRatio" value="1.0"/> - <Property name="DecelerationFromPowertrainDrag" value="0.5"/> - <Property name="FrictionCoefficient" value="1.0"/> - <Property name="FrontSurface" value="2.38"/> - <Property name="GearRatio1" value="9.665"/> - <Property name="Mass" value="1320.0"/> - <Property name="MaximumEngineSpeed" value="6000.0"/> - <Property name="MaximumEngineTorque" value="250.0"/> - <Property name="MinimumEngineSpeed" value="900.0"/> - <Property name="MinimumEngineTorque" value="-54.0"/> - <Property name="MomentInertiaPitch" value="0.0"/> - <Property name="MomentInertiaRoll" value="0.0"/> - <Property name="MomentInertiaYaw" value="0.0"/> - <Property name="NumberOfGears" value="1"/> - <Property name="SteeringRatio" value="10.7"/> - </Properties> - <BoundingBox> - <Center x="1.25" y="0.0" z="0.84"/> - <Dimensions width="2.04" length="3.96" height="1.68"/> - </BoundingBox> - <Performance maxSpeed="41.67" maxAcceleration="9.80665" maxDeceleration="9.80665"/> - <Axles> - <FrontAxle maxSteering="0.5282" wheelDiameter="0.682" trackWidth="1.8" positionX="2.52" positionZ="0.341"/> - <RearAxle maxSteering="0.0" wheelDiameter="0.682" trackWidth="1.8" positionX="0.0" positionZ="0.341"/> - </Axles> - </Vehicle> - <Vehicle name="car_bmw_3" vehicleCategory="car"> - <Properties> - <Property name="AirDragCoefficient" value="0.3"/> - <Property name="AxleRatio" value="2.813"/> - <Property name="DecelerationFromPowertrainDrag" value="0.5"/> - <Property name="FrictionCoefficient" value="1.0"/> - <Property name="FrontSurface" value="2.2"/> - <Property name="GearRatio1" value="5.0"/> - <Property name="GearRatio2" value="3.2"/> - <Property name="GearRatio3" value="2.143"/> - <Property name="GearRatio4" value="1.72"/> - <Property name="GearRatio5" value="1.314"/> - <Property name="GearRatio6" value="1.0"/> - <Property name="GearRatio7" value="0.822"/> - <Property name="GearRatio8" value="0.64"/> - <Property name="Mass" value="1525.0"/> - <Property name="MaximumEngineSpeed" value="6000.0"/> - <Property name="MaximumEngineTorque" value="270.0"/> - <Property name="MinimumEngineSpeed" value="900.0"/> - <Property name="MinimumEngineTorque" value="-54.0"/> - <Property name="MomentInertiaPitch" value="0.0"/> - <Property name="MomentInertiaRoll" value="0.0"/> - <Property name="MomentInertiaYaw" value="0.0"/> - <Property name="NumberOfGears" value="8"/> - <Property name="SteeringRatio" value="10.7"/> - </Properties> - <BoundingBox> - <Center x="1.285" y="0.0" z="0.72"/> - <Dimensions width="1.96" length="4.63" height="1.44"/> - </BoundingBox> - <Performance maxSpeed="69.44" maxAcceleration="9.80665" maxDeceleration="9.80665"/> - <Axles> - <FrontAxle maxSteering="0.5012" wheelDiameter="0.634" trackWidth="1.8" positionX="2.81" positionZ="0.317"/> - <RearAxle maxSteering="0.0" wheelDiameter="0.634" trackWidth="1.8" positionX="0.0" positionZ="0.317"/> - </Axles> - </Vehicle> - <Vehicle name="car_bmw_7_1" vehicleCategory="car"> - <Properties> - <Property name="AirDragCoefficient" value="0.3"/> - <Property name="AxleRatio" value="3.077"/> - <Property name="DecelerationFromPowertrainDrag" value="0.5"/> - <Property name="FrictionCoefficient" value="1.0"/> - <Property name="FrontSurface" value="2.42"/> - <Property name="GearRatio1" value="5.0"/> - <Property name="GearRatio2" value="3.2"/> - <Property name="GearRatio3" value="2.143"/> - <Property name="GearRatio4" value="1.72"/> - <Property name="GearRatio5" value="1.314"/> - <Property name="GearRatio6" value="1.0"/> - <Property name="GearRatio7" value="0.822"/> - <Property name="GearRatio8" value="0.64"/> - <Property name="Mass" value="1845.0"/> - <Property name="MaximumEngineSpeed" value="6000.0"/> - <Property name="MaximumEngineTorque" value="450.0"/> - <Property name="MinimumEngineSpeed" value="900.0"/> - <Property name="MinimumEngineTorque" value="-54.0"/> - <Property name="MomentInertiaPitch" value="0.0"/> - <Property name="MomentInertiaRoll" value="0.0"/> - <Property name="MomentInertiaYaw" value="0.0"/> - <Property name="NumberOfGears" value="8"/> - <Property name="SteeringRatio" value="10.7"/> - </Properties> - <BoundingBox> - <Center x="1.46" y="0.0" z="0.755"/> - <Dimensions width="2.18" length="5.26" height="1.51"/> - </BoundingBox> - <Performance maxSpeed="69.44" maxAcceleration="9.80665" maxDeceleration="9.80665"/> - <Axles> - <FrontAxle maxSteering="0.5226" wheelDiameter="0.682" trackWidth="1.8" positionX="3.22" positionZ="0.341"/> - <RearAxle maxSteering="0.0" wheelDiameter="0.682" trackWidth="1.8" positionX="0.0" positionZ="0.341"/> - </Axles> - </Vehicle> - <Vehicle name="car_bmw_7_2" vehicleCategory="car"> - <Properties> - <Property name="AirDragCoefficient" value="0.3"/> - <Property name="AxleRatio" value="3.077"/> - <Property name="DecelerationFromPowertrainDrag" value="0.5"/> - <Property name="FrictionCoefficient" value="1.0"/> - <Property name="FrontSurface" value="2.42"/> - <Property name="GearRatio1" value="4.714"/> - <Property name="GearRatio2" value="3.143"/> - <Property name="GearRatio3" value="2.106"/> - <Property name="GearRatio4" value="1.667"/> - <Property name="GearRatio5" value="1.285"/> - <Property name="GearRatio6" value="1.0"/> - <Property name="GearRatio7" value="0.839"/> - <Property name="GearRatio8" value="0.667"/> - <Property name="Mass" value="1900.0"/> - <Property name="MaximumEngineSpeed" value="6000.0"/> - <Property name="MaximumEngineTorque" value="450.0"/> - <Property name="MinimumEngineSpeed" value="900.0"/> - <Property name="MinimumEngineTorque" value="-54.0"/> - <Property name="MomentInertiaPitch" value="0.0"/> - <Property name="MomentInertiaRoll" value="0.0"/> - <Property name="MomentInertiaYaw" value="0.0"/> - <Property name="NumberOfGears" value="8"/> - <Property name="SteeringRatio" value="10.7"/> - </Properties> - <BoundingBox> - <Center x="1.485" y="0.0" z="0.745"/> - <Dimensions width="2.16" length="5.27" height="1.49"/> - </BoundingBox> - <Performance maxSpeed="69.44" maxAcceleration="9.80665" maxDeceleration="9.80665"/> - <Axles> - <FrontAxle maxSteering="0.5279" wheelDiameter="0.682" trackWidth="1.8" positionX="3.25" positionZ="0.341"/> - <RearAxle maxSteering="0.0" wheelDiameter="0.682" trackWidth="1.8" positionX="0.0" positionZ="0.341"/> - </Axles> - </Vehicle> - <Vehicle name="car_mini_cooper" vehicleCategory="car"> - <Properties> - <Property name="AirDragCoefficient" value="0.3"/> - <Property name="AxleRatio" value="3.789"/> - <Property name="DecelerationFromPowertrainDrag" value="0.5"/> - <Property name="FrictionCoefficient" value="1.0"/> - <Property name="FrontSurface" value="2.07"/> - <Property name="GearRatio1" value="4.154"/> - <Property name="GearRatio2" value="2.45"/> - <Property name="GearRatio3" value="1.557"/> - <Property name="GearRatio4" value="1.09"/> - <Property name="GearRatio5" value="0.843"/> - <Property name="GearRatio6" value="0.675"/> - <Property name="GearRatio7" value="0.547"/> - <Property name="Mass" value="1235.0"/> - <Property name="MaximumEngineSpeed" value="6000.0"/> - <Property name="MaximumEngineTorque" value="220.0"/> - <Property name="MinimumEngineSpeed" value="900.0"/> - <Property name="MinimumEngineTorque" value="-54.0"/> - <Property name="MomentInertiaPitch" value="0.0"/> - <Property name="MomentInertiaRoll" value="0.0"/> - <Property name="MomentInertiaYaw" value="0.0"/> - <Property name="NumberOfGears" value="7"/> - <Property name="SteeringRatio" value="10.7"/> - </Properties> - <BoundingBox> - <Center x="1.35" y="0.0" z="0.71"/> - <Dimensions width="1.89" length="3.8" height="1.42"/> - </BoundingBox> - <Performance maxSpeed="58.33" maxAcceleration="9.80665" maxDeceleration="9.80665"/> - <Axles> - <FrontAxle maxSteering="0.4766" wheelDiameter="0.59" trackWidth="1.8" positionX="2.48" positionZ="0.295"/> - <RearAxle maxSteering="0.0" wheelDiameter="0.59" trackWidth="1.8" positionX="0.0" positionZ="0.295"/> - </Axles> - </Vehicle> - <Vehicle name="car_oldtimer" vehicleCategory="car"> - <Properties> - <Property name="AirDragCoefficient" value="0.3"/> - <Property name="AxleRatio" value="2.813"/> - <Property name="DecelerationFromPowertrainDrag" value="0.5"/> - <Property name="FrictionCoefficient" value="1.0"/> - <Property name="FrontSurface" value="2.2"/> - <Property name="GearRatio1" value="5.0"/> - <Property name="GearRatio2" value="3.2"/> - <Property name="GearRatio3" value="2.143"/> - <Property name="GearRatio4" value="1.72"/> - <Property name="GearRatio5" value="1.314"/> - <Property name="GearRatio6" value="1.0"/> - <Property name="GearRatio7" value="0.822"/> - <Property name="GearRatio8" value="0.64"/> - <Property name="Mass" value="1525.0"/> - <Property name="MaximumEngineSpeed" value="6000.0"/> - <Property name="MaximumEngineTorque" value="270.0"/> - <Property name="MinimumEngineSpeed" value="900.0"/> - <Property name="MinimumEngineTorque" value="-54.0"/> - <Property name="MomentInertiaPitch" value="0.0"/> - <Property name="MomentInertiaRoll" value="0.0"/> - <Property name="MomentInertiaYaw" value="0.0"/> - <Property name="NumberOfGears" value="8"/> - <Property name="SteeringRatio" value="10.7"/> - </Properties> - <BoundingBox> - <Center x="1.2" y="0.0" z="0.675"/> - <Dimensions width="1.68" length="3.89" height="1.35"/> - </BoundingBox> - <Performance maxSpeed="40.0" maxAcceleration="9.80665" maxDeceleration="9.80665"/> - <Axles> - <FrontAxle maxSteering="0.5012" wheelDiameter="0.634" trackWidth="1.4" positionX="2.81" positionZ="0.317"/> - <RearAxle maxSteering="0.0" wheelDiameter="0.634" trackWidth="1.4" positionX="0.0" positionZ="0.317"/> - </Axles> - </Vehicle> - <Vehicle name="bus" vehicleCategory="truck"> - <Properties> - <Property name="AirDragCoefficient" value="0.8"/> - <Property name="AxleRatio" value="4.0"/> - <Property name="DecelerationFromPowertrainDrag" value="1.0"/> - <Property name="FrictionCoefficient" value="1.0"/> - <Property name="FrontSurface" value="9.0"/> - <Property name="GearRatio1" value="6.316"/> - <Property name="GearRatio2" value="4.554"/> - <Property name="GearRatio3" value="3.269"/> - <Property name="GearRatio4" value="2.352"/> - <Property name="GearRatio5" value="1.692"/> - <Property name="GearRatio6" value="1.217"/> - <Property name="GearRatio7" value="0.876"/> - <Property name="GearRatio8" value="0.630"/> - <Property name="Mass" value="25000.0"/> - <Property name="MaximumEngineSpeed" value="2500.0"/> - <Property name="MaximumEngineTorque" value="1400.0"/> - <Property name="MinimumEngineSpeed" value="600.0"/> - <Property name="MinimumEngineTorque" value="-140.0"/> - <Property name="MomentInertiaPitch" value="0.0"/> - <Property name="MomentInertiaRoll" value="0.0"/> - <Property name="MomentInertiaYaw" value="0.0"/> - <Property name="NumberOfGears" value="8"/> - <Property name="SteeringRatio" value="15.0"/> - </Properties> - <BoundingBox> - <Center x="2.815" y="0.0" z="1.92"/> - <Dimensions width="2.91" length="13.23" height="3.84"/> - </BoundingBox> - <Performance maxSpeed="33.33" maxAcceleration="9.80665" maxDeceleration="9.80665"/> - <Axles> - <FrontAxle maxSteering="0.6972" wheelDiameter="0.808" trackWidth="1.8" positionX="6.64" positionZ="0.404"/> - <RearAxle maxSteering="0.0" wheelDiameter="0.808" trackWidth="1.8" positionX="0.0" positionZ="0.404"/> - </Axles> - </Vehicle> - <Vehicle name="truck" vehicleCategory="truck"> - <Properties> - <Property name="AirDragCoefficient" value="0.8"/> - <Property name="AxleRatio" value="4.0"/> - <Property name="DecelerationFromPowertrainDrag" value="1.0"/> - <Property name="FrictionCoefficient" value="1.0"/> - <Property name="FrontSurface" value="9.0"/> - <Property name="GearRatio1" value="6.316"/> - <Property name="GearRatio2" value="4.554"/> - <Property name="GearRatio3" value="3.269"/> - <Property name="GearRatio4" value="2.352"/> - <Property name="GearRatio5" value="1.692"/> - <Property name="GearRatio6" value="1.217"/> - <Property name="GearRatio7" value="0.876"/> - <Property name="GearRatio8" value="0.630"/> - <Property name="Mass" value="30000.0"/> - <Property name="MaximumEngineSpeed" value="2500.0"/> - <Property name="MaximumEngineTorque" value="1400.0"/> - <Property name="MinimumEngineSpeed" value="600.0"/> - <Property name="MinimumEngineTorque" value="-140.0"/> - <Property name="MomentInertiaPitch" value="0.0"/> - <Property name="MomentInertiaRoll" value="0.0"/> - <Property name="MomentInertiaYaw" value="0.0"/> - <Property name="NumberOfGears" value="8"/> - <Property name="SteeringRatio" value="15.0"/> - </Properties> - <BoundingBox> - <Center x="2.685" y="0.0" z="1.74"/> - <Dimensions width="3.16" length="8.83" height="3.48"/> - </BoundingBox> - <Performance maxSpeed="25.0" maxAcceleration="9.80665" maxDeceleration="9.80665"/> - <Axles> - <FrontAxle maxSteering="0.4352" wheelDiameter="0.808" trackWidth="1.8" positionX="4.36" positionZ="0.404"/> - <RearAxle maxSteering="0.0" wheelDiameter="0.808" trackWidth="1.8" positionX="0.0" positionZ="0.404"/> - </Axles> - </Vehicle> - <Vehicle name="lorry" vehicleCategory="truck"> - <Properties> - <Property name="AirDragCoefficient" value="0.8"/> - <Property name="AxleRatio" value="4.0"/> - <Property name="DecelerationFromPowertrainDrag" value="1.0"/> - <Property name="FrictionCoefficient" value="1.0"/> - <Property name="FrontSurface" value="9.0"/> - <Property name="GearRatio1" value="6.316"/> - <Property name="GearRatio2" value="4.554"/> - <Property name="GearRatio3" value="3.269"/> - <Property name="GearRatio4" value="2.352"/> - <Property name="GearRatio5" value="1.692"/> - <Property name="GearRatio6" value="1.217"/> - <Property name="GearRatio7" value="0.876"/> - <Property name="GearRatio8" value="0.630"/> - <Property name="Mass" value="30000.0"/> - <Property name="MaximumEngineSpeed" value="2500.0"/> - <Property name="MaximumEngineTorque" value="1400.0"/> - <Property name="MinimumEngineSpeed" value="600.0"/> - <Property name="MinimumEngineTorque" value="-140.0"/> - <Property name="MomentInertiaPitch" value="0.0"/> - <Property name="MomentInertiaRoll" value="0.0"/> - <Property name="MomentInertiaYaw" value="0.0"/> - <Property name="NumberOfGears" value="8"/> - <Property name="SteeringRatio" value="15.0"/> - </Properties> - <BoundingBox> - <Center x="2.11" y="0.0" z="1.7"/> - <Dimensions width="2.93" length="8.47" height="3.4"/> - </BoundingBox> - <Performance maxSpeed="25.0" maxAcceleration="9.80665" maxDeceleration="9.80665"/> - <Axles> - <FrontAxle maxSteering="0.4352" wheelDiameter="0.808" trackWidth="1.8" positionX="4.36" positionZ="0.404"/> - <RearAxle maxSteering="0.0" wheelDiameter="0.808" trackWidth="1.8" positionX="0.0" positionZ="0.404"/> - </Axles> - </Vehicle> - <Vehicle name="bicycle" vehicleCategory="bicycle"> - <Properties> - <Property name="AirDragCoefficient" value="0.3"/> - <Property name="AxleRatio" value="3.0"/> - <Property name="DecelerationFromPowertrainDrag" value="0.5"/> - <Property name="FrictionCoefficient" value="1.0"/> - <Property name="FrontSurface" value="1.9"/> - <Property name="GearRatio1" value="4.350"/> - <Property name="GearRatio2" value="2.496"/> - <Property name="GearRatio3" value="1.665"/> - <Property name="GearRatio4" value="1.230"/> - <Property name="GearRatio5" value="1.0"/> - <Property name="GearRatio6" value="0.851"/> - <Property name="Mass" value="90.0"/> - <Property name="MaximumEngineSpeed" value="6000.0"/> - <Property name="MaximumEngineTorque" value="540.0"/> - <Property name="MinimumEngineSpeed" value="900.0"/> - <Property name="MinimumEngineTorque" value="-54.0"/> - <Property name="MomentInertiaPitch" value="0.0"/> - <Property name="MomentInertiaRoll" value="0.0"/> - <Property name="MomentInertiaYaw" value="0.0"/> - <Property name="NumberOfGears" value="6"/> - <Property name="SteeringRatio" value="10.7"/> - </Properties> - <BoundingBox> - <Center x="0.175" y="0.0" z="0.9325"/> - <Dimensions width="0.5" length="1.89" height="1.865"/> - </BoundingBox> - <Performance maxSpeed="10.0" maxAcceleration="9.80665" maxDeceleration="9.80665"/> - <Axles> - <FrontAxle maxSteering="1.5708" wheelDiameter="0.636" trackWidth="0.1" positionX="1.04" positionZ="0.318"/> - <RearAxle maxSteering="0.0" wheelDiameter="0.636" trackWidth="0.1" positionX="0.0" positionZ="0.318"/> - </Axles> - </Vehicle> - </Catalog> -</OpenSCENARIO>
diff --git a/content/html/_downloads/c182e909c0bef397a2a7e7c51c6f7763/conf.py b/content/html/_downloads/c182e909c0bef397a2a7e7c51c6f7763/conf.py index c2d9d09..c7cee5f 100644 --- a/content/html/_downloads/c182e909c0bef397a2a7e7c51c6f7763/conf.py +++ b/content/html/_downloads/c182e909c0bef397a2a7e7c51c6f7763/conf.py
@@ -20,7 +20,7 @@ # -- Project information ----------------------------------------------------- project = 'openPASS' -copyright = f'{datetime.datetime.now().year} OpenPASS Working Group' +copyright = f'{datetime.datetime.now().year} openPASS Working Group' author = 'in-tech GmbH' # -- Version is generated via cmake @@ -58,8 +58,8 @@ html_static_path = ['_static'] html_theme = 'sphinx_rtd_theme' -html_title = 'OpenPASS Documentation' -html_short_title = 'OpenPASS|Doc' +html_title = 'openPASS Documentation' +html_short_title = 'openPASS|Doc' html_favicon = '_static/openPASS.ico' html_logo = '_static/openPASS.png' @@ -71,10 +71,8 @@ rst_epilog = """ .. |op| replace:: **openPASS** -.. |Op| replace:: **OpenPASS** .. |opwg| replace:: **openPASS** Working Group .. |op_oss| replace:: **openPASS** (Open Source) -.. |Op_oss| replace:: **OpenPASS** (Open Source) .. |mingw_shell| replace:: ``MinGW 64-bit`` shell """
diff --git a/content/html/_downloads/cf3a708e6048855aab4490b408d22f7c/settings.json b/content/html/_downloads/cf3a708e6048855aab4490b408d22f7c/settings.json index 82ee219..b1d2333 100644 --- a/content/html/_downloads/cf3a708e6048855aab4490b408d22f7c/settings.json +++ b/content/html/_downloads/cf3a708e6048855aab4490b408d22f7c/settings.json
@@ -13,12 +13,11 @@ "cmake.parallelJobs": 4, // See openPASS documentation for individual WITH_* settings "cmake.configureArgs": [ - "-DCMAKE_INSTALL_PREFIX=C:\\OpenPASS\\bin\\core", + "-DCMAKE_INSTALL_PREFIX=C:\\openPASS\\bin\\core", // Adjust paths depending on your system - "-DCMAKE_PREFIX_PATH=${workspaceRoot}/deps/thirdParty/win64/FMILibrary;${workspaceRoot}/deps/thirdParty/win64/osi;${workspaceRoot}/deps/thirdParty/win64/minizip;${command:mingw64.root};${command:mingw64.root}/bin;${command:mingw64.root}/lib", + "-DCMAKE_PREFIX_PATH=${workspaceFolder}/deps/thirdParty/win64/minizip;${workspaceFolder}/deps/thirdParty/win64/FMILibrary;${workspaceFolder}/deps/thirdParty/win64/protobuf-shared;${workspaceFolder}/deps/thirdParty/win64/protobuf;${workspaceFolder}/deps/thirdParty/win64/zlib;${workspaceFolder}/deps/thirdParty/win64/osi;${workspaceFolder}/deps/thirdParty/win64/units;${workspaceFolder}/deps/thirdParty/win64/googletest;${workspaceFolder}/deps/thirdParty/win64/scenario_api;${workspaceFolder}/deps/thirdParty/win64/openScenario.v1_0.API;${workspaceFolder}/deps/thirdParty/win64/openScenarioEngine/release;${command:mingw64.root};${command:mingw64.root}/bin;${command:mingw64.root}/lib", "-DUSE_CCACHE=ON", "-DCMAKE_BUILD_TYPE=Debug", - "-DWITH_GUI=OFF", "-DWITH_SIMCORE=ON", "-DWITH_TESTS=ON", "-DWITH_DOC=OFF", @@ -36,16 +35,16 @@ "testMate.cpp.test.parallelExecutionOfExecutableLimit": 2, // Optional: Set, if you like to debug test discovery and test start issues "testMate.cpp.log.logfile": "C:\\temp\\cpp.testmate.log", - // Optional: As CTest triggers the install step, dependencies between test executables + // Optional: As CTest triggers the install step, dependencies between test executables // and openpass libraries can be resolved by linking text executables to // openpass install directory - // Alternative: Check dependencies of test executables by 'ldd <_Tests.exe> and copy + // Alternative: Check dependencies of test executables by 'ldd <_Tests.exe> and copy // libraries right next to test executable within build direcory "testMate.cpp.test.advancedExecutables": [ { "pattern": "build/**/*{tests,Tests,TESTS}*", "env": { - "Path": "C:\\msys64\\mingw64\\bin;C:\\OpenPASS\\bin\\core;C:\\OpenPASS\\bin\\core\\lib;${os_env:PATH};${workspaceFolder}\\deps\\thirdParty\\win64\\FMILibrary\\lib;${workspaceFolder}\\deps\\thirdParty\\win64\\osi\\lib\\osi3" + "Path": "C:\\msys64\\mingw64\\bin;C:\\openPASS\\bin\\core;C:\\openPASS\\bin\\core\\lib;${os_env:PATH};${workspaceFolder}\\deps\\thirdParty\\win64\\FMILibrary\\lib;${workspaceFolder}\\deps\\thirdParty\\win64\\osi\\lib\\osi3" } } ], @@ -71,5 +70,12 @@ "terminal.integrated.defaultProfile.windows": "MinGW64", // Enforce usage of .clang-format of modified code "editor.formatOnSave": true, - "editor.formatOnSaveMode": "modifications" -} \ No newline at end of file + "editor.formatOnSaveMode": "modifications", + // EOL and whitespace enforcement + "editor.detectIndentation": true, + "editor.insertSpaces": true, + "editor.renderFinalNewline": "dimmed", + "files.insertFinalNewline": true, + "files.trimFinalNewlines": true, + "files.trimTrailingWhitespace": true +}
diff --git a/content/html/_downloads/dca649c6abf7935b694a9b820bb4efc5/c_cpp_properties.json b/content/html/_downloads/dca649c6abf7935b694a9b820bb4efc5/c_cpp_properties.json index 5aa4f69..42788dc 100644 --- a/content/html/_downloads/dca649c6abf7935b694a9b820bb4efc5/c_cpp_properties.json +++ b/content/html/_downloads/dca649c6abf7935b694a9b820bb4efc5/c_cpp_properties.json
@@ -1,7 +1,7 @@ { "configurations": [ { - "name": "simopenpass", + "name": "openpass", "cStandard": "c99", "cppStandard": "c++17", "configurationProvider": "ms-vscode.cmake-tools",
diff --git a/content/html/_downloads/459c8430e19638f5201d47052051994a/PedestrianModelsCatalog.xosc b/content/html/_downloads/e127566572084ecb8640fe52563f5060/PedestrianModelsCatalog.xosc similarity index 62% rename from content/html/_downloads/459c8430e19638f5201d47052051994a/PedestrianModelsCatalog.xosc rename to content/html/_downloads/e127566572084ecb8640fe52563f5060/PedestrianModelsCatalog.xosc index a9fb9b3..32c4e37 100644 --- a/content/html/_downloads/459c8430e19638f5201d47052051994a/PedestrianModelsCatalog.xosc +++ b/content/html/_downloads/e127566572084ecb8640fe52563f5060/PedestrianModelsCatalog.xosc
@@ -2,25 +2,21 @@ <OpenSCENARIO> <FileHeader revMajor="1" revMinor="0" date="2020-06-26T00:17:00" description="openPASS pedestrian models" author="in-tech GmbH"/> <Catalog name="PedestrianCatalog"> - <Pedestrian model="pedestrian_child" mass="30.0" name="pedestrian_child" pedestrianCategory="pedestrian"> + <Pedestrian model3d="pedestrian_child" mass="30.0" name="pedestrian_child" pedestrianCategory="pedestrian"> <ParameterDeclarations/> - <Properties> - <Property name="Mass" value="30.0"/> - </Properties> <BoundingBox> <Center x="0.0" y="0.0" z="0.577"/> <Dimensions width="0.298" length="0.711" height="1.154"/> </BoundingBox> + <Properties/> </Pedestrian> - <Pedestrian model="pedestrian_adult" mass="70.0" name="pedestrian_adult" pedestrianCategory="pedestrian"> + <Pedestrian model3d="pedestrian_adult" mass="70.0" name="pedestrian_adult" pedestrianCategory="pedestrian"> <ParameterDeclarations/> - <Properties> - <Property name="Mass" value="70.0"/> - </Properties> <BoundingBox> <Center x="0.0" y="0.0" z="0.9"/> <Dimensions width="0.5" length="0.6" height="1.8"/> </BoundingBox> + <Properties/> </Pedestrian> </Catalog> </OpenSCENARIO>
diff --git a/content/html/_images/VehicleDynamicsOverview.svg b/content/html/_images/VehicleDynamicsOverview.svg new file mode 100644 index 0000000..1320f8d --- /dev/null +++ b/content/html/_images/VehicleDynamicsOverview.svg
@@ -0,0 +1 @@ +<svg width="4430" height="1496" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" xml:space="preserve" overflow="hidden"><defs><clipPath id="clip0"><rect x="-15" y="439" width="4430" height="1496"/></clipPath></defs><g clip-path="url(#clip0)" transform="translate(15 -439)"><rect x="390.5" y="441.5" width="714" height="226" stroke="#000000" stroke-width="4.58333" stroke-miterlimit="8" fill="#FFFFFF"/><text font-family="Times New Roman,Times New Roman_MSFontService,sans-serif" font-weight="400" font-size="64" transform="matrix(1 0 0 1 518.931 578)">ActionPowertrain</text><rect x="390.5" y="1074.5" width="714" height="226" stroke="#000000" stroke-width="4.58333" stroke-miterlimit="8" fill="#FFFFFF"/><text font-family="Times New Roman,Times New Roman_MSFontService,sans-serif" font-weight="400" font-size="64" transform="matrix(1 0 0 1 488.28 1210)">ActionBrakeSystem</text><rect x="390.5" y="1707.5" width="714" height="225" stroke="#000000" stroke-width="4.58333" stroke-miterlimit="8" fill="#FFFFFF"/><text font-family="Times New Roman,Times New Roman_MSFontService,sans-serif" font-weight="400" font-size="64" transform="matrix(1 0 0 1 458.202 1843)">ActionSteeringSystem</text><rect x="1647.5" y="1064.5" width="715" height="226" stroke="#000000" stroke-width="4.58333" stroke-miterlimit="8" fill="#FFFFFF"/><text font-family="Times New Roman,Times New Roman_MSFontService,sans-serif" font-weight="400" font-size="64" transform="matrix(1 0 0 1 1737.93 1200)">DynamicsTireModel</text><rect x="2647.5" y="1067.5" width="715" height="226" stroke="#000000" stroke-width="4.58333" stroke-miterlimit="8" fill="#FFFFFF"/><text font-family="Times New Roman,Times New Roman_MSFontService,sans-serif" font-weight="400" font-size="64" transform="matrix(1 0 0 1 2695.94 1204)">DynamicsMotionModel</text><rect x="3604.5" y="1064.5" width="715" height="226" stroke="#000000" stroke-width="4.58333" stroke-miterlimit="8" fill="#FFFFFF"/><text font-family="Times New Roman,Times New Roman_MSFontService,sans-serif" font-weight="400" font-size="64" transform="matrix(1 0 0 1 3732.82 1200)">DynamicsChassis</text><path d="M1104.5 556C1104.5 538.051 1119.05 523.5 1137 523.5 1154.95 523.5 1169.5 538.051 1169.5 556 1169.5 573.949 1154.95 588.5 1137 588.5 1119.05 588.5 1104.5 573.949 1104.5 556Z" stroke="#000000" stroke-width="4.58333" stroke-miterlimit="8" fill="#FFFFFF" fill-rule="evenodd"/><path d="M325.5 555C325.5 537.051 340.051 522.5 358 522.5 375.949 522.5 390.5 537.051 390.5 555 390.5 572.949 375.949 587.5 358 587.5 340.051 587.5 325.5 572.949 325.5 555Z" stroke="#000000" stroke-width="4.58333" stroke-miterlimit="8" fill="#FFFFFF" fill-rule="evenodd"/><path d="M1102.5 1186C1102.5 1168.05 1117.05 1153.5 1135 1153.5 1152.95 1153.5 1167.5 1168.05 1167.5 1186 1167.5 1203.95 1152.95 1218.5 1135 1218.5 1117.05 1218.5 1102.5 1203.95 1102.5 1186Z" stroke="#000000" stroke-width="4.58333" stroke-miterlimit="8" fill="#FFFFFF" fill-rule="evenodd"/><path d="M325.5 1187C325.5 1169.05 340.051 1154.5 358 1154.5 375.949 1154.5 390.5 1169.05 390.5 1187 390.5 1204.95 375.949 1219.5 358 1219.5 340.051 1219.5 325.5 1204.95 325.5 1187Z" stroke="#000000" stroke-width="4.58333" stroke-miterlimit="8" fill="#FFFFFF" fill-rule="evenodd"/><path d="M325.5 1820C325.5 1802.05 340.051 1787.5 358 1787.5 375.949 1787.5 390.5 1802.05 390.5 1820 390.5 1837.95 375.949 1852.5 358 1852.5 340.051 1852.5 325.5 1837.95 325.5 1820Z" stroke="#000000" stroke-width="4.58333" stroke-miterlimit="8" fill="#FFFFFF" fill-rule="evenodd"/><path d="M1102.5 1820C1102.5 1802.05 1117.05 1787.5 1135 1787.5 1152.95 1787.5 1167.5 1802.05 1167.5 1820 1167.5 1837.95 1152.95 1852.5 1135 1852.5 1117.05 1852.5 1102.5 1837.95 1102.5 1820Z" stroke="#000000" stroke-width="4.58333" stroke-miterlimit="8" fill="#FFFFFF" fill-rule="evenodd"/><path d="M25.0001 552.854 302.041 552.855 302.041 555.146 25.0001 555.146ZM297.458 540.25 324.958 554 297.458 567.75Z"/><path d="M27.9998 1185.85 301.332 1185.85 301.332 1188.15 27.9998 1188.15ZM296.749 1173.25 324.248 1187 296.748 1200.75Z"/><path d="M25.0001 1818.85 302.041 1818.85 302.041 1821.15 25.0001 1821.15ZM297.458 1806.25 324.958 1820 297.458 1833.75Z"/><path d="M1582.5 1186C1582.5 1168.05 1597.05 1153.5 1615 1153.5 1632.95 1153.5 1647.5 1168.05 1647.5 1186 1647.5 1203.95 1632.95 1218.5 1615 1218.5 1597.05 1218.5 1582.5 1203.95 1582.5 1186Z" stroke="#000000" stroke-width="4.58333" stroke-miterlimit="8" fill="#FFFFFF" fill-rule="evenodd"/><path d="M1169 553.854 1422.84 553.854 1422.84 1185.25 1421.69 1184.1 1558.84 1184.1 1558.84 1186.39 1420.55 1186.39 1420.55 555 1421.69 556.146 1169 556.146ZM1554.26 1171.5 1581.76 1185.25 1554.26 1199Z"/><path d="M0-1.14583 448.776-1.14583 448.776 578.488 446.485 578.488 446.485 0 447.63 1.14583 0 1.14583ZM461.38 573.905 447.63 601.405 433.88 573.905Z" transform="matrix(1 0 0 -1 1167 1819.41)"/><path d="M9.9608e-07-1.14583 392.233-1.14549 392.233 1.14617-9.9608e-07 1.14583ZM387.65-13.7497 415.15 0.000360892 387.65 13.7503Z" transform="matrix(1 0 0 -1 1167 1186)"/><path d="M2.82573e-06-1.14583 123.425-1.14553 123.425 1.14614-2.82573e-06 1.14583ZM118.842-13.7497 146.342 0.000360892 118.842 13.7503Z" transform="matrix(1 0 0 -1 1436 1186)"/><path d="M2362.5 1186C2362.5 1168.05 2377.05 1153.5 2395 1153.5 2412.95 1153.5 2427.5 1168.05 2427.5 1186 2427.5 1203.95 2412.95 1218.5 2395 1218.5 2377.05 1218.5 2362.5 1203.95 2362.5 1186Z" stroke="#000000" stroke-width="4.58333" stroke-miterlimit="8" fill="#FFFFFF" fill-rule="evenodd"/><path d="M2583.5 1187C2583.5 1169.05 2598.05 1154.5 2616 1154.5 2633.95 1154.5 2648.5 1169.05 2648.5 1187 2648.5 1204.95 2633.95 1219.5 2616 1219.5 2598.05 1219.5 2583.5 1204.95 2583.5 1187Z" stroke="#000000" stroke-width="4.58333" stroke-miterlimit="8" fill="#FFFFFF" fill-rule="evenodd"/><path d="M3362.5 1184C3362.5 1166.05 3377.05 1151.5 3395 1151.5 3412.95 1151.5 3427.5 1166.05 3427.5 1184 3427.5 1201.95 3412.95 1216.5 3395 1216.5 3377.05 1216.5 3362.5 1201.95 3362.5 1184Z" stroke="#000000" stroke-width="4.58333" stroke-miterlimit="8" fill="#FFFFFF" fill-rule="evenodd"/><path d="M3539.5 1181C3539.5 1163.05 3554.05 1148.5 3572 1148.5 3589.95 1148.5 3604.5 1163.05 3604.5 1181 3604.5 1198.95 3589.95 1213.5 3572 1213.5 3554.05 1213.5 3539.5 1198.95 3539.5 1181Z" stroke="#000000" stroke-width="4.58333" stroke-miterlimit="8" fill="#FFFFFF" fill-rule="evenodd"/><path d="M2427 1184.85 2560.35 1185.22 2560.34 1187.51 2427 1187.15ZM2555.8 1172.6 2583.26 1186.43 2555.73 1200.1Z"/><path d="M0.0334134-1.14535 89.6008 1.46762 89.5339 3.75831-0.0334134 1.14535ZM85.3869-11.2648 112.474 3.28123 84.585 16.2235Z" transform="matrix(1 0 0 -1 3427 1183.28)"/><path d="M0-1.14583 1449.69-1.14583 1449.69 578.064 1447.4 578.064 1447.4 0 1448.54 1.14583 0 1.14583ZM1462.29 573.48 1448.54 600.98 1434.79 573.48Z" transform="matrix(1 0 0 -1 1167 1819.98)"/><path d="M4319.5 1177.5C4319.5 1159.83 4334.05 1145.5 4352 1145.5 4369.95 1145.5 4384.5 1159.83 4384.5 1177.5 4384.5 1195.17 4369.95 1209.5 4352 1209.5 4334.05 1209.5 4319.5 1195.17 4319.5 1177.5Z" stroke="#000000" stroke-width="4.58333" stroke-miterlimit="8" fill="#FFFFFF" fill-rule="evenodd"/><path d="M4349.89 1145 4349.89 749.868 4351.03 751.014 1614 751.014 1615.15 749.868 1615.15 1130.81 1612.85 1130.81 1612.85 748.722 4352.18 748.722 4352.18 1145ZM1627.75 1126.23 1614 1153.73 1600.25 1126.23Z"/><text font-family="Times New Roman,Times New Roman_MSFontService,sans-serif" font-weight="400" font-size="37" transform="matrix(1 0 0 1 33 1793)">SteeringSignal</text><text font-family="Times New Roman,Times New Roman_MSFontService,sans-serif" font-weight="400" font-size="37" transform="matrix(1 0 0 1 28.1666 1162)">LongitudinalSignal</text><text font-family="Times New Roman,Times New Roman_MSFontService,sans-serif" font-weight="400" font-size="37" transform="matrix(1 0 0 1 17.7238 526)">LongitudinalSignal</text><text font-family="Times New Roman,Times New Roman_MSFontService,sans-serif" font-weight="400" font-size="37" transform="matrix(1 0 0 1 1169.96 1158)">BrakeTorque</text><text font-family="Times New Roman,Times New Roman_MSFontService,sans-serif" font-weight="400" font-size="37" transform="matrix(1 0 0 1 1176.53 531)">DriveTorque</text><text font-family="Times New Roman,Times New Roman_MSFontService,sans-serif" font-weight="400" font-size="37" transform="matrix(1 0 0 1 1202.2 1797)">WheelAngle</text><text font-family="Times New Roman,Times New Roman_MSFontService,sans-serif" font-weight="400" font-size="37" transform="matrix(1 0 0 1 4075.68 722)">VerticalTireForce</text><text font-family="Times New Roman,Times New Roman_MSFontService,sans-serif" font-weight="400" font-size="37" transform="matrix(1 0 0 1 2426.75 1150)">TireForce</text><text font-family="Times New Roman,Times New Roman_MSFontService,sans-serif" font-weight="400" font-size="37" transform="matrix(1 0 0 1 3394.91 1133)">InertiaForce</text></g></svg> \ No newline at end of file
diff --git a/content/html/_images/crash_config.svg b/content/html/_images/crash_config.svg new file mode 100644 index 0000000..d8d2aea --- /dev/null +++ b/content/html/_images/crash_config.svg
@@ -0,0 +1 @@ +<svg width="870" height="323" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" xml:space="preserve" overflow="hidden"><defs><clipPath id="clip0"><rect x="314" y="308" width="870" height="323"/></clipPath><clipPath id="clip1"><rect x="-0.0869094" y="-0.257223" width="5310076" height="1969179"/></clipPath><image width="1372" height="509" xlink:href="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAABVwAAAH9CAMAAADRUUfXAAAAAXNSR0IArs4c6QAAAARnQU1BAACxjwv8YQUAAAK4UExURQAAAAAAAAAAACBgnwAAAAAAADBQjwAAAAAAACtViitVlQAAAAAAAAAAADBQjzBYlwAAAAAAAC1TjC1TmQAAAAAAAAAAADBQjzBVlQAAAAAAAC5XlgAAAAAAADBUlwAAAAAAAAQLEgAAAAAAAC5VlQAAABopTTBWlgAAABEgNy5UlypJfgAAACxVlAAAADBVlwAAAAAAAC9Rji9WlgAAADBUli9WlQAAAAAAAC9Rji9VlwAAADBWlwAAAAAAAAAAAC9TkC9VlwAAAAAAAC5WmAAAAA4YKwAAAC9TkC9UmAMHCgAAAAAAAAAAAC9Sjy9VlyZFeQAAAAAAAC9WlwAAAAAAAC9VmAAAAAAAAAsVJgAAAC9VmB00XAAAAC9VlwAAAAQHDB84ZgAAAAAAAC9SkC9VlwAAAAAAAAECBQAAAC9Tjy9VmAAAAAAAAAsTIQAAABUmRC9VlwAAABcqTAAAAAAAAC9Sjy9VlwAAAAAAAAAAAC1Ski9Vly9RjwAAAAAAAAAAAAAAAAAAACVEeS9Sjy9VmAAAAC5UlQAAAAsVJy9TkAAAACdFeAAAAC9VlwAAACtMiDBSjwAAACZFegIEByE5ZAAAAAsUJS5TkztZhwAAAAEDBAEDBQMFCAMFCQQIDgYLEwcNGAkPGwkQHAoTIQsTIgwVJg0XKA0YKw8bLxAdNBIgORUkPxUlQhYoRhYoRxcqShcqSxkuURowVRwxVRwyWRwyWh01Xh84YyA6aCI7ZyNAcSVCdiZFeyhFeShHfChIfylIfSlKhCtKgitNiSxQji5Ski9Sjy9TkC9TkS9Tki9Tky9Uky9UlS9Uli9Vli9VlzZVizxZhkNcgklgfVZndGNua2pxZ3B0YoqCUJ2MQ6SQP6qTOr6eLcShKMulJNGoH9irG96vFuWyEuu2DfK5Cfi9BP/AAN25nCMAAACadFJOUwAECAgKEBAVGBgYGR0gICAhKCgoKy8wMDA2ODg8QEBCRkZHSEhQUFBYWFhbXV1gYGJoaGhwcHF3eHh4gICEhoeHh42Pj5KTl5eXmp2en5+foKKnp6uvr7CytLe3ur+/wMPDxcfHx8zNzs/Pz9LU1tfX19ja29/f3+Hk5+fn6Onr7e7v7+/v8vP09PT19vf3+Pj4+fn6+vv7/f6HhK/kAAAACXBIWXMAABcRAAAXEQHKJvM/AABHz0lEQVR4Xu2d+2McWXbX5VbkKEqERzhRJvL0LKwsRpggWUhihdus8EiLIhLFREZDkGkvrJgEMQvCQOOlMQ83GJZHG1jelyUJr5BkCTBAYGEJhLCJ2IUEJ0uAPMiDhMy/wbn3nK6u1+2u7q6urqr7/fxg31Pdqq7bOvXVrVv3fGsKAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAACFZfPJvevSBAAAkBZvv3z58p3NOYkAAACkwTXSVs1bt6ZlCwAAgJG5K+L68uXz+6/LNgAAACPyRKTV8HQf068AAJACN0RWPR5vY/o1GfML0sgBs4vSAADkhEPRVD8P14s7/bpSP5DWuFlRalaak+dM7UkLAJALpp+KoAZ5cf+mvCEnzFR3dqpJtOxIKWn5WKxWpZUip+pMWsRsdadWnZFgAuyoVkWaAIA88AaL6a1XD8Mq+/TwVXnP5Fk6VYaD/vIVJ66L+kelnRq00x1pTq2c8/E1ExzgeJhXalWaAIA88MAI6XM9DfDGgxcm6PL4zjV+14RZY+kiLvoOz+LEdY9+sj3CwG61tiEtH/RB89yaOeGD01ws8bZs8B3YmapLCwCQA66ynt6XaP2RCX08Wr/Kr02SI9XYWJya32krVZNNVuLEtanoJ0cY2NVVQ1pdKq2OmlVo2NqqVaemFtb0AHaZt2aC78B2PK0HAOSAdZbQ7vrWa3ce8yaPFw/ekNcmxuoW/79CI0Nu2YkR12WlaOx7KtEQxIkr7VRGjVtKNeVefYXGsOfczATfgc0n+MMDAMgMHqk+kYi5vh+efn1+eENemzAtpfpNasaI65Fq0lXzCLf248SVPod3WKFxcXfMSGPXFWlmgP/AzqiXAICcIKWv9yT0uHk/PP365G4epl/rIq5L9RMaOx5cnB91lWzr6OJ8bylGXCtttaeHlzL8JRYO6u2zukbmCpZq9VZ9rxMEdz5/Um+pNr33ODBre9EZRNOej7ml2VC8hmBJrwirHl9cHK2Z7dENxFLt5OKiXpNhb1ynBjiwXaWw1hWAvHCHlTOmKmt6/SG/1uXtzYlPvzZEOekq39ylIuSO/QzprmYrKq705qWpWRE9jZ67FXiuYEeiY6PcoZ1XuUn45zRnvHmG04CozbRVS/+/phoVOhQNa19kQ/c42tyHaKcGOjCS9a5sAwAmC8+vviNRiLntd8zLPh7cktcmAykk30QimTlV7eOalhpWNrrsv9itnZBSRcT11Fw7k/hKQRWJ0vlydZl+4ljfhpqaOqC9rVaX6YdpZBjZ+Wyt1lCtWq3WUTwD7eSIWxeqzQ3mnAfXa6p5qlp7tYMmfYzeHtmgx9jN3ZWNo5ZSu/yOcKcGOrAVhToCAPLCqyyZ2xJGuX4v4DxATNTchQZyPDgjmVHnWsNouGZ0h5TlXI8Hl/VgUG/oQoqs7/TQjxgJM5OT+q2VBv+oXrDKqkRapkUtsvO4Odct7/6RCr5IIu7tRI8o5+nSXU/ORjbQx56ZWdtF/zv8nzvYgdG7sRgLgJywz4LZ00vg9fvP+V0eE/PWnm3TpbVpkcwYldGrrMxVOA3ueFyq1dU0PEgG9Ut0vS5C1BLJ2pMh5wmLrdm/Ho1Gdh4nrrXOYoH5kKbReFTPiHZ3IjIc2dCdTqCX9BHFdGqQA6M/In2XUgAAsoFXBTyUyMb0rbfM+3xMxlub5EiqWElmpEWqqgWo7a2Aisy5nstL9E7zMyRCfB1N+mikqu1Vb/FbIzuPE1caTPKC1qpVXGUn9Hl6mBneUKFrfI71HbfYzx3wwLy/HgCACXOTlXJdwh7MbUamX7P31t7tTip2ZYa0jK61Sa9kBjQirgsdLV3tlMC25L2nvHaJ3lCvMQ0zIAzvPFZc6SUed9LItaPrBtI9uYSXnUw1QsrIG+hjZZpCa2fc5w56YI3g5C8AYGJw6euLZCJ57W54+jVjcxeSljO+So7KzFJ3BT1tkBZDkmx0SI8P2dvkRLX1D6/IjaVl5WNwcQ3PuZ51bmj5tFS/IbyBPtZbG0aCTD8T/txBD6yzlAIAMGGmA6WvCbhxGJ5+zdBbe5muennVPhGWGbo2t4krSU4Xs2B0kRr13bpSTbM/EtnOALFWC17Rx2oYQy9JnSt9QEfzNS2jgxEtjWyggbTnC8BX+eHPHfTAMC0AQE6Q0teBhp+3eLTrIyNvba2tRk8MYZkhvexMT9IGaRm6i0E15h57XV2Y4JRvgdHPdoSZ6aNhzJ6njaTSPtsCUkSzntanpWxCEN7g/9jzkPx6nRrkwHBDC4C8wFUCTyVKytXNiLlLBt7aiy2/tkZkZoYGeRyHxZXClarQUm26+ibNmp1fra3IVb2+s9SZr2XiNCxSWVrzlG+re2eKoEGoKZ/q7mSB9x/eQIfMy6nMhIXeQ/hzBzww6lfgzhoAYELMsTLuSzgA2Zu7kLa2OmKoicgMXZvzIqWl4FKsSsvnaH1gRpv0s970gqHRWfEkRDWMFDP4I2aEKspXafrsBOhn+faWbvAR7fLkamRDk1e3EiTP8o5wpwY5MDqizugdADBJpPR1OEfsbL21w9oalRnSJ3N3ikanAXFd7ZaSmikCUtolunw+qNVWqx3nVa1KImLzWv6iGkaq7MmnMN8dr9JndwpPaTwr76SdsJiS2huJjGzYoD0YtV2iUbm8I/i5gx0Y7c+bxAUATBBeXPVYosHJ0FubxqUN47NCmPFiRGZmSFTrGysUnQfElYZ2RoUY2g9FnYJ91d4z4jZFP3JRq1arW3UjklENI91qbKye8LuFljfDWTmmfTXrtd06jZrbsgSAdtJWraONA19xa3CD/thGbWXjgH7K3BuLfu5AB0YD4kyNugEA8VxnQbwj4TBk5q3NWijoDVGZWeRVAe1Vesm8YJhp+2YFjP7UzEhTq7T+AV7bNSsPkSG0PEV3XuGdm3YH+hnvinxNj5cNjY6+0U7WzngbS2lkQ/djm/xD0c8d6MDqIz1sAQCQFvdYDUcca85th6dfx2HusmvGrIwZuS7V66J0q3UZUM7X6u2z3YWpxbrv9tJ8ve6/nl+o17e6LtcLJF3y6uoRjTrPT7bMTmN2PnNQV83gjCYpXfcqfH7noN6mweuqN7g1QrjVUJ5/YGQDsUq7vTjekR+K+dwBDmy24wcDAJgsPGf6SKIRyLG3dixn3mB2IbzWaRBoUNzr5nx3lClENqTMBp5QCEAueJ11MEHpawLy6q0dS9sb4VVHckANTueGyVxcMSsAQD64bzTwRVozpNPrEXOXHHhrx3Ku2rzyYJZaYvE6DCTNAYfXIFmL6yzcXAHIBdNcyPpAwjTIhblLAlaVUie1Wu20PeKF9HngZlmIrMV1w/MCBwBMklusfik7r+TMW9vCCle/KlUfTe1WoqUFXbIW17pX7wUAmCRS+pr+wDJH3tp2Fldo5LocKEsYhqUe60oXajVv5YAhsiFdFqqYcQUgB8zxDahDCVMlN97aAACQNZsseuNaMXV1823+gC4ZmLsAAMCkYe0bvvS1PxP31gYAgMyR0te7Eo6JiXprAwBA9txlrRv/Ov9bUXOXbLy1AQBgAvAV+9sSjZXMzF0AAGDSSOnrpoTjJntvbQAAmASHrHAZjh+z9dYGAIBJIKWvb0mYERl6awMAwCR4g7UtfdvVPkyvc12Yj7yauwAAwOBwAdXzSSzqz8ZbGwAAJsDVMZa+JqBo3toAAJAMKX2doFvVzai5S369tQEAIBm87vSJRJMB5i4AgLJxjbVszKWv/SmKtzYAACRCSl/zUORfDG9tAABIAt+uz6T0NQGF8NYGAIC+3GAJ25YwB9x6wIfUBeYuAIDCsW/k60Wu1Ave2gCAojPNi0wfSpgb4K0NACg0N1m58lgVdSNq7gJvbQBAQeD5zRc5veaGuQsAoJhI6et9CfMHvLUBAEVknfUq14tJ4a0NACgcPCx8KlFugbc2AKBQzLFS3ZMwz9y8H55+hbkLACCv3GGZKsYgEN7aAICiwJOZ70iUf+CtDQAoAq+yPt2RsBBc34+Yu8BbGwCQL+6xOhWtcB/mLgCAfMO34B9JVCDgrQ0AyDFS+rouYbGAtzYAIK/cN5KU19LX/sBbGwCQR6Z54egDCQvJjcPw9CvMXQAAzEx1ubYo7Uy5xWpUdCM/eGsDAAIsVjdqR/ULpZmXbZnCS/JzX/raH3hrAwA85htGVZm6bMwUKX3dl7DYXLsbMXeBtzYAbuJX1zXZlinbLEKlWYAPcxcAgGG+JdKq1IxsyhS+lH4sUSmAtzYAgFj01LV1sCTbsuM6q0+hSl/7A29tAIBfXZVq1DK+qSWlr+Ub2MFbGwCw3Na62jL/KnW2keX0AK+/L2DpawKu74enX2HuAoBbGHU9mFk7ZXlVx6sVeWXcvM6isylh6YC3NgBus0yKqudbZ7d4watqHVX5lTEjpa8lno6EtzYATrOmGtJa2GuyvjZ2F2TT+JjmqtFCl772Z247Yu4Cb20AXGGtJg1i+UimX883ZmXTmJDS1/Lf6IG5CwBAU1k7YXlVJ2OdfmU71OdO1IjCWxsAoJndOGd5bR8ty6bUmeO7PYcSlh14awMADAu7Uhvb3BvP9OsmK4xDy5PgrQ0AMFSPpMLgYmsM069c+vpEIke4djc8/QpzFwBcpLLamX49XUt5+vUaa8tdCd0B3toAAM3MxhnLa/t4RTalwl0WFidlBd7aAADNfK0z/XqQ3uMK+PL4bYlc4+pmxNwF3toAuMjSQWf6dScdc5cbrCilLX3tD8xdAACG1WOWV1VfS8Hc5ZDlxO2LYXhrAwA0M2t1ltf28apsGpZpVpW3JHQXeGsDADTzOx1zl9G8td9gIUGRPby1AQDC4kHH3GUEb22+Xe5G6Wt/5rbD068wdwHASVaOR/TWvsrXwvclBPDWBgAY/N7asmkQ1lk/YA3lB97aAADNKN7aPMvoWOlrf6bXI+Yu8NYGwEWG9daW0td7EoIuMHcBABiG8ta+w6qBivpY4K0NANBUvOnXxN7afG/8HYlABHhrAwA0nrd2K5G3tpS+bksIYoC3NgDAMIi39j6LBaSiN1c32fL2B77lu/6tacDcBQA3SeytzSs6H0oE7Bhv7e9R6lvNN6aBtzYALpLMW/smy8S6hKAnNw7/plLfzV8ZA29tAFxk1vPWPrJ5a3Pp6wtc4CZjnr7Mv2q+si7w1gbARfp4a0+j9HUgakpdwNwFAGDo5a0tpa+YOkzIhVI79B+8tQEABqu39kOjDE8lAn1Yoq9Q/kDBWxsAoJnZ8Ly1fdOvcywL+xKCPuzRnydpEvDWBgBoYry1pfQVI65kVJpKrUnbML3OQ38fMHcBwEXC3trsS/LYvAb6skwD/7BnLry1AQAGv7f2dRaDO/IS6MOxUsfS9ANvbQCAxnu0ofp9nzZSgGWayZihP0uW9cI3o+Yu8NYGwEE8b+1v+eefeflINoI+rCnVtNa6wdwFAGBgb+1P/l31bb9tIG9th6EB/4E0Y4G3NgDA8Ns/9cl/ZMavg3hru8ssfVP9HmEOb20AgC59/cFPf4dR1wG8td1lR6kLafYC3toAuM4tc+Z/9jcO5K3tMBdK1aTZh1tsh+MD5i4AOISUvk5PLez+cdbXBN7a7rJIX1DEm8FGx1vbB7y1AXCEOa7dPNTtI3We0FvbXXaVOpNmIoy3dgB4awPgBNt8xpvV7k21lMxb22GaSm1IMyk3ouYu8NYGoPTwdaspfV1STf1fAm9td4krfU0AzF0AcA0pfb2r27vqyGzr663tMEdKnUhzMOCtDYBb3OXz3IyiLvxVnb28td2l0lZqVdoDA29tAByC77a8rZvzqh2cZbV6a7vLmlKtUaai4a0NgCO8zmf4pm5vqVOzzYdn7tI+Hnq8VipO+5S+JuDm/fD0K8xdACgfh+bsfmHm/uqxt8FjvLXdRZe+VqU9PPDWBqD0THOJ5lu6PWNdHB/21naXLfoOpDka8NYGoNy8wee1uauyps7Ntlj83tqyyUXOE5e+9uf6fsTcBd7aAJQF9h59bgoyj3rrxszaKcurOnbW3GWBep9mZTDMXQAoKVd9pa9TDZu9vofnrd06Gn3isYgMWvraH3hrA1BKNvl0Nk6js0oluOBnb22iseuguUtDqS1ppge8tQEoH1wz9MS0VxK5lBLLRzL96py3dlWp9li6DG9tAMrFNT6RTenr1J5X+9qXrrnLiVPmLkcquhI4LW4chqdfYe4CQGGR0lc+h8/Umvk/GbMb4q3ddsdbu9IaofQ1AfDWBqAs8FJLU/qqi+YHtGhZ2O2Yuzjirb1Kf0rGO1CHtzYApeAGn77bJlhSLfP/QFSPXPLWPlXJZ06G5trdiLkLvLUBKBhS+spXnjHGAkmoeOYup2U3d5ltp1H6mgCYuwBQbKb5FH7I0cnQpUcznrf2cam9tTcUe4lnAby1ASgwN/mslYr25iijMie8telPyK40MwDe2gAUFr43/YLvl8wnKiHoQem9tdMufe0PvLUBKCRS+nqfo9Veri0J8cxd6mU0d6mpFL6iQbm+H55+hbkLAHlnnU9WKQTaU3vcGAnPW1uVz1u7odSONDMF3toAFAye0nsq0enAz4u2UFZv7SXq0oSWm8FbG4AiMcdn6T0JL1R6hVal9NY+GGPpa3/mtiPmLvDWBiCf3OFTVNZPVlIelq10zF3OSmLuoktfBykPTh+YuwBQDPhG9DsSLQ5Tn9WTiuetfVIGb+2VsZe+JgDe2gDkn1f55Lwj4WraJtCaMnlrnyh1LM1JAm9tAPLOPT4zO+dlbeQHRsdTFm/tmbZKcVJ6JOCtDUCuCZS+Tk0dj2+ZkWfucl5gc5csS1/7c+1uePoV5i4A5AQpfV2XcOq87/OzRqDrrX1aVG/tukplHXB6wFsbgHxy35yPUvpKtMdc2Vlwb+15OvLcmSbAWxuA/DHNRT8PJJxaUG1pjY8ie2vXVNIHjGXK1c2IuQu8tQEYhNusSkp9/Iunpt7PzY984Ivk1akrGx+hDZ/4sO/K/srGN9GmD3+FhGFu8ZnozdMtZ1M2X/XMXbaKVV1wMaHS1/7A3AWAUQiIqxd84qv41a9+JhvUR7+ct0y9v7Ppmz0FDsDllJ3SV+2UfSKtceN5a9cL5K2tS1/z+9cA3toADM1tv0hycIX0U0utEduP6jHrl36Qxbe76cr76vEO2FL6ui+hru3Mzqm0gN7ae/S3QJr5BN7aAAxHjLhOTb2mjHLSfyfy4vupqf9/5Vnn/Vc+GCuu23wCdr3rjtOybUlGwby1K81Jl772B97aAAxDrLhWPqal9Mo3doarxJs8VfCmb1MsvAr9sUREfZwrsWLxzF0u8m/uskyj7ALMYcxth6dfYe4CQB9ixZVklcSVRqndwSkH9G/vGdTrfOZ1Sl+JRjZP3gvieWuf5dxb+zgfpa8JgLc2AINhG7mSkr7m3dcieDD7mlK9naql9NU3KdeazP2aYnhr56j0NQHw1gZgAGLF9bbR0Nv+KQAezN72620cXDv5SCKiotSkKqcK4K29plSzSIVl0+sRcxd4awMQj7f6Sl/us7he+WAnCoorvdZvyvV1PuE2JSTmM6ghsLPombvUclldQKPr8bjajA+YuwCQjJC4CmYAG1DSZOIqpa++scySakhrQix3vLXP8+etPUuHVcAH1sBbG4AEhKYFNJ16rNhpgZ7iOs2OH17pK7Ey+WWc+fXW3sln6WsC4K0NQD9i51yZwAQr3+PqM+cqpa/+Gsk1MySeNDn11qaDil0sXATgrQ1Ab3qIa2ApFq8TCGyKwqfbc/8M3LissgfGM3dp5MbcZZGOpsiPWby6+bb5hfuAuQsAHXqIKw1WvfAKFxTIfxbmeKXOoYSGvRyNzTxv7Yt8eGvvqXE8ASdT4K0NgI0e4kqhp4ydJv3fqYi9Hbne3+TTK7C0POPq1z7ky1u7qXL15QwJvLUBiKWXuNI4la0FFz7EqwmIN5X6qN70vnp0MpUvEp9IxGRf/dqH/HhrF6T0NQG3ouYu8NYGztNLXKeukKgKXysv6EWwTPCtxDU+r+5KyNQnUf3ahwXP3GVvkuYuR95frOIDcxcAwvQUVz1m1c7YFx/w3Xf5sg89U+oT3xA1y77LJ1WwIDKP4kosed7aO5O6pVRpq7yN6kcC3toAjAu+tfG2RMJFPsWVmLS39ppSrYI+U9EGvLUBGAc3+HTylb5qJmKKlZDJemufFq/0NQHw1gYgdQ7NqfQidCOjke/6Ts/cpZm1uYsufc3v350RmF7nJ/34gLkLACMgpa9vSdihkftl8p63diNTb+0t+kBplg54awOQIm/wSRQ+hxKIa58nzEYeSfta5xFfqTEJb+3zApe+JgDe2gCkxQM+g8LVj/29svs9Ydaz6urYGrxJ7bQNsDP31l6gj8qlC2J63Iyau8BbG4CBucr3Me5L6NG3ep60s/cTZnl9WPeRtJWPffzrootsR2feM3c5yGAudLf4pa/9gbkLAKMjpa8RW89+4tr/CbOdxbfySFr6/+SVZ30eiDAkC5639u64R5X0QVvSLDXw1gZgRLhAJ1j6qunzlJeAE0z8E2Y74spP8dIvr9JPjWu+MiNv7apS7dx5d48JeGsDMAJS+npPwi5KSSOegIchB/RvoCq0I66kqHr7K89IeqOlZOmRibf2kVKn0nQBB721pZ8ADIEkEXOHt0VPmD7imuAJs76Rq9bh2/o9JMDjvO/kmbu0xmTuUmmlf08u59ziO54+ym3uIp0EYAgkiRhe1/iORD76iGuCJ8x2xPW20SN6D/8bGN2mj+et3RyHt/Zq+Upf++OWt7b0EIAhkCQySOnrtoQ+lOq5cjTBE2ZZXDuPpDWzAqGfGxNj9NY+VepImk7hkLe29A/E8u6770oLxCFJZNjnTTGXeX1WCyR4wqy3ztUMYN/kIeuY5wWEcXlrz7ZLWvqagBtRc5dSemtL50AsdEpJC8QhSWTg8+WhRH6avcU1wRNmWVylgKvyMRbV8c8LCLOeuctReuYuG0o1pekiTpi7SM9ALHRCSQvEIUmkuclb1iX00+hdh5TgCbOBlQGv0UX6RzTPQu8aI/Oet/ZBSt7apNe70nQTB7y1uVcSgBB0NkkLBInkDd8IfhF3c6KP5WBgKVb8E2YD4qpLXzsE3jVe0vXWdqD0tT9l99bmPkkAQtAZIC0QJJw305bSV815b3GlwaonnXSprycE5D8Pv7h2ZgWIN/2amwEpemvXlDqXptOU2lubOyQBCEHnkbRAkHDerPOG2Nu+/R7zcrvvE2b94uqbjw2skM0Ez9ylPaK5S0OpHWm6zs374enXspi7cG8kACEgrjbCecPmyE8lClJXa9KKh8apfZ4w6xNX/20sGsRmc0vLj+et3RrBW7tKP+9K6Wt/yuqtzV2RAISgU0BaIEgob+Y4jpa+ak77iGv/J8z6xDWwACu8ZCsjRvfWPnCr9LU/pfTW5n5IAELQ+SMtECSUN1L6Gj9bdtRPXPWYtecTZn3iGlillf28QIfRvLV16Wvf78Q1ru9HzF0K7q3NvZAAhKCTR1ogSChv2FPusUQhjko5vTjjmbscD2zusqJU27nS1wSUzNyFuyABCEFnjrRAkGDevMrhHQlDHGW5YipLZj1v7aPBiq1OHC197U+pvLX5+CUAISCuNoJ5c49Dy0mwq/akVT6G8taeaSs1HqutMlAeb20+eAlACIirjWDe8FrFRxKF2VDH0iolg3trO1762p+ot7bloijf8KFLAEJAXG0E8uZ1juJKXzUrqi6tktI1dzlJZO5SVyUey6fEjcPA9GshZwb40CUAIeh0kRYIEsib+yZ4YVuZuFTep/N7eN7a7f7e2vP0tpQcCkqNz1vbdlGUb/jYJQAh6CyQFgjizxspfX3AUZR51ZZWqUnsrV1T6kKaoCdXO9OvtouifMPHLgEIAXG14c+bWxzYHY+dqUZK5q19gdLXxPS5KMo35tghrhYgrjb8eSOlr/Ybuk13roIrnrnLqc3cZYleTMFXywn6XRTlG3PsEFcLdBpICwTx5c0cnwCHJojl3KmFRzOet/ZxrLf2gSr7Db706HtRlGv44CUAISCuNnx5s83tHpWKJ67Vevby1q40UfqamL4XRbnGHDzE1QLE1YYvb/h5npbSV8NBWUu0emD11l6mIe2obrCuIBdF+xIWDXPwEFcLEFcb3by5zs27ZnM8NXWg/5ttuVXz6Zm71P3mLseq3DUVadL/oijX8NFLAEJAXG108+YuN3vZG6+x7erOBNxXJ4vnra08b22Uvg5A/4uiXGOOHuJqgc4KaYEg3bzhQsX4Vd4Lx2bKcZkfadLI4lHYeSPsrb2mVBOGWMlIcFGUa/jwJQAhIK42vLyR0tdN3hxiRzX0es9F1aJ/q66qSsBbm4ayZo4E9Ef8gAr7zBc+fAlACIirDS9vDk3Dssp75kKdkaBWTBXBkcMF9SsdcxftCT7802Eco9dFUREwhw9xtUBngrRAkE7eTLO9xluyOcxCy9y9uVDLerLRuYL6papmuUb8+t/6R4y6KvVnBvbWdpSeF0VFgI9fAhCCTgVpgSCdvHmDG9anzS+bUs8TtTW1UdZnSS8YBa3uaAmt7dUNsszVwqDe2o7S86KoCJjjh7haoBNBWiBIJ2/YN/65fZX3llIrU7vqYOqMBLa4zLKCbhkFrbGCyp2qoRjEW9tR+lwUFQBz/BBXC3QWSAsE+eHPf+5zn/uhqat9S1+nDlR7cVWdLap27t1bZlhB11hBT4yCSinrcJybXdR5fxu069+i1O/tmLuc9zJ3AZ3SV+tFUf7hDkgAQtApIC0Q4OsvDb/r13L+vC6b46jUVWNZtfZys3SeFXSFFe+Y5U9uNw1Fg3exZ/a3w3u3DUubSm34vLVPE3lrO0rfi6LcYzoAcbVA+S8t4OfrL3/kx3/mZ37yC5d/3qTPE9kcz0xDnSvVynbp/KLROHMrqVY7YPmTBVFD0eJdHPAOl83eB78/55W+DuKt7SgJLoryjukAxNUCZb+0gI+vufzbP/0e8fP/4/JzOn14lbe1QmDRjAvH8NSoeaNxcitpl+Wv962k3rR5F8dmf7VV3rt8ViocqW6RWmJvbUfZNMpU2NJXDfdAAhCCUl9aoMtXXv7Iz2ltJXX9wuUPUfroR8uvNOzPclnRGrIrwaDIraQNVjyWPxn2DceZ2cUp72+N956Nk0qF/sr4XQirnrnLFgxew3Dpa++LopxjegBxtUB5Ly3Q5Wsuf5y19b33fvLyv7x8+fbU1NIZjfvk5Rh26IvsOTyrsMatsuLxraROWf5QXPAueH9bvPeJC9iaUq3QJKvnrV23eWs7yjVWpsKWvmq4CxKAEJT00gIeX/JXLn9BtPW9X9RD1+15vkEjr8dxbPyheU293Eo6Yvkb5VZSk3fBt5JqZufWW0l54DSu9LWft7ajiB+QvigqLNwFCUAISnlpAY9fc/m/RVqJn7j8/F/+TSwO8lXxraQqC56sqU/hVtIR75BvJRWzgHSWehM7hdvLW9tVuPSVLooKjOkCxNUC5bu0ADHbqtdW5n/D5U+IshI/ffkf/xoLw2iwgp6wgsqtpLItU9pR9meMe+YuFzVMvxI3WJiKW/qq4T5IAEJQsksLaMyNpL9++X9EWYn/e/mf9LZk8Jp6uZWk19QTDs000rfX64kMnrf2md9b21Gk9HVOwmJi+gBxtUCZLi2g2dPn/n+4lLUChsvLv6M3dpFbSbtGQWVNPQZjxAJ9Ob1nhGO8tR1l+qnRpYcSFhTTB4irBUpzaQFNVZ/4//ny50VYNT96+ff1Rg0ktCe7NCaVpp2wt7ajiB/QLQkLCndCAhCCklxagKis6tP+312aCgLmFy4vX/6bf6A3w6e0D6b0NQGLezL92qg5W13wwMhSkUtfNaYTEFcLlOHSAks7smToX13+lCgr8bOmRusz36lf+J23Cn4yjBUa9Se2rlnueGufbzhp7iKlr/clLCqmExBXC5Te0nKb+bVjqSUi/km3huC9937q8vMmg77vU59Un3n5/H4vCxe3OVLqVJoJqKydytd94qC39rrJqZ5+QEWAeyEBCEG5LS13qSzvecalZwf0zz++/MIvirS+996PXf5XTqGXn333e/V/T+4Vet332KjQX6fB7lLNbnWmX53z1n5kMqrQpa8a0wuIqwXKbGk5yuJOZwClGkerM/oJrkr9xcufFGl972cv/9ivZms4H+9sFnsFzVhYjZa+9sczd2k4Ze4ipa/3JCws3A0JQAhKa2k5yOzaUaeyqn26JSc3Xdye/arLL/w/1tZf/J+Xv25q6uomm2z4eLiO6dcg9EfqSJoDUe14a1+44619h5Oo8JdA3A0JQAjKaWm5xvKu5zx1vuuzHF1TJ5Wp33P5Y0Zdf/F/Xf7pLzGbr93lcsUuL+7fNK8Aw2zbUvraH/e8tR+bDHpHouJiugFxtUAJLS2XWNg67dipNI/WguOlGT38+iV/+PLHfu69936etPUreTNx45CfedTl6T6mXztsjWRo65a3tpS+bktYXLgfEoAQlM7ScoWZ1SPPbvpPqj9gmekjdb380S9c+rVVc+sBL6Hp8ngb06+Gs+ENbZkFz9xlr+zmLvucO8XPHO6HBCAE5bK0nGBp13sc38XecqWpVMvigvcl/00/Quvzv1RCj6vrfKPXx6P14j4bOTX6l74mYMnz1t4pdTFcKUpfNaYfEFcLlMjSKj3zGyedpayt4zV98lZMsBc/zffy5X//4fi8uXaHp8y6vHhQ4Cd4pkNNqXNpjoQL3to3OWvWJSww3BEJQAjKYmmVmsrKgTcXcLbTqWLVoy3S27PYm9Q98+bVQx58dHl6+Kq85ib09W5Jc0TK763Npa8vSrDcxHQE4mqBclha5WWxU9aqVONgxTdOXSFpbW+0VCvuHkq/vHkjOv1655q85h7a8Ca9hVSeuUuzjOYu0+UofdWYjkBcLVACS6uc+Mpa2ycboYm8LXV6pnbm411I++fN9PpDflOXR5uOTr8eDFT6mgDPW7tROm9tKX0tw0I+7okEIARlr7TKR6CsdTdmCLSn9tZUc6pCylCPTPAlypu57fD068sHBXeRGwpd+rom7dQoq7c2/0l+KlGhMT2BuFqg1JVWyVjcCpW1xnCitipNvfJ9ta2aYfFNmjfX98PTr88Pi/wo+qFYoQuDMSz/L6W39hxnSeFLXzXcFQlACMpbaZWI2LLWGC7UMl3P6qKBBRrihk7fAfLm5v3w9OuTu25Nv54MWfran3nP3OWgJOYuUvpaivuf3BUJQAjKWmmVBVtZawxttTC1xG4jM8fhOcOB8mb6ltPmLjN0/T6+wqoFz1t7twzmLu+Y9HgsUbExXYG4WqCUlVYZWNg6sZa1Rpk1fW/IkHUp9PZB82Zuk88aH2+54q29MVLpawJK5K39KufGHQmLDfdFAhCC8lVaRcdf1nq6k6SAsmqeA11TJxyGGCJvrt8Lm7s44q19ptSeNMdFaby173FmlOOyhvsiAQhBySqtQhMoa/UvZe3FmpkJmFft2Ntdw+XN6/fD5i4OeGvP09eegR2AZ+7SKrK5C9/+fCRRwTF9gbhaoFSVVmGJlrUmZFcd6P/O4p+qN3Te3OICHB/vlNzcpUZ/0qQ5Zjxv7WZRvbVf55QoQemrhjsjAQhBeSqtQhJf1pqQIy7Y3FB1E4YYIW9c89a+UGpHmuOn4N7a9006vBhvrcmVjY/QF/SJD5vy4dvqE19ltk5V6jwF9toz9fEvNltGxXQG4mqBfgfSKh7BstbB15mvXZhr2dm2ihvujpY3LnlrL9EvIEudK7K3tpS+PpBwPHz1M/l+1Ee/nL6uj3XuKnRk9k16JZ11w6YzEFcL9DVLq1j0LGsdkNNYy5GR88YZb21d4CbNrJj1zF2OimXucoszYax/Z2+TqOpv5Us/qMwItaOpHZWtfOzjX6e++Yt0c1S4NxKAEJSf0ioO/rLW87iy1gFZi9WGNPImxtxlu3TVBdoVN/XS1/7Me97aBwXy1pbS13HOEb2m1Iko5/up2RXVjsi+pk5eedaZKhgN0xuIqwVKTmkVhCRlrQMyG7teIJ28ccBbe5nGj6n8HgameN7ac/zHdl/CcXDlG30Tqm8aPWVV9aYH3lSr9KYYr6LBMb2BuFqgzJRWAZhdTVbWOihncTNQqeVN2b21j5U6lmb2FMxbe5sTYJzeE6888+kmByyrr8nA9ZVnJL6305kX4O5IAEJQWkor7/jLWvfSXee4E6cOaeZNmb21x1v62h/P3KVdAHMXXkUy1tLXjoYaZLSqh640WOWB6239P6luGt+W6Q7E1QIlpbTyzGBlrQOzwP4CQVLOmzci5i6Py2Huska/kwnfs/e8tVs599a+zr/5uxKOhdv+ZVaiqKSxtddkO20iWfWkdjS4PxKAEJSR0sorM6vdpazJyloHpxHzxP3U8ybGW/vtEnhr07jR1GJMlmJ4a0vp61j/qIbF1Vz+09D1m2S2wMwKhN42NNwfCUAISkdp5ZKhyloHZzemNH4ceVNCb21d+pqP4WIBvLV57fN4S1/fjBNXGrp2Nr/JQ9Z05gVMfyCuFigXpZU7hi5rHZxlY+ESZEx5UzZv7Z3MSl/7M+OZuxzn0txFSl83JRwPcdMCeqsMXElmjaimMy/AHZIAhKBElFauqKwceEtZBy5rHZxKTJHW+PImxtzlbmGrC+jXlMqinpSY9by1j/LnrX1oftljLn3trGY16MlW0/AGqq/RH8OPaJ753zcspkMQVwuUhtLKD6OWtQ5BPboMfpx5Ux5v7UX6JeVskjO33trT/Dd1vKWvWka7f+1ISllTPXHVpa8dRv+raDoEcbVAX7G08sFsimWtAxBj6jrmvCmJt/Ze9qWvCcint7aUvo55jTMNVr0lrHTtL3MEHXHtzAoQb6aw1JV7JAEIQQkorcmTdlnrAFRVS1oe48+bMnhr0yAx1rBx0nTNXU5yY+7CVyvPx/0X1Jte9Tc74uqbkQ0siB0S0yOIqwXKPmlNGF9ZazOlstYBqLQjbs+Z5M3rEXOXYnlrT670tT+et3Y7H97aUvp6KOHYoOGq+vBXUGPhQ8ZawCDi6r+NRYPYkW9pmR5BXC1Q7klrgoyrrHUATiKOpFnlTdRb+3FxvLWPuqdvHsmVt/Ym/3bHvzTkComq8LWdC38RV2/qVRNYtDUc3CUJQAj6BUhrUoyxrHUAtiJTh9nlTXG9tWnAr3Ju+Zcfb23+JT+RaKwsfOibdI8/0L1nIaoaWKeVwryA6RLE1QL9DqQ1Cfxlrcfpl7UOwKJqh6bmMs2bgnprr6m4wuGcUfHMXU4nae5yjX+vYy19zRzukwQgBKWctLImi7LWAWiFK2CzzpsbUXOX/bybu5zmovS1PzOet/bxxAbad/mXWi67dO6TBCAEJZy0MmWplklZ6wBEJl0nkDcx3tp38mzuMku/vnw7pXSZuLc2X5q8LVFJMH2CuFqgbJNWZgTKWrNbytqHnfCdmYnkTbG8tXdUTNlwfpmot/YN/m2Ot/Q1c7hTEoAQlGrSyoSMy1oHIGIvMKm8KZC39nm+Sl8T4Jm71LM2d5HS15I9Y910CuJqgfJMWuNncUdsjbMra03OTPgJphPMm4J4ay/QLzJfBaYJ8Ly1Vabe2tP8G31LwrJgOgVxtUBJJq3xEixrzeMpeRFaVDTZvLkZ8dZ+kjtv7V26+pBmoZiEt/Yb/EssuL9kBO6VBCAEpZi0xsjkyloH4EjtSouZdN7k31s7r6WvCcjcW5srRcZe+po1plcQVwuUX9IaE6OUtXafouYr27uyoRdIm/o+/ehgzUc+0ClEee3Z0FUnW+pUWkwO8ibf3tpVugjJkS3KoKx0zF3OMjB3ucrXIfclLA2mVxBXC5Rc0hoDo5a1xonr+5/JHvVLt6XtlZpoQ7Uhp9IWQ94t+cib6/sRc5e8eGsfqdCfo6JR8by1T8btrS2lr0Wz5ekLd0sCEIIyS1ppUx29rDVGXElOP7pC8fvq+kY1v+EKCS6PVysf+/jXeT8zIJV28O5MbvImxls7D+YuuvQ1y1tCYyErb21eYJdJ6WummG5BXC1QXkkrTVIqa42K6yvPOpuufNATV+MJbNYEvaZOXnk2bMH0efAJ0TnKm1x6a68WofQ1AVl4a0vp6z0JywP3SwIQgpJKWmmRYllrVFxDRj6dN3Tc095Uq/TOIddenqgtaRnylTf589amS+ojaRYdz9zlfEzmLnf4N1au0lcN90sCEIIySlqpkG5Za0RcaeDKswNC5w3eyyS93R8akN1gnXzu8iZf3tqzdGmSv6dUDUvXW/t0HN7afF/yHYlKhOkXxNUCpZO0Rib9staIuHqPBBJ8I1c9XL2t3xSwrByE1eCqzTzmzY2It/bT/QkNh7aKVfranzF6a0vp67aEJYI7JgEIQckkrZEIlLXW0lrKGhHXwJMtic4bbhvRpTfxv4HRbWJCywVymjd58damK5TguuASMC5v7X3+RZWs9FXDHZMAhKBMktbwjK2s1VtppdGKGfZOZ3G98kF+1cwK6I3BNyWlEiyAzW3e5MJbu5ClrwmoeuYuW+lVF3Dp60OJyoTpGMTVAqWRtIZjrGWtCcRVMAPYN3nIOvS8wEVgEjHPeTN5b+2aUufSLBuet3Y9JW/tm/wrKlvpq4Z7JgEIQTkkrSEIlLWO4e5GzLRAnLh+4sPGFaDz1OCh5wVOAtWcOc+bCZu70PVzYG1FqUjZW5sncl6UrfRVY3oGcbVAGSStAVnI4GmtiedcDa/RtdxHNM+GfDbQrtqTlib/eTNBb+0q/doLXPranxS9tadLWvqqMT2DuFqg9JHWAPjKWtU4n9YaEVe64g8sYg2Iqy597TDUUtcNdSwtTRHyZmLe2gdFL31NgGfucjGaucs6/2IK8Ei0weGuSQBCUO5IKykplLUmJSKu9F9gXsAvrp1ZAeJNv+YmZyWwFqsgeTMRb+1KS6k1aZcZz1v7bARvbf7791SicmG6BnG1QIkjrSQsbGT6tNaIuNIWdSKbbtMGv7j65mOHfGbwompKS1OcvLm+H51+Ha+5y6qKPCy3pIzurT3Hv5Lylb5quG8SgBCUNdLqh7+stZ7N01qj4qqv/T+q3QbfV9cbfOLqvYPoVMMOyIxSPsUoVN5k7K19Up7S1/6M6K0tpa95f5DvcHDfJAAhKGek1ZPJPK01Rlz1mlZGv+QT18ACrPCSrYS0lG9yrWB5k6W39gxdvox3QihnLHrmLrWB7zCwJ8RjiUqG6RvE1QIljLSszG94S1kzflprjLhOTX3Zh54p9YlvMGbZPnENrNIacl7g3L/QtXh5k5m39oYKTKA4wXLHW/t8MG/tV/kXcUfCksGdkwCEoGyRVizjKWvNK6f+uzSFzJtszF3KWPran+G8te/xr6GEpa8a7pwEIASlirSi5PpprePgwL+Eq6h5M35v7XlKiEzm3HPHEN7afK/xkURlw3QO4mqBEkVaQWbXjr0ntOTzaa1joOa/TVPcvBm3t3ZNqQtpuodn7tJIZO7yOn//6xKWDe6dBCAEZYm0fIy7rDWvBKoICp03Y/XWpuTYkaaTeN7aF/29te+b776Upa8a0zuIqwVKEWkJwbLWUpc4RlhTdWkRRc+b6xFzl+fpmLssUWq4lRcREntrS+nrAwlLh+kdxNUC5Ye0iKzKWvNK1V+iVYK8GY+39oHy/w1ylWTe2rf4ay9l6auGuycBCEHZIS1fWevFmMta88qS31y/HHmTvrd2hf7+ulD62p8Fz9xlz3Z/j9cePy3rrADEtSeUGvRvxmWteWXe/yyCsuRN2t7aKzRYc2DlSDKWPG/tnbgF4FL6ui9h+eD+SQBCUF5kX9aaV2b8cyQlypsYc5f7Q5u7HKuAeZjz9PLW3uZve7xGD5OEOveudB+AQfgX3/7tdRuntR4sV+1M5rogNW9t50pf+2P31uZrhpKWvmqodxBXMAz/VP7PjKYodxw91XxFlDuOzvVqOt7aa3SUbhhiDYJn7tL0m7tc56/5roQlhHoHcQXDkLm4jplv+dRn+HTv8qd+/+8Q8Y4iwh2koeugk6m5W3je2g3PW1tKXzN6OkQabNUGm07nDkoAQlAySAsEoaT5/s98RvQiyjJrTTynIk9xeIvdJsK3fff38Qnh8YOf/i55LQta8i3EIt9eLEVQ87C3Ni80LlLpa021BpJX00GIqwXKBGmBIJPIm1lRizhSU/O/9y8/y33z+IF//Q/ltfLRU8135euLY1W+9zisS8AD3tpS+roprxWBGh15ayf5tA/3UAIQgr5MaYEgZc6bqLf2H/3Nv1KEwyNWzf+EUh/W//dSc2/xiZP8pT/0F7jxN/6cmYT5W/55l9TVPGW0uCrV3EoqryZ3IK4W6KuUFghS7rwZ0lt7kfJlpIvwGVGLWERlYjkReYojt2r+bd/78uWnpT022vItxDKgmh/JPpPKK2eOBCAEfZHSAkFKnzdz2xFzlwf9zF32Clf6OlE1/+QPvnz5ndIuGI1EVXicNhKAEPQ1SgsEcSFvBvbWbiq1IU0QT0fNf9kf/A71qZcv/+wvl9ggwh3LsSh3HJ5LXYYkeTw9J40EIAR9idICQRzJm4G8tZdR+pqYuRcvP/vZly8PJRwfFRHuWHZEueOIUXNvSN4+SDT7wxkjAQhB36O0QBBn8mYAb+1jNdRjdZ1kk7/KYpW+8g0t1d5LWEfIfZQAhIC42nApb+ai5i5x3tqVtlKhAk9gg7/RJxIVBCOuiaUV4tobiKsNx/LmWsRb+0XEW3tNqRZKX5Nxjb/EgpW+krgOVEXAnZQAhIC42nAvb/p6a58qdSBN0Ie7/A0WqPRVUxusQAvi2hOIqw0n86ant/YsJUvZn66eGnwd8LZERWFxwNuVppMQVwsQVxuO5s3VzUfc8y4P17m6YEf5n9QAenGDv7oilb4OA/dSAhAC4mrD3byJ8dZ+oL21z5OtfQTEIX9vKT7QPJeYXkJcLUBcbTidN3He2r+CcsW9h1YOxzTPXr8lYWkxvYS4WoC42nA9byLe2v9Mqd8tr4E+vMFf2S0JSwt3UwIQAuJqA3lzdT0w/fqtSn3PI5l+Bb3h+4LPS/vU1w6mmxBXCxBXG8gbYm7bm37990p9UhvBPij9cGx0rvKg/76E5cV0E+JqAeJqA3nDXN+X6dfvf/e7ufH8sLyPM00HKX3t6YFTCrifEoAQEFcbyBuPqLf2k7sFWx2fLTydUrDS12Ew/cRJYgHiagN542N6PWLuksRb21Gk9PWehCWGOyoBCAFxtYG8CTK3GfHWjjN3AVNTd/jrsTo3lgfuqAQgBMTVBvImwsDe2o7CNwGLVvo6DKajOEksQFxtIG/iGMhb21Gk9HVbwjLDPZUAhIC42kDexDOAt7aj7PO34sJ3wj2VAISAuNpA3li5GvXWfriO6VdhmpeuPZSw1Jie4iSxAHG1gbzpRRJvbUe5yd+HE7UW3FUJQAiIqw3kTR/6ems7Cpe+vnBiJG+6ipPEAsTVBvKmPz29tR1l2pXSV43pKk4SCxBXG8ibJITMXTSOm7us87fgxhwJ91UCEALiagN5kxCbt7aj8B+bpxKVHNNXnCQWIK42kDfJifPWflVec4w57r8Dpa8a7qwEIATE1QbyZiAi3tovH99x0dxFSl8d+dPCnZUAhIC42kDeDMj0+kP+zro8cs/chQ0Y3pGo7JjO4iSxAHG1gbwZHJ+3dgfHvLVf5V7fkbDscG8lACEgrjaQN0PheWt7OOWtfY/77Mp6NO6tBCAExNUG8mZYXPbW5r8sjyQqPaa3OEksQFxtIG+Gx1lzFyl9XZew9HB3JQAhIK42kDcj4aa39n3TUTdKXzWmuzhJLEBcbSBvRsU9b20pfX0gYfkx3cVJYgHiagN5kwKOeWvf4j66Yw/G/ZUAhIC42kDepMJ01NzlndKau/BC36fuWNua/uIksQBxtYG8SQtnvLWl9HVfQgfgDksAQkBcbSBvUsQNb+1t7ppDy3q5wxKAEBBXG8ibdHHAW5sH6I8lcgHTYZwkFiCuNpA3qRNj7rJdouqC69wnV0pfNdxjCUAIiKsN5M0YKLW3tpS+uuQFxj2WAISAuNpA3oyH8npr87SyM6WvGtNjnCQWIK42kDdjo5ze2q9zVzYldALusgQgBMTVBvJmnLwRMXcpvLe2lL465WBruoyTxALE1QbyZrzEeGu/XWRv7WleDOFO6avGdBkniQWIqw3kzdgplbe2lL669WhG7rMEIATE1QbyJgvK463NJovP3Sl91Zg+4ySxAHG1gbzJiJtRc5e7xasumOM55EMJHcH0GSeJBYirDeRNZpTBW3uTj9uh0lcNd1oCEALiagN5kyWF99bm0tcnErmC6TROEgsQVxvIm4wptLf2NT7iuxK6AvdaAhAC4moDeZM9r0fMXYrirX2XD9el0lcN91oCEALiagN5MxGi3tqPi+CtzYPutyVyBtNrnCQWIK42kDcTooje2jf4OJ0qfdVwtyUAISCuNpA3k6Nw3tqHfJAuPD08gOk2ThILEFcbyJuJciNq7pJfb20pfX1LQncw3cZJYgHiagN5M2livLVzau7yBh9eYUt3h4b7LQEIAXG1gbyZPEXx1uabcI6VvmpMv3GSWIC42kDe5IIieGtfdbL0VWP6jZPEAsTVBvImL+TeW1tKXwtT8ZAe3HEJQAiIqw3kTY64GfHWfnI3P9OvPHfhWumrxnQcJ4kFiKsN5E2uyLG3tpS+3pPQJbjnEoAQEFcbyJu8kVdvbSl9LZ5N4uhwzyUAISCuNpA3OeT6fsTcZfLe2iz5zpW+akzPcZJYgLjaQN7kk9ej3tqTNXeR0tdtCZ2Cuy4BCAFxtYG8ySs589be50NwrvRVw12XAISAuNpA3uSYHHlrT/M6sYcSuoXpOk4SCxBXG8ibfJMXb+2b/OHulb5quO8SgBAQVxvIm9xzI+qtnb25C5e+vnCv9FVj+o6TxALE1QbypghM3Ft7mqsb7kvoGKbvOEksQFxtIG+KwYS9tdf5Ix0sfdVw5yUAISCuNpA3hWGS3tpc+vpUItcwncdJYgHiagN5UyQmZe4yxx/mYumrhnsvAQgBcbWBvCkYE/HWvsOflCuTrgzh3ksAQkBcbSBvCscEvLW59PUdiZzD9B4niQWIqw3kTRHJ2Fv7Vf6MOxI6B3dfAhAC4moDeVNQru9Hp1/HZe5yjz/AydJXDXdfAhAC4moDeVNcMvPWZhl/JJF7mO7jJLEAcbWBvCky2XhrS+nruoTuwf2XAISAuNpA3hScDLy175u9Olr6qjH9x0liAeJqA3lTfGLMXQ5TrKWS0tcHEjqI6T9OEgsQVxvIm1IwTm/tW7zDrIrBcgh/ARKAEBBXG8ibkjA+b22e1nW19FVjvgCcJBYgrjaQN+VhPN7aUvq6L6GL8DcgAQgBcbWBvCkV1yPmLs9HNXfZ5v1M/AGJE4S/AQlACIirDeRN2Yh6az8dyVubR8OPJXIS8w3gJLEAcbWBvCkhaXprX+cdOFv6quGvQAIQAuJqA3lTStLz1pbS17Ebb+UZ/gokACEgrjaQN2Ulxtzl/hDmLjyH627pq8Z8BThJLEBcbSBvSkwK3tqv889tSugm/B1IAEJAXG0gb8rNqN7aUvo6XrvYvGO+A5wkFiCuNpA3ZWckb+1pXnngcOmrxnwHOEksQFxtIG8c4FrE3CWpt7aUvo7RiLsI8JcgAQgBcbWBvHGDqLf28yTe2lxS+9RdQyyD+RJwkliAuNpA3jjDEN7ac/wThxK6ivkScJJYgLjaQN44xMDe2pv8JpdLXzX8LUgAQkBcbSBv3GJuO2Lu8sBu7sKVCE8kchbzLeAksQBxtYG8cY4Yb+378d7aUvp6V0Jn4a9BAhAC4moDeeMiCb217/JrTpe+avhrkACEgLjaQN64SSJvbR7hvi2Ru5ivASeJBYirDeSNs8xFzV2C3to3eKPbpa8a/h4kACEgrjaQNy5zLeKt/cLnrX3IW1J5VkyhMd8DThILEFcbyBvHsXtrS+nrWyZwGvM94CSxAHG1gbwBFm/tN7h9S97lMPxFSABCQFxtIG+A9taOmLs8XOc7Xs8dL33VmC8CJ4kFiKsN5A0wRL21GddLXzXyVYBYSFylBeKQJAJOE/XWJuLLC9xCvgoQC8S1N5JEwHUi3trOl75q5LsAsUBceyNJBEDIW/uebHYa+S5ALO+++660QBySRAAQcz5v7ZiiWPeQ7wKAIZAkAoDpeGuj9FVjvgoAhkKSCAAP4629LQEAAIC0mF5/C6WvAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAABh9vR0RprDU6uvSAsAAIBmVzUr0hyeVHYCAADpsHRa35VmIion9dRHiJWm2jP/n9ZrZoNmt34irYQsKbUqTQAAmCyVXaVUXYIQlWrcpfoG/cC5tIchbq9rSs3r/+f9x1JXSlo98e2vMdKBAQBAalQvSCpt4nqqLqTlhzRPqQUJhiBur3U5hGHE1bc/+kMxwoEBAEBaHCjVXLWKa101pOWD9O9IqYEmEoLE7HVWqR3TGEZcfftbUqo7qwAAABODVHKG/hlEXHeUmm2opkRDELPXDaUWTWNEcZ1qqDNpAQDABNnVV9EBcZ2pbtRWzCRmtXqumtVqdcls97hQp/ryuyohMVvd2aL3VauzsmGmWlvpXJ5Xqlo259fWWD3j93raEWu7uC5tbFW7SwFsR7mnVNw0MQAATAC/oK029YyqvuqnS2zB3GrqQJvXphaUOpJ4avZY3qYU39yfNZOyqslyt0YKOX+uN1xovY3fa6sz4LSI64x8xqnIt/UoaQiMpa4AgJzgE7QVEsWTI9JCo3NMuzMgNeypNo0NL1RLhpGVC/rxvTPzzgO9YYmEr35Qb6u2WRZF4qq3aDVs0Y5i90pafcyteHFd1HfdLhr0T8sMmO1HuYxJVwBAbvAJWkOdadGcN4tOA7OZHZrqlP7d8VaUHvBYcbktt6QqDdXQMwALF6x3JK5tVZufmiGptO2V3sMvxYtrhWS0Roc1Q591rg/PfpSLNLqVJgAATJiuoM0otSVNTYy40tBQqyqJoIiYnoLVHKi2+X+rc2+KdE6LHwmnWtPxTFv2Ft1rzftYbyAqmI20SxZureT0xh5HSS9FDhkAACZDV1wr7c71uSFGXI9V28wHnHWu6zvX4Rsy63nh7ezCTKSSuIoSHotWRve6642DY8W14VW1LphD7XWU7VHWMQAAQJr4LsXpSvygOxkalUFP10hLN0yjLUteafSpFbDiXeFPnRidI3GVhQV7SpldR/d6pJQsHiBxbdQ6NFhcaTTq3T07Mz/b4ygvRJABAGDi+MR1oaVU+7izzCoqgySVPMacVXKD/1w1jKhecOUpjS190IauuJL8mrFtrLjK2oG4OddF302qUyPhPY6yM08LAAATxy9osyR0FPMq1agMkrjt8rCyKZWmK6Syy9XlM5lZrRpRFfRsbEJxlffEieuq7FpD79RDVvtRymgXAAAmj1/QSN/2aFzYNEvxIzJI41UfZjxJ4snw7IB/mGlIIq6BOdeIuJJee7usy20z61FizhUAkBuC4jo1NUPjUyNnERncUeq8LvB9+Zm22tqtt+oHUoDlnyA1JBFXekWWA8SJK23zdnnRNWmJPUpS//DOAQBgQoTFVSumKbY6kaUBHuemgoA5M3ehVsJvaYVc/6LiGtmrvvDvtc6VhqjyAzQu7q4TiDtKrHMFAOSHiLjSxbUZKx511qwK3UoqYsNUZJEuHsjNKGYvVIAaFdfwXs1+uXI2XlxplzKwpcGq70djjnKlMz0BAAATpytoO+fL+r9dWWe1Y0aUXTnrzo0Ss21dAqurpzTN+h5r7GxTtfn+04q5nx8V1/BeiXZPbwH6JFWbpRdPeIKgx1GS4nePEAAAJoWxymb0BT/pVKNeb5DCmQttrWqENzJteo4CGhpG0hiVLsQ7cLHASouaZk7W3OSPimt4r0RdtbgRK65TG/onmnq/5imGPY7yILhfAACYDCFxFfep9p7MrK5qQfOmWUlH/Ter9IzA1MyFOl+uVqurB/RWrgSYJdXVNM1eouIa2quG5JJHnrOx4qqNCjRtnh3ocZTN2GcnAADApKlUN9Y8X1YaSVZ3VrrRUvDpV0v0xgPVlqHilm/FVHVtpyqGrpWqaOvUjOfhGtwrQQNW+dnFwIfLPoiZ6sZyd0xqO0r/qi0AACgwjc6tKJ9ADsGZb8A6Agd4hhYAoBw0vOtwuuof3qeahr1pzJU28fRXAEA5OFbqdKM6NVs98s+WDkylmcYSqiqeQwAAKAkzshSLqAemUQdkzysUGIGDNHYCAAC5YPWkrpe5eiZVwzF70nk+1gjs1jFwBQAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAUD6mpv4/401ggl6xaGEAAAAASUVORK5CYII=" preserveAspectRatio="none" id="img2"></image><clipPath id="clip3"><rect x="0" y="0" width="5303980" height="1967730"/></clipPath></defs><g clip-path="url(#clip0)" transform="translate(-314 -308)"><g clip-path="url(#clip1)" transform="matrix(0.000164028 0 0 0.000164028 314 308)"><g clip-path="url(#clip3)" transform="matrix(1 0 0 1.00074 -0.107422 -0.0912925)"><use width="100%" height="100%" xlink:href="#img2" transform="scale(3865.87 3865.87)"></use></g></g></g></svg> \ No newline at end of file
diff --git a/content/html/_images/gui_framework_overview.png b/content/html/_images/gui_framework_overview.png deleted file mode 100644 index da3cf9c..0000000 --- a/content/html/_images/gui_framework_overview.png +++ /dev/null Binary files differ
diff --git a/content/html/_images/math/1f81befb8ab4e6d3af9e6e11361477a156ea9836.png b/content/html/_images/math/1f81befb8ab4e6d3af9e6e11361477a156ea9836.png new file mode 100644 index 0000000..cb7cdfc --- /dev/null +++ b/content/html/_images/math/1f81befb8ab4e6d3af9e6e11361477a156ea9836.png Binary files differ
diff --git a/content/html/_images/math/340d7e571b3feafaa7e510b6c7d1328b1f4c64ad.png b/content/html/_images/math/340d7e571b3feafaa7e510b6c7d1328b1f4c64ad.png new file mode 100644 index 0000000..902268b --- /dev/null +++ b/content/html/_images/math/340d7e571b3feafaa7e510b6c7d1328b1f4c64ad.png Binary files differ
diff --git a/content/html/_images/math/bb9c6cf90a7cce5208d424db5de2b83f0ef1fddb.png b/content/html/_images/math/bb9c6cf90a7cce5208d424db5de2b83f0ef1fddb.png new file mode 100644 index 0000000..6d18634 --- /dev/null +++ b/content/html/_images/math/bb9c6cf90a7cce5208d424db5de2b83f0ef1fddb.png Binary files differ
diff --git a/content/html/_images/math/bc08e6aac48aefa03313665a4a532f6a9c5ecd63.png b/content/html/_images/math/bc08e6aac48aefa03313665a4a532f6a9c5ecd63.png new file mode 100644 index 0000000..ed445da --- /dev/null +++ b/content/html/_images/math/bc08e6aac48aefa03313665a4a532f6a9c5ecd63.png Binary files differ
diff --git a/content/html/_images/math/f1aece6474c2a5f6a6db0e37b59055fb90810d92.png b/content/html/_images/math/f1aece6474c2a5f6a6db0e37b59055fb90810d92.png new file mode 100644 index 0000000..47039a5 --- /dev/null +++ b/content/html/_images/math/f1aece6474c2a5f6a6db0e37b59055fb90810d92.png Binary files differ
diff --git a/content/html/_sources/advanced_topics/simulator/agent_components.rst.txt b/content/html/_sources/advanced_topics/simulator/agent_components.rst.txt index baf028d..507557e 100644 --- a/content/html/_sources/advanced_topics/simulator/agent_components.rst.txt +++ b/content/html/_sources/advanced_topics/simulator/agent_components.rst.txt
@@ -1,6 +1,7 @@ .. ******************************************************************************* Copyright (c) 2021 in-tech GmbH + 2023 Bayerische Motoren Werke Aktiengesellschaft (BMW AG) This program and the accompanying materials are made available under the terms of the Eclipse Public License 2.0 which is available at @@ -88,6 +89,11 @@ Currently the collision is implemented fully inelastic, i.e. all agents will have the same velocity after the collision, while the momentum is conserved. After the collision the agents slow down with a fixed deceleration until fully stopped. +Dynamics_Scenario +----------------- + +See :ref:`dynamics_scenario`. + Dynamics_RegularDriving ------------------------
diff --git a/content/html/_sources/advanced_topics/simulator/event_detector.rst.txt b/content/html/_sources/advanced_topics/simulator/event_detector.rst.txt index ac93273..dfc5841 100644 --- a/content/html/_sources/advanced_topics/simulator/event_detector.rst.txt +++ b/content/html/_sources/advanced_topics/simulator/event_detector.rst.txt
@@ -1,6 +1,7 @@ .. ******************************************************************************* Copyright (c) 2021 in-tech GmbH + 2023 Mercedes-Benz Tech Innovation GmbH This program and the accompanying materials are made available under the terms of the Eclipse Public License 2.0 which is available at @@ -37,3 +38,38 @@ In case of a collision, a CollisionEvent containing the participating object Ids is created. This type of event is picked up by the CollisionManipulator, which updates the state of the collided objects accordingly. +The geometric parameters of the crash configuration in terms of collision angles are determined according to Wagstrom et. al. (https://www-esv.nhtsa.dot.gov/Proceedings/26/26ESV-000177.pdf). In addition, collision velocities are stored. + +.. figure:: ./images/crash_config.svg + +Furthermore, the CollisionDetector contains an impact evaluation which estimates based on momentum the changes in velocities due to the collision, considering vehicle mass ratio and initial crash configuration, e.h. `VelocityChange`. The impact model behind these calculations was developed and tested with full-overlap vehicle-to-vehicle collisions. + +The concept was described in detail at ESAR 2016 in Kolk et. al. (https://bast.opus.hbz-nrw.de/opus45-bast/frontdoor/deliver/index/docId/1825/file/F117_21.pdf). + + +The parameters stored for each collision are listed in detail in the table below. + +============================ ==================================================================== +Parameter Description +============================ ==================================================================== +CollisionVelocity velocity of host prior to the collision +CollisionWithAgent true (1) / false (0) if collision occured with another agent +HCPA host collision point angle in degree +HCPAo normalized HCPA +OCPA opponent collision point angle +OCPAo normalized OCPA +OYA opponent yaw angle +OpponentCollisionVelocity velocity of opponent prior to the collision +OpponentPointOfContactLocalX X-coordinate of opponent point of contact in local coordinate system +OpponentPointOfContactLocalY Y-coordinate of opponent point of contact in local coordinate system +OpponentVelocity velocity of opponent after the collision +OpponentVelocityChange velocity change of opponent due to collision +OpponentVelocityDirection velocity direction +OpponentYawVelocity opponent yaw velocity +PointOfContactLocalX X-coordinate of point of contact in local coordinate system +PointOfContactLocalY Y-coordinate of opponent point of contact in local coordinate system +Velocity velocity of host after the collision +VelocityChange velocity change of host due to collision +============================ ==================================================================== + +.. note:: Both geometric interpretation and impact calculation only work for collisions between two car agents. A more general application is work in progress.
diff --git a/content/html/_sources/advanced_topics/simulator/scenario_actions.rst.txt b/content/html/_sources/advanced_topics/simulator/scenario_actions.rst.txt new file mode 100644 index 0000000..435411a --- /dev/null +++ b/content/html/_sources/advanced_topics/simulator/scenario_actions.rst.txt
@@ -0,0 +1,309 @@ +.. + ******************************************************************************* + Copyright (c) 2023 Bayerische Motoren Werke Aktiengesellschaft (BMW AG) + + This program and the accompanying materials are made available under the + terms of the Eclipse Public License 2.0 which is available at + http://www.eclipse.org/legal/epl-2.0. + + SPDX-License-Identifier: EPL-2.0 + ******************************************************************************* + +.. _mapping_scenario_actions: + +Mapping of OpenSCENARIO Actions +================================ + +.. table:: + :class: tight-table + + =================== ============= + Layer/Component API/Datatype + =================== ============= + OpenScenario + OpenScenarioEngine mantle_api + opSimualtion openPASS + FMU Interface osi3 + =================== ============= + +AcquirePositionAction +---------------------- + +.. table:: + :class: tight-table + + +--------------+-------------------------------------------------------------------------------------------------------+ + | API/Datatype | Used Methods/Classes/API | + +==============+=======================================================================================================+ + | OpenScenario | **AcquirePositionAction** | + +--------------+-------------------------------------------------------------------------------------------------------+ + | mantle_api | Entity::AssignRoute(UniqueId, RouteDefinition) | + | | Entity::GetPosition() | + | | GeometryHelper::TranslateGlobalPositionLocally() | + +--------------+-------------------------------------------------------------------------------------------------------+ + | openPASS | SpawnParameter | + | | AgentInterface::GetPositionX() | + | | AgentInterface::GetPositionY() | + | | AgentInterface::GetYaw() | + | +-------------------------------------------------------------------------------------------------------+ + | | RouteSamplerInterface::CalculateRouteFromWaypoints(std::vector<mantle_api::RouteWaypoint>) | + | | EgoAgentInterface::SetRoadGraph(RoadGraph, RoadGraphVertex, RoadGraphVertex) | + +--------------+-------------------------------------------------------------------------------------------------------+ + | osi3 | x -- not implemented | + +--------------+-------------------------------------------------------------------------------------------------------+ + +AssignRouteAction +------------------ + +.. table:: + :class: tight-table + + +--------------+-------------------------------------------------------------------------------------------------------+ + | API/Datatype | Used Methods/Classes/API | + +==============+=======================================================================================================+ + | OpenScenario | **AssignRouteAction** | + +--------------+-------------------------------------------------------------------------------------------------------+ + | mantle_api | Entity::AssignRoute(UniqueId, RouteDefinition) | + +--------------+-------------------------------------------------------------------------------------------------------+ + | openPASS | RouteSamplerInterface::CalculateRouteFromWaypoints(std::vector<mantle_api::RouteWaypoint>) | + | | EgoAgentInterface::SetRoadGraph(RoadGraph, RoadGraphVertex, RoadGraphVertex) | + +--------------+-------------------------------------------------------------------------------------------------------+ + | osi3 | x -- not relevant | + +--------------+-------------------------------------------------------------------------------------------------------+ + +CustomCommandAction +-------------------- + +.. table:: + :class: tight-table + + +--------------+-------------------------------------------------------------------------------------------------------+ + | API/Datatype | Used Methods/Classes/API | + +==============+=======================================================================================================+ + | OpenScenario | **CustomCommandAction** | + +--------------+-------------------------------------------------------------------------------------------------------+ + | mantle_api | ExecuteCustomCommand(actors, type, command) | + +--------------+-------------------------------------------------------------------------------------------------------+ + | openPASS | AddCustomCommand(command) | + | | GetCustomCommands() | + | | ComponentControllerImplementation::Trigger(time) | + | | TrajectoryFollowerCommonBase::Trigger(time) | + +--------------+-------------------------------------------------------------------------------------------------------+ + | osi3 | osi3::TrafficAction::CustomAction | + | | TrafficAction::mutable_custom_action() | + | | TrafficAction_CustomAction::set_command(command) | + +--------------+-------------------------------------------------------------------------------------------------------+ + +FollowTrajectoryAction +----------------------- + +.. table:: + :class: tight-table + + +--------------+-------------------------------------------------------------------------------------------------------+ + | API/Datatype | Used Methods/Classes/API | + +==============+=======================================================================================================+ + | OpenScenario | **FollowTrajectoryAction** | + +--------------+-------------------------------------------------------------------------------------------------------+ + | mantle_api | UpdateControlStrategies(FollowTrajectoryControlStrategy) | + | | HasControlStrategyGoalBeenReached(ControlStrategyType::kFollowTrajectory) | + | | GeometryHelper::TranslateGlobalPositionLocally(PolyLine) | + | | MovementDomain::kBoth | + +--------------+-------------------------------------------------------------------------------------------------------+ + | openPASS | SetStrategies(MovementDomain::kBoth, ControlStrategyType::kFollowTrajectory) | + | | Algorithm_Routecontrol_Implementation::ReadWayPointData() | + | | DynamicsScenarioImplementation::ReadWayPointData() | + | | TrajectoryFollowerImplementation::Trigger(time) | + | | FmuHelper::AddTrafficCommandActionFromOpenScenarioTrajectory(TrafficCommand::add_action(), Trajectory)| + +--------------+-------------------------------------------------------------------------------------------------------+ + | osi3 | **osi3::TrafficAction::FollowTrajectoryAction** | + | | | + | | TrafficAction::mutable_follow_trajectory_action() | + | | TrafficAction_FollowTrajectoryAction::add_trajectory_point() | + | +-------------------------------------------------------------------------------------------------------+ + | | **osi3::TrafficAction::FollowPathAction** | + | | | + | | TrafficAction::mutable_follow_path_action() | + | | TrafficAction_FollowPathAction::add_path_point() | + +--------------+-------------------------------------------------------------------------------------------------------+ + +LaneChangeAction +---------------- + +.. table:: + :class: tight-table + + +--------------+-------------------------------------------------------------------------------------------------------+ + | API/Datatype | Used Methods/Classes/API | + +==============+=======================================================================================================+ + | OpenScenario | **LaneChangeAction** | + | | | + | | LaneChangeActionImpl::GetLaneChangeTarget() | + | | ConvertScenarioLaneChangeTarget(ILaneChangeTarget) -> mantle_api::LaneId | + | +-------------------------------------------------------------------------------------------------------+ + | | **RelativeTargetLane** | + | | | + | | LaneChangeTargetImpl::GetRelativeTargetLane() | + | | ConvertScenarioRelativeTargetLane(IRelativeTargetLane) -> mantle_api::LaneId | + | +-------------------------------------------------------------------------------------------------------+ + | | **AbsoluteTargetLane** | + | | | + | | LaneChangeTargetImpl::GetAbsoluteTargetLane() | + | | ConvertScenarioAbsoluteTargetLane(IAbsoluteTargetLane) -> mantle_api::LaneId | + +--------------+-------------------------------------------------------------------------------------------------------+ + | mantle_api | UpdateControlStrategies(PerformLaneChangeControlStrategy) | + | | (ControlStrategyType::kPerformLaneChange) | + | +-------------------------------------------------------------------------------------------------------+ + | | **Relative** | + | | | + | | LaneLocationQueryService::GetRelativeLaneId() | + +--------------+-------------------------------------------------------------------------------------------------------+ + | openPASS | SetStrategies(MovementDomain::kLateral, ControlStrategyType::kPerformLaneChange) | + | | DynamicsScenarioImplementation::CalculateSinusiodalLaneChange(PerformLaneChangeControlStrategy) | + | | DynamicsScenarioImplementation::ReadWayPointData() | + +--------------+-------------------------------------------------------------------------------------------------------+ + | osi3 | x -- not implemented | + +--------------+-------------------------------------------------------------------------------------------------------+ + +SpeedAction +--------------- + +.. table:: + :class: tight-table + + +--------------+-------------------------------------------------------------------------------------------------------+ + | API/Datatype | Used Methods/Classes/API | + +==============+=======================================================================================================+ + | OpenScenario | **SpeedAction** | + | | SetLinearVelocitySplineControlStrategy(std::string) | + +--------------+-------------------------------------------------------------------------------------------------------+ + | mantle_api | UpdateControlStrategies(FollowVelocitySplineControlStrategy) | + | | HasControlStrategyGoalBeenReached(ControlStrategyType::kFollowVelocitySpline) | + | | SetSpeed(IEntity, units::velocity::meters_per_second_t) | + | | MovementDomain::kLongitudinal | + +--------------+-------------------------------------------------------------------------------------------------------+ + | openPASS | SetStrategies(MovementDomain::kLongitudinal, ControlStrategyType::kFollowVelocitySpline) | + | | ControlStrategies::HasNewLongitudinalStrategy() | + | | DynamicsScenarioImplementation::GetVelocityFromSplines() | + +--------------+-------------------------------------------------------------------------------------------------------+ + | osi3 | osi3::TrafficAction::SpeedAction | + | | TrafficAction::mutable_speed_action() | + | | TrafficAction_CustomAction::set_absolute_target_speed(targetSpeed) | + +--------------+-------------------------------------------------------------------------------------------------------+ + +TeleportAction +--------------- + +.. table:: + :class: tight-table + + +--------------+-------------------------------------------------------------------------------------------------------+ + | API/Datatype | Used Methods/Classes/API | + +==============+=======================================================================================================+ + | OpenScenario | **TeleportAction** | + +--------------+-------------------------------------------------------------------------------------------------------+ + | mantle_api | Entity::SetPosition(Vec3<units::length::meter_t>) | + | | Entity::SetOrientation(Orientation3<units::angle::radian_t>) | + | | Entity::SetAssignedLaneIds(std::vector<uint64_t>) | + | | GeometryHelper::TranslateGlobalPositionLocally(...) | + | | LaneLocationQueryService::GetUpwardsShiftedLanePosition(...) | + | | LaneLocationQueryService::GetLaneIdsAtPosition(…) | + +--------------+-------------------------------------------------------------------------------------------------------+ + | openPASS | RouteSampler::Sample(mantle_api::Vec3<units::length::meter_t>, units::angle::radian_t) | + | | AgentInterface::SetPositionX(units::length::meter_t) | + | | AgentInterface::SetPositionY(units::length::meter_t) | + | | AgentInterface:SetYaw(units::angle::radian_t) | + +--------------+-------------------------------------------------------------------------------------------------------+ + | osi3 | x -- not relevant | + +--------------+-------------------------------------------------------------------------------------------------------+ + +TrafficSignalAction +-------------------- + +.. table:: + :class: tight-table + + +--------------+-------------------------------------------------------------------------------------------------------+ + | API/Datatype | Used Methods/Classes/API | + +==============+=======================================================================================================+ + | OpenScenario | **TrafficSignalAction** | + +--------------+-------------------------------------------------------------------------------------------------------+ + | mantle_api | SetTrafficSignalState(std::string name, std::string state) | + +--------------+-------------------------------------------------------------------------------------------------------+ + | openPASS | WorldData::GetTrafficSignIdMapping() | + | | WorldData::GetSignalType(Id) | + | | WorldData::GetTrafficLight(Id) | + | | ThreeSignalsTrafficLight::SetState(CommonTrafficLight::State) | + | | TwoSignalsTrafficLight::SetState(CommonTrafficLight::State) | + | | OneSignalsTrafficLight::SetState(CommonTrafficLight::State) | + | | DataBuffer::PutAcyclic | + +--------------+-------------------------------------------------------------------------------------------------------+ + | osi3 | TrafficLight_Classification::set_mode(::osi3::TrafficLight_Classification_Mode) | + +--------------+-------------------------------------------------------------------------------------------------------+ + +TrafficSignalStateAction +------------------------- + +.. table:: + :class: tight-table + + +--------------+-------------------------------------------------------------------------------------------------------+ + | API/Datatype | Used Methods/Classes/API | + +==============+=======================================================================================================+ + | OpenScenario | **TrafficSignalStateAction** | + +--------------+-------------------------------------------------------------------------------------------------------+ + | mantle_api | SetTrafficSignalState(std::string name, std::string state) | + +--------------+-------------------------------------------------------------------------------------------------------+ + | openPASS | WorldData::GetTrafficSignIdMapping() | + | | WorldData::GetSignalType(Id) | + | | WorldData::GetTrafficLight(Id) | + | | ThreeSignalsTrafficLight::SetState(CommonTrafficLight::State) | + | | TwoSignalsTrafficLight::SetState(CommonTrafficLight::State) | + | | OneSignalsTrafficLight::SetState(CommonTrafficLight::State) | + | | DataBuffer::PutAcyclic | + +--------------+-------------------------------------------------------------------------------------------------------+ + | osi3 | TrafficLight_Classification::set_mode(::osi3::TrafficLight_Classification_Mode) | + +--------------+-------------------------------------------------------------------------------------------------------+ + +TrafficSinkAction +-------------------- + +.. table:: + :class: tight-table + + +--------------+-------------------------------------------------------------------------------------------------------+ + | API/Datatype | Used Methods/Classes/API | + +==============+=======================================================================================================+ + | OpenScenario | **TrafficSinkAction** | + | | | + | | ConvertScenarioTrafficDefinition(NET_ASAM_OPENSCENARIO::v1_1::ITrafficDefinition) | + +--------------+-------------------------------------------------------------------------------------------------------+ + | mantle_api | Entity::GetPosition() | + | | GeometryHelper::TranslateGlobalPositionLocally() | + +--------------+-------------------------------------------------------------------------------------------------------+ + | openPASS | SpawnParameter | + | +-------------------------------------------------------------------------------------------------------+ + | | AgentInterface::GetPositionX() | + | | AgentInterface::GetPositionY() | + | | AgentInterface:GetYaw() | + +--------------+-------------------------------------------------------------------------------------------------------+ + | osi3 | x -- not relevant | + +--------------+-------------------------------------------------------------------------------------------------------+ + +VisibilityAction +-------------------- + +.. table:: + :class: tight-table + + +--------------+-------------------------------------------------------------------------------------------------------+ + | API/Datatype | Used Methods/Classes/API | + +==============+=======================================================================================================+ + | OpenScenario | **VisibilityAction** | + +--------------+-------------------------------------------------------------------------------------------------------+ + | mantle_api | SetVisibility(EntityVisibilityConfig) | + +--------------+-------------------------------------------------------------------------------------------------------+ + | openPASS | x -- not implemented | + +--------------+-------------------------------------------------------------------------------------------------------+ + | osi3 | x -- not implemented | + +--------------+-------------------------------------------------------------------------------------------------------+
diff --git a/content/html/_sources/developer_information/20_documentation.rst.txt b/content/html/_sources/developer_information/20_documentation.rst.txt index f16170d..6de5712 100644 --- a/content/html/_sources/developer_information/20_documentation.rst.txt +++ b/content/html/_sources/developer_information/20_documentation.rst.txt
@@ -1,6 +1,8 @@ .. ******************************************************************************* Copyright (c) 2021 in-tech GmbH + 2023 Mercedes-Benz Tech Innovation GmbH + 2023 Bayerische Motoren Werke Aktiengesellschaft (BMW AG) This program and the accompanying materials are made available under the terms of the Eclipse Public License 2.0 which is available at @@ -22,7 +24,7 @@ Basic Build Mechanics --------------------- -The required steps to build the documentation are described in :ref:`download_and_install_openpass`, provided by CMake files using the build option ``WITH_GUI=ON``. +The required steps to build the documentation are described in :ref:`download_and_install_openpass`. Before building, a temporary copy of the original documentation is made. This temporary copy acts as *seam* for custom extension, as proprietary content is simply copied into the temporary folder (see below). This mechanism keeps contents clearly separated during development and allows easy transition from closed to open source if desired. @@ -32,10 +34,9 @@ Thus, placeholders are used to have a fixed reference to the |op_oss| tree: - *@*\ *OP_REL_ROOT*\ *@* - Root of repository (``.``) - - *@*\ *OP_REL_GUI*\ *@* - Folder ``./gui`` - *@*\ *OP_REL_SIM*\ *@* - Folder ``./sim`` -This placeholders must be used when files outside of the documentation root shall be referenced. +These placeholders must be used when files outside of the documentation root shall be referenced. Note that this also makes sources more readable. **Example** @@ -95,3 +96,20 @@ Sphinx allows to specify a configuration residing in ``conf.py`` in the documentation source directory. Customization is done by providing a customized file here, with the open source version as template (:download:`/../../../repo/doc/source/conf.py`). + +Docker Image +------------ + +This documentation provides an overview of the Dockerfile used to build an image containing all the necessary packages required for building |Op_oss|. The resulting image can be used as a development environment. + +**Usage** + +#. Clone the |Op_oss| project + +#. At the root level (the folder containing the repo), execute the following command + + .. code-block:: + + docker build -f ./repo/utils/Dockerfile -t <DockerImageName> . + + .. note:: The Dockerfile assumes the name of the repository as "repo". The command and the Dockerfile should be modified accordingly, if different name is used
diff --git a/content/html/_sources/developer_information/30_coding_conventions.rst.txt b/content/html/_sources/developer_information/30_coding_conventions.rst.txt new file mode 100644 index 0000000..ea37b20 --- /dev/null +++ b/content/html/_sources/developer_information/30_coding_conventions.rst.txt
@@ -0,0 +1,289 @@ +.. + ******************************************************************************* + Copyright (c) 2023 Bayerische Motoren Werke Aktiengesellschaft (BMW AG) + + This program and the accompanying materials are made available under the + terms of the Eclipse Public License 2.0 which is available at + http://www.eclipse.org/legal/epl-2.0. + + SPDX-License-Identifier: EPL-2.0 + ******************************************************************************* + +.. _coding_conventions: + +Coding Guidelines +================= + +General +------- + +|Op_oss| is based on modern C++ (currently C++17). For coding guidelines, please refer to `ISO C++ Core Guidelines <https://github.com/isocpp/CppCoreGuidelines>`_. + +**Headers/Sources** + + - Use ``*.h`` as file extension for header files + - Use ``*.cpp`` as file extension for source files + +Naming Conventions +------------------ + +Concise summarized Naming Conventions +.. literalinclude:: _static/custom_doc/NamingConventions.txt + +**Namespaces** + + #. Use lowercase for namespaces + #. Use singular form for namespaces where appropriate + #. Use base namespace ``openpass`` + #. Core uses ``openpass::core::*`` + #. Components use ``openpass::component::*`` + #. Use the appropriate namespace for the type your component + * ``openpass::component::algorithm`` + * ``openpass::component::sensor`` + * ``openpass::component::dynamics`` + * ``openpass::component::driver`` + * ... + #. Code with shared scope (e.g. ``common``) namespaces are separated in + * For everyone ``openpass::common`` e.g. ``openpass::common::XmlParser`` + * Common for components ``openpass::component::common`` e.g. ``openpass::components::Ports`` + * For the core only ``openpass::core::common`` e.g. ``openpass::core::common::Parameters`` + #. Discussion: ``openpass::type::*`` + Example: ``openpass::type::Vector2D, openpass::type::OpenDriveId`` + +**Interfaces** + + #. Interfaces should be named descriptively according to the functionality they outline with an ``UpperCamelCase`` name + + Example: Interface for the **world** = ``class WorldInterface`` + #. Interfaces are abstract classes, and as such provide pure virtual functions only, withtout any default implementation. For example: + ``virtual double GetDistance() const = 0;`` + #. Interface methods **do not** exibit default parameters. + #. We excessively use **gmock**, so for every interface a fake interface should be provided + + Example: ``class FakeWorld : public WorldInterface {...};`` + + Note: Following ***Roy Osherove***, we use Fake instead of Mock, whick allows to distinguish Mocks and + Stubs more easily in the code + +**Classes** + + #. Classes should be named descriptively according to the functionality they implement with an ``UpperCamelCase`` name + #. A Class implementing an Interface should have the Interfaces name (see below), with the Interface portion removed. For example: + .. code-block:: + + class AgentBlueprint : public AgentBlueprintInterface {...}; + +**Methods** + + #. Methods should be descriptively named in ``UpperCamelCase`` + + Example: Method for retrieving the time of day should be named ``GetTimeOfDay()`` + +**Member Variables** + + #. Member variables should be descriptively named in ``lowerCamelCase`` + #. Normally, it is sufficient to use the classes name directly. + + Example: The member variable containing the AgentNetwork should be named ``agentNetwork`` + +**Input / Output Signal Naming** + + #. Components use a special form of signal transmission. For easier use, the following abstraction is recommended: + .. code-block:: + + std::map<int, ComponentPort *> outputPorts; + bool success = outputPorts.at(localLinkId)->SetSignalValue(data); + + .. code-block:: + + std::map<int, ComponentPort *> inputPorts; + bool success = inputPorts.at(localLinkId)->GetSignalValue(data); + #. Discussion: Wrap in ``openpass::components::common::Port`` and further + ``openpass::components::common::Ports`` + +**Additional Information** + + #. Use ``UpperCamelCase`` for abbreviations used in files, classes, methods, or variables + #. This does not apply if the abbreviation is the entire name or the beginning of the name - in such a case the name is written with the rules for the appropriate type + + * int ID→int id + * class AgentID→ class AgentId + * ADASDriver.cpp→adasDriver.cpp + #. Avoid public class data members. If unavoidable, use ``lowerCamelCase`` + #. Enums should be preferably defined as enum class; as such, enum names should be in ``UpperCamelCase`` + #. Decorate container by type aliases and use UpperCamelCase. For example: + + .. code-block:: + + using FooParts = std::vector<FooPart>; + +**Avoid** + + #. Do **not** use Hungarian notation for variables names (iCounter → counter) + #. Do **not** specify the type of the underlying implementation (partMap→ parts) + #. Do **not** use magic numbers in the code; explicitly define constants instead + #. Do **not** use global variables + +**Exceptions** + + #. Autogenerated code does not need to follow the coding conventions + + Example:: Signals/Slots (QT): ``void on_button_clicked();`` + +**Documentation** + + #. The following should be documented + * Public functions and class methods + * Classes + * File headers + * Constants + * Private functions or methods with more than 3 arguments and/or complex functionality?? + #. Language + * Document "what" it does rather than describing "why" + * Third-person singular verbs should be used to describe what it does + #. Use the below methods to comment in source code. The below 2 syntaxes must be placed just above an entity. + + Multi line comments + + .. code-block:: + + //! … comments… + //! … comments… + //! … comments… + + Single line comments + + .. code-block:: + + /// Comments. + + #. Use the following structural commands + + .. list-table:: + :widths: 25 50 + :header-rows: 1 + + * - Syntax + - Definition + * - @file + - The file name must be present in the file header + * - @param[in/out] + - Parameter documentation for functions + * - @page + - Markdown page name + + #. Use the following syntax for parameter description + + .. code-block:: + + @param[in/out] <variable name> <variable description> + #. All parameters description should be aligned as shown below to make them more readable. + + .. code-block:: + + @param[in] shortName Description. + @param[in] longerName Description. + @param[out] veryLongName Description. + #. Example + + .. literalinclude:: _static/custom_doc/InlineDocumentation.txt + + #. Do not comment on polymorph methods (virtual base → override), unless there is a severe change + +**End Of Line** + + #. Native end of line (EOL) should be used in the working directory + #. The ``.gitattributes`` configuration file provides correct EOL handling for ``git`` related commands and actions + #. When editing files + + * Trim trailing whitespaces + * Single EOL at end of files + * Use spaces for tabs (use tab size according to coding guidelines or existing file contents) + +See :ref:`Example VSCode user settings <vscode_user_settings>`. + +ClangFormat +----------- + +To ensure consistent and readable code across the project, **ClangFormat** is recommended. + +.. note:: + + The following guidelines are based on ClangFormat version 15.0.7 + +**Installing ClangFormat** + +To install **ClangFormat 15.0.7**, execute the following command depending on the operating system. + +.. tabs:: + + .. tab:: Windows + + .. code-block:: + + pacman -S mingw-w64-x86_64-clang + + .. tab:: Linux (Debian Bookworm or Ubuntu 22.04) + + .. code-block:: + + apt -y install clang-format + +**Configuring ClangFormat** + +To configure ClangFormat, create a `.clang-format` file in the root directory of your project. Below is the configuration used in |op_oss|: + + .. literalinclude:: /../../../repo/.clang-format + +**Running ClangFormat** + +To format the code using ClangFormat, run the following command in the terminal: + +.. code-block:: bash + + clang-format -i [source_file(s)] + +Replace `[source_file(s)]` with the path(s) to the file(s) to format. The `-i` option tells ClangFormat to modify the files in-place. + +Commit Message Guidelines +------------------------- + +**Overview** + +This section outlines the guidelines for writing commit messages in openPASS repository. Following these guidelines ensures that commit messages are clear, descriptive, and help facilitate collaboration among team members. +This section uses excerpts from `Conventional Commits <https://www.conventionalcommits.org/en/v1.0.0/>`_ licensed under `CC BY 3.0 <https://creativecommons.org/licenses/by/3.0/>`_ by it's authors. + +**Commit Message Format** + +Each commit message should consist of a single short summary line (recommended, up to 50 characters) followed by a more detailed description (if necessary). +The message should adhere to the following format: + + .. code-block:: + + <type>[optional scope]: <description> + + [optional body] + + [optional footer(s)] + + #. The ``<type>`` part represents the type of the commit, which helps in categorizing the nature of the changes. The following types are allowed: + + * ``feat``: A new feature or enhancement. + * ``fix``: A bug fix. + * ``docs``: Documentation-related changes. + * ``style``: Code style changes (e.g., formatting, spacing). + * ``refactor``: Code refactoring without adding new features or fixing bugs. + * ``test``: Adding or improving tests. + * ``chore``: Maintenance tasks, build changes, or other non-functional modifications. + * ``ci``: Changes related to CI. + * ``build``: Modifications related to build step. + * ``perf``: Modifications related to performance improvements. + * ``revert``: Revert any code changes. + + #. The ``<optional scope>`` section is optional but is used to provide additional contextual information and is contained within parenthesis. + + #. The ``<description>`` is a brief description of the changes made in the commit. It should be concise yet informative and is recommended to not exceed 50 characters. + + #. The ``<optional body>`` section is optional but recommended, especially for complex changes or when further explanation is needed. This section should provide additional context, justification, and details about the changes made. Use bullet points for better readability when necessary. + + #. The ``<optional footer>`` section is also optional but can be used to provide supplementary information related to the commit.
diff --git a/content/html/_sources/developer_information/ide_support/20_qt_creator.rst.txt b/content/html/_sources/developer_information/ide_support/20_qt_creator.rst.txt index 873368e..d3822d4 100644 --- a/content/html/_sources/developer_information/ide_support/20_qt_creator.rst.txt +++ b/content/html/_sources/developer_information/ide_support/20_qt_creator.rst.txt
@@ -77,7 +77,7 @@ .. todo:: The configuration is still "itchy", as Qt creator changes the interface with every version - See https://gitlab.eclipse.org/eclipse/simopenpass/simopenpass/-/issues/149 + See https://gitlab.eclipse.org/eclipse/openpass/opSimulation/-/issues/149 Settings (Linux) @@ -99,7 +99,7 @@ .. todo:: The configuration is still "itchy", as Qt creator changes the interface with every version - See https://gitlab.eclipse.org/eclipse/simopenpass/simopenpass/-/issues/149 + See https://gitlab.eclipse.org/eclipse/openpass/opSimulation/-/issues/149 Alternative Method ------------------
diff --git a/content/html/_sources/developer_information/ide_support/30_vscode.rst.txt b/content/html/_sources/developer_information/ide_support/30_vscode.rst.txt index f726e50..919eb3d 100644 --- a/content/html/_sources/developer_information/ide_support/30_vscode.rst.txt +++ b/content/html/_sources/developer_information/ide_support/30_vscode.rst.txt
@@ -1,6 +1,7 @@ .. ******************************************************************************* Copyright (c) 2021 in-tech GmbH + 2023 Bayerische Motoren Werke Aktiengesellschaft (BMW AG) This program and the accompanying materials are made available under the terms of the Eclipse Public License 2.0 which is available at @@ -47,7 +48,7 @@ `MSYS2/Cygwin/MinGW/Clang support <https://marketplace.visualstudio.com/items?itemName=fougas.msys2>`_ |win_only| MSYS2/MinGW configuration adapter ======================================================================================================== ======================================================= -3. Open the repository as folder, e.g. by calling ``code simopenpass`` after checking out. +3. Open the repository as folder, e.g. by calling ``code openpass`` after checking out. Say yes, when CMake Tools ask to configure the project. This creates a ``build`` folder, **but fails** (well, we need to config some stages). @@ -59,11 +60,16 @@ Normally, runtime dependencies (DLLs) are not copied into the executables folder within the build process. This means, that programs cannot be executed natively from Windows shells or the explorer. -It is therefore highly recommended, to set the environmental variable ``MSYSTEM=MINGW64`` and ``CHERE_INVOKING=1``. +It is therefore highly recommended, to set the environmental variable ``MSYSTEM=MINGW64`` and ``CHERE_INVOKING=1``. The setting of ``MSYSTEM`` will cause the environment to be set up correctly for MinGW64. Windows will then look for DLLs within the msys64 folders, allowing native execution. ``CHERE_INVOKING`` makes sure the shell stays in the current working directory. -As investigated recently, the ``C:\msys64\usr\bin``must also be added to the ``PATH`` environment variable in order to resolve dependencies to ``cygpath.exe``. +As investigated recently, the ``C:\msys64\usr\bin``must also be added to the ``PATH`` environment variable in order to resolve dependencies to ``cygpath.exe``. + +.. note:: + If ``C:\msys64`` is not already listed in ``PATH`` variable, then add ``C:\msys64`` in ``PATH`` variable before adding ``C:\msys64\usr\bin`` to the ``PATH`` variable. + If there are any other Unix like environments installed on Windows operating systems (example: cygwin), there might even be file collisions when calling certain cmake commands. + Therefore, it is suggested to add ``C:\msys64`` in ``PATH`` variable before any other Unix like environmental calls. Either set environment variable through the ``Windows PowerShell`` @@ -79,20 +85,20 @@ setx MSYSTEM "MINGW64" setx CHERE_INVOKING "1" -or +or 1. Open the start search 2. Type in “env” and choose “Edit the system environment variables” -3. Choose “Environment Variables…” +3. Choose “Environment Variables…” 4. Set the environment variables: - + i. MSYSTEM=MINGW64 ii. CHERE_INVOKING=1 iii. Add ``C:\msys64\usr\bin`` to PATH Visual Studio Code needs to be reloaded/restarted after the path update. -.. note:: +.. note:: An optimal solution would be to set the system environment variables in VSCode under ``settings.json``. This is currently not possible. Please contact us if you find a better solution. @@ -128,6 +134,8 @@ See also :ref:`prerequisites`. +.. _vscode_user_settings: + User Settings +++++++++++++ @@ -175,22 +183,22 @@ CMake should now be able to configure the project. -If not, cmake should give you at least a hint, what's missing (normally external libraries). +If not, cmake should give you at least a hint, what's missing (normally external libraries). Read :ref:`cmake` or :ref:`prerequisites` for more information. .. admonition:: CMake Some changes such as changing the build type (Debug/Release) will cause CMake to updates the configuration automatically. - Other changes won't trigger an update, such as changing the paths to libraries (`CMAKE_PREFIX_PATH`), the cmake cache needs to be cleared before reconfiguration: + Other changes won't trigger an update, such as changing the paths to libraries (`CMAKE_PREFIX_PATH`), the cmake cache needs to be cleared before reconfiguration: ``Ctrl+Shift+P`` > ``CMake: Delete Cache and Reconfigure`` Debug Targets +++++++++++++ CMake Tools and C++ Testmate automatically use custom launch configurations, if available. -When using the debugging functionality, the according executable will be executed from where they are built (per default inside the ``build`` folder). +When using the debugging functionality, the according executable will be executed from where they are built (per default inside the ``build`` folder). -- This is acceptable for unit test, which do not require openPASS specific libraries. +- This is acceptable for unit test, which do not require openPASS specific libraries. The corresponding config is ``CMake Target``. - For the core, located at ``./build/sim/src/core/opSimulation/opSimulation``, this does not work, as no libraries and no configurations are available.
diff --git a/content/html/_sources/index.rst.txt b/content/html/_sources/index.rst.txt index 43205fe..a5f2e82 100644 --- a/content/html/_sources/index.rst.txt +++ b/content/html/_sources/index.rst.txt
@@ -1,6 +1,7 @@ .. ******************************************************************************* Copyright (c) 2021 in-tech GmbH + 2023 Mercedes-Benz Tech Innovation GmbH This program and the accompanying materials are made available under the terms of the Eclipse Public License 2.0 which is available at @@ -9,10 +10,10 @@ SPDX-License-Identifier: EPL-2.0 ******************************************************************************* -OpenPASS Documentation +openPASS Documentation ====================== -The OpenPASS (Open Platform for Assessment of Safety Systems) tool is a developed framework for the simulation of interaction between traffic participants to evaluate and parametrize active safety systems. +The openPASS (Open Platform for Assessment of Safety Systems) tool is a developed framework for the simulation of interaction between traffic participants to evaluate and parametrize active safety systems. The simulation is based on a specific situation configuration and can contain several simulation runs, which differ due to random parameters. The software suite of openPASS started as a set of stand-alone applications, which can be installed and configured individually. @@ -27,6 +28,8 @@ installation_guide/* +.. TODO:: Update section for new react GUI. + The GUI lets the user configure the simulation and generate configuration files from all set parameters. Based on these the simulation core calculates different simulation runs and compiles trace files for further processing.
diff --git a/content/html/_sources/installation_guide/15_system_requirements.rst.txt b/content/html/_sources/installation_guide/15_system_requirements.rst.txt index 385bec3..fdf69b3 100644 --- a/content/html/_sources/installation_guide/15_system_requirements.rst.txt +++ b/content/html/_sources/installation_guide/15_system_requirements.rst.txt
@@ -1,6 +1,6 @@ .. ******************************************************************************* - Copyright (c) 2022 Bayerische Motoren Werke Aktiengesellschaft (BMW AG) + Copyright (c) 2022-2023 Bayerische Motoren Werke Aktiengesellschaft (BMW AG) This program and the accompanying materials are made available under the terms of the Eclipse Public License 2.0 which is available at @@ -25,7 +25,7 @@ ==================== ============================================================== ========================== System Specification Minimal Requirements Tested Setup (exemplarily) ==================== ============================================================== ========================== - Operating System Windows or Linux (Debian Bullseye or Ubuntu 20.10 recommended) Windows 10 + Operating System Windows or Linux (Debian Bookworm or Ubuntu 22.04 recommended) Windows 10 CPU Intel x64 Architecture with at least 1,50 GHz clock frequency Intel i5-10310U RAM at least 8 GB 8 GB GPU not used by the simulation Intel UHD Graphics 620
diff --git a/content/html/_sources/installation_guide/20_install_prerequisites.rst.txt b/content/html/_sources/installation_guide/20_install_prerequisites.rst.txt index f5a7c41..766aad7 100644 --- a/content/html/_sources/installation_guide/20_install_prerequisites.rst.txt +++ b/content/html/_sources/installation_guide/20_install_prerequisites.rst.txt
@@ -1,6 +1,6 @@ .. ******************************************************************************* - Copyright (c) 2021-2022 Bayerische Motoren Werke Aktiengesellschaft (BMW AG) + Copyright (c) 2021-2023 Bayerische Motoren Werke Aktiengesellschaft (BMW AG) 2021 in-tech GmbH This program and the accompanying materials are made available under the @@ -85,7 +85,7 @@ On Linux, no special build environment is needed. |Op| is developed under Debian 64-Bit, which means that developing under a recent Ubuntu distribution will also work. - Debian Bullseye or Ubuntu 20.10 is recommended. Debian uses ``apt`` (or ``apt-get``) as package managing system. + Debian Bookworm or Ubuntu 22.04 LTS is recommended. Debian uses ``apt`` (or ``apt-get``) as package managing system. Details will be given in :ref:`binary_packages` and :ref:`building_prerequisites`. @@ -123,13 +123,29 @@ | Tested packages - at time of writing - have been listed above as comment. | If in doubt, download the package in the right version from the `MSYS2 package repository <http://repo.msys2.org/mingw/x86_64/>`_. | Install with ``pacman -U <package-filename>`` + | If there is no old enough MSYS2 Package Version available in the package Repository you can download specific versions with python-pip + | Install with ``pip3 install <package-filename>==<version>`` + + #. Optional Packages + + .. code-block:: + + pacman -S git + pacman -S diffutils + pacman -S patch + pacman -S mingw-w64-x86_64-ag + pacman -S mingw-w64-x86_64-qt5-debug + pacman -S zlib-devel + + # for api documentation (optional) + pip3 install breathe exhale .. admonition:: GIT/SSH The |mingw_shell| does not access an already existing git installation or available SSH keys. Make sure, to update/copy your configuration and credentials within the |mingw_shell| before working with git. - .. tab:: Linux (Debian Bullseye) + .. tab:: Linux (Debian Bookworm) #. Update the package database on the system @@ -148,22 +164,25 @@ .. code-block:: # for simulator - apt install ccache - apt install cmake - apt install doxygen - apt install googletest - apt install gcc - apt install g++ - apt install graphviz - apt install libboost-dev - apt install libqt5xmlpatterns5-dev - apt install qtbase5-dev - apt install qtchooser - apt install zlib1g-dev + apt -y install ccache + apt -y install cmake + apt -y install doxygen + apt -y install googletest + apt -y install gcc + apt -y install g++ + apt -y install graphviz + apt -y install libboost-dev + apt -y install libqt5xmlpatterns5-dev + apt -y install qtbase5-dev + apt -y install qtchooser + apt -y install zlib1g-dev # for documentation - sudo apt install doxygen python3 python3-pip libenchant-2-2 dvipng dos2unix - pip3 install sphinx sphinx-rtd-theme sphinx-tabs breathe exhale sphinxcontrib-spelling + sudo apt install python3 python3-pip libenchant-2-2 dvipng + pip3 install sphinx sphinx-rtd-theme sphinx-tabs breathe exhale sphinxcontrib-spelling myst-parser + + # for testing + pip3 install pytest pandas Under Linux, it is deliberate that the googletest package only installs the header files to the system, but not the static and dynamic libraries. The missing libraries can be build and installed to ``/usr/lib`` via @@ -208,7 +227,7 @@ :: - C:\OpenPASS\thirdParty + C:\openpass\thirdParty ├── FMILibrary │ ├── include │ └── lib @@ -229,7 +248,7 @@ In the folder structure above: - - ``C:\OpenPASS\thirdParty`` refers to a temporary directory used to built the prerequisites from source, **not** the ``simopenpass`` repository + - ``C:\openpass\thirdParty`` refers to a temporary directory used to built the prerequisites from source, **not** the ``openpass`` repository - ``FMILibrary`` is the install directory of the :term:`Functional Mock-up Interface (FMI) <FMI>` when build from source - ``osi`` is the install directory of the :term:`Open Simulation Interface (OSI) <OSI>` when build from source. - ``protobuf`` and ``protobuf-shared`` are the install directories of ``Google Protocol Buffers`` for shared and static builds, respectively. @@ -238,7 +257,7 @@ :: - ~/OpenPASS/thirdParty + ~/openpass/thirdParty ├── FMILibrary │ ├── include │ └── lib @@ -259,7 +278,7 @@ In the folder structure above: - - ``~/OpenPASS/thirdParty`` refers to a temporary directory used to built the prerequisites from source, **not** the ``simopenpass`` repository + - ``~/openpass/thirdParty`` refers to a temporary directory used to built the prerequisites from source, **not** the ``openpass`` repository - ``FMILibrary`` is the install directory of the :term:`Functional Mock-up Interface (FMI) <FMI>` when build from source - ``osi`` is the install directory of the :term:`Open Simulation Interface (OSI) <OSI>` when build from source. - ``protobuf`` and ``protobuf-shared`` are the install directories of ``Google Protocol Buffers`` for shared and static builds, respectively. @@ -274,16 +293,16 @@ Google Protocol Buffers provide the foundation of :term:`OSI` (see also :ref:`building_osi`). Due to the usage of OSI different situations (|Op| executables, libraries, tests, :term:`FMUs <FMU>`, etc.) static and shared libraries of protobuf have to be provided. -This section gives instructions, how to compile version 3.17.3. and hook it into the |op| build. +This section gives instructions, how to compile version 3.20.0. and hook it into the |op| build. This currently applies to the |op| build, as static and shared libraries of Protobuf are required. -#. Download release 3.17.3 from https://github.com/protocolbuffers/protobuf/releases +#. Download release 3.20.0 from https://github.com/protocolbuffers/protobuf/releases #. Extract - - for Windows to ``C:\OpenPASS\thirdParty\sources\protobuf-cpp-3.17.3`` + - for Windows to ``C:\openpass\thirdParty\sources\protobuf-cpp-3.20.0`` - - for Linux to ``~/OpenPASS/thirdParty/sources/protobuf-cpp-3.17.3`` + - for Linux to ``~/openpass/thirdParty/sources/protobuf-cpp-3.20.0`` #. Navigate to the extracted folder @@ -295,7 +314,7 @@ .. code-block:: - cd /C/OpenPASS/thirdParty/sources/protobuf-cpp-3.17.3 + cd /C/openpass/thirdParty/sources/protobuf-cpp-3.20.0 .. tab:: Linux @@ -303,7 +322,7 @@ .. code-block:: - cd ~/OpenPASS/thirdParty/sources/protobuf-cpp-3.17.3 + cd ~/openpass/thirdParty/sources/protobuf-cpp-3.20.0 #. Create build directory @@ -324,7 +343,7 @@ cmake -G "MSYS Makefiles" \ -DCMAKE_BUILD_TYPE=Release \ - -DCMAKE_INSTALL_PREFIX=C:/OpenPASS/thirdParty/protobuf \ + -DCMAKE_INSTALL_PREFIX=C:/openpass/thirdParty/protobuf \ -Dprotobuf_BUILD_SHARED_LIBS=OFF \ -Dprotobuf_BUILD_TESTS=OFF \ -DCMAKE_CXX_FLAGS=-fPIC \ @@ -336,7 +355,7 @@ :emphasize-lines: 5 cmake -DCMAKE_BUILD_TYPE=Release \ - -DCMAKE_INSTALL_PREFIX=$HOME/OpenPASS/thirdParty/protobuf \ + -DCMAKE_INSTALL_PREFIX=$HOME/openpass/thirdParty/protobuf \ -Dprotobuf_BUILD_SHARED_LIBS=OFF \ -Dprotobuf_BUILD_TESTS=OFF \ -DCMAKE_CXX_FLAGS=-fPIC \ @@ -363,7 +382,7 @@ After completion, **repeat the steps described above** with the following changes applied to the CMake call: #. Set ``protobuf_BUILD_SHARED_LIBS`` to ``ON`` and remove -DCMAKE_CXX_FLAGS=-fPIC flag. - #. Use ``$HOME/OpenPASS/thirdParty/protobuf-shared`` as ``CMAKE_INSTALL_PREFIX`` + #. Use ``$HOME/openpass/thirdParty/protobuf-shared`` as ``CMAKE_INSTALL_PREFIX`` This creates and installs the Protobuf libraries, as the Protobuf dynamic and static libs are required for the openPASS build. @@ -391,7 +410,7 @@ .. code-block:: cd /C/ - mkdir -p OpenPASS/thirdParty/sources + mkdir -p openpass/thirdParty/sources .. tab:: Linux @@ -400,15 +419,15 @@ .. code-block:: cd ~ - mkdir -p OpenPASS/thirdParty/sources + mkdir -p openpass/thirdParty/sources -#. Download release 3.5.0 from https://github.com/OpenSimulationInterface/open-simulation-interface +#. Download release 3.5.0 from https://github.com/OpenSimulationInterface/open-simulation-interface #. Extract - - for Windows to ``C:\OpenPASS\thirdParty\sources\open-simulation-interface-3.5.0`` + - for Windows to ``C:\openpass\thirdParty\sources\open-simulation-interface-3.5.0`` - - for Linux to ``~/OpenPASS/thirdParty/sources/open-simulation-interface-3.5.0`` + - for Linux to ``~/openpass/thirdParty/sources/open-simulation-interface-3.5.0`` #. Navigate to the extracted folder @@ -418,13 +437,13 @@ .. code-block:: - cd /C/OpenPASS/thirdParty/sources/open-simulation-interface-3.5.0 + cd /C/openpass/thirdParty/sources/open-simulation-interface-3.5.0 .. tab:: Linux .. code-block:: - cd ~/OpenPASS/thirdParty/sources/open-simulation-interface-3.5.0 + cd ~/openpass/thirdParty/sources/open-simulation-interface-3.5.0 #. Optional: Enable Arenas @@ -436,8 +455,8 @@ This can be achieved in two ways. Either the line ``option cc_enable_arenas = true;`` gets added manually **after the second line** of each PROTO file - - for Windows in ``C:\OpenPASS\thirdParty\sources\open-simulation-interface`` - - for Linux in ``~/OpenPASS/thirdParty/sources/open-simulation-interface`` + - for Windows in ``C:\openpass\thirdParty\sources\open-simulation-interface`` + - for Linux in ``~/openpass/thirdParty/sources/open-simulation-interface`` by using a text editor or one makes use of the stream editor in the shell: @@ -467,8 +486,8 @@ cmake -G "MSYS Makefiles" \ -DCMAKE_BUILD_TYPE=Release \ - -DCMAKE_INSTALL_PREFIX=C:/OpenPASS/thirdParty/osi \ - -DCMAKE_PREFIX_PATH=C:/OpenPASS/thirdParty/protobuf-shared/ + -DCMAKE_INSTALL_PREFIX=C:/openpass/thirdParty/osi \ + -DCMAKE_PREFIX_PATH=C:/openpass/thirdParty/protobuf-shared/ .. .. tab:: Linux @@ -476,8 +495,8 @@ .. code-block:: cmake -DCMAKE_BUILD_TYPE=Release \ - -DCMAKE_INSTALL_PREFIX=$HOME/OpenPASS/thirdParty/osi \ - -DCMAKE_PREFIX_PATH=$HOME/OpenPASS/thirdParty/protobuf-shared/ + -DCMAKE_INSTALL_PREFIX=$HOME/openpass/thirdParty/osi \ + -DCMAKE_PREFIX_PATH=$HOME/openpass/thirdParty/protobuf-shared/ .. #. Compile @@ -496,7 +515,7 @@ and check if correct protobuf version is used. - .. note:: If no protobuf is found the path to protoc needs to be first set manually in the terminal. ``export PATH=$HOME/OpenPASS/thirdParty/protobuf-shared/bin:$PATH`` + .. note:: If no protobuf is found the path to protoc needs to be first set manually in the terminal. ``export PATH=$HOME/openpass/thirdParty/protobuf-shared/bin:$PATH`` #. Install @@ -524,9 +543,9 @@ #. Extract - - for Windows to ``C:\OpenPASS\thirdParty\sources\fmi-library-2.0.3`` + - for Windows to ``C:\openpass\thirdParty\sources\fmi-library-2.0.3`` - - for Linux to ``~/OpenPASS/thirdParty/sources/fmi-library-2.0.3`` + - for Linux to ``~/openpass/thirdParty/sources/fmi-library-2.0.3`` #. Navigate to the extracted folder @@ -538,7 +557,7 @@ .. code-block:: - cd /C/OpenPASS/thirdParty/sources/fmi-library-2.0.3 + cd /C/openpass/thirdParty/sources/fmi-library-2.0.3 .. tab:: Linux @@ -546,7 +565,7 @@ .. code-block:: - cd ~/OpenPASS/thirdParty/sources/fmi-library-2.0.3 + cd ~/openpass/thirdParty/sources/fmi-library-2.0.3 #. Create build directory @@ -564,7 +583,7 @@ .. code-block:: cmake -G "MSYS Makefiles" \ - -DFMILIB_INSTALL_PREFIX=C:/OpenPASS/thirdParty/FMILibrary \ + -DFMILIB_INSTALL_PREFIX=C:/openpass/thirdParty/FMILibrary \ -DCMAKE_BUILD_TYPE=Release \ -DFMILIB_BUILD_STATIC_LIB=OFF \ -DFMILIB_BUILD_SHARED_LIB=ON \ @@ -574,7 +593,7 @@ .. code-block:: - cmake -DFMILIB_INSTALL_PREFIX=$HOME/OpenPASS/thirdParty/FMILibrary \ + cmake -DFMILIB_INSTALL_PREFIX=$HOME/openpass/thirdParty/FMILibrary \ -DCMAKE_BUILD_TYPE=Release \ -DFMILIB_BUILD_STATIC_LIB=OFF \ -DFMILIB_BUILD_SHARED_LIB=ON \ @@ -592,20 +611,9 @@ - :download:`Windows/Linux Patch </_static/resources/fmil/fmi-library-2.0.3-fixes.patch>` - .. tabs:: + .. code-block:: - .. tab:: Windows - - .. code-block:: - - git apply --ignore-whitespace "<path/to>/fmi-library-2.0.3-fixes.patch" - - .. tab:: Linux - - .. code-block:: - - dos2unix src/Import/src/FMI1/fmi1_import_capi.c src/Import/src/FMI2/fmi2_import_capi.c src/Util/include/JM/jm_portability.h - git apply --ignore-whitespace "<path/to>/fmi-library-2.0.3-fixes.patch" + git apply --ignore-whitespace "<path/to>/fmi-library-2.0.3-fixes.patch" #. Enter build directory @@ -646,7 +654,7 @@ .. code-block:: cd /C/ - mkdir -p OpenPASS/thirdParty/sources + mkdir -p openpass/thirdParty/ .. tab:: Linux @@ -655,13 +663,13 @@ .. code-block:: cd ~ - mkdir -p OpenPASS/thirdParty/sources + mkdir -p openpass/thirdParty/ #. Download release v1.2.12 from https://github.com/madler/zlib #. Extract - - for Windows to ``C:\OpenPASS\thirdParty\sources\zlib`` + - for Windows to ``C:\openpass\thirdParty\zlib`` - - for Linux to ``~/OpenPASS/thirdParty/sources/zlib`` + - for Linux to ``~/openpass/thirdParty/zlib``
diff --git a/content/html/_sources/installation_guide/30_install_openpass.rst.txt b/content/html/_sources/installation_guide/30_install_openpass.rst.txt index 5c3ff01..47ddc49 100644 --- a/content/html/_sources/installation_guide/30_install_openpass.rst.txt +++ b/content/html/_sources/installation_guide/30_install_openpass.rst.txt
@@ -1,6 +1,6 @@ .. ******************************************************************************* - Copyright (c) 2021-2022 Bayerische Motoren Werke Aktiengesellschaft (BMW AG) + Copyright (c) 2021-2023 Bayerische Motoren Werke Aktiengesellschaft (BMW AG) 2021 in-tech GmbH This program and the accompanying materials are made available under the @@ -12,12 +12,12 @@ .. _download_and_install_openpass: -Installing OpenPASS +Installing openPASS =================== This section describes how compile and run |op|. Please make sure that all prerequisites have been properly installed according to section :ref:`Prerequisites`. If you have strictly followed the instructions, the installed source packages should be located on your machine under -``C:\OpenPASS\thirdParty`` for **Windows** and ``~/OpenPASS/thirdParty`` for **Linux**. If there is a path deviation, +``C:\openpass\thirdParty`` for **Windows** and ``~/openpass/thirdParty`` for **Linux**. If there is a path deviation, the following commands must be adjusted. To keep the installation process of |op| as simple as possible, we again recommend a specific folder structure. @@ -27,21 +27,21 @@ .. tab:: Notes for Windows - - Recommended checkout path of |op| repository: ``C:\simopenpass`` - - Recommended dependency directory within the |op| repository: ``C:\simopenpass\deps\thirdParty`` - - Recommended installation directory of |op|: ``C:\OpenPASS\bin\core`` + - Recommended checkout path of |op| repository: ``C:\openpass`` + - Recommended dependency directory within the |op| repository: ``C:\openpass\deps\thirdParty`` + - Recommended installation directory of |op|: ``C:\openPASS\bin\core`` .. tab:: Notes for Linux - - Recommended checkout path of |op| repository: ``~/simopenpass`` - - Recommended dependency directory within the |op| repository: ``~/simopenpass/deps/thirdParty`` - - Recommended installation directory of |op|: ``/usr/local/OpenPASS/bin/core`` + - Recommended checkout path of |op| repository: ``~/openpass`` + - Recommended dependency directory within the |op| repository: ``~/openpass/deps/thirdParty`` + - Recommended installation directory of |op|: ``/usr/local/openPASS/bin/core`` The above directory structure will be created by following the instructions of this guide. #. Clone |Op| repository - As described above, the checkout path of the repository is assumed to be the default ``simopenpass``. + As described above, the checkout path of the repository is assumed to be the default ``openpass``. .. tabs:: @@ -52,7 +52,7 @@ .. code-block:: cd /C/ - git clone https://gitlab.eclipse.org/eclipse/simopenpass/simopenpass.git + git clone https://gitlab.eclipse.org/eclipse/openpass/opSimulation.git openpass .. note:: @@ -68,13 +68,13 @@ .. code-block:: cd ~ - git clone https://gitlab.eclipse.org/eclipse/simopenpass/simopenpass.git + git clone https://gitlab.eclipse.org/eclipse/openpass/opSimulation.git openpass #. Navigate into repository and checkout main branch .. code-block:: - cd simopenpass + cd openpass git checkout main #. Create directory structure @@ -91,13 +91,13 @@ .. code-block:: - cd /C/OpenPASS/thirdParty + cd /C/openpass/thirdParty .. tab:: Linux .. code-block:: - cd ~/OpenPASS/thirdParty + cd ~/openpass/thirdParty #. Copy prerequisites into repository (c.f. :ref:`Prerequisites`) @@ -107,29 +107,29 @@ .. code-block:: - cp -r osi /C/simopenpass/deps/thirdParty - cp -r protobuf /C/simopenpass/deps/thirdParty - cp -r protobuf-shared /C/simopenpass/deps/thirdParty - cp -r FMILibrary /C/simopenpass/deps/thirdParty - cp -r zlib/contrib/minizip /C/simopenpass/deps/thirdParty + cp -r osi /C/openpass/deps/thirdParty + cp -r protobuf /C/openpass/deps/thirdParty + cp -r protobuf-shared /C/openpass/deps/thirdParty + cp -r FMILibrary /C/openpass/deps/thirdParty + cp -r zlib/contrib/minizip /C/openpass/deps/thirdParty .. tab:: Linux .. code-block:: - cp -r osi ~/simopenpass/deps/thirdParty - cp -r protobuf ~/simopenpass/deps/thirdParty - cp -r protobuf-shared ~/simopenpass/deps/thirdParty - cp -r FMILibrary ~/simopenpass/deps/thirdParty - cp -r zlib/contrib/minizip /C/simopenpass/deps/thirdParty + cp -r osi ~/openpass/deps/thirdParty + cp -r protobuf ~/openpass/deps/thirdParty + cp -r protobuf-shared ~/openpass/deps/thirdParty + cp -r FMILibrary ~/openpass/deps/thirdParty + cp -r zlib/contrib/minizip /C/openpass/deps/thirdParty .. _ref_prerequisites: - Once prerequisites are in place, all third party dependencies within ``simopenpass`` can be resolved by ``CMake``. + Once prerequisites are in place, all third party dependencies within ``openpass`` can be resolved by ``CMake``. For ``CMake`` builds, each installed prerequisite, which is located in its own subdirectory under - - ``C:\simopenpass\deps\thirdParty`` for Windows and - - ``~/simopenpass/deps/thirdParty`` for Linux, + - ``C:\openpass\deps\thirdParty`` for Windows and + - ``~/openpass/deps/thirdParty`` for Linux, can be referenced by its path. The reference is made via the :ref:`CMAKE_PREFIX_PATH` environmental variable, which holds a list of directories specifying the installed prerequisite. @@ -143,13 +143,13 @@ .. code-block:: - cd /C/simopenpass + cd /C/openpass .. tab:: Linux .. code-block:: - cd ~/simopenpass + cd ~/openpass #. Create build directory and navigate into it @@ -171,8 +171,8 @@ .. code-block:: cmake -G "MSYS Makefiles" \ - -D CMAKE_PREFIX_PATH="C:/simopenpass/deps/thirdParty/FMILibrary;C:/simopenpass/deps/thirdParty/osi;C:/simopenpass/deps/thirdParty/protobuf;C:/simopenpass/deps/thirdParty/protobuf-shared;C:/msys64/mingw64/bin" \ - -D CMAKE_INSTALL_PREFIX=C:/OpenPASS/bin/core \ + -D CMAKE_PREFIX_PATH="C:/openpass/deps/thirdParty/FMILibrary;C:/openpass/deps/thirdParty/osi;C:/openpass/deps/thirdParty/protobuf;C:/openpass/deps/thirdParty/protobuf-shared;C:/msys64/mingw64/bin;C:/openpass/deps/thirdParty/minizip" \ + -D CMAKE_INSTALL_PREFIX=C:/openPASS/bin/core \ -D CMAKE_BUILD_TYPE=Release \ -D USE_CCACHE=ON \ -D WITH_DEBUG_POSTFIX=OFF \ @@ -189,8 +189,8 @@ .. code-block:: - cmake -D CMAKE_PREFIX_PATH="$HOME/simopenpass/deps/thirdParty/FMILibrary;$HOME/simopenpass/deps/thirdParty/osi;$HOME/simopenpass/deps/thirdParty/protobuf;$HOME/simopenpass/deps/thirdParty/protobuf-shared" \ - -D CMAKE_INSTALL_PREFIX=/usr/local/OpenPASS/bin/core \ + cmake -D CMAKE_PREFIX_PATH="$HOME/openpass/deps/thirdParty/FMILibrary;$HOME/openpass/deps/thirdParty/osi;$HOME/openpass/deps/thirdParty/protobuf;$HOME/openpass/deps/thirdParty/protobuf-shared;$HOME/openpass/deps/thirdParty/minizip" \ + -D CMAKE_INSTALL_PREFIX=/usr/local/openPASS/bin/core \ -D CMAKE_BUILD_TYPE=Release \ -D USE_CCACHE=ON \ -D WITH_DEBUG_POSTFIX=OFF \ @@ -198,15 +198,19 @@ -D INSTALL_EXTRA_RUNTIME_DEPS=ON \ .. - .. note: If you need to adjust paths and options based on your system and needs, you need to pay attention on quotations ``" "``, when using it in console (see :ref:`Cmake_prefix_path`). - And also you need to be careful with it when you configuring it under VSCode (see :ref:`vscode`). + .. note: + + - To install in the mentioned CMAKE_INSTALL_PREFIX path, create ``openPASS`` folder under ``/usr/local`` using ``sudo mkdir /usr/local/openPASS`` + And for the user to access the folder, modify the permissions using ``sudo chown <uesrname>:<username> /usr/local/openPASS`` + - If you need to adjust paths and options based on your system and needs, you need to pay attention on quotations ``" "``, when using it in console (see :ref:`Cmake_prefix_path`). + And also you need to be careful with it when you configuring it under VSCode (see :ref:`vscode`). .. note:: For a build that goes beyond the default settings, see :ref:`Cmake` for more available variables and options that can be set. #. Optional: Build and execute unit tests - Starting from ``simopenpass/build``: + Starting from ``openpass/build``: .. code-block:: @@ -219,7 +223,7 @@ #. Build documentation - Starting from ``simopenpass/build``: + Starting from ``openpass/build``: .. code-block:: @@ -229,7 +233,7 @@ #. Build simulation core - Starting from ``simopenpass/build``: + Starting from ``openpass/build``: .. code-block::
diff --git a/content/html/_sources/installation_guide/60_conan.rst.txt b/content/html/_sources/installation_guide/60_conan.rst.txt index 6868d3d..723de7b 100644 --- a/content/html/_sources/installation_guide/60_conan.rst.txt +++ b/content/html/_sources/installation_guide/60_conan.rst.txt
@@ -1,6 +1,7 @@ .. ******************************************************************************* Copyright (c) 2021 ITK Engineering GmbH + 2023 Bayerische Motoren Werke Aktiengesellschaft (BMW AG) This program and the accompanying materials are made available under the terms of the Eclipse Public License 2.0 which is available at @@ -28,7 +29,7 @@ Additional Prerequisites -------------------------- -To be able to work with Conan it´s necessary to add additional packages. +To be able to work with Conan it is necessary to add additional packages. .. tabs:: @@ -36,153 +37,126 @@ .. code-block:: bash - pip install conan + pip install "conan>=1.0,<2.0" - .. tab:: Linux (Debian Bullseye) + .. tab:: Linux (Debian Bookworm) .. code-block:: bash - apt install conan + apt install "conan>=1.0,<2.0" -Export Recipes --------------- +Conan Recipes +------------- -.. note:: - - A *recipe* is python file, which is used by conan to build and create a package. - In this file there are several hooks available, which can be used for several tasks. - E.g. Retrieving the source files, building from source, configuring dependencies, packaging, etc. - Visit `Conan <https://conan.io/>`_. for detailed information about *recipes*. - - -To make Conan aware and to use the custom recipes for the ThirdParty libraries, these recipes have to be exported to the *local cache* of Conan. -This can be done in different ways. - -Conan Export -^^^^^^^^^^^^ - -.. code-block:: bash - - cd <path to conanfile.py of recipe> - conan export . <optional user>/<optional channel> - -The optional user and channel flags can be used to export a recipe while it´s still in development. -In that case there could be several different versions and their corresponding binaries of the same library available at the same time. -The *local cache* could then show the following packages. -E.g. - -.. code-block:: bash - - packagename/3.2.0 - packagename/3.2.0@openpassWG/stable - packagename/3.3.0@myUserName/testing - -.. note:: - - At least this step has to be done in prior before any ThirdParty library can be installed by Conan. - Every upcoming step is optional, but can be useful while developing or debugging. - Also with these steps it´s possible to install ThirdParty libraries separately. - -Conan Install -^^^^^^^^^^^^^ - -Conan is now able to differentiate different version and the user can now install exactly the version he wishes to. - -.. code-block:: bash - - conan install <package_name> - -This command has a look into the *local cache* for the recipe and the binaries of the package and installs them into the *local cache*. -If no binaries where found an error is thrown. - -.. note:: - - To make conan also build the package the command can be appended with the following argument: ``--build=missing``. +A *recipe* is python file, which is used by conan to build and create a package. +In this file there are several hooks available, which can be used for several tasks. +E.g. Retrieving the source files, building from source, configuring dependencies, packaging, etc. +Visit `Conan <https://conan.io/>`_. for detailed information about *recipes*. Conan Create -^^^^^^^^^^^^ +------------ -Both of the previous commands can be combined with the ``create``` command. What it basically does is calling ``export`` and ``install`` after another. +The `conan create` command is used to create Conan packages from source code. It involves building the source code, packaging the resulting binaries and artifacts, and generating the necessary metadata to publish the package. +The basic syntax of the command is as follows: .. code-block:: bash - cd <path to conanfile.py of recipe> - conan create . <optional user>/<optional channel> + $ conan create <path_to_recipe> <pkg/version@user/channel> -At this step the binaries of this package are now available in the *local cache*. +- `<path_to_source>`: The path to the conan recipe of that corresponding package. +- `<pkg/version@user/channel>`: The user and channel specify the namespace under which the package with the corresponding version will be built. + +.. code-block:: bash + + $ conan create openscenario_engine/0.1@openpass/testing + +This command will build the package `openscenario_engine` with version `1.0` under the user `openpass` and channel `testing`. + +**Optional Settings** + +The `-o` option allows you to pass optional settings to the `conan create` command, which can be used to customize the build process of the package. These settings are defined in the `conanfile.py` recipe. +For example, you can specify build options, compiler flags, or any other configuration settings that influence the package creation process. + +.. code-block:: bash + + $ conan create openscenario_engine/0.1@openpass/testing -o MantleAPI_version=0.1 -o Yase_version=0.1 + +In this example, the `-o` option is used to set the `MantleAPI_version` and `Yase_version` build options for the `openscenario_engine` package. These options will be considered during the package creation process. + +.. note:: + + For the packages MantleAPI, Yase, openscenario_api and openscenario_engine corresponding commit ids can be used instead of version when creating the package + +Conan Install +------------- + +The `conan install` command is used to install Conan packages from a Conan recipe (a `conanfile.py` file) and its associated dependencies. It resolves and fetches the required packages from a remote Conan repository or local conan cache and installs them in the specified target location. +The basic syntax of the command is as follows: + +.. code-block:: bash + + $ conan install <pkg/version@user/channel> -g <generator> -s <setting=value> --build <missing|outdated> --install-folder=<installation-path> + +- `<pkg/version@user/channel>`: The user and channel specify the namespace under which the package with the corresponding version will be built. +- `-g <generator>`: Specifies the build system generator (e.g., `cmake`, `make`, `visual_studio`) for generating build files. +- `-s <setting=value>`: Overrides a Conan setting defined in the recipe with the given value. +- `--build <missing|outdated>`: Specifies whether to build missing or outdated packages. + +**Generate Deployment Files** + +The `-g deploy` option with the `conan install` command is used to generate deployment-related files and scripts for installing and running the package on a target system. +These files can include packaging scripts, installation scripts, and other artifacts required for deploying the package to a specific environment. + +.. code-block:: bash + + $ conan install openscenario_engine/0.1@openpass/testing -g deploy --install-folder="my/installation/path" + +This command will deploy the package `openscenario_engine/0.1@openpass/testing` at the installation path. .. note:: There are several additional commands, arguments and fields for these commands available. Please see `Conan Docs <https://docs.conan.io/en/latest/>`_ for additional information. -Build |op| ----------- - -If you followed the previous steps and export all dependencies and |op| recipes to Conans *local cache*, then you can go on with the next steps. -If not then at least the ``export`` should be done. -Else Conan is not able to know how to build the dependencies and |op|. - -|op| can be build using a ``conanfile.txt``. -It holds every Information which is needed to build and install |op|. - -The following file shows an example which can be used. -This example is also available in the ``conan`` folder in the ``simopenpass`` repository. - -.. code-block:: - - [requires] - openpass/0.8 - - [generators] - cmake - - [imports] - . , * -> C:/openpass @ - -The ``requires`` field describes what package with what version shall be installed. -It´s also possible to add more packages here or change the version. - -The ``generator`` field is used to add different generators to the process. -In this example the ``cmake`` generator would generate cmake files, which describe where to find the |op| in the *local cache*. -There are also other possibilities like a ``cmake_find_package`` generator, which generates *cmake* *FindPackage* files. - -At this point |op| only exists in the *local cache* of Conan. -With the ``imports`` field it´s possible to specify where and how the binaries shall be copied from the *local cache* to the *user space*. -The example follows the following pattern: - - <source>, <pattern> -> <destination> - -.. note:: - - It is possible to add several lines for more specific copying operations. - Also there are more field available than this simple example shows. - See `Conan Docs <https://docs.conan.io/en/latest/>`_ for additional information. - -Conan can simply install |op| with the following command. -If the dependencies or |op| were not build in any previous step, the binaries will not be available in the *local cache* of Conan. -Conan can build them by adding ``--build=missing`` to the following command. - -.. code-block:: bash - - conan install <path to conanfile.txt> - - Build only ThirdParties ----------------------- -The ThirdParty libraries can be build and installed the same way. +|op| requires number of third parties libraries and they are listed in ``conanfile.txt``. To install all the dependencies, the script ``15_prepare_thirdParty.sh`` can be used. + +The following file shows an example which can be used. This example is also available in the conan folder in the opSimulation repository. .. code-block:: [requires] - OSI/3.5.0 - FMILibrary/2.0.3 + zlib/1.2.12@ + qt/5.15.3@ + gtest/1.11.0@openpass/testing + FMILibrary/2.0.3@openpass/testing + protobuf/3.20.0@ + units/2.3.3@openpass/testing + open-simulation-interface/3.5.0@openpass/testing + MantleAPI/0.1@openpass/testing + Yase/0.1@openpass/testing + openscenario_api/v1.3.1@openpass/testing + openscenario_engine/0.1@openpass/testing + + [options] + qt:with_pq=False + qt:openssl=False + qt:opengl=no + msys2:no_kill=True + qt:qtxmlpatterns=True + b2:use_cxx_env=True + b2:toolset=gcc + protobuf:shared=True + openscenario_engine:MantleAPI_version=515f156900f866e1004a53b352931547cf5a85f6 + openscenario_engine:Yase_version=d0c0e58d17358044cc9018c74308b45f6097ecfb [generators] + deploy cmake_find_package - cmake_paths - [imports] - . , * -> C:/openpass/ThirdParty @ +.. note:: + + The exact list of dependency can be found in the source code.
diff --git a/content/html/_sources/installation_guide/further_guidance/10_cmake.rst.txt b/content/html/_sources/installation_guide/further_guidance/10_cmake.rst.txt index dc2511e..d847a50 100644 --- a/content/html/_sources/installation_guide/further_guidance/10_cmake.rst.txt +++ b/content/html/_sources/installation_guide/further_guidance/10_cmake.rst.txt
@@ -1,7 +1,7 @@ .. ******************************************************************************* - Copyright (c) 2021 Bayerische Motoren Werke Aktiengesellschaft (BMW AG) - 2021 in-tech GmbH + Copyright (c) 2021 in-tech GmbH + 2021-2023 Bayerische Motoren Werke Aktiengesellschaft (BMW AG) This program and the accompanying materials are made available under the terms of the Eclipse Public License 2.0 which is available at @@ -95,7 +95,7 @@ -------------------- - Install directory used by install, when invoking ``make install`` -- Recommendation: ``/OpenPASS/bin/core`` (Linux) | ``C:/OpenPASS/bin/core`` (Windows) +- Recommendation: ``/openPASS/bin/core`` (Linux) | ``C:/openPASS/bin/core`` (Windows) CMAKE_WITH_DEBUG_POSTIX ----------------------- @@ -117,7 +117,7 @@ CMAKE_C_COMPILER ---------------- -- Options: **gcc-10** | gcc-9 | gcc-8 +- Options: **gcc-13** | gcc-12 | gcc-11 | gcc-10 | gcc-9 | gcc-8 - See: https://cmake.org/cmake/help/latest/variable/CMAKE_LANG_COMPILER.html .. note:: @@ -127,7 +127,7 @@ CMAKE_CXX_COMPILER ------------------ -- Options: **g++-10** | g++-9 | g++-8 +- Options: **gcc-13** | gcc-12 | gcc-11 | gcc-10 | gcc-9 | gcc-8 - See: https://cmake.org/cmake/help/latest/variable/CMAKE_LANG_COMPILER.html .. note:: @@ -181,16 +181,6 @@ The generated files are placed next to the test executable. Each test will be built without optimization, which will increase the testing run-time. - -WITH_GUI --------- - -- Activates the additional build of the GUI provided with |Op| (open source). -- Options: **OFF** | ON - -.. note:: - - Please refer to :ref:`gui_plugins` for information on the GUI. WITH_TESTS ---------- @@ -218,20 +208,6 @@ .. _cmake_protobuf_arenas: -WITH_EXTENDED_OSI ------------------ - -- When set, assumes that extended version of OSI is available, by enabling the ``USE_EXTENDED_OSI`` preprocessor variable. -- This variable can be used to enable e.g. customized OSI features: - - .. code-block:: c++ - - #ifdef USE_EXTENDED OSI - #include <osi3/osi_<custom_message>.pb.h> - #endif - -- Options: **OFF** | ON - WITH_PROTOBUF_ARENA ------------------- @@ -265,6 +241,12 @@ - during installation step, this configuration copies detected runtime dependencies (i.e. required shared libraries) specified in `CMAKE_PREFIX_PATH` to install directory - Options: ON | **OFF** +INSTALL_EXAMPLES +---------------- + +- If `ON`, **opSimulation** configuration examples are copied to the `examples` folder inside the installation directory (during the installation step). +- Options: **ON** | OFF + Make Targets/Commands ---------------------
diff --git a/content/html/_sources/other_information/10_external_dependencies.rst.txt b/content/html/_sources/other_information/10_external_dependencies.rst.txt index 5cf1be0..5524f7f 100644 --- a/content/html/_sources/other_information/10_external_dependencies.rst.txt +++ b/content/html/_sources/other_information/10_external_dependencies.rst.txt
@@ -1,6 +1,7 @@ .. ******************************************************************************* - Copyright (c) 2021 Bayerische Motoren Werke Aktiengesellschaft (BMW AG) + Copyright (c) 2021-2023 Bayerische Motoren Werke Aktiengesellschaft (BMW AG) + 2023 Mercedes-Benz Tech Innovation GmbH This program and the accompanying materials are made available under the terms of the Eclipse Public License 2.0 which is available at @@ -28,7 +29,7 @@ GNU Compiler Collection (gcc) ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Version (latest tested): 10.2.3 +Version (latest tested): 13.2.0 |Op| is developed on Linux and Windows (64-Bit) in `C++17 <https://isocpp.org/>`_ using the GNU Compiler Collection (`gcc <https://gcc.gnu.org/>`_). @@ -42,14 +43,14 @@ GNU Debugger (gdb) ~~~~~~~~~~~~~~~~~~ -Version (latest tested): 9.2 +Version (latest tested): 13.2.0 Debugging tools for gcc: https://www.gnu.org/savannah-checkouts/gnu/gdb/index.html CMake ~~~~~ -Version (latest tested): 3.18.4 +Version (latest tested): 3.27.3 |Op| uses `CMake <https://cmake.org/>`_ for building and testing. For details on the provided options, see :ref:`cmake`. @@ -59,7 +60,7 @@ Ccache ~~~~~~ -Version (latest tested): 3.7.11 +Version (latest tested): 4.7.4 |Op| supports the compiler cache `Ccache <https://ccache.dev/>`_ for faster recompilation. Use only, if you need to recompile regularly. @@ -72,7 +73,7 @@ Doxygen ~~~~~~~ -Version (latest tested): 1.8.20 +Version (latest tested): 1.9.6 Documentation is created using `Doxygen <https://www.doxygen.nl/index.html>`_. @@ -84,15 +85,14 @@ Qt Framework ~~~~~~~~~~~~ -Version (officially supported): 5.12.3 +Version (officially supported): 5.15.3 |Op| uses some features from the `Qt <https://www.qt.io/>`_ framework. -While the GUI of |op_oss| heavily relies on it, the simulator tries to stick to the C++ standard framework as far as possible. +A previous version of the GUI of |op| relied on Qt. |Op| itself tries to stick to the C++ standard framework as far as possible, but still uses the Qt framework for some tasks, e.g. xml parsing. .. admonition:: Note on Versions | Versions starting from 5.4 should generally work, but are not officially supported anymore/yet. - | Version 5.15.1 has been reported to work well. Boost C++ Libraries ~~~~~~~~~~~~~~~~~~~ @@ -108,7 +108,7 @@ googletest ~~~~~~~~~~ -Version (officially supported): 1.10.0 +Version (officially supported): 1.14.0 Tests are written in `googletest <https://github.com/google/googletest>`_ and |Op| makes use of the included *googletest* (gtest) C++ testing framework, as well as the included mocking framework *googlemock* (gmock). @@ -149,17 +149,12 @@ As shown, OSI itself depends on :ref:`prerequisites_protobuf`. If not already installed, the library and headers have to be built prior to OSI. -.. admonition:: Note on Versions - - |Op| supports **integration of custom made or experimental versions** of OSI (see :ref:`building_osi`). - For example, `Algorithm_FmuWrapper` and the wrapped `OSMP` FMUs use the proposed OSI messages `MotionCommand` and `VehicleCommunicationData`, not yet defined in OSI 3.5.0. - .. _prerequisites_protobuf: Protocol Buffers (protobuf) ~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Supported Version (officially supported): 3.12.2 +Supported Version (officially supported): 3.20.0 :ref:`prerequisites_osi` uses `Protocol Buffers <https://developers.google.com/protocol-buffers>`_ for describing and serialization of its datastructures.
diff --git a/content/html/_sources/other_information/20_glossary.rst.txt b/content/html/_sources/other_information/20_glossary.rst.txt index 6b13498..656d198 100644 --- a/content/html/_sources/other_information/20_glossary.rst.txt +++ b/content/html/_sources/other_information/20_glossary.rst.txt
@@ -72,7 +72,7 @@ See https://www.vufo.de/pcm/?lang=en PreCASE - Framework for the Simulative Evaluation of Active Safety Systems in Vehicles (OpenPASS predecessor). + Framework for the Simulative Evaluation of Active Safety Systems in Vehicles (openPASS predecessor). Scenario A set of similar traffic situations.
diff --git a/content/html/_sources/user_guide/30_gui_plugins.rst.txt b/content/html/_sources/other_information/30_gui_plugins.rst.txt similarity index 61% rename from content/html/_sources/user_guide/30_gui_plugins.rst.txt rename to content/html/_sources/other_information/30_gui_plugins.rst.txt index c6b7d64..337f004 100644 --- a/content/html/_sources/user_guide/30_gui_plugins.rst.txt +++ b/content/html/_sources/other_information/30_gui_plugins.rst.txt
@@ -2,6 +2,7 @@ ******************************************************************************* Copyright (c) 2021 Bayerische Motoren Werke Aktiengesellschaft (BMW AG) 2021 ITK Engineering GmbH + 2023 Mercedes-Benz Tech Innovation GmbH This program and the accompanying materials are made available under the terms of the Eclipse Public License 2.0 which is available at @@ -15,13 +16,11 @@ GUI Plugins =========================== + * The deprecated “Qt GUI” for simulation configuration based on Qt mainly aimed to edit PCM-based openPASS experiments was part of minor releases v0.5 – v0.11. + * The latest version of this deprecated GUI can be found here: https://ci.eclipse.org/openpass/job/openPASS_simulator_build/view/tags/job/openPASS_0.11/ + .. toctree:: :glob: :maxdepth: 1 gui_user_guide/* - -Additionally, the following plugins are currently work in progress: - - * agentConfiguration - * trafficSimulation
diff --git a/content/html/_sources/other_information/30_license.rst.txt b/content/html/_sources/other_information/40_license.rst.txt similarity index 100% rename from content/html/_sources/other_information/30_license.rst.txt rename to content/html/_sources/other_information/40_license.rst.txt
diff --git a/content/html/_sources/user_guide/gui_user_guide/10_projects.rst.txt b/content/html/_sources/other_information/gui_user_guide/10_projects.rst.txt similarity index 82% rename from content/html/_sources/user_guide/gui_user_guide/10_projects.rst.txt rename to content/html/_sources/other_information/gui_user_guide/10_projects.rst.txt index c162908..6580323 100644 --- a/content/html/_sources/user_guide/gui_user_guide/10_projects.rst.txt +++ b/content/html/_sources/other_information/gui_user_guide/10_projects.rst.txt
@@ -2,6 +2,7 @@ ******************************************************************************* Copyright (c) 2021 Bayerische Motoren Werke Aktiengesellschaft (BMW AG) 2021 ITK Engineering GmbH + 2023 Mercedes-Benz Tech Innovation GmbH This program and the accompanying materials are made available under the terms of the Eclipse Public License 2.0 which is available at @@ -16,6 +17,10 @@ Project ======= + * The deprecated “Qt GUI” for simulation configuration based on Qt mainly aimed to edit PCM-based openPASS experiments was part of minor releases v0.5 – v0.11. + * The latest version of this deprecated GUI can be found here: https://ci.eclipse.org/openpass/job/openPASS_simulator_build/view/tags/job/openPASS_0.11/ + + The Project Plugin can be used to simply start a simulation from the gui. .. image:: _static/images/plugin/project/overview.png @@ -38,8 +43,8 @@ The next step is path settings. These will change depending on where your openPASS.exe is located. -In the screen shot above the openPASS.exe is located at ``C:/OpenPASS``. -For easier use of this tutorial it is recommended to save the Demo Folder in ``C:/`` and name it *OpenPASS*. +In the screen shot above the openPASS.exe is located at ``C:openPASS``. +For easier use of this tutorial it is recommended to save the Demo Folder in ``C:/`` and name it *openPASS*. On to the settings. As you can see three paths need to be set. The library comes with openPASS. @@ -47,7 +52,7 @@ The Simulation Path references the opSimulation.exe, the file to execute the simulation. If you are using the provided Demo, there is no need for you to change it. The only path you need to set is the path of the Configuration Files. -In the Demo it will be located at ``[directory of openPASS.exe]/configs``, so in this case it would be ``C:/OpenPASS/configs``. +In the Demo it will be located at ``[directory of openPASS.exe]/configs``, so in this case it would be ``C:/openPASS/configs``. Simulation Output Settings -------------------------- @@ -63,4 +68,4 @@ .. note:: - It is recommended to create a new folder in C:/OpenPASS called “results” and set it as the results path as in the picture above. + It is recommended to create a new folder in C:/openPASS called “results” and set it as the results path as in the picture above.
diff --git a/content/html/_sources/user_guide/gui_user_guide/20_system_editor.rst.txt b/content/html/_sources/other_information/gui_user_guide/20_system_editor.rst.txt similarity index 79% rename from content/html/_sources/user_guide/gui_user_guide/20_system_editor.rst.txt rename to content/html/_sources/other_information/gui_user_guide/20_system_editor.rst.txt index e2931ed..a29587c 100644 --- a/content/html/_sources/user_guide/gui_user_guide/20_system_editor.rst.txt +++ b/content/html/_sources/other_information/gui_user_guide/20_system_editor.rst.txt
@@ -1,6 +1,7 @@ .. ******************************************************************************* Copyright (c) 2021 ITK Engineering GmbH + 2023 Mercedes-Benz Tech Innovation GmbH This program and the accompanying materials are made available under the terms of the Eclipse Public License 2.0 which is available at @@ -14,6 +15,10 @@ System Editor ============= + * The deprecated “Qt GUI” for simulation configuration based on Qt mainly aimed to edit PCM-based openPASS experiments was part of minor releases v0.5 – v0.11. + * The latest version of this deprecated GUI can be found here: https://ci.eclipse.org/openpass/job/openPASS_simulator_build/view/tags/job/openPASS_0.11/ + + The System Editor helps building the system configuration (systemConfig) in the GUI. This file is also a XML-file and specifies the components of an agent and systems used, in this case advanced driver assistance systems.
diff --git a/content/html/_sources/user_guide/gui_user_guide/30_pcm_sim.rst.txt b/content/html/_sources/other_information/gui_user_guide/30_pcm_sim.rst.txt similarity index 92% rename from content/html/_sources/user_guide/gui_user_guide/30_pcm_sim.rst.txt rename to content/html/_sources/other_information/gui_user_guide/30_pcm_sim.rst.txt index a58d630..9018986 100644 --- a/content/html/_sources/user_guide/gui_user_guide/30_pcm_sim.rst.txt +++ b/content/html/_sources/other_information/gui_user_guide/30_pcm_sim.rst.txt
@@ -1,6 +1,7 @@ .. ******************************************************************************* Copyright (c) 2021 ITK Engineering GmbH + 2023 Mercedes-Benz Tech Innovation GmbH This program and the accompanying materials are made available under the terms of the Eclipse Public License 2.0 which is available at @@ -14,6 +15,10 @@ PCM Simulation ============== + * The deprecated “Qt GUI” for simulation configuration based on Qt mainly aimed to edit PCM-based openPASS experiments was part of minor releases v0.5 – v0.11. + * The latest version of this deprecated GUI can be found here: https://ci.eclipse.org/openpass/job/openPASS_simulator_build/view/tags/job/openPASS_0.11/ + + This plugin is used to configure and start a simulation based pcm data or simulation configuration sets of previous simulations. Simulation Input
diff --git a/content/html/_sources/user_guide/gui_user_guide/40_pcm_eval.rst.txt b/content/html/_sources/other_information/gui_user_guide/40_pcm_eval.rst.txt similarity index 76% rename from content/html/_sources/user_guide/gui_user_guide/40_pcm_eval.rst.txt rename to content/html/_sources/other_information/gui_user_guide/40_pcm_eval.rst.txt index 36e6029..e9d609b 100644 --- a/content/html/_sources/user_guide/gui_user_guide/40_pcm_eval.rst.txt +++ b/content/html/_sources/other_information/gui_user_guide/40_pcm_eval.rst.txt
@@ -14,6 +14,9 @@ PCM Evaluation ============== + * The deprecated “Qt GUI” for simulation configuration based on Qt mainly aimed to edit PCM-based openPASS experiments was part of minor releases v0.5 – v0.11. + * The latest version of this deprecated GUI can be found here: https://ci.eclipse.org/openpass/job/openPASS_simulator_build/view/tags/job/openPASS_0.11/ + This plugin is used to load results of previous simulations. Loading Results
diff --git a/content/html/_sources/user_guide/gui_user_guide/50_result_visualization.rst.txt b/content/html/_sources/other_information/gui_user_guide/50_result_visualization.rst.txt similarity index 65% rename from content/html/_sources/user_guide/gui_user_guide/50_result_visualization.rst.txt rename to content/html/_sources/other_information/gui_user_guide/50_result_visualization.rst.txt index adbf6f9..151fdc9 100644 --- a/content/html/_sources/user_guide/gui_user_guide/50_result_visualization.rst.txt +++ b/content/html/_sources/other_information/gui_user_guide/50_result_visualization.rst.txt
@@ -14,6 +14,9 @@ Result Visualization ==================== + * The deprecated “Qt GUI” for simulation configuration based on Qt mainly aimed to edit PCM-based openPASS experiments was part of minor releases v0.5 – v0.11. + * The latest version of this deprecated GUI can be found here: https://ci.eclipse.org/openpass/job/openPASS_simulator_build/view/tags/job/openPASS_0.11/ + .. image:: result_visualization/_static/images/timeplot/select.png .. toctree::
diff --git a/content/html/_sources/user_guide/gui_user_guide/result_visualization/10_statistics.rst.txt b/content/html/_sources/other_information/gui_user_guide/result_visualization/10_statistics.rst.txt similarity index 100% rename from content/html/_sources/user_guide/gui_user_guide/result_visualization/10_statistics.rst.txt rename to content/html/_sources/other_information/gui_user_guide/result_visualization/10_statistics.rst.txt
diff --git a/content/html/_sources/user_guide/gui_user_guide/result_visualization/20_timePlot.rst.txt b/content/html/_sources/other_information/gui_user_guide/result_visualization/20_timePlot.rst.txt similarity index 100% rename from content/html/_sources/user_guide/gui_user_guide/result_visualization/20_timePlot.rst.txt rename to content/html/_sources/other_information/gui_user_guide/result_visualization/20_timePlot.rst.txt
diff --git a/content/html/_sources/user_guide/10_overview.rst.txt b/content/html/_sources/user_guide/10_overview.rst.txt index 511d939..532fda5 100644 --- a/content/html/_sources/user_guide/10_overview.rst.txt +++ b/content/html/_sources/user_guide/10_overview.rst.txt
@@ -14,8 +14,8 @@ Overview ======== -OpenPASS is an open-source software, which is continuously being improved by stakeholders of the openPASS working group: |op_oss| (https://openpass.eclipse.org/) -OpenPASS can simulate traffic situations with the goal of predicting and evaluating the safety of driver assistance systems, more specifically ADAS (Advanced Driving Assistance Systems) or AD functions. Its main use-cases are PCM-(PreCrash Matrix), and scenario-based simulations. +openPASS is an open-source software, which is continuously being improved by stakeholders of the openPASS working group: |op_oss| (https://openpass.eclipse.org/) +openPASS can simulate traffic situations with the goal of predicting and evaluating the safety of driver assistance systems, more specifically ADAS (Advanced Driving Assistance Systems) or AD functions. Its main use-cases are PCM-(PreCrash Matrix), and scenario-based simulations. Let’s have a look at what that means: .. image:: sim_user_guide/_static/images/crash-scenario.png @@ -62,14 +62,6 @@ Thereby, the **Simulation Output** is again a set of files. -Interaction GUI and Framework ------------------------------ - -.. image:: gui_user_guide/_static/images/plugin/gui_framework_overview.png - -The GUI sits on top of the simulation framework. It produces configuration files for the framework based on the user input. -With these files, the GUI can trigger the simulation to start. The results of the simulation (in form of files) can be evaluated by the GUI. - Workflow --------
diff --git a/content/html/_sources/user_guide/40_configs_in_depth.rst.txt b/content/html/_sources/user_guide/30_configs_in_depth.rst.txt similarity index 100% rename from content/html/_sources/user_guide/40_configs_in_depth.rst.txt rename to content/html/_sources/user_guide/30_configs_in_depth.rst.txt
diff --git a/content/html/_sources/user_guide/50_outputs_in_depth.rst.txt b/content/html/_sources/user_guide/40_outputs_in_depth.rst.txt similarity index 100% rename from content/html/_sources/user_guide/50_outputs_in_depth.rst.txt rename to content/html/_sources/user_guide/40_outputs_in_depth.rst.txt
diff --git a/content/html/_sources/user_guide/60_scenario_simulation.rst.txt b/content/html/_sources/user_guide/50_scenario_simulation.rst.txt similarity index 100% rename from content/html/_sources/user_guide/60_scenario_simulation.rst.txt rename to content/html/_sources/user_guide/50_scenario_simulation.rst.txt
diff --git a/content/html/_sources/user_guide/configs/scenario.rst.txt b/content/html/_sources/user_guide/configs/scenario.rst.txt index e8550d8..e2392f4 100644 --- a/content/html/_sources/user_guide/configs/scenario.rst.txt +++ b/content/html/_sources/user_guide/configs/scenario.rst.txt
@@ -1,7 +1,7 @@ .. ******************************************************************************* Copyright (c) 2021 in-tech GmbH - 2022 Bayerische Motoren Werke Aktiengesellschaft (BMW AG) + 2022-2023 Bayerische Motoren Werke Aktiengesellschaft (BMW AG) This program and the accompanying materials are made available under the terms of the Eclipse Public License 2.0 which is available at @@ -86,8 +86,8 @@ VehicleCatalog ~~~~~~~~~~~~~~ -This file is mandatory. -It contains the available vehicle models for the simulation. +This path is mandatory. +It contains the available vehicle model catalogs for the simulation. For each vehicle the physical parameters are stored here. **Supported models:** @@ -101,15 +101,17 @@ - truck - bicycle -**Full Example:** :download:`/../../../repo/sim/contrib/examples/Common/VehicleModelsCatalog.xosc` +**Example Catalog:** :download:`/../../../repo/sim/contrib/examples/Common/Vehicles/VehicleModelsCatalog.xosc` .. _scenario_pedestrianmodels: PedestrianCatalog ~~~~~~~~~~~~~~~~~ -This file is mandatory. -It contains the available pedestrian models for the simulation. +.. warning:: This part of the documentation needs a major update! Pedestrians are handled as vehicles and are included in the vehicle catalogs. + +This path is mandatory. +It contains the available pedestrian model catalogs for the simulation. For each pedestrian the physical parameters are stored here. .. note:: @@ -122,7 +124,7 @@ - pedestrian_child - pedestrian_adult -**Full Example:** :download:`/../../../repo/sim/contrib/examples/Common/PedestrianModelsCatalog.xosc` +**Full Example:** :download:`/../../../repo/sim/contrib/examples/Common/Vehicles/PedestrianModelsCatalog.xosc` .. _scenario_roadnetwork: @@ -492,10 +494,15 @@ SimulationTime ++++++++++++++ -Defines, when the simulation ends. -Triggers at a specified time value, given in seconds. +The SimulationTimeCondition only defines an arbitrary trigger, which can be used in ANY condition (see here: https://www.asam.net/static_downloads/ASAM_OpenSCENARIO_V1.1.1_Model_Documentation/modelDocumentation/content/SimulationTimeCondition.html) +If used in conjunction with a StopTrigger of a Storyboard defines how long the simulation will be executed at max. The rule is required and only ``greaterThan`` is currently supported. +.. warning:: + + It is mandatory for openPASS to define a StopTrigger that will fire in any case. + This does not necessarily have to be a SimulationTimeCondition, but it is recommended to use it, perhaps in conjunction with another trigger. + **Example** .. literalinclude:: /../../../repo/sim/contrib/examples/Common/Scenario.xosc @@ -519,7 +526,7 @@ .. literalinclude:: /../../../repo/sim/contrib/examples/Configurations/ByEntityCondition_RelativeLane/Scenario.xosc :language: xml :dedent: 18 - :start-at: <Condition name="RelativeLanePosition"> + :start-at: <Condition name="RelativeLanePosition" :end-at: </Condition> .. _scenario_roadposition: @@ -536,7 +543,7 @@ .. literalinclude:: /../../../repo/sim/contrib/examples/Configurations/ByEntityCondition_RoadPosition/Scenario.xosc :language: xml :dedent: 18 - :start-at: <Condition name="RoadPosition"> + :start-at: <Condition name="RoadPosition" :end-at: </Condition> .. _scenario_relativespeed: @@ -551,7 +558,7 @@ .. literalinclude:: /../../../repo/sim/contrib/examples/Configurations/ByEntityCondition_RelativeSpeed/Scenario.xosc :language: xml :dedent: 18 - :start-at: <Condition name="RelativeSpeed"> + :start-at: <Condition name="RelativeSpeed" :end-at: </Condition> .. _scenario_timetocollision: @@ -567,7 +574,7 @@ .. literalinclude:: /../../../repo/sim/contrib/examples/Configurations/ByEntityCondition_TimeToCollision/Scenario.xosc :language: xml :dedent: 18 - :start-at: <Condition name="TimeToCollision"> + :start-at: <Condition name="TimeToCollision" :end-at: </Condition> .. _scenario_timeheadway: @@ -584,7 +591,7 @@ .. literalinclude:: /../../../repo/sim/contrib/examples/Configurations/ByEntityCondition_TimeHeadway/Scenario.xosc :language: xml :dedent: 18 - :start-at: <Condition name="TimeHeadway"> + :start-at: <Condition name="TimeHeadway" :end-at: </Condition> .. _scenario_actions: @@ -697,7 +704,7 @@ .. warning:: - An FMU might contain routing logic not visible to the OpenPASS simulation core. + An FMU might contain routing logic not visible to the openPASS simulation core. For that reason, an equivalent `RoutingAction` should be set when using `AcquirePosition`. Otherwise the simulation output might contain missing data for fields depending on the localization along the route (`PositionRoute`, `TCoordinate`, `AgentInFront`, ...).
diff --git a/content/html/_sources/user_guide/configs/systemconfigblueprint.rst.txt b/content/html/_sources/user_guide/configs/systemconfigblueprint.rst.txt index 510f577..2d82c46 100644 --- a/content/html/_sources/user_guide/configs/systemconfigblueprint.rst.txt +++ b/content/html/_sources/user_guide/configs/systemconfigblueprint.rst.txt
@@ -1,6 +1,7 @@ .. ******************************************************************************* Copyright (c) 2021 in-tech GmbH + 2023 Bayerische Motoren Werke Aktiengesellschaft (BMW AG) This program and the accompanying materials are made available under the terms of the Eclipse Public License 2.0 which is available at @@ -178,6 +179,8 @@ Dynamics_RegularDriving Dynamics 3 Dynamics_Collision Dynamics 4 PrioritizerDynamics Dynamics 5 + Dynamics_Scenario Dynamics 6 + ControllerSwitch Dynamics 7 Algorithm_LongitudinalVehicleComponent Algorithm 11 Algorithm_LongitudinalAfdm Algorithm 12 Algorithm_SteeringVehicleComponent Algorithm 14
diff --git a/content/html/_sources/user_guide/outputs/observation_log.rst.txt b/content/html/_sources/user_guide/outputs/observation_log.rst.txt index d3a78ee..bc6cc2a 100644 --- a/content/html/_sources/user_guide/outputs/observation_log.rst.txt +++ b/content/html/_sources/user_guide/outputs/observation_log.rst.txt
@@ -1,6 +1,7 @@ .. ******************************************************************************* Copyright (c) 2021 in-tech GmbH + 2023 Bayerische Motoren Werke Aktiengesellschaft (BMW AG) This program and the accompanying materials are made available under the terms of the Eclipse Public License 2.0 which is available at @@ -16,10 +17,10 @@ This section describes the parameters and outputs of the ``Observation_Log`` observer. -.. _observationlog_paramerization: +.. _observationlog_parameterization: -Paramerization -============== +Parameterization +================ Following parameters are supported: @@ -42,20 +43,35 @@ The world publishes the following cyclics (see source of ``AgentNetwork.cpp``): -- XPosition -- YPosition -- VelocityEgo -- AccelerationEgo -- YawAngle -- YawRate -- SteeringAngle -- TotalDistanceTraveled -- PositionRoute -- TCoordinate -- Lane -- Road -- SecondaryLanes -- AgentInFront +.. table:: + :class: tight-table + + ====================== ============== ===== ================================================================================================= + Cyclics Type Unit Description + ====================== ============== ===== ================================================================================================= + XPosition Double m Position x of the reference point (in world coordinates) + YPosition Double m Position y of the reference point (in world coordinates) + VelocityEgo Double m/s Absolute velocity (length of the velocity vector) at the reference point + (including spin caused by YawRate) + AccelerationEgo Double m/s² Longitudinal acceleration (including angular acceleration) at the reference point. + Longitudinal refers to the angle of the vehicle regardless of the curvature of the road it is on. + YawAngle Double rad Yaw angle w.r.t. x-axis + YawRate Double rad/s Yaw rate of the agent + SteeringAngle Double rad Steering wheel angle + TotalDistanceTraveled Double m Total traveled distance of all agents + PositionRoute\* Double m Position of the agent's front center in **road's** s coordinate + (distance to the start of the road) + TCoordinate\* Double m Position of the agent's front center in **lane's** t coordinate + (distance to the middle of the lane respecting intended driving direction) + Lane\* Integer Id of the lane + Road\* String OpenDrive id of the road on which the agent is on (i.e. the front center). + SecondaryLanes\* IntegerVector List of secondary lanes on a specific road + AgentInFront\* Integer Id of the next object on the agent's route + ====================== ============== ===== ================================================================================================= + +\*Only valid when the agent has a valid route assigned in the current timestep. + +The agent's reference point is located at the center of the rear axle (see :ref:`coordinatesystems`). Please refer to the individual components, for information about their published cyclics. @@ -63,7 +79,7 @@ We also need a way to better communicate, who is publishing what. This should directly come out of the source code, to keep the documentation up to date. - See https://gitlab.eclipse.org/eclipse/simopenpass/simopenpass/-/issues/148 + See https://gitlab.eclipse.org/eclipse/openpass/opSimulation/-/issues/148 .. admonition:: **Wildcards in LoggingGroup definitions** @@ -85,7 +101,7 @@ SimulationOutput ~~~~~~~~~~~~~~~~ -Every successful run (single experiment) generates a single file, normally called ``simulationOutput.xml`` (see :ref:'observationlog_paramerization'). +Every successful run (single experiment) generates a single file, normally called ``simulationOutput.xml`` (see :ref:'observationlog_parameterization'). The output can contain multiple invocations of the same configuration with different random seeds. For each invocation a RunResult is stored, which contains information about the agents and their parameters. As well as run specific events and parameters. @@ -177,6 +193,8 @@ be used by the |op| Visualizer. The initial state of the ThreeSignalsTrafficLight is posted too. ====================== ===================================================================================== +The change in the active component of longitudinal and/or lateral control is also logged as event with name "ActiveComponentChange". + .. _observationlog_agents: Agents @@ -221,6 +239,18 @@ Negative distances are closer to the rear of the vehicle. ======================= ============================================================================= +The Components tag lists all instantiated components from the SystemProfile. + +.. table:: + :class: tight-table + + ======================= ============================================================================= + Attribute Description + ======================= ============================================================================= + Type Type of the component + Profile Name of the component profile + ======================= ============================================================================= + The Sensors tag lists all sensors of the agent and their parameters. .. table::
diff --git a/content/html/_sources/user_guide/sim_user_guide/components/dynamics_scenario.rst.txt b/content/html/_sources/user_guide/sim_user_guide/components/dynamics_scenario.rst.txt new file mode 100644 index 0000000..13ec0c0 --- /dev/null +++ b/content/html/_sources/user_guide/sim_user_guide/components/dynamics_scenario.rst.txt
@@ -0,0 +1,64 @@ +.. _dynamics_scenario: + +Dynamics_Scenario +================= + +This module acts as a direct implementation of external scenario actions, requested through `ControlStrategies` defined in the `Mantle API <https://gitlab.eclipse.org/eclipse/openpass/scenario_api>`. +As the MantleAPI is not an official standard, the module currently follows a "standard conform" interpretation based on `openSCENARIO V1.1 <https://www.asam.net/standards/detail/openscenario/>`. + +.. note:: + + Due to the nature of |op| actions that are set by the scenario engine in one timestep, will be visible in the simulation output starting with the next timestep, + because all states are only syncronized at the end of a timestep + +In every timestep one strategy for each MovementDomain (longitudinal and lateral) is active. +If the scenario engine sets a new strategy for a MovementDomain the previous strategy for this MovementDomain is stopped. +A strategy can also apply to both MovementDomains (meaning it is the only active strategy). +If a strategy is finished (except KeepVelocity and KeepLaneOffset which are never finished), this is reported back to the scenario engine. + +DefaultStrategies +----------------- + +KeepVelocity - longitudinal +~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +During this strategy the velocity is constant (same as at the time when this strategy is set). +This is the default longitudinal strategy, if no other longitudinal strategy is set. + +KeepLaneOffset - lateral +~~~~~~~~~~~~~~~~~~~~~~~~ + +During this strategy the agent will drive along the lane with a constant offset (same as at the time when this strategy is set). +This is the default lateral strategy, if no other lateral strategy is set. + +Strategies +---------- + +FollowVelocitySpline - longitudinal +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +A velocity spline defines a function over time of the agent velocity. +This function is a piecewise polynomial of degree 3. +This strategy will be set for SpeedActions with DynamicsShape other than step. + +PerformChangeLane - lateral +~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +This strategy will have the agent switching lanes while keeping a constant longitudinal velocity (in s direction). +It will be set for LaneChangeActions where the target lane is not the current lane. +At the momement only DynamicsShape sinusoidal and DynamicsDimension distance or time is supported. + +.. note:: + + In the current implementation both movement domains are touched, even if a longitudinal movement controller is active. + This means that the velocity of the longitudinal is ignored while the lane change is executed. + This may result in a jump of the velocity at the end of the lane change. + + +FollowTrajectory - both +~~~~~~~~~~~~~~~~~~~~~~~~ + +A trajectory defines the position and orientation of the agent at defined times. +If a timestep lies between the trajectory points the position is linearly interpolated. +This strategy will be set for FollowTrajectoryActions. +TrajectoryFollowingMode is not supported and the agent will always strictly adhere to the trajectory.
diff --git a/content/html/_sources/user_guide/sim_user_guide/components/spawner.rst.txt b/content/html/_sources/user_guide/sim_user_guide/components/spawner.rst.txt index b142e46..617a7dc 100644 --- a/content/html/_sources/user_guide/sim_user_guide/components/spawner.rst.txt +++ b/content/html/_sources/user_guide/sim_user_guide/components/spawner.rst.txt
@@ -1,6 +1,7 @@ .. ******************************************************************************* - Copyright (c) 2021 in-tech GmbH + Copyright (c) 2021-2023 Bayerische Motoren Werke Aktiengesellschaft (BMW AG) + 2021 in-tech GmbH This program and the accompanying materials are made available under the terms of the Eclipse Public License 2.0 which is available at @@ -15,26 +16,7 @@ ------- Spawners are responsible to populate the world. -In order to do so, several spawners can be used, whereas only the **ScenarioSpawner** is mandatory. - -.. _components_scenariospawner: - -ScenarioSpawner -~~~~~~~~~~~~~~~ - -The ScenarioSpawner is responsible for spawning Ego and Scenario vehicles as defined in the Scenario configuration file. -It is only called once initially and is **mandatory** for each simulation. -This Spawner should trigger before any other Spawners. - -The ScenarioSpawner has no parameters. - -Behavior: - -- In order to spawn correctly, a position for each Ego and Scenario vehicle is necessary, normally coming from the scenario (recommended). - As the position is *optional* in openSCENARIO it is possible that it is **not defined**. - In such cases spawning takes place at ``x = 0`` and ``y = 0``. -- If there is no route defined in the Scenario, the Spawner will set a random route starting at the spawning position. -- If there are multiple lanes at this position (this is only possible on junctions) it will take the lane with the lowest relative heading. +In order to do so, several spawners can be used. .. _components_prerunspawner: @@ -73,8 +55,18 @@ SStart, SEnd and SLength may be out of range for the road. In this case they are cropped such that the spawn range is maximum within the road's bounds. -It is also possible to define the minimum gap in meters either as fixed parameter of type double or as stochastic distribution. -If it isn't defined the default value of 5m is used. +It is also possible to define the MinimumSeparationBuffer either as fixed parameter of type double or as stochastic distribution: + +.. table:: + :class: tight-table + + ======================= ======================================= ==== ======== ==================================================== + Parameter Type Unit optional Description + ======================= ======================================= ==== ======== ==================================================== + MinimumSeparationBuffer Double (or any stochastic distribution) m yes Required minimum distance on lane between two agents + ======================= ======================================= ==== ======== ==================================================== + +If the MinimumSeparationBuffer isn't defined the default value of 5m is used. .. literalinclude:: /../../../repo/sim/contrib/examples/Common/ProfilesCatalog.xml :language: xml @@ -156,8 +148,8 @@ The RuntimeSpawner (included in library "SpawnerRuntimeCommon_OSI") is responsible for maintaining a populated scenery throughout the simulation runtime. It acts at each timestep throughout the simulation run and attempts to spawn Common Agents at the specified location(s). -The RuntimeSpawner needs a list of Spawners that define where it will spawn agents and a list of weighted :ref:`components_trafficgroups` that defines the type and parameters of the spawned agents. -The Spawners have the following parameters: +The RuntimeSpawner needs a list of SpawnZones that define where it will spawn agents and a list of weighted :ref:`components_trafficgroups` that defines the type and parameters of the spawned agents. +The SpawnZones have the following parameters: .. table:: :class: tight-table @@ -170,8 +162,18 @@ S-Position Double m The S position specifying at which point to spawn Agents ========== ============ ==== ============================================================== -It is also possible to define the minimum gap in meters either as fixed parameter of type double or as stochastic distribution. -If it isn't defined the default value of 5m is used. +It is also possible to define the MinimumSeparationBuffer either as fixed parameter of type double or as stochastic distribution: + +.. table:: + :class: tight-table + + ======================= ======================================= ==== ======== ==================================================== + Parameter Type Unit optional Description + ======================= ======================================= ==== ======== ==================================================== + MinimumSeparationBuffer Double (or any stochastic distribution) m yes Required minimum distance on lane between two agents + ======================= ======================================= ==== ======== ==================================================== + +If the MinimumSeparationBuffer isn't defined the default value of 5m is used. .. literalinclude:: /../../../repo/sim/contrib/examples/Common/ProfilesCatalog.xml :language: xml @@ -182,7 +184,7 @@ The RuntimeSpawner will spawn based on the following logic: - First the agentprofile needs to be determined. If the current spawn position evaluates to a right lane, the pool from which the agentprofile is drafted is extended by all traffic groups which contain the RightLaneOnly flag set to true. -- Then the time gap between the new agent and the closest existing agent is sampled. +- Then the gap between the spawn time of the new agent and the previously spawned agent is sampled. - Afterwards the velocity of the new agent is being sampled under consideration of the homogeneity. - A random route is sampled starting at the appropriate road - Once the timely gap expires, the spawnpoint evaluate if the TTC (2s) conditions and a minimum required distance between agents (5m) are met. If the TTC is critical the spawn velocity is reduced to fullfill the TTC requriements. If the minimum distance is not fullfilled, the agent will be held back.
diff --git a/content/html/_sources/user_guide/sim_user_guide/components/vehicle.rst.txt b/content/html/_sources/user_guide/sim_user_guide/components/vehicle.rst.txt index ca11244..3d8ef88 100644 --- a/content/html/_sources/user_guide/sim_user_guide/components/vehicle.rst.txt +++ b/content/html/_sources/user_guide/sim_user_guide/components/vehicle.rst.txt
@@ -1,7 +1,8 @@ .. ******************************************************************************* Copyright (c) 2021 in-tech GmbH - 2022 Bayerische Motoren Werke Aktiengesellschaft (BMW AG) + 2022-2023 Bayerische Motoren Werke Aktiengesellschaft (BMW AG) + 2023 Volkswagen AG This program and the accompanying materials are made available under the terms of the Eclipse Public License 2.0 which is available at @@ -81,7 +82,7 @@ .. _components_fmuwrapper: FMU Wrapper -~~~~~~~~~~~~ +~~~~~~~~~~~ The FMU Wrapper provides a connection to arbitrary FMUs (Functional Mock-up Unit). An FMU has to be compatible with the FMI 1.0 or the FMI 2.0 specification (Functional Mock-up Interface) and has to be ABI (Application Binary Interface) compatible with the opSimulation binary. @@ -119,7 +120,7 @@ Communication with the FMU happens via FMI variables (inputs and outputs). The wrapper will read in available variables from ``modelDescription.xml`` in the FMU package. -These variables need to be mapped to variables and signals of OpenPASS in the VehicleComponentProfile. +These variables need to be mapped to variables and signals of openPASS in the VehicleComponentProfile. FMI 1.0 supports these standard datatypes: - bool @@ -138,6 +139,7 @@ .. table:: :class: tight-table + :name: FmuWrapper basic configuration ==================== ======= ======= ================================================================================================================================ Key Type Default Description @@ -166,34 +168,75 @@ **Primitive Datatypes** -The Fmu Handler allows to link Simulink models or any other FMU to |op|. -It lets the user link any input variables of the FMU to values of the Agent in the simulation and any output values of the FMU to signals, that are forwarded to other components. -These mappings are defined with the following additional parameters, where the key describes the meaning in the simulation and the value is the variable in the modelDescription.xml: +The FMU Wrapper allows to link Simulink models or any other FMU to |op|. +It lets the user link any input variables of the FMU to values of the Agent in the simulation and any output values of the FMU to signals, that are forwarded to other |op| components. +These mappings are defined with the following optional parameters. .. note:: - Be careful with the size of integer data types when used in Matlab/Simulink. The FMU integer data type shall always be 32bit or higher for the ID. + Be careful with the size of integer data types when used in Matlab/Simulink. The FMU integer data type shall always be 32 bit or bigger, e.g. for IDs. .. table:: :class: tight-table - ======================= ======= =========================================================================================================== - Key Type Description - ======================= ======= =========================================================================================================== - Parameter\_\ *varName* any Mapping of a fixed value (bool, integer, double, string) to an FMU input. - ``varName`` references the FMU input defined in the modelDescription.xml. - Input\_\ *varName* string Mapping of a specific value of the simulation to an FMU input. - ``varName`` references the FMU input defined in the modelDescription.xml. - The value of this parameter has to be one of the types specified in the table below. - Output\_\ *varName* string Mapping of a FMU output to a specific field in a specific signal. - ``varName`` references the FMU output defined in the modelDescription.xml. - The value of this parameter has to be one of the types specified in the signal table below. - ======================= ======= =========================================================================================================== + ===================================== ======= ================================================================================================================== + Key Type Description + ===================================== ======= ================================================================================================================== + Parameter\_\ *varName* any Mapping of a fixed value (bool, integer, double, string) to an FMU input: + + * ``varName`` references an FMI input variable. + * The type of the parameter has to match the FMI variable type. + + Parameter_AssignSpecial\_\ *varName* any Mapping of a specific value of the simulation to an FMU input, assigned only once at FMU initialization: + + * ``varName`` references an FMI input variable. + * The parameter is always of type string. + * The value of this parameter has to be one of the types specified in the `Special simulation values`_ table below, + which will also determine the required type of the FMI variable. + + Input\_\ *varName* string Mapping of a specific value of the simulation to an FMU input: + + * ``varName`` references an FMI input variable. + * The value of this parameter has to be one of the types specified in the `Input simulation values`_ table below. + + Output\_\ *varName* string Mapping of a FMU output to a specific field in a specific signal: + + * ``varName`` references an FMI output variable. + * The value of this parameter has to be one of the types specified in the `Output simulation signals`_ table below. + ===================================== ======= ================================================================================================================== + +The allowed special simulation values are as follows: + +.. table:: + :class: tight-table + :name: Special simulation values + + ========================================= ================== ================================================================================================== + Type FMU Variable Type Calculation + ========================================= ================== ================================================================================================== + RandomSeed Integer The random seed of the current simulation run. + OutputPath String An output path unique to this FmuWrapper instance. + The path will always refer to a directory below the simulator's current result folder. + This directory is not necessarily created by the FmuWrapper, depending on the setting of + `CsvOutput` and `Logging` parameters (see `FmuWrapper basic configuration`_). + MaxSteering Real The `max_steering` property of an agent's front axle as defined in OpenSCENARIO (catalog). + SteeringRatio Real The steering ratio of the vehicle model. + Has to be defined in the properties of the Entity in the OpenSCENARIO catalog with the name + ``SteeringRatio`` and the value has to be a valid floating point expression. + NumberOfGears Integer The number of gears of the vehicle model. + Has to be defined in the properties of the Entity in the OpenSCENARIO catalog with the name + ``NumberOfGears`` and the value has to be a valid integer. + GearRatio\ *N* Real The ratio of the Nth gear. + Has to be defined in the properties of the Entity in the OpenSCENARIO catalog with the name + ``GearRatioN`` and the value has to be a valid floating point expression. + *N* is allowed to be in the range 1-9. + ========================================= ================== ================================================================================================== The allowed inputs (simulation values) are as follows: .. table:: :class: tight-table + :name: Input simulation values ========================================= ================== ================================================================================================== Type FMU Variable Type Calculation @@ -208,7 +251,7 @@ PositionXEgo Real X position of the reference point PositionYEgo Real Y position of the reference point YawEgo Real Yaw of the reference point - LaneEgo Integer Lane id of the MainLocatePoint on the route (0, if off route) + LaneEgo Integer Lane id of the front center on the route (0, if off route) PositionSEgo Real S position of the reference point on the route (0, if off route) PositionTEgo Real T position of the reference point on the route (0, if off route) ExistenceFront Boolean true, if there is a object in front on the own lane (any range), false otherwise @@ -229,17 +272,21 @@ RelativeDistanceFrontFront Real Net distance to second front object reference point (0, if no second front object) VelocityFrontFront Real Absolute velocity of second front object reference point (0, if no second front object) LaneFrontFront Integer Lane id of the reference point of second front object reference point (0, if no second front object) - LaneCountLeft Integer Number of lanes to the left of MainLocatePoint of type Driving, Exit, Entry, OnRamp or OffRamp - LaneCountRight Integer Number of lanes to the right of MainLocatePoint of type Driving, Exit, Entry, OnRamp or OffRamp - SpeedLimit\_\ *X* Real Speed limit in effect in distance *X* meters from MainLocatePoint (999, if no speed limit) - RoadCurvature\_\ *X* Real Road curvature in distance *X* meters from MainLocatePoint + LaneCountLeft Integer Number of lanes to the left of front center of type Driving, Exit, Entry, OnRamp or OffRamp + LaneCountRight Integer Number of lanes to the right of front center of type Driving, Exit, Entry, OnRamp or OffRamp + SpeedLimit\_\ *X* Real Speed limit in effect in distance *X* meters from front center (999, if no speed limit) + RoadCurvature\_\ *X* Real Road curvature in distance *X* meters from front center ========================================= ================== ================================================================================================== +* **reference point**: Center of the rear axle +* **front center**: Center of the front of the bounding box of the object If the FmuWrapper is linked to at least one sensor with InputId "Camera", the following additional inputs are available. The objects seen by this sensor(s) are sorted by distance from the agent and accessed by indices starting from 0. For each object the values listed in the following table are available where *X* is the index of the object (between 0 and 9). If there are less objects than *X*, a default value is set (-1 for the Id, 0 for the other values). +Only the list of objects is taken from the sensor. +The values are then calculated by the FmuWrapper (not from the SensorData). .. table:: :class: tight-table @@ -251,16 +298,18 @@ SensorFusionNumberOfDetectingSensors\_\ *X* Integer Number of sensors detecting the object SensorFusionRelativeS\_\ *X* Real Distance between reference points along route (NaN, if object not on route) SensorFusionRelativeNetS\_\ *X* Real Net distance along route (NaN, if object not on route) - SensorFusionRelativeT\_\ *X* Real Lateral obstruction for MainLocatePoint (NaN, if object not on route) (see :ref:`world_getobstruction`) + SensorFusionRelativeT\_\ *X* Real Lateral obstruction for front center (NaN, if object not on route) (see :ref:`world_getobstruction`) + SensorFusionRelativeX\_\ *X* Real Relative distance between reference points in x in world coordinates + SensorFusionRelativeY\_\ *X* Real Relative distance between reference points in y in world coordinates SensorFusionRelativeNetLeft\_\ *X* Real Lateral obstruction for leftmost point (NaN, if object not on route) SensorFusionRelativeNetRight\_\ *X* Real Lateral obstruction for rightmost point (NaN, if object not on route) - SensorFusionRelativeNetX\_\ *X* Real Net distance between bounding boxes in x - SensorFusionRelativeNetY\_\ *X* Real Net distance between bounding boxes in y - SensorFusionLane\_\ *X* Integer Lane of MainLocatePoint + SensorFusionRelativeNetX\_\ *X* Real Net distance between bounding boxes in x in world coordinates + SensorFusionRelativeNetY\_\ *X* Real Net distance between bounding boxes in y in world coordinates + SensorFusionLane\_\ *X* Integer Lane of front center SensorFusionVelocity\_\ *X* Real Absolute velocity at reference point - SensorFusionVelocityX\_\ *X* Real Velocity in x at reference point - SensorFusionVelocityY\_\ *X* Real Velocity in y at reference point - SensorFusionYaw\_\ *X* Real Yaw + SensorFusionVelocityX\_\ *X* Real Velocity in x at reference point in world coordinates + SensorFusionVelocityY\_\ *X* Real Velocity in y at reference point in world coordinates + SensorFusionYaw\_\ *X* Real Yaw in world coordinates ============================================ ================== ======================================================================================================== The FMU wrapper can output one or more of these signals: @@ -271,6 +320,7 @@ .. table:: :class: tight-table + :name: Output simulation signals ====================================== =================== ========================================= Type FMU Variable Type Enum Values @@ -318,7 +368,7 @@ ========================================================= ==================== =============================================================================================================================================== Init\_\ *var_name* string *var_name* references an FMU variable (as defined in FMU's modelDescription.xml) to which a specific OSI message is sent during initialization Allowed values: `GroundTruth` Input\_\ *var_name* string *var_name* references an FMU variable (as defined in FMU's modelDescription.xml) to which a specific OSI message is sent Allowed values: `SensorView`, `SensorViewConfig`, `SensorData`, `TrafficCommand` - Output\_\ *var_name* string *var_name* references an FMU variable (as defined in FMU's modelDescription.xml) from which a specific OSI message is received Allowed values: `SensorViewConfigRequest`, `SensorData`, `TrafficUpdate`, ``MotionCommand`` + Output\_\ *var_name* string *var_name* references an FMU variable (as defined in FMU's modelDescription.xml) from which a specific OSI message is received Allowed values: `SensorViewConfigRequest`, `SensorData`, `TrafficUpdate` Parameter\_\ *var_name* any The value of the parameter is assigned to the FMU variable *var_name* Parameter\_\ *transformation*\ [*mapping* ]\_\ *name* string/string/any\* Same as Parameter\_\ *name* but with an preceding *transformation* according to a *mapping*. |br| Currently, only mappings between the same types are supported. |br| \*;When using `TransformList` as *transformation*, the type of the data is expected to be a string and the string must be a comma separated list of values. |br| |br| Allowed values: |br| *transformation*: `Transform`, `TransformList` |br| *mapping*: `ScenarioName>Id` |br| |br| Example: `Parameter_TransformList[ScenarioName>Id]\_\ *name*` WriteJson\_\ *var_name* bool If true the osi message specified by *var_name* is written to a json file @@ -334,10 +384,8 @@ * SensorView: SensorView generated from the GroundTruth with this agent is host vehicle. * SensorViewConfig, SensorViewConfigRequest: Configuration of a sensor according to OSMP. * TrafficCommand: Trajectory from openSCENARIO, that will be converted into a TrafficCommand. -* VehicleCommunicationData: Contains host vehicle location data * SensorData: Output of a sensor. Can be input and/or output of an FMU. Received SensorData is forwarded to other components as SensorDataSignal. * TrafficUpdate: Will be converted to a DynamicsSignal. -* MotionCommand: Will be converted to a DynamicsSignal. Has priority over TrafficUpdate. * GroundTruth: Will be used as groundtruth information for everything that exists in the simulation world. **FmuVariables** @@ -442,7 +490,9 @@ DetectionRange Double m Detection range EnableVisualObstruction Bool Activates 2D sensor obstruction calculation FailureProbability Double Probability object is not detected although it is visible - Latency Double s Sensor latency + Latency Double s Delay the sensor output + DetectionDelayTime Double s Time an object needs to be in detection range before it is detected (optional) + MaxDropOutTime Double s Time after which delay for undetected object starts anew (optional) OpeningAngleH Double rad Horizontal opening angle RequiredPercentageOfVisibleArea Double Required percentage of an object within the sensor cone to trigger a detection =============================== ====== ==== ================================================================================================== @@ -469,7 +519,7 @@ ================== ====== ==== =========================================================================================== Parameter Type Unit Description ================== ====== ==== =========================================================================================== - FailureProbability Double Probability object is not detected although it is visible (mandatory, but currently unused) + FailureProbability Double Probability object is not detected although it is visible Latency Double s Sensor latency Sensitivity Double W/m² Sensitivity of the sensor ================== ====== ==== =========================================================================================== @@ -500,3 +550,209 @@ .. |br| raw:: html <br> + +VehicleDynamics +~~~~~~~~~~~~~~~ + +Components of this group can be used to model the vehicle dynamics. The vehicle dynamics model has a modular design. If necessary, the individual components can be replaced by the user with their own models. The vehicle dynamics model consists of six components listed below: + + +.. table:: + :class: tight-table + + ================================ ================================================================================================================================================================== + Component Short Description + ================================ ================================================================================================================================================================== + :ref:`components_steeringsystem` The steering model transfers the driver's input into the vehicle's wheel angle + :ref:`components_powertrain` The powertrain model converts the accelerator pedal position into wheel drive torques, under consideration of the selected gear + :ref:`components_brakesystem` The brake model converts the brake pedal position into wheel brake torques + :ref:`components_tiremodel` The tire model converts the predetermined drive and braking torques of the tires into tire longitudinal and lateral forces, under consideration of the wheel angles + :ref:`components_motionmodel` The motion model calculates the translational and rotational vehicle movement with the calculated tire forces + :ref:`components_chassismodel` The chassis model determines the dynamic wheel loads via the vehicle's longitudinal and lateral acceleration + ================================ ================================================================================================================================================================== + + +The following figure gives an overview of the driving dynamics components and their signals: + + +.. image:: _static/images/VehicleDynamicsOverview.svg + :alt: |op| Vehicle dynamics overview + + + +.. _components_steeringsystem: + +ActionSteeringSystem +^^^^^^^^^^^^^^^^^^^^ + +The steering model obtains the "SteeringRatio" property from the :ref:`scenario_vehiclemodels` and uses it to calculate the steering angle of the front wheels. +Both wheels are turned at the same angle. Steering elasticities are currently not taken into account. The following parameter can be used to set a static toe: + +.. table:: + :class: tight-table + + ========= ============ ==== ========================================================================================================================= + Attribute Type Unit Description + ========= ============ ==== ========================================================================================================================= + StaticToe VectorDouble rad Static toe of the wheels (A positive value corresponds to a toe-in; wheels are indexed from the front left in the vector) + ========= ============ ==== ========================================================================================================================= + +.. _components_powertrain: + +ActionPowertrain +^^^^^^^^^^^^^^^^ + +The powertrain model contains an engine model and a gear model. The type of the powertrain can be set using the following parameters: + +.. table:: + :class: tight-table + + ============== ====== ==== ============================================================================================================================= + Attribute Type Unit Description + ============== ====== ==== ============================================================================================================================= + TypeDrivetrain String - Type of drivetrain; A selection can be made between front-wheel drive (FWD), rear-wheel drive (RWD) and all-wheel drive (AWD) + FrontRatioAWD Double - Distribution of the drive torque to the front axle in the case of all-wheel drive (AWD); Range 0-1 + ============== ====== ==== ============================================================================================================================= + +The wheel speed is converted into an engine speed [Hz] according to the axle ratio and the transmission ratio of the selected gear. +The axle ratio and gear ratios are obtained from the :ref:`scenario_vehiclemodels` ("AxleRatio" & "GearRatio"). The average value of the powered wheels is used for the determination of the engine speed. + +.. math:: + \omega_{engine} = \omega_{wheels,avg} \cdot i_{axle} \cdot i_{gear,selected} + +The maximum possible engine torque [Nm] is limited by the engine power [W] or the maximum engine torque [Nm]. +The engine power and the maximum engine torque are obtained from the :ref:`scenario_vehiclemodels` ("MaximumEnginePower" & "MaximumEngineTorque"). + +.. math:: + M_{engine,max,current} = \begin{cases} + \frac{P_{engine,max}}{\omega_{engine}} & \text{ if } \frac{P_{engine,max}}{\omega_{engine}} < M_{engine,max} \\ + M_{engine,max} & \text{ if } \frac{P_{engine,max}}{\omega_{engine}} >= M_{engine,max} + \end{cases} + +When 98% of the maximum speed of the motor is reached ("MaximumEngineSpeed" in the :ref:`scenario_vehiclemodels`), the engine torque is linearly reduced to 0. + +The maximum engine torque is scaled via the accelerator pedal position (input). This value is calculated back to the total wheel drive torque via the gear ratio. + +.. math:: + M_{wheels,current} = M_{engine,max,current} \cdot position_{accelerator pedal} \cdot i_{axle} \cdot i_{gear,selected} + +The wheel total drive torque is evenly distributed to the wheels of an axle according to the definition of the drive type. +With all-wheel drive, the entire wheel drive torque is distributed statically over the defined ratio. + + +.. _components_brakesystem: + +ActionBrakeSystem +^^^^^^^^^^^^^^^^^ + +The brake model is a linearized model. The brake pedal position is used as input. As output, the model returns the braking torques of the wheels as a vector. +The model considers a response time [ms] and linear factors [m/s³] for the increase and decrease of the braking force.The distribution of braking force between the front and rear axles can be defined statically. + +.. table:: + :class: tight-table + + ============================ ====== ==== ============================================================================================================== + Attribute Type Unit Description + ============================ ====== ==== ============================================================================================================== + FrontAxlePercentage Double - Distribution of the brake torque to the front axle in the case of all-wheel drive (AWD); Range 0-1 + BrakeDecelerationInclineRate Double m/s³ Linear Rate of braking force increase + BrakeDecelerationDeclineRate Double m/s³ Linear Rate of braking force decrease + BrakeResponseTimeMs Double ms Brake response time + ============================ ====== ==== ============================================================================================================== + + +The maximum braking force of the system is determined from the maximum possible deceleration and the mass of the vehicle and is scaled by the brake pedal position (Input). +The maximum possible deceleration and the vehicle mass are obtained from the :ref:`scenario_vehiclemodels` ("maxDeceleration" & "mass"). + +.. math:: + F_{brake,max} = a_{deceleration,max} \cdot m_{vehicle} \cdot position_{brake pedal} + +When the brake is applied, a deceleration is calculated after the response time has elapsed. Then the braking force is built up linearly until the maximum or requested braking force has been reached. + +.. math:: + F_{brake,current} = rate_{incline} \cdot (t_{brake} - t_{response}) + +When the brake is released, the braking force is dissipated with the decline rate until it has dropped to zero. After that, the response time builds up again. +The braking force is divided among the axles according to the parameter "FrontAxlePercentage". Another input allows you to request a prefill that reduces the response time without braking + + +.. _components_chassismodel: + +DynamicsChassis +^^^^^^^^^^^^^^^ + +The chassis model determines the vertical forces of the four wheels from the longitudinal and lateral acceleration of the vehicle. Constant spring and damper rates are taken into account, which can be defined by the following parameters per axis: + +.. table:: + :class: tight-table + + ============================ ============ ==== ============================================================================================================== + Attribute Type Unit Description + ============================ ============ ==== ============================================================================================================== + SpringCoefficient VectorDouble N/m Constant spring coefficient for each axis + DamperCoefficient VectorDouble Ns/m Constant damper coefficient for each axis + ============================ ============ ==== ============================================================================================================== + +.. _components_tiremodel: + +DynamicsTireModel +^^^^^^^^^^^^^^^^^ + +The tire model is freely configurable and includes a degressive behaviour. The tire forces are modeled according to Rill using the TMEasy model. The following parameters can be set for the tire model per axis : + +.. table:: + :class: tight-table + + ==================== ============ ==== ============================================================================================================== + Attribute Type Unit Description + ==================== ============ ==== ============================================================================================================== + MuTireMaxXFRef VectorDouble - Normalized scaling factor for maximum longitudinal force at reference vertical force + MuTireMaxX2FRef VectorDouble - Normalized scaling factor for maximum longitudinal force at double reference vertical force + MuTireSlideXFRef VectorDouble - Normalized scaling factor for sliding longitudinal force at reference vertical force + MuTireSlideX2FRef VectorDouble - Normalized scaling factor for sliding longitudinal force at double reference vertical force + SlipTireMaxXFRef VectorDouble - Longitudinal slip at maximum longitudinal force at reference vertical force + SlipTireMaxX2FRef VectorDouble - Longitudinal slip at maximum longitudinal force at double reference vertical force + SlipTireSlideXFRef VectorDouble - Longitudinal slip at sliding longitudinal force at reference vertical force + SlipTireSlideX2FRef VectorDouble - Longitudinal slip at sliding longitudinal force at double reference vertical force + F0pXFRef VectorDouble N Initial slope of longitudinal force at reference force + F0pX2FRef VectorDouble N Initial slope of longitudinal force at double reference force + MuTireMaxYFRef VectorDouble - Normalized scaling factor for maximum lateral force at reference vertical force + MuTireMaxY2FRef VectorDouble - Normalized scaling factor for maximum lateral force at double reference vertical force + MuTireSlideYFRef VectorDouble - Normalized scaling factor for sliding lateral force at reference vertical force + MuTireSlideY2FRef VectorDouble - Normalized scaling factor for sliding lateral force at double reference vertical force + SlipTireMaxYFRef VectorDouble - Lateral slip at maximum lateral force at reference vertical force + SlipTireMaxY2FRef VectorDouble - Lateral slip at maximum lateral force at double reference vertical force + SlipTireSlideYFRef VectorDouble - Lateral slip at sliding lateral force at reference vertical force + SlipTireSlideY2FRef VectorDouble - Lateral slip at sliding lateral force at double reference vertical force + F0pYFRef VectorDouble N Initial slope of lateral force at reference force + F0pY2FRef VectorDouble N Initial slope of lateral force at double reference force + FRef VectorDouble N Vertical reference force for the tire parameters + FRefNormalized VectorBool - Should the reference force be scaled with the static vertical tire force? + Inertia VectorDouble kgm² Inertia of tire + PneumaticTrail VectorDouble m Pneumatic trail of tire + ==================== ============ ==== ============================================================================================================== + +The normalized factors refer to the reference vertical force or to the double reference vertical force +The input variables used by the model are tire drive and braking torques as well as the wheel angles and vertical wheel forces. All data is provided as vectors. +The model determines tire forces in the longitudinal and lateral directions as well as the wheel self aligning torques. The wheel self aligning torque is formed from the product of the tire side force and the pneumatic trail. +A linear interpolation is performed between the values for the reference force and the double reference force. If no degressive tire behavior is desired, the parameters for the double reference force must be set identically to the values for the reference force. + +All forces are scaled with the coefficient of friction from the :ref:`scenario_vehiclemodels` ("FrictionCoefficient"). + +All further information about the model can be found in the following sources: + +https://www.tmeasy.de/ + +Rill, Georg. (2013). TMeasy -- A Handling Tire Model based on a three-dimensional slip approach. + + +.. _components_motionmodel: + +DynamicsMotionModel +^^^^^^^^^^^^^^^^^^^ +The motion model converts the tire forces (input) into a translational and rotational movement of the vehicle. The air resistance of the vehicle is taken into account. For the dynamic calculation, the center of gravity position is taken from the :ref:`scenario_vehiclemodels` ("XPositionCOG","YPositionCOG"), +which indicates the distance of the center of gravity to the center of the rear axle. If this data is not given, the center of gravity is positioned on half wheelbase. For air resistance, the properties "AirDragCoefficient" & "FrontSurface" from the :ref:`scenario_vehiclemodels` are used. + +For the equations of motion, see relevant vehicle dynamics books such as: + +Kücükay, Ferit (2022), "Grundlagen der Fahrzeugtechnik", page 1067 ff
diff --git a/content/html/_sources/user_guide/tutorials/10_scenario_simulation.rst.txt b/content/html/_sources/user_guide/tutorials/10_scenario_simulation.rst.txt index 12a73b3..af5dcfe 100644 --- a/content/html/_sources/user_guide/tutorials/10_scenario_simulation.rst.txt +++ b/content/html/_sources/user_guide/tutorials/10_scenario_simulation.rst.txt
@@ -1,7 +1,8 @@ .. ******************************************************************************* - Copyright (c) 2021 Bayerische Motoren Werke Aktiengesellschaft (BMW AG) - 2021 in-tech GmbH + Copyright (c) 2021-2023 Bayerische Motoren Werke Aktiengesellschaft (BMW AG) + 2021 in-tech GmbH + 2023 Mercedes-Benz Tech Innovation GmbH This program and the accompanying materials are made available under the terms of the Eclipse Public License 2.0 which is available at @@ -23,19 +24,20 @@ The scenario agent performs a cut-in and triggers as a result the AEB system of the ego agent. To force this exact maneuver, the scenario agent is set up to follow a predefined trajectory. +.. TODO:: Update this paragraph for the new react GUI. + The GUI is not yet capable of configuring and executing a scenario based simulation as this is currently work in progress. Thus, an existing simulation configuration is used and the simulation is started manually. **Step-by-step instructions** -#. Navigate into the |op| install directory (e.g. ``C:\OpenPASS``) +#. Navigate into the |op| install directory (e.g. ``C:\openPASS\bin\core``) #. The install directory should look like the following :: - OpenPASS-Install-Dir - ├── bin + openPASS-Install-Dir └── configs <-- this directory will be created in the next step └── examples <-- if non existent, it can be copied from the openPASS checkout repository (see note) │ ├── Common @@ -48,13 +50,13 @@ .. note:: - The folder ``examples`` might not be existent right after the installation. In this case one can find it in the checkout repository of OpenPASS under ``sim/contrib``. From there one can copy it into the installation folder. + The folder ``examples`` might not be existent right after the installation. In this case one can find it in the checkout repository of openPASS under ``deps/os/sim/contrib``. From there one can copy it into the installation folder. #. Create a new folder named "configs" for the configuration files within the |op| install directory #. Copy configuration files - Simulations for |op| are fully configured through configuration files. This is where the user defines the traffic scenario to be simulated by OpenPASS. + Simulations for |op| are fully configured through configuration files. This is where the user defines the traffic scenario to be simulated by openPASS. Examples for |op| configuration files are located in the directory ``examples`` and are divided into two groups: *default configurations* and *specific configurations*. a. The *default configuration* files located under ``examples/Common`` contain the basis for any simulation. They represent the minimum input required, therefore:
diff --git a/content/html/_static/documentation_options.js b/content/html/_static/documentation_options.js index 186e2e1..52d532d 100644 --- a/content/html/_static/documentation_options.js +++ b/content/html/_static/documentation_options.js
@@ -1,6 +1,6 @@ var DOCUMENTATION_OPTIONS = { URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'), - VERSION: 'openPASS v0.11', + VERSION: '"develop_4d7f6d4f2e22c286789082dd8cbe3eb7f5b5af62"', LANGUAGE: 'None', COLLAPSE_INDEX: false, BUILDER: 'html',
diff --git a/content/html/_static/documentation_options.js.bak b/content/html/_static/documentation_options.js.bak deleted file mode 100644 index 6d251a0..0000000 --- a/content/html/_static/documentation_options.js.bak +++ /dev/null
@@ -1,12 +0,0 @@ -var DOCUMENTATION_OPTIONS = { - URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'), - VERSION: '"openPASS_0.11_15d807f087ee0c78ee3ab2be306f3f9f4030a4c0"', - LANGUAGE: 'None', - COLLAPSE_INDEX: false, - BUILDER: 'html', - FILE_SUFFIX: '.html', - LINK_SUFFIX: '.html', - HAS_SOURCE: true, - SOURCELINK_SUFFIX: '.txt', - NAVIGATION_WITH_KEYS: false -}; \ No newline at end of file
diff --git a/content/html/advanced_topics/20_simulator_advanced.html b/content/html/advanced_topics/20_simulator_advanced.html index 20205c7..7d8645f 100644 --- a/content/html/advanced_topics/20_simulator_advanced.html +++ b/content/html/advanced_topics/20_simulator_advanced.html
@@ -7,7 +7,7 @@ <meta name="viewport" content="width=device-width, initial-scale=1.0" /> - <title>Simulator — OpenPASS Documentation</title> + <title>Simulator — openPASS Documentation</title> @@ -70,7 +70,7 @@ <div class="version"> - "openPASS v0.11" + "develop_4d7f6d4f2e22c286789082dd8cbe3eb7f5b5af62" </div> @@ -100,7 +100,7 @@ <li class="toctree-l1"><a class="reference internal" href="../installation_guide/10_getting_started.html">Getting Started</a></li> <li class="toctree-l1"><a class="reference internal" href="../installation_guide/15_system_requirements.html">System Requirements</a></li> <li class="toctree-l1"><a class="reference internal" href="../installation_guide/20_install_prerequisites.html">Installing Prerequisites</a></li> -<li class="toctree-l1"><a class="reference internal" href="../installation_guide/30_install_openpass.html">Installing OpenPASS</a></li> +<li class="toctree-l1"><a class="reference internal" href="../installation_guide/30_install_openpass.html">Installing openPASS</a></li> <li class="toctree-l1"><a class="reference internal" href="../installation_guide/50_further_guidance.html">Further Guidance</a></li> <li class="toctree-l1"><a class="reference internal" href="../installation_guide/60_conan.html">Building with Conan</a></li> </ul> @@ -108,10 +108,9 @@ <ul> <li class="toctree-l1"><a class="reference internal" href="../user_guide/10_overview.html">Overview</a></li> <li class="toctree-l1"><a class="reference internal" href="../user_guide/20_tutorials.html">Tutorials</a></li> -<li class="toctree-l1"><a class="reference internal" href="../user_guide/30_gui_plugins.html">GUI Plugins</a></li> -<li class="toctree-l1"><a class="reference internal" href="../user_guide/40_configs_in_depth.html">Configs in Depth</a></li> -<li class="toctree-l1"><a class="reference internal" href="../user_guide/50_outputs_in_depth.html">Outputs in Depth</a></li> -<li class="toctree-l1"><a class="reference internal" href="../user_guide/60_scenario_simulation.html">Simulator</a></li> +<li class="toctree-l1"><a class="reference internal" href="../user_guide/30_configs_in_depth.html">Configs in Depth</a></li> +<li class="toctree-l1"><a class="reference internal" href="../user_guide/40_outputs_in_depth.html">Outputs in Depth</a></li> +<li class="toctree-l1"><a class="reference internal" href="../user_guide/50_scenario_simulation.html">Simulator</a></li> </ul> <p class="caption"><span class="caption-text">Advanced topics</span></p> <ul class="current"> @@ -119,6 +118,7 @@ <li class="toctree-l2"><a class="reference internal" href="simulator/agent_components.html">Agent Components</a></li> <li class="toctree-l2"><a class="reference internal" href="simulator/coordinate_systems.html">Coordinate Systems</a></li> <li class="toctree-l2"><a class="reference internal" href="simulator/event_detector.html">EventDetector</a></li> +<li class="toctree-l2"><a class="reference internal" href="simulator/scenario_actions.html">Mapping of OpenSCENARIO Actions</a></li> <li class="toctree-l2"><a class="reference internal" href="simulator/simulation.html">Simulation</a></li> <li class="toctree-l2"><a class="reference internal" href="simulator/spawner_features.html">Spawner Features</a></li> <li class="toctree-l2"><a class="reference internal" href="simulator/world_osi.html">World_OSI</a></li> @@ -130,12 +130,14 @@ <ul> <li class="toctree-l1"><a class="reference internal" href="../developer_information/10_ide_support.html">IDE Support</a></li> <li class="toctree-l1"><a class="reference internal" href="../developer_information/20_documentation.html">Documentation Concept</a></li> +<li class="toctree-l1"><a class="reference internal" href="../developer_information/30_coding_conventions.html">Coding Guidelines</a></li> </ul> <p class="caption"><span class="caption-text">Other Information</span></p> <ul> <li class="toctree-l1"><a class="reference internal" href="../other_information/10_external_dependencies.html">External Dependencies</a></li> <li class="toctree-l1"><a class="reference internal" href="../other_information/20_glossary.html">Glossary</a></li> -<li class="toctree-l1"><a class="reference internal" href="../other_information/30_license.html">License</a></li> +<li class="toctree-l1"><a class="reference internal" href="../other_information/30_gui_plugins.html">GUI Plugins</a></li> +<li class="toctree-l1"><a class="reference internal" href="../other_information/40_license.html">License</a></li> </ul> @@ -215,6 +217,7 @@ <li class="toctree-l2"><a class="reference internal" href="simulator/agent_components.html#algorithm-longitudinal">Algorithm_Longitudinal</a></li> <li class="toctree-l2"><a class="reference internal" href="simulator/agent_components.html#algorithmcar2xsender">AlgorithmCar2XSender</a></li> <li class="toctree-l2"><a class="reference internal" href="simulator/agent_components.html#dynamics-collision">Dynamics_Collision</a></li> +<li class="toctree-l2"><a class="reference internal" href="simulator/agent_components.html#dynamics-scenario">Dynamics_Scenario</a></li> <li class="toctree-l2"><a class="reference internal" href="simulator/agent_components.html#dynamics-regulardriving">Dynamics_RegularDriving</a></li> <li class="toctree-l2"><a class="reference internal" href="simulator/agent_components.html#limiteraccelerationvehiclecomponents">LimiterAccelerationVehicleComponents</a></li> <li class="toctree-l2"><a class="reference internal" href="simulator/agent_components.html#openscenarioactions">OpenScenarioActions</a></li> @@ -253,6 +256,20 @@ <li class="toctree-l2"><a class="reference internal" href="simulator/event_detector.html#collisiondetector">CollisionDetector</a></li> </ul> </li> +<li class="toctree-l1"><a class="reference internal" href="simulator/scenario_actions.html">Mapping of OpenSCENARIO Actions</a><ul> +<li class="toctree-l2"><a class="reference internal" href="simulator/scenario_actions.html#acquirepositionaction">AcquirePositionAction</a></li> +<li class="toctree-l2"><a class="reference internal" href="simulator/scenario_actions.html#assignrouteaction">AssignRouteAction</a></li> +<li class="toctree-l2"><a class="reference internal" href="simulator/scenario_actions.html#customcommandaction">CustomCommandAction</a></li> +<li class="toctree-l2"><a class="reference internal" href="simulator/scenario_actions.html#followtrajectoryaction">FollowTrajectoryAction</a></li> +<li class="toctree-l2"><a class="reference internal" href="simulator/scenario_actions.html#lanechangeaction">LaneChangeAction</a></li> +<li class="toctree-l2"><a class="reference internal" href="simulator/scenario_actions.html#speedaction">SpeedAction</a></li> +<li class="toctree-l2"><a class="reference internal" href="simulator/scenario_actions.html#teleportaction">TeleportAction</a></li> +<li class="toctree-l2"><a class="reference internal" href="simulator/scenario_actions.html#trafficsignalaction">TrafficSignalAction</a></li> +<li class="toctree-l2"><a class="reference internal" href="simulator/scenario_actions.html#trafficsignalstateaction">TrafficSignalStateAction</a></li> +<li class="toctree-l2"><a class="reference internal" href="simulator/scenario_actions.html#trafficsinkaction">TrafficSinkAction</a></li> +<li class="toctree-l2"><a class="reference internal" href="simulator/scenario_actions.html#visibilityaction">VisibilityAction</a></li> +</ul> +</li> <li class="toctree-l1"><a class="reference internal" href="simulator/simulation.html">Simulation</a><ul> <li class="toctree-l2"><a class="reference internal" href="simulator/simulation.html#command-line-arguments">Command Line Arguments</a></li> <li class="toctree-l2"><a class="reference internal" href="simulator/simulation.html#scheduler">Scheduler</a><ul> @@ -308,7 +325,7 @@ <div role="contentinfo"> <p> - © Copyright 2023 OpenPASS Working Group. + © Copyright 2023 openPASS Working Group. </p> </div>
diff --git a/content/html/advanced_topics/30_testing.html b/content/html/advanced_topics/30_testing.html index 20cdf07..31e32c5 100644 --- a/content/html/advanced_topics/30_testing.html +++ b/content/html/advanced_topics/30_testing.html
@@ -7,7 +7,7 @@ <meta name="viewport" content="width=device-width, initial-scale=1.0" /> - <title>EndToEnd Test Framework — OpenPASS Documentation</title> + <title>EndToEnd Test Framework — openPASS Documentation</title> @@ -70,7 +70,7 @@ <div class="version"> - "openPASS v0.11" + "develop_4d7f6d4f2e22c286789082dd8cbe3eb7f5b5af62" </div> @@ -100,7 +100,7 @@ <li class="toctree-l1"><a class="reference internal" href="../installation_guide/10_getting_started.html">Getting Started</a></li> <li class="toctree-l1"><a class="reference internal" href="../installation_guide/15_system_requirements.html">System Requirements</a></li> <li class="toctree-l1"><a class="reference internal" href="../installation_guide/20_install_prerequisites.html">Installing Prerequisites</a></li> -<li class="toctree-l1"><a class="reference internal" href="../installation_guide/30_install_openpass.html">Installing OpenPASS</a></li> +<li class="toctree-l1"><a class="reference internal" href="../installation_guide/30_install_openpass.html">Installing openPASS</a></li> <li class="toctree-l1"><a class="reference internal" href="../installation_guide/50_further_guidance.html">Further Guidance</a></li> <li class="toctree-l1"><a class="reference internal" href="../installation_guide/60_conan.html">Building with Conan</a></li> </ul> @@ -108,10 +108,9 @@ <ul> <li class="toctree-l1"><a class="reference internal" href="../user_guide/10_overview.html">Overview</a></li> <li class="toctree-l1"><a class="reference internal" href="../user_guide/20_tutorials.html">Tutorials</a></li> -<li class="toctree-l1"><a class="reference internal" href="../user_guide/30_gui_plugins.html">GUI Plugins</a></li> -<li class="toctree-l1"><a class="reference internal" href="../user_guide/40_configs_in_depth.html">Configs in Depth</a></li> -<li class="toctree-l1"><a class="reference internal" href="../user_guide/50_outputs_in_depth.html">Outputs in Depth</a></li> -<li class="toctree-l1"><a class="reference internal" href="../user_guide/60_scenario_simulation.html">Simulator</a></li> +<li class="toctree-l1"><a class="reference internal" href="../user_guide/30_configs_in_depth.html">Configs in Depth</a></li> +<li class="toctree-l1"><a class="reference internal" href="../user_guide/40_outputs_in_depth.html">Outputs in Depth</a></li> +<li class="toctree-l1"><a class="reference internal" href="../user_guide/50_scenario_simulation.html">Simulator</a></li> </ul> <p class="caption"><span class="caption-text">Advanced topics</span></p> <ul class="current"> @@ -141,12 +140,14 @@ <ul> <li class="toctree-l1"><a class="reference internal" href="../developer_information/10_ide_support.html">IDE Support</a></li> <li class="toctree-l1"><a class="reference internal" href="../developer_information/20_documentation.html">Documentation Concept</a></li> +<li class="toctree-l1"><a class="reference internal" href="../developer_information/30_coding_conventions.html">Coding Guidelines</a></li> </ul> <p class="caption"><span class="caption-text">Other Information</span></p> <ul> <li class="toctree-l1"><a class="reference internal" href="../other_information/10_external_dependencies.html">External Dependencies</a></li> <li class="toctree-l1"><a class="reference internal" href="../other_information/20_glossary.html">Glossary</a></li> -<li class="toctree-l1"><a class="reference internal" href="../other_information/30_license.html">License</a></li> +<li class="toctree-l1"><a class="reference internal" href="../other_information/30_gui_plugins.html">GUI Plugins</a></li> +<li class="toctree-l1"><a class="reference internal" href="../other_information/40_license.html">License</a></li> </ul> @@ -224,7 +225,7 @@ <p>The test framework is based on Python and some additional Python modules. Installation of the required modules can be accomplished using <code class="docutils literal notranslate"><span class="pre">pip</span></code>. Please refer to the file <code class="docutils literal notranslate"><span class="pre">requirements.txt</span></code> located in the source code repository at <code class="docutils literal notranslate"><span class="pre">sim/tests/endToEndTests/pyOpenPASS</span></code> for a list of dependencies. -See <a class="reference internal" href="../installation_guide/30_install_openpass.html#download-and-install-openpass"><span class="std std-ref">Installing OpenPASS</span></a> for instructions on repository checkout.</p> +See <a class="reference internal" href="../installation_guide/30_install_openpass.html#download-and-install-openpass"><span class="std std-ref">Installing openPASS</span></a> for instructions on repository checkout.</p> <p>The requirements file can be directly passed to <code class="docutils literal notranslate"><span class="pre">pip</span></code> for installation:</p> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">pip</span> <span class="n">install</span> <span class="o">-</span><span class="n">r</span> <span class="n">requirements</span><span class="o">.</span><span class="n">txt</span> </pre></div> @@ -237,7 +238,7 @@ If it is unable to locate a binary package for the current environment, packages will be compiled from source. This step fails for the <code class="docutils literal notranslate"><span class="pre">numpy</span></code> package when being built from the MSYS2 environment. Thus, it is recommended to set up a native Windows Python environment and perform the installation there. -To force the usage of a specific Python environment, the variable <code class="docutils literal notranslate"><span class="pre">Python3_EXECUTABLE</span></code> can be set to the indended Python interpreter executable during cmake configuration (see <a class="reference internal" href="../installation_guide/30_install_openpass.html#download-and-install-openpass"><span class="std std-ref">Installing OpenPASS</span></a>).</p> +To force the usage of a specific Python environment, the variable <code class="docutils literal notranslate"><span class="pre">Python3_EXECUTABLE</span></code> can be set to the indended Python interpreter executable during cmake configuration (see <a class="reference internal" href="../installation_guide/30_install_openpass.html#download-and-install-openpass"><span class="std std-ref">Installing openPASS</span></a>).</p> </div> </div> <div class="section" id="execution"> @@ -263,6 +264,15 @@ </pre></div> </div> <p>For each specified <code class="docutils literal notranslate"><span class="pre">test_*.json</span></code> a corresponding <code class="docutils literal notranslate"><span class="pre">test_*.html</span></code> will be generated.</p> +<div class="admonition warning"> +<p class="admonition-title">Warning</p> +<p><img alt="win_only" src="../_images/win_only.png" /> +Depending on the names of the config file sets and test cases configured in the JSON file, the resulting collection of artifacts might conflict with a specific path length limit. +This limit can be increased by setting the Windows Registry key variable <code class="docutils literal notranslate"><span class="pre">LongPathsEnabled</span></code> to 1. +The variable can be accessed at <code class="docutils literal notranslate"><span class="pre">Computer\HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Control\FileSystem\LongPathsEnabled</span></code>. +Please note that the limit cannot be disabled completely. +Resulting error messages are often misleading (e.g. <code class="docutils literal notranslate"><span class="pre">File</span> <span class="pre">not</span> <span class="pre">found</span></code> where the file actually exists or <code class="docutils literal notranslate"><span class="pre">shutil.py</span> <span class="pre">2</span></code>, etc.).</p> +</div> </div> <div class="section" id="test-configuration"> <h2>Test Configuration<a class="headerlink" href="#test-configuration" title="Permalink to this headline">¶</a></h2> @@ -537,10 +547,10 @@ <span class="nt">"type"</span><span class="p">:</span> <span class="s2">"python"</span><span class="p">,</span> <span class="nt">"module"</span><span class="p">:</span> <span class="s2">"pytest"</span><span class="p">,</span> <span class="nt">"args"</span><span class="p">:</span> <span class="p">[</span> - <span class="s2">"--simulation=/OpenPASS/bin/core/opSimulation"</span><span class="p">,</span> - <span class="s2">"--mutual=/OpenPASS/bin/core/examples/OSS/Common/"</span><span class="p">,</span> - <span class="s2">"--resources=/OpenPASS/bin/core/examples/OSS/Configurations/"</span><span class="p">,</span> - <span class="s2">"--report-path=/OpenPASS/reports"</span><span class="p">,</span> + <span class="s2">"--simulation=/openPASS/bin/core/opSimulation"</span><span class="p">,</span> + <span class="s2">"--mutual=/openPASS/bin/core/examples/OSS/Common/"</span><span class="p">,</span> + <span class="s2">"--resources=/openPASS/bin/core/examples/OSS/Configurations/"</span><span class="p">,</span> + <span class="s2">"--report-path=/openPASS/reports"</span><span class="p">,</span> <span class="s2">"test_end_to_end.json"</span><span class="p">,</span> <span class="s2">"-v"</span><span class="p">],</span> <span class="nt">"request"</span><span class="p">:</span> <span class="s2">"launch"</span><span class="p">,</span> @@ -565,7 +575,7 @@ <div role="contentinfo"> <p> - © Copyright 2023 OpenPASS Working Group. + © Copyright 2023 openPASS Working Group. </p> </div>
diff --git a/content/html/advanced_topics/simulator/agent_components.html b/content/html/advanced_topics/simulator/agent_components.html index 5066bbf..3b65eaa 100644 --- a/content/html/advanced_topics/simulator/agent_components.html +++ b/content/html/advanced_topics/simulator/agent_components.html
@@ -7,7 +7,7 @@ <meta name="viewport" content="width=device-width, initial-scale=1.0" /> - <title>Agent Components — OpenPASS Documentation</title> + <title>Agent Components — openPASS Documentation</title> @@ -70,7 +70,7 @@ <div class="version"> - "openPASS v0.11" + "develop_4d7f6d4f2e22c286789082dd8cbe3eb7f5b5af62" </div> @@ -100,7 +100,7 @@ <li class="toctree-l1"><a class="reference internal" href="../../installation_guide/10_getting_started.html">Getting Started</a></li> <li class="toctree-l1"><a class="reference internal" href="../../installation_guide/15_system_requirements.html">System Requirements</a></li> <li class="toctree-l1"><a class="reference internal" href="../../installation_guide/20_install_prerequisites.html">Installing Prerequisites</a></li> -<li class="toctree-l1"><a class="reference internal" href="../../installation_guide/30_install_openpass.html">Installing OpenPASS</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../installation_guide/30_install_openpass.html">Installing openPASS</a></li> <li class="toctree-l1"><a class="reference internal" href="../../installation_guide/50_further_guidance.html">Further Guidance</a></li> <li class="toctree-l1"><a class="reference internal" href="../../installation_guide/60_conan.html">Building with Conan</a></li> </ul> @@ -108,10 +108,9 @@ <ul> <li class="toctree-l1"><a class="reference internal" href="../../user_guide/10_overview.html">Overview</a></li> <li class="toctree-l1"><a class="reference internal" href="../../user_guide/20_tutorials.html">Tutorials</a></li> -<li class="toctree-l1"><a class="reference internal" href="../../user_guide/30_gui_plugins.html">GUI Plugins</a></li> -<li class="toctree-l1"><a class="reference internal" href="../../user_guide/40_configs_in_depth.html">Configs in Depth</a></li> -<li class="toctree-l1"><a class="reference internal" href="../../user_guide/50_outputs_in_depth.html">Outputs in Depth</a></li> -<li class="toctree-l1"><a class="reference internal" href="../../user_guide/60_scenario_simulation.html">Simulator</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../user_guide/30_configs_in_depth.html">Configs in Depth</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../user_guide/40_outputs_in_depth.html">Outputs in Depth</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../user_guide/50_scenario_simulation.html">Simulator</a></li> </ul> <p class="caption"><span class="caption-text">Advanced topics</span></p> <ul class="current"> @@ -124,6 +123,7 @@ <li class="toctree-l3"><a class="reference internal" href="#algorithm-longitudinal">Algorithm_Longitudinal</a></li> <li class="toctree-l3"><a class="reference internal" href="#algorithmcar2xsender">AlgorithmCar2XSender</a></li> <li class="toctree-l3"><a class="reference internal" href="#dynamics-collision">Dynamics_Collision</a></li> +<li class="toctree-l3"><a class="reference internal" href="#dynamics-scenario">Dynamics_Scenario</a></li> <li class="toctree-l3"><a class="reference internal" href="#dynamics-regulardriving">Dynamics_RegularDriving</a></li> <li class="toctree-l3"><a class="reference internal" href="#limiteraccelerationvehiclecomponents">LimiterAccelerationVehicleComponents</a></li> <li class="toctree-l3"><a class="reference internal" href="#openscenarioactions">OpenScenarioActions</a></li> @@ -148,6 +148,7 @@ </li> <li class="toctree-l2"><a class="reference internal" href="coordinate_systems.html">Coordinate Systems</a></li> <li class="toctree-l2"><a class="reference internal" href="event_detector.html">EventDetector</a></li> +<li class="toctree-l2"><a class="reference internal" href="scenario_actions.html">Mapping of OpenSCENARIO Actions</a></li> <li class="toctree-l2"><a class="reference internal" href="simulation.html">Simulation</a></li> <li class="toctree-l2"><a class="reference internal" href="spawner_features.html">Spawner Features</a></li> <li class="toctree-l2"><a class="reference internal" href="world_osi.html">World_OSI</a></li> @@ -159,12 +160,14 @@ <ul> <li class="toctree-l1"><a class="reference internal" href="../../developer_information/10_ide_support.html">IDE Support</a></li> <li class="toctree-l1"><a class="reference internal" href="../../developer_information/20_documentation.html">Documentation Concept</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../developer_information/30_coding_conventions.html">Coding Guidelines</a></li> </ul> <p class="caption"><span class="caption-text">Other Information</span></p> <ul> <li class="toctree-l1"><a class="reference internal" href="../../other_information/10_external_dependencies.html">External Dependencies</a></li> <li class="toctree-l1"><a class="reference internal" href="../../other_information/20_glossary.html">Glossary</a></li> -<li class="toctree-l1"><a class="reference internal" href="../../other_information/30_license.html">License</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../other_information/30_gui_plugins.html">GUI Plugins</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../other_information/40_license.html">License</a></li> </ul> @@ -331,6 +334,10 @@ Currently the collision is implemented fully inelastic, i.e. all agents will have the same velocity after the collision, while the momentum is conserved. After the collision the agents slow down with a fixed deceleration until fully stopped.</p> </div> +<div class="section" id="dynamics-scenario"> +<h2>Dynamics_Scenario<a class="headerlink" href="#dynamics-scenario" title="Permalink to this headline">¶</a></h2> +<p>See <a class="reference internal" href="../../user_guide/sim_user_guide/components/dynamics_scenario.html#dynamics-scenario"><span class="std std-ref">Dynamics_Scenario</span></a>.</p> +</div> <div class="section" id="dynamics-regulardriving"> <h2>Dynamics_RegularDriving<a class="headerlink" href="#dynamics-regulardriving" title="Permalink to this headline">¶</a></h2> <p>The module takes care that the motion of the agent fit to the physical limitations, such as friction or maximum possible acceleration based on the current gear. @@ -833,7 +840,7 @@ <div role="contentinfo"> <p> - © Copyright 2023 OpenPASS Working Group. + © Copyright 2023 openPASS Working Group. </p> </div>
diff --git a/content/html/advanced_topics/simulator/coordinate_systems.html b/content/html/advanced_topics/simulator/coordinate_systems.html index b116a46..01eea48 100644 --- a/content/html/advanced_topics/simulator/coordinate_systems.html +++ b/content/html/advanced_topics/simulator/coordinate_systems.html
@@ -7,7 +7,7 @@ <meta name="viewport" content="width=device-width, initial-scale=1.0" /> - <title>Coordinate Systems — OpenPASS Documentation</title> + <title>Coordinate Systems — openPASS Documentation</title> @@ -70,7 +70,7 @@ <div class="version"> - "openPASS v0.11" + "develop_4d7f6d4f2e22c286789082dd8cbe3eb7f5b5af62" </div> @@ -100,7 +100,7 @@ <li class="toctree-l1"><a class="reference internal" href="../../installation_guide/10_getting_started.html">Getting Started</a></li> <li class="toctree-l1"><a class="reference internal" href="../../installation_guide/15_system_requirements.html">System Requirements</a></li> <li class="toctree-l1"><a class="reference internal" href="../../installation_guide/20_install_prerequisites.html">Installing Prerequisites</a></li> -<li class="toctree-l1"><a class="reference internal" href="../../installation_guide/30_install_openpass.html">Installing OpenPASS</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../installation_guide/30_install_openpass.html">Installing openPASS</a></li> <li class="toctree-l1"><a class="reference internal" href="../../installation_guide/50_further_guidance.html">Further Guidance</a></li> <li class="toctree-l1"><a class="reference internal" href="../../installation_guide/60_conan.html">Building with Conan</a></li> </ul> @@ -108,10 +108,9 @@ <ul> <li class="toctree-l1"><a class="reference internal" href="../../user_guide/10_overview.html">Overview</a></li> <li class="toctree-l1"><a class="reference internal" href="../../user_guide/20_tutorials.html">Tutorials</a></li> -<li class="toctree-l1"><a class="reference internal" href="../../user_guide/30_gui_plugins.html">GUI Plugins</a></li> -<li class="toctree-l1"><a class="reference internal" href="../../user_guide/40_configs_in_depth.html">Configs in Depth</a></li> -<li class="toctree-l1"><a class="reference internal" href="../../user_guide/50_outputs_in_depth.html">Outputs in Depth</a></li> -<li class="toctree-l1"><a class="reference internal" href="../../user_guide/60_scenario_simulation.html">Simulator</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../user_guide/30_configs_in_depth.html">Configs in Depth</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../user_guide/40_outputs_in_depth.html">Outputs in Depth</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../user_guide/50_scenario_simulation.html">Simulator</a></li> </ul> <p class="caption"><span class="caption-text">Advanced topics</span></p> <ul class="current"> @@ -130,6 +129,7 @@ </ul> </li> <li class="toctree-l2"><a class="reference internal" href="event_detector.html">EventDetector</a></li> +<li class="toctree-l2"><a class="reference internal" href="scenario_actions.html">Mapping of OpenSCENARIO Actions</a></li> <li class="toctree-l2"><a class="reference internal" href="simulation.html">Simulation</a></li> <li class="toctree-l2"><a class="reference internal" href="spawner_features.html">Spawner Features</a></li> <li class="toctree-l2"><a class="reference internal" href="world_osi.html">World_OSI</a></li> @@ -141,12 +141,14 @@ <ul> <li class="toctree-l1"><a class="reference internal" href="../../developer_information/10_ide_support.html">IDE Support</a></li> <li class="toctree-l1"><a class="reference internal" href="../../developer_information/20_documentation.html">Documentation Concept</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../developer_information/30_coding_conventions.html">Coding Guidelines</a></li> </ul> <p class="caption"><span class="caption-text">Other Information</span></p> <ul> <li class="toctree-l1"><a class="reference internal" href="../../other_information/10_external_dependencies.html">External Dependencies</a></li> <li class="toctree-l1"><a class="reference internal" href="../../other_information/20_glossary.html">Glossary</a></li> -<li class="toctree-l1"><a class="reference internal" href="../../other_information/30_license.html">License</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../other_information/30_gui_plugins.html">GUI Plugins</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../other_information/40_license.html">License</a></li> </ul> @@ -322,7 +324,7 @@ <div role="contentinfo"> <p> - © Copyright 2023 OpenPASS Working Group. + © Copyright 2023 openPASS Working Group. </p> </div>
diff --git a/content/html/advanced_topics/simulator/event_detector.html b/content/html/advanced_topics/simulator/event_detector.html index 446d1b8..c4cf5e2 100644 --- a/content/html/advanced_topics/simulator/event_detector.html +++ b/content/html/advanced_topics/simulator/event_detector.html
@@ -7,7 +7,7 @@ <meta name="viewport" content="width=device-width, initial-scale=1.0" /> - <title>EventDetector — OpenPASS Documentation</title> + <title>EventDetector — openPASS Documentation</title> @@ -42,7 +42,7 @@ <link rel="index" title="Index" href="../../genindex.html" /> <link rel="search" title="Search" href="../../search.html" /> - <link rel="next" title="Simulation" href="simulation.html" /> + <link rel="next" title="Mapping of OpenSCENARIO Actions" href="scenario_actions.html" /> <link rel="prev" title="Coordinate Systems" href="coordinate_systems.html" /> </head> @@ -70,7 +70,7 @@ <div class="version"> - "openPASS v0.11" + "develop_4d7f6d4f2e22c286789082dd8cbe3eb7f5b5af62" </div> @@ -100,7 +100,7 @@ <li class="toctree-l1"><a class="reference internal" href="../../installation_guide/10_getting_started.html">Getting Started</a></li> <li class="toctree-l1"><a class="reference internal" href="../../installation_guide/15_system_requirements.html">System Requirements</a></li> <li class="toctree-l1"><a class="reference internal" href="../../installation_guide/20_install_prerequisites.html">Installing Prerequisites</a></li> -<li class="toctree-l1"><a class="reference internal" href="../../installation_guide/30_install_openpass.html">Installing OpenPASS</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../installation_guide/30_install_openpass.html">Installing openPASS</a></li> <li class="toctree-l1"><a class="reference internal" href="../../installation_guide/50_further_guidance.html">Further Guidance</a></li> <li class="toctree-l1"><a class="reference internal" href="../../installation_guide/60_conan.html">Building with Conan</a></li> </ul> @@ -108,10 +108,9 @@ <ul> <li class="toctree-l1"><a class="reference internal" href="../../user_guide/10_overview.html">Overview</a></li> <li class="toctree-l1"><a class="reference internal" href="../../user_guide/20_tutorials.html">Tutorials</a></li> -<li class="toctree-l1"><a class="reference internal" href="../../user_guide/30_gui_plugins.html">GUI Plugins</a></li> -<li class="toctree-l1"><a class="reference internal" href="../../user_guide/40_configs_in_depth.html">Configs in Depth</a></li> -<li class="toctree-l1"><a class="reference internal" href="../../user_guide/50_outputs_in_depth.html">Outputs in Depth</a></li> -<li class="toctree-l1"><a class="reference internal" href="../../user_guide/60_scenario_simulation.html">Simulator</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../user_guide/30_configs_in_depth.html">Configs in Depth</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../user_guide/40_outputs_in_depth.html">Outputs in Depth</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../user_guide/50_scenario_simulation.html">Simulator</a></li> </ul> <p class="caption"><span class="caption-text">Advanced topics</span></p> <ul class="current"> @@ -122,6 +121,7 @@ <li class="toctree-l3"><a class="reference internal" href="#collisiondetector">CollisionDetector</a></li> </ul> </li> +<li class="toctree-l2"><a class="reference internal" href="scenario_actions.html">Mapping of OpenSCENARIO Actions</a></li> <li class="toctree-l2"><a class="reference internal" href="simulation.html">Simulation</a></li> <li class="toctree-l2"><a class="reference internal" href="spawner_features.html">Spawner Features</a></li> <li class="toctree-l2"><a class="reference internal" href="world_osi.html">World_OSI</a></li> @@ -133,12 +133,14 @@ <ul> <li class="toctree-l1"><a class="reference internal" href="../../developer_information/10_ide_support.html">IDE Support</a></li> <li class="toctree-l1"><a class="reference internal" href="../../developer_information/20_documentation.html">Documentation Concept</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../developer_information/30_coding_conventions.html">Coding Guidelines</a></li> </ul> <p class="caption"><span class="caption-text">Other Information</span></p> <ul> <li class="toctree-l1"><a class="reference internal" href="../../other_information/10_external_dependencies.html">External Dependencies</a></li> <li class="toctree-l1"><a class="reference internal" href="../../other_information/20_glossary.html">Glossary</a></li> -<li class="toctree-l1"><a class="reference internal" href="../../other_information/30_license.html">License</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../other_information/30_gui_plugins.html">GUI Plugins</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../other_information/40_license.html">License</a></li> </ul> @@ -229,6 +231,83 @@ </div> <p>In case of a collision, a CollisionEvent containing the participating object Ids is created. This type of event is picked up by the CollisionManipulator, which updates the state of the collided objects accordingly.</p> +<p>The geometric parameters of the crash configuration in terms of collision angles are determined according to Wagstrom et. al. (<a class="reference external" href="https://www-esv.nhtsa.dot.gov/Proceedings/26/26ESV-000177.pdf">https://www-esv.nhtsa.dot.gov/Proceedings/26/26ESV-000177.pdf</a>). In addition, collision velocities are stored.</p> +<div class="figure align-default"> +<img alt="../../_images/crash_config.svg" src="../../_images/crash_config.svg" /></div> +<p>Furthermore, the CollisionDetector contains an impact evaluation which estimates based on momentum the changes in velocities due to the collision, considering vehicle mass ratio and initial crash configuration, e.h. <cite>VelocityChange</cite>. The impact model behind these calculations was developed and tested with full-overlap vehicle-to-vehicle collisions.</p> +<p>The concept was described in detail at ESAR 2016 in Kolk et. al. (<a class="reference external" href="https://bast.opus.hbz-nrw.de/opus45-bast/frontdoor/deliver/index/docId/1825/file/F117_21.pdf">https://bast.opus.hbz-nrw.de/opus45-bast/frontdoor/deliver/index/docId/1825/file/F117_21.pdf</a>).</p> +<p>The parameters stored for each collision are listed in detail in the table below.</p> +<table class="docutils align-default"> +<colgroup> +<col style="width: 29%" /> +<col style="width: 71%" /> +</colgroup> +<thead> +<tr class="row-odd"><th class="head"><p>Parameter</p></th> +<th class="head"><p>Description</p></th> +</tr> +</thead> +<tbody> +<tr class="row-even"><td><p>CollisionVelocity</p></td> +<td><p>velocity of host prior to the collision</p></td> +</tr> +<tr class="row-odd"><td><p>CollisionWithAgent</p></td> +<td><p>true (1) / false (0) if collision occured with another agent</p></td> +</tr> +<tr class="row-even"><td><p>HCPA</p></td> +<td><p>host collision point angle in degree</p></td> +</tr> +<tr class="row-odd"><td><p>HCPAo</p></td> +<td><p>normalized HCPA</p></td> +</tr> +<tr class="row-even"><td><p>OCPA</p></td> +<td><p>opponent collision point angle</p></td> +</tr> +<tr class="row-odd"><td><p>OCPAo</p></td> +<td><p>normalized OCPA</p></td> +</tr> +<tr class="row-even"><td><p>OYA</p></td> +<td><p>opponent yaw angle</p></td> +</tr> +<tr class="row-odd"><td><p>OpponentCollisionVelocity</p></td> +<td><p>velocity of opponent prior to the collision</p></td> +</tr> +<tr class="row-even"><td><p>OpponentPointOfContactLocalX</p></td> +<td><p>X-coordinate of opponent point of contact in local coordinate system</p></td> +</tr> +<tr class="row-odd"><td><p>OpponentPointOfContactLocalY</p></td> +<td><p>Y-coordinate of opponent point of contact in local coordinate system</p></td> +</tr> +<tr class="row-even"><td><p>OpponentVelocity</p></td> +<td><p>velocity of opponent after the collision</p></td> +</tr> +<tr class="row-odd"><td><p>OpponentVelocityChange</p></td> +<td><p>velocity change of opponent due to collision</p></td> +</tr> +<tr class="row-even"><td><p>OpponentVelocityDirection</p></td> +<td><p>velocity direction</p></td> +</tr> +<tr class="row-odd"><td><p>OpponentYawVelocity</p></td> +<td><p>opponent yaw velocity</p></td> +</tr> +<tr class="row-even"><td><p>PointOfContactLocalX</p></td> +<td><p>X-coordinate of point of contact in local coordinate system</p></td> +</tr> +<tr class="row-odd"><td><p>PointOfContactLocalY</p></td> +<td><p>Y-coordinate of opponent point of contact in local coordinate system</p></td> +</tr> +<tr class="row-even"><td><p>Velocity</p></td> +<td><p>velocity of host after the collision</p></td> +</tr> +<tr class="row-odd"><td><p>VelocityChange</p></td> +<td><p>velocity change of host due to collision</p></td> +</tr> +</tbody> +</table> +<div class="admonition note"> +<p class="admonition-title">Note</p> +<p>Both geometric interpretation and impact calculation only work for collisions between two car agents. A more general application is work in progress.</p> +</div> </div> </div> @@ -238,7 +317,7 @@ </div> <footer> <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> - <a href="simulation.html" class="btn btn-neutral float-right" title="Simulation" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a> + <a href="scenario_actions.html" class="btn btn-neutral float-right" title="Mapping of OpenSCENARIO Actions" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a> <a href="coordinate_systems.html" class="btn btn-neutral float-left" title="Coordinate Systems" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a> </div> @@ -246,7 +325,7 @@ <div role="contentinfo"> <p> - © Copyright 2023 OpenPASS Working Group. + © Copyright 2023 openPASS Working Group. </p> </div>
diff --git a/content/html/advanced_topics/simulator/scenario_actions.html b/content/html/advanced_topics/simulator/scenario_actions.html new file mode 100644 index 0000000..ff7beb5 --- /dev/null +++ b/content/html/advanced_topics/simulator/scenario_actions.html
@@ -0,0 +1,689 @@ + + +<!DOCTYPE html> +<html class="writer-html5" lang="en" > +<head> + <meta charset="utf-8" /> + + <meta name="viewport" content="width=device-width, initial-scale=1.0" /> + + <title>Mapping of OpenSCENARIO Actions — openPASS Documentation</title> + + + + <link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" /> + <link rel="stylesheet" href="../../_static/pygments.css" type="text/css" /> + <link rel="stylesheet" href="../../_static/tabs.css" type="text/css" /> + <link rel="stylesheet" href="../../_static/css/custom.css" type="text/css" /> + + + + <link rel="shortcut icon" href="../../_static/openPASS.ico"/> + + + + + + + + + <!--[if lt IE 9]> + <script src="../../_static/js/html5shiv.min.js"></script> + <![endif]--> + + + <script type="text/javascript" id="documentation_options" data-url_root="../../" src="../../_static/documentation_options.js"></script> + <script src="../../_static/jquery.js"></script> + <script src="../../_static/underscore.js"></script> + <script src="../../_static/doctools.js"></script> + + <script type="text/javascript" src="../../_static/js/theme.js"></script> + + + <link rel="index" title="Index" href="../../genindex.html" /> + <link rel="search" title="Search" href="../../search.html" /> + <link rel="next" title="Simulation" href="simulation.html" /> + <link rel="prev" title="EventDetector" href="event_detector.html" /> +</head> + +<body class="wy-body-for-nav"> + + + <div class="wy-grid-for-nav"> + + <nav data-toggle="wy-nav-shift" class="wy-nav-side"> + <div class="wy-side-scroll"> + <div class="wy-side-nav-search" > + + + + <a href="../../index.html" class="icon icon-home"> openPASS + + + + + <img src="../../_static/openPASS.png" class="logo" alt="Logo"/> + + </a> + + + + + <div class="version"> + "develop_4d7f6d4f2e22c286789082dd8cbe3eb7f5b5af62" + </div> + + + + +<div role="search"> + <form id="rtd-search-form" class="wy-form" action="../../search.html" method="get"> + <input type="text" name="q" placeholder="Search docs" /> + <input type="hidden" name="check_keywords" value="yes" /> + <input type="hidden" name="area" value="default" /> + </form> +</div> + + + </div> + + + <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation"> + + + + + + + <p class="caption"><span class="caption-text">Installation Guide</span></p> +<ul> +<li class="toctree-l1"><a class="reference internal" href="../../installation_guide/10_getting_started.html">Getting Started</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../installation_guide/15_system_requirements.html">System Requirements</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../installation_guide/20_install_prerequisites.html">Installing Prerequisites</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../installation_guide/30_install_openpass.html">Installing openPASS</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../installation_guide/50_further_guidance.html">Further Guidance</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../installation_guide/60_conan.html">Building with Conan</a></li> +</ul> +<p class="caption"><span class="caption-text">User Guides</span></p> +<ul> +<li class="toctree-l1"><a class="reference internal" href="../../user_guide/10_overview.html">Overview</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../user_guide/20_tutorials.html">Tutorials</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../user_guide/30_configs_in_depth.html">Configs in Depth</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../user_guide/40_outputs_in_depth.html">Outputs in Depth</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../user_guide/50_scenario_simulation.html">Simulator</a></li> +</ul> +<p class="caption"><span class="caption-text">Advanced topics</span></p> +<ul class="current"> +<li class="toctree-l1 current"><a class="reference internal" href="../20_simulator_advanced.html">Simulator</a><ul class="current"> +<li class="toctree-l2"><a class="reference internal" href="agent_components.html">Agent Components</a></li> +<li class="toctree-l2"><a class="reference internal" href="coordinate_systems.html">Coordinate Systems</a></li> +<li class="toctree-l2"><a class="reference internal" href="event_detector.html">EventDetector</a></li> +<li class="toctree-l2 current"><a class="current reference internal" href="#">Mapping of OpenSCENARIO Actions</a><ul> +<li class="toctree-l3"><a class="reference internal" href="#acquirepositionaction">AcquirePositionAction</a></li> +<li class="toctree-l3"><a class="reference internal" href="#assignrouteaction">AssignRouteAction</a></li> +<li class="toctree-l3"><a class="reference internal" href="#customcommandaction">CustomCommandAction</a></li> +<li class="toctree-l3"><a class="reference internal" href="#followtrajectoryaction">FollowTrajectoryAction</a></li> +<li class="toctree-l3"><a class="reference internal" href="#lanechangeaction">LaneChangeAction</a></li> +<li class="toctree-l3"><a class="reference internal" href="#speedaction">SpeedAction</a></li> +<li class="toctree-l3"><a class="reference internal" href="#teleportaction">TeleportAction</a></li> +<li class="toctree-l3"><a class="reference internal" href="#trafficsignalaction">TrafficSignalAction</a></li> +<li class="toctree-l3"><a class="reference internal" href="#trafficsignalstateaction">TrafficSignalStateAction</a></li> +<li class="toctree-l3"><a class="reference internal" href="#trafficsinkaction">TrafficSinkAction</a></li> +<li class="toctree-l3"><a class="reference internal" href="#visibilityaction">VisibilityAction</a></li> +</ul> +</li> +<li class="toctree-l2"><a class="reference internal" href="simulation.html">Simulation</a></li> +<li class="toctree-l2"><a class="reference internal" href="spawner_features.html">Spawner Features</a></li> +<li class="toctree-l2"><a class="reference internal" href="world_osi.html">World_OSI</a></li> +</ul> +</li> +<li class="toctree-l1"><a class="reference internal" href="../30_testing.html">EndToEnd Test Framework</a></li> +</ul> +<p class="caption"><span class="caption-text">Developer Information</span></p> +<ul> +<li class="toctree-l1"><a class="reference internal" href="../../developer_information/10_ide_support.html">IDE Support</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../developer_information/20_documentation.html">Documentation Concept</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../developer_information/30_coding_conventions.html">Coding Guidelines</a></li> +</ul> +<p class="caption"><span class="caption-text">Other Information</span></p> +<ul> +<li class="toctree-l1"><a class="reference internal" href="../../other_information/10_external_dependencies.html">External Dependencies</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../other_information/20_glossary.html">Glossary</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../other_information/30_gui_plugins.html">GUI Plugins</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../other_information/40_license.html">License</a></li> +</ul> + + + + </div> + + </div> + </nav> + + <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> + + + <nav class="wy-nav-top" aria-label="top navigation"> + + <i data-toggle="wy-nav-top" class="fa fa-bars"></i> + <a href="../../index.html">openPASS</a> + + </nav> + + + <div class="wy-nav-content"> + + <div class="rst-content"> + + + + + + + + + + + + + + + + + + + +<div role="navigation" aria-label="breadcrumbs navigation"> + + <ul class="wy-breadcrumbs"> + + <li><a href="../../index.html" class="icon icon-home"></a> »</li> + + <li><a href="../20_simulator_advanced.html">Simulator</a> »</li> + + <li>Mapping of OpenSCENARIO Actions</li> + + + <li class="wy-breadcrumbs-aside"> + + + <a href="../../_sources/advanced_topics/simulator/scenario_actions.rst.txt" rel="nofollow"> View page source</a> + + + </li> + + </ul> + + + <hr/> +</div> + <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> + <div itemprop="articleBody"> + + <div class="section" id="mapping-of-openscenario-actions"> +<span id="mapping-scenario-actions"></span><h1>Mapping of OpenSCENARIO Actions<a class="headerlink" href="#mapping-of-openscenario-actions" title="Permalink to this headline">¶</a></h1> +<table class="tight-table docutils align-default"> +<colgroup> +<col style="width: 53%" /> +<col style="width: 47%" /> +</colgroup> +<thead> +<tr class="row-odd"><th class="head"><p>Layer/Component</p></th> +<th class="head"><p>API/Datatype</p></th> +</tr> +</thead> +<tbody> +<tr class="row-even"><td><p>OpenScenarioEngine</p></td> +<td><p>mantle_api</p></td> +</tr> +<tr class="row-odd"><td><p>opSimualtion</p></td> +<td><p>openPASS</p></td> +</tr> +<tr class="row-even"><td><p>FMU Interface</p></td> +<td><p>osi3</p></td> +</tr> +</tbody> +</table> +<div class="section" id="acquirepositionaction"> +<h2>AcquirePositionAction<a class="headerlink" href="#acquirepositionaction" title="Permalink to this headline">¶</a></h2> +<table class="tight-table docutils align-default"> +<colgroup> +<col style="width: 12%" /> +<col style="width: 88%" /> +</colgroup> +<thead> +<tr class="row-odd"><th class="head"><p>API/Datatype</p></th> +<th class="head"><p>Used Methods/Classes/API</p></th> +</tr> +</thead> +<tbody> +<tr class="row-even"><td><p>OpenScenario</p></td> +<td><p><strong>AcquirePositionAction</strong></p></td> +</tr> +<tr class="row-odd"><td><p>mantle_api</p></td> +<td><p>Entity::AssignRoute(UniqueId, RouteDefinition) +Entity::GetPosition() +GeometryHelper::TranslateGlobalPositionLocally()</p></td> +</tr> +<tr class="row-even"><td rowspan="2"><p>openPASS</p></td> +<td><p>SpawnParameter +AgentInterface::GetPositionX() +AgentInterface::GetPositionY() +AgentInterface::GetYaw()</p></td> +</tr> +<tr class="row-odd"><td><p>RouteSamplerInterface::CalculateRouteFromWaypoints(std::vector<mantle_api::RouteWaypoint>) +EgoAgentInterface::SetRoadGraph(RoadGraph, RoadGraphVertex, RoadGraphVertex)</p></td> +</tr> +<tr class="row-even"><td><p>osi3</p></td> +<td><p>x – not implemented</p></td> +</tr> +</tbody> +</table> +</div> +<div class="section" id="assignrouteaction"> +<h2>AssignRouteAction<a class="headerlink" href="#assignrouteaction" title="Permalink to this headline">¶</a></h2> +<table class="tight-table docutils align-default"> +<colgroup> +<col style="width: 12%" /> +<col style="width: 88%" /> +</colgroup> +<thead> +<tr class="row-odd"><th class="head"><p>API/Datatype</p></th> +<th class="head"><p>Used Methods/Classes/API</p></th> +</tr> +</thead> +<tbody> +<tr class="row-even"><td><p>OpenScenario</p></td> +<td><p><strong>AssignRouteAction</strong></p></td> +</tr> +<tr class="row-odd"><td><p>mantle_api</p></td> +<td><p>Entity::AssignRoute(UniqueId, RouteDefinition)</p></td> +</tr> +<tr class="row-even"><td><p>openPASS</p></td> +<td><p>RouteSamplerInterface::CalculateRouteFromWaypoints(std::vector<mantle_api::RouteWaypoint>) +EgoAgentInterface::SetRoadGraph(RoadGraph, RoadGraphVertex, RoadGraphVertex)</p></td> +</tr> +<tr class="row-odd"><td><p>osi3</p></td> +<td><p>x – not relevant</p></td> +</tr> +</tbody> +</table> +</div> +<div class="section" id="customcommandaction"> +<h2>CustomCommandAction<a class="headerlink" href="#customcommandaction" title="Permalink to this headline">¶</a></h2> +<table class="tight-table docutils align-default"> +<colgroup> +<col style="width: 12%" /> +<col style="width: 88%" /> +</colgroup> +<thead> +<tr class="row-odd"><th class="head"><p>API/Datatype</p></th> +<th class="head"><p>Used Methods/Classes/API</p></th> +</tr> +</thead> +<tbody> +<tr class="row-even"><td><p>OpenScenario</p></td> +<td><p><strong>CustomCommandAction</strong></p></td> +</tr> +<tr class="row-odd"><td><p>mantle_api</p></td> +<td><p>ExecuteCustomCommand(actors, type, command)</p></td> +</tr> +<tr class="row-even"><td><p>openPASS</p></td> +<td><p>AddCustomCommand(command) +GetCustomCommands() +ComponentControllerImplementation::Trigger(time) +TrajectoryFollowerCommonBase::Trigger(time)</p></td> +</tr> +<tr class="row-odd"><td><p>osi3</p></td> +<td><p>osi3::TrafficAction::CustomAction +TrafficAction::mutable_custom_action() +TrafficAction_CustomAction::set_command(command)</p></td> +</tr> +</tbody> +</table> +</div> +<div class="section" id="followtrajectoryaction"> +<h2>FollowTrajectoryAction<a class="headerlink" href="#followtrajectoryaction" title="Permalink to this headline">¶</a></h2> +<table class="tight-table docutils align-default"> +<colgroup> +<col style="width: 12%" /> +<col style="width: 88%" /> +</colgroup> +<thead> +<tr class="row-odd"><th class="head"><p>API/Datatype</p></th> +<th class="head"><p>Used Methods/Classes/API</p></th> +</tr> +</thead> +<tbody> +<tr class="row-even"><td><p>OpenScenario</p></td> +<td><p><strong>FollowTrajectoryAction</strong></p></td> +</tr> +<tr class="row-odd"><td><p>mantle_api</p></td> +<td><p>UpdateControlStrategies(FollowTrajectoryControlStrategy) +HasControlStrategyGoalBeenReached(ControlStrategyType::kFollowTrajectory) +GeometryHelper::TranslateGlobalPositionLocally(PolyLine) +MovementDomain::kBoth</p></td> +</tr> +<tr class="row-even"><td><p>openPASS</p></td> +<td><p>SetStrategies(MovementDomain::kBoth, ControlStrategyType::kFollowTrajectory) +Algorithm_Routecontrol_Implementation::ReadWayPointData() +DynamicsScenarioImplementation::ReadWayPointData() +TrajectoryFollowerImplementation::Trigger(time) +FmuHelper::AddTrafficCommandActionFromOpenScenarioTrajectory(TrafficCommand::add_action(), Trajectory)</p></td> +</tr> +<tr class="row-odd"><td rowspan="2"><p>osi3</p></td> +<td><p><strong>osi3::TrafficAction::FollowTrajectoryAction</strong></p> +<p>TrafficAction::mutable_follow_trajectory_action() +TrafficAction_FollowTrajectoryAction::add_trajectory_point()</p> +</td> +</tr> +<tr class="row-even"><td><p><strong>osi3::TrafficAction::FollowPathAction</strong></p> +<p>TrafficAction::mutable_follow_path_action() +TrafficAction_FollowPathAction::add_path_point()</p> +</td> +</tr> +</tbody> +</table> +</div> +<div class="section" id="lanechangeaction"> +<h2>LaneChangeAction<a class="headerlink" href="#lanechangeaction" title="Permalink to this headline">¶</a></h2> +<table class="tight-table docutils align-default"> +<colgroup> +<col style="width: 12%" /> +<col style="width: 88%" /> +</colgroup> +<thead> +<tr class="row-odd"><th class="head"><p>API/Datatype</p></th> +<th class="head"><p>Used Methods/Classes/API</p></th> +</tr> +</thead> +<tbody> +<tr class="row-even"><td rowspan="3"><p>OpenScenario</p></td> +<td><p><strong>LaneChangeAction</strong></p> +<p>LaneChangeActionImpl::GetLaneChangeTarget() +ConvertScenarioLaneChangeTarget(ILaneChangeTarget) -> mantle_api::LaneId</p> +</td> +</tr> +<tr class="row-odd"><td><p><strong>RelativeTargetLane</strong></p> +<p>LaneChangeTargetImpl::GetRelativeTargetLane() +ConvertScenarioRelativeTargetLane(IRelativeTargetLane) -> mantle_api::LaneId</p> +</td> +</tr> +<tr class="row-even"><td><p><strong>AbsoluteTargetLane</strong></p> +<p>LaneChangeTargetImpl::GetAbsoluteTargetLane() +ConvertScenarioAbsoluteTargetLane(IAbsoluteTargetLane) -> mantle_api::LaneId</p> +</td> +</tr> +<tr class="row-odd"><td rowspan="2"><p>mantle_api</p></td> +<td><p>UpdateControlStrategies(PerformLaneChangeControlStrategy) +(ControlStrategyType::kPerformLaneChange)</p></td> +</tr> +<tr class="row-even"><td><p><strong>Relative</strong></p> +<p>LaneLocationQueryService::GetRelativeLaneId()</p> +</td> +</tr> +<tr class="row-odd"><td><p>openPASS</p></td> +<td><p>SetStrategies(MovementDomain::kLateral, ControlStrategyType::kPerformLaneChange) +DynamicsScenarioImplementation::CalculateSinusiodalLaneChange(PerformLaneChangeControlStrategy) +DynamicsScenarioImplementation::ReadWayPointData()</p></td> +</tr> +<tr class="row-even"><td><p>osi3</p></td> +<td><p>x – not implemented</p></td> +</tr> +</tbody> +</table> +</div> +<div class="section" id="speedaction"> +<h2>SpeedAction<a class="headerlink" href="#speedaction" title="Permalink to this headline">¶</a></h2> +<table class="tight-table docutils align-default"> +<colgroup> +<col style="width: 12%" /> +<col style="width: 88%" /> +</colgroup> +<thead> +<tr class="row-odd"><th class="head"><p>API/Datatype</p></th> +<th class="head"><p>Used Methods/Classes/API</p></th> +</tr> +</thead> +<tbody> +<tr class="row-even"><td><p>OpenScenario</p></td> +<td><p><strong>SpeedAction</strong> +SetLinearVelocitySplineControlStrategy(std::string)</p></td> +</tr> +<tr class="row-odd"><td><p>mantle_api</p></td> +<td><p>UpdateControlStrategies(FollowVelocitySplineControlStrategy) +HasControlStrategyGoalBeenReached(ControlStrategyType::kFollowVelocitySpline) +SetSpeed(IEntity, units::velocity::meters_per_second_t) +MovementDomain::kLongitudinal</p></td> +</tr> +<tr class="row-even"><td><p>openPASS</p></td> +<td><p>SetStrategies(MovementDomain::kLongitudinal, ControlStrategyType::kFollowVelocitySpline) +ControlStrategies::HasNewLongitudinalStrategy() +DynamicsScenarioImplementation::GetVelocityFromSplines()</p></td> +</tr> +<tr class="row-odd"><td><p>osi3</p></td> +<td><p>osi3::TrafficAction::SpeedAction +TrafficAction::mutable_speed_action() +TrafficAction_CustomAction::set_absolute_target_speed(targetSpeed)</p></td> +</tr> +</tbody> +</table> +</div> +<div class="section" id="teleportaction"> +<h2>TeleportAction<a class="headerlink" href="#teleportaction" title="Permalink to this headline">¶</a></h2> +<table class="tight-table docutils align-default"> +<colgroup> +<col style="width: 12%" /> +<col style="width: 88%" /> +</colgroup> +<thead> +<tr class="row-odd"><th class="head"><p>API/Datatype</p></th> +<th class="head"><p>Used Methods/Classes/API</p></th> +</tr> +</thead> +<tbody> +<tr class="row-even"><td><p>OpenScenario</p></td> +<td><p><strong>TeleportAction</strong></p></td> +</tr> +<tr class="row-odd"><td><p>mantle_api</p></td> +<td><p>Entity::SetPosition(Vec3<units::length::meter_t>) +Entity::SetOrientation(Orientation3<units::angle::radian_t>) +Entity::SetAssignedLaneIds(std::vector<uint64_t>) +GeometryHelper::TranslateGlobalPositionLocally(…) +LaneLocationQueryService::GetUpwardsShiftedLanePosition(…) +LaneLocationQueryService::GetLaneIdsAtPosition(…)</p></td> +</tr> +<tr class="row-even"><td><p>openPASS</p></td> +<td><p>RouteSampler::Sample(mantle_api::Vec3<units::length::meter_t>, units::angle::radian_t) +AgentInterface::SetPositionX(units::length::meter_t) +AgentInterface::SetPositionY(units::length::meter_t) +AgentInterface:SetYaw(units::angle::radian_t)</p></td> +</tr> +<tr class="row-odd"><td><p>osi3</p></td> +<td><p>x – not relevant</p></td> +</tr> +</tbody> +</table> +</div> +<div class="section" id="trafficsignalaction"> +<h2>TrafficSignalAction<a class="headerlink" href="#trafficsignalaction" title="Permalink to this headline">¶</a></h2> +<table class="tight-table docutils align-default"> +<colgroup> +<col style="width: 12%" /> +<col style="width: 88%" /> +</colgroup> +<thead> +<tr class="row-odd"><th class="head"><p>API/Datatype</p></th> +<th class="head"><p>Used Methods/Classes/API</p></th> +</tr> +</thead> +<tbody> +<tr class="row-even"><td><p>OpenScenario</p></td> +<td><p><strong>TrafficSignalAction</strong></p></td> +</tr> +<tr class="row-odd"><td><p>mantle_api</p></td> +<td><p>SetTrafficSignalState(std::string name, std::string state)</p></td> +</tr> +<tr class="row-even"><td><p>openPASS</p></td> +<td><p>WorldData::GetTrafficSignIdMapping() +WorldData::GetSignalType(Id) +WorldData::GetTrafficLight(Id) +ThreeSignalsTrafficLight::SetState(CommonTrafficLight::State) +TwoSignalsTrafficLight::SetState(CommonTrafficLight::State) +OneSignalsTrafficLight::SetState(CommonTrafficLight::State) +DataBuffer::PutAcyclic</p></td> +</tr> +<tr class="row-odd"><td><p>osi3</p></td> +<td><p>TrafficLight_Classification::set_mode(::osi3::TrafficLight_Classification_Mode)</p></td> +</tr> +</tbody> +</table> +</div> +<div class="section" id="trafficsignalstateaction"> +<h2>TrafficSignalStateAction<a class="headerlink" href="#trafficsignalstateaction" title="Permalink to this headline">¶</a></h2> +<table class="tight-table docutils align-default"> +<colgroup> +<col style="width: 12%" /> +<col style="width: 88%" /> +</colgroup> +<thead> +<tr class="row-odd"><th class="head"><p>API/Datatype</p></th> +<th class="head"><p>Used Methods/Classes/API</p></th> +</tr> +</thead> +<tbody> +<tr class="row-even"><td><p>OpenScenario</p></td> +<td><p><strong>TrafficSignalStateAction</strong></p></td> +</tr> +<tr class="row-odd"><td><p>mantle_api</p></td> +<td><p>SetTrafficSignalState(std::string name, std::string state)</p></td> +</tr> +<tr class="row-even"><td><p>openPASS</p></td> +<td><p>WorldData::GetTrafficSignIdMapping() +WorldData::GetSignalType(Id) +WorldData::GetTrafficLight(Id) +ThreeSignalsTrafficLight::SetState(CommonTrafficLight::State) +TwoSignalsTrafficLight::SetState(CommonTrafficLight::State) +OneSignalsTrafficLight::SetState(CommonTrafficLight::State) +DataBuffer::PutAcyclic</p></td> +</tr> +<tr class="row-odd"><td><p>osi3</p></td> +<td><p>TrafficLight_Classification::set_mode(::osi3::TrafficLight_Classification_Mode)</p></td> +</tr> +</tbody> +</table> +</div> +<div class="section" id="trafficsinkaction"> +<h2>TrafficSinkAction<a class="headerlink" href="#trafficsinkaction" title="Permalink to this headline">¶</a></h2> +<table class="tight-table docutils align-default"> +<colgroup> +<col style="width: 12%" /> +<col style="width: 88%" /> +</colgroup> +<thead> +<tr class="row-odd"><th class="head"><p>API/Datatype</p></th> +<th class="head"><p>Used Methods/Classes/API</p></th> +</tr> +</thead> +<tbody> +<tr class="row-even"><td><p>OpenScenario</p></td> +<td><p><strong>TrafficSinkAction</strong></p> +<p>ConvertScenarioTrafficDefinition(NET_ASAM_OPENSCENARIO::v1_1::ITrafficDefinition)</p> +</td> +</tr> +<tr class="row-odd"><td><p>mantle_api</p></td> +<td><p>Entity::GetPosition() +GeometryHelper::TranslateGlobalPositionLocally()</p></td> +</tr> +<tr class="row-even"><td rowspan="2"><p>openPASS</p></td> +<td><p>SpawnParameter</p></td> +</tr> +<tr class="row-odd"><td><p>AgentInterface::GetPositionX() +AgentInterface::GetPositionY() +AgentInterface:GetYaw()</p></td> +</tr> +<tr class="row-even"><td><p>osi3</p></td> +<td><p>x – not relevant</p></td> +</tr> +</tbody> +</table> +</div> +<div class="section" id="visibilityaction"> +<h2>VisibilityAction<a class="headerlink" href="#visibilityaction" title="Permalink to this headline">¶</a></h2> +<table class="tight-table docutils align-default"> +<colgroup> +<col style="width: 12%" /> +<col style="width: 88%" /> +</colgroup> +<thead> +<tr class="row-odd"><th class="head"><p>API/Datatype</p></th> +<th class="head"><p>Used Methods/Classes/API</p></th> +</tr> +</thead> +<tbody> +<tr class="row-even"><td><p>OpenScenario</p></td> +<td><p><strong>VisibilityAction</strong></p></td> +</tr> +<tr class="row-odd"><td><p>mantle_api</p></td> +<td><p>SetVisibility(EntityVisibilityConfig)</p></td> +</tr> +<tr class="row-even"><td><p>openPASS</p></td> +<td><p>x – not implemented</p></td> +</tr> +<tr class="row-odd"><td><p>osi3</p></td> +<td><p>x – not implemented</p></td> +</tr> +</tbody> +</table> +</div> +</div> + + + </div> + + </div> + <footer> + <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> + <a href="simulation.html" class="btn btn-neutral float-right" title="Simulation" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a> + <a href="event_detector.html" class="btn btn-neutral float-left" title="EventDetector" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a> + </div> + + <hr/> + + <div role="contentinfo"> + <p> + © Copyright 2023 openPASS Working Group. + + </p> + </div> + + + + Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a + + <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a> + + provided by <a href="https://readthedocs.org">Read the Docs</a>. + +</footer> + </div> + </div> + + </section> + + </div> + + + <script type="text/javascript"> + jQuery(function () { + SphinxRtdTheme.Navigation.enable(true); + }); + </script> + + + + + + +</body> +</html> \ No newline at end of file
diff --git a/content/html/advanced_topics/simulator/simulation.html b/content/html/advanced_topics/simulator/simulation.html index 71f905e..a5c3a51 100644 --- a/content/html/advanced_topics/simulator/simulation.html +++ b/content/html/advanced_topics/simulator/simulation.html
@@ -7,7 +7,7 @@ <meta name="viewport" content="width=device-width, initial-scale=1.0" /> - <title>Simulation — OpenPASS Documentation</title> + <title>Simulation — openPASS Documentation</title> @@ -43,7 +43,7 @@ <link rel="index" title="Index" href="../../genindex.html" /> <link rel="search" title="Search" href="../../search.html" /> <link rel="next" title="Spawner Features" href="spawner_features.html" /> - <link rel="prev" title="EventDetector" href="event_detector.html" /> + <link rel="prev" title="Mapping of OpenSCENARIO Actions" href="scenario_actions.html" /> </head> <body class="wy-body-for-nav"> @@ -70,7 +70,7 @@ <div class="version"> - "openPASS v0.11" + "develop_4d7f6d4f2e22c286789082dd8cbe3eb7f5b5af62" </div> @@ -100,7 +100,7 @@ <li class="toctree-l1"><a class="reference internal" href="../../installation_guide/10_getting_started.html">Getting Started</a></li> <li class="toctree-l1"><a class="reference internal" href="../../installation_guide/15_system_requirements.html">System Requirements</a></li> <li class="toctree-l1"><a class="reference internal" href="../../installation_guide/20_install_prerequisites.html">Installing Prerequisites</a></li> -<li class="toctree-l1"><a class="reference internal" href="../../installation_guide/30_install_openpass.html">Installing OpenPASS</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../installation_guide/30_install_openpass.html">Installing openPASS</a></li> <li class="toctree-l1"><a class="reference internal" href="../../installation_guide/50_further_guidance.html">Further Guidance</a></li> <li class="toctree-l1"><a class="reference internal" href="../../installation_guide/60_conan.html">Building with Conan</a></li> </ul> @@ -108,10 +108,9 @@ <ul> <li class="toctree-l1"><a class="reference internal" href="../../user_guide/10_overview.html">Overview</a></li> <li class="toctree-l1"><a class="reference internal" href="../../user_guide/20_tutorials.html">Tutorials</a></li> -<li class="toctree-l1"><a class="reference internal" href="../../user_guide/30_gui_plugins.html">GUI Plugins</a></li> -<li class="toctree-l1"><a class="reference internal" href="../../user_guide/40_configs_in_depth.html">Configs in Depth</a></li> -<li class="toctree-l1"><a class="reference internal" href="../../user_guide/50_outputs_in_depth.html">Outputs in Depth</a></li> -<li class="toctree-l1"><a class="reference internal" href="../../user_guide/60_scenario_simulation.html">Simulator</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../user_guide/30_configs_in_depth.html">Configs in Depth</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../user_guide/40_outputs_in_depth.html">Outputs in Depth</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../user_guide/50_scenario_simulation.html">Simulator</a></li> </ul> <p class="caption"><span class="caption-text">Advanced topics</span></p> <ul class="current"> @@ -119,6 +118,7 @@ <li class="toctree-l2"><a class="reference internal" href="agent_components.html">Agent Components</a></li> <li class="toctree-l2"><a class="reference internal" href="coordinate_systems.html">Coordinate Systems</a></li> <li class="toctree-l2"><a class="reference internal" href="event_detector.html">EventDetector</a></li> +<li class="toctree-l2"><a class="reference internal" href="scenario_actions.html">Mapping of OpenSCENARIO Actions</a></li> <li class="toctree-l2 current"><a class="current reference internal" href="#">Simulation</a><ul> <li class="toctree-l3"><a class="reference internal" href="#command-line-arguments">Command Line Arguments</a></li> <li class="toctree-l3"><a class="reference internal" href="#scheduler">Scheduler</a><ul> @@ -139,12 +139,14 @@ <ul> <li class="toctree-l1"><a class="reference internal" href="../../developer_information/10_ide_support.html">IDE Support</a></li> <li class="toctree-l1"><a class="reference internal" href="../../developer_information/20_documentation.html">Documentation Concept</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../developer_information/30_coding_conventions.html">Coding Guidelines</a></li> </ul> <p class="caption"><span class="caption-text">Other Information</span></p> <ul> <li class="toctree-l1"><a class="reference internal" href="../../other_information/10_external_dependencies.html">External Dependencies</a></li> <li class="toctree-l1"><a class="reference internal" href="../../other_information/20_glossary.html">Glossary</a></li> -<li class="toctree-l1"><a class="reference internal" href="../../other_information/30_license.html">License</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../other_information/30_gui_plugins.html">GUI Plugins</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../other_information/40_license.html">License</a></li> </ul> @@ -372,14 +374,14 @@ <footer> <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> <a href="spawner_features.html" class="btn btn-neutral float-right" title="Spawner Features" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a> - <a href="event_detector.html" class="btn btn-neutral float-left" title="EventDetector" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a> + <a href="scenario_actions.html" class="btn btn-neutral float-left" title="Mapping of OpenSCENARIO Actions" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a> </div> <hr/> <div role="contentinfo"> <p> - © Copyright 2023 OpenPASS Working Group. + © Copyright 2023 openPASS Working Group. </p> </div>
diff --git a/content/html/advanced_topics/simulator/spawner_features.html b/content/html/advanced_topics/simulator/spawner_features.html index 0eef571..faa6dca 100644 --- a/content/html/advanced_topics/simulator/spawner_features.html +++ b/content/html/advanced_topics/simulator/spawner_features.html
@@ -7,7 +7,7 @@ <meta name="viewport" content="width=device-width, initial-scale=1.0" /> - <title>Spawner Features — OpenPASS Documentation</title> + <title>Spawner Features — openPASS Documentation</title> @@ -70,7 +70,7 @@ <div class="version"> - "openPASS v0.11" + "develop_4d7f6d4f2e22c286789082dd8cbe3eb7f5b5af62" </div> @@ -100,7 +100,7 @@ <li class="toctree-l1"><a class="reference internal" href="../../installation_guide/10_getting_started.html">Getting Started</a></li> <li class="toctree-l1"><a class="reference internal" href="../../installation_guide/15_system_requirements.html">System Requirements</a></li> <li class="toctree-l1"><a class="reference internal" href="../../installation_guide/20_install_prerequisites.html">Installing Prerequisites</a></li> -<li class="toctree-l1"><a class="reference internal" href="../../installation_guide/30_install_openpass.html">Installing OpenPASS</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../installation_guide/30_install_openpass.html">Installing openPASS</a></li> <li class="toctree-l1"><a class="reference internal" href="../../installation_guide/50_further_guidance.html">Further Guidance</a></li> <li class="toctree-l1"><a class="reference internal" href="../../installation_guide/60_conan.html">Building with Conan</a></li> </ul> @@ -108,10 +108,9 @@ <ul> <li class="toctree-l1"><a class="reference internal" href="../../user_guide/10_overview.html">Overview</a></li> <li class="toctree-l1"><a class="reference internal" href="../../user_guide/20_tutorials.html">Tutorials</a></li> -<li class="toctree-l1"><a class="reference internal" href="../../user_guide/30_gui_plugins.html">GUI Plugins</a></li> -<li class="toctree-l1"><a class="reference internal" href="../../user_guide/40_configs_in_depth.html">Configs in Depth</a></li> -<li class="toctree-l1"><a class="reference internal" href="../../user_guide/50_outputs_in_depth.html">Outputs in Depth</a></li> -<li class="toctree-l1"><a class="reference internal" href="../../user_guide/60_scenario_simulation.html">Simulator</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../user_guide/30_configs_in_depth.html">Configs in Depth</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../user_guide/40_outputs_in_depth.html">Outputs in Depth</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../user_guide/50_scenario_simulation.html">Simulator</a></li> </ul> <p class="caption"><span class="caption-text">Advanced topics</span></p> <ul class="current"> @@ -119,6 +118,7 @@ <li class="toctree-l2"><a class="reference internal" href="agent_components.html">Agent Components</a></li> <li class="toctree-l2"><a class="reference internal" href="coordinate_systems.html">Coordinate Systems</a></li> <li class="toctree-l2"><a class="reference internal" href="event_detector.html">EventDetector</a></li> +<li class="toctree-l2"><a class="reference internal" href="scenario_actions.html">Mapping of OpenSCENARIO Actions</a></li> <li class="toctree-l2"><a class="reference internal" href="simulation.html">Simulation</a></li> <li class="toctree-l2 current"><a class="current reference internal" href="#">Spawner Features</a><ul> <li class="toctree-l3"><a class="reference internal" href="#prerunspawner">PreRunSpawner</a><ul> @@ -144,12 +144,14 @@ <ul> <li class="toctree-l1"><a class="reference internal" href="../../developer_information/10_ide_support.html">IDE Support</a></li> <li class="toctree-l1"><a class="reference internal" href="../../developer_information/20_documentation.html">Documentation Concept</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../developer_information/30_coding_conventions.html">Coding Guidelines</a></li> </ul> <p class="caption"><span class="caption-text">Other Information</span></p> <ul> <li class="toctree-l1"><a class="reference internal" href="../../other_information/10_external_dependencies.html">External Dependencies</a></li> <li class="toctree-l1"><a class="reference internal" href="../../other_information/20_glossary.html">Glossary</a></li> -<li class="toctree-l1"><a class="reference internal" href="../../other_information/30_license.html">License</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../other_information/30_gui_plugins.html">GUI Plugins</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../other_information/40_license.html">License</a></li> </ul> @@ -677,7 +679,7 @@ <div role="contentinfo"> <p> - © Copyright 2023 OpenPASS Working Group. + © Copyright 2023 openPASS Working Group. </p> </div>
diff --git a/content/html/advanced_topics/simulator/world_osi.html b/content/html/advanced_topics/simulator/world_osi.html index 8c8496f..1ded278 100644 --- a/content/html/advanced_topics/simulator/world_osi.html +++ b/content/html/advanced_topics/simulator/world_osi.html
@@ -7,7 +7,7 @@ <meta name="viewport" content="width=device-width, initial-scale=1.0" /> - <title>World_OSI — OpenPASS Documentation</title> + <title>World_OSI — openPASS Documentation</title> @@ -70,7 +70,7 @@ <div class="version"> - "openPASS v0.11" + "develop_4d7f6d4f2e22c286789082dd8cbe3eb7f5b5af62" </div> @@ -100,7 +100,7 @@ <li class="toctree-l1"><a class="reference internal" href="../../installation_guide/10_getting_started.html">Getting Started</a></li> <li class="toctree-l1"><a class="reference internal" href="../../installation_guide/15_system_requirements.html">System Requirements</a></li> <li class="toctree-l1"><a class="reference internal" href="../../installation_guide/20_install_prerequisites.html">Installing Prerequisites</a></li> -<li class="toctree-l1"><a class="reference internal" href="../../installation_guide/30_install_openpass.html">Installing OpenPASS</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../installation_guide/30_install_openpass.html">Installing openPASS</a></li> <li class="toctree-l1"><a class="reference internal" href="../../installation_guide/50_further_guidance.html">Further Guidance</a></li> <li class="toctree-l1"><a class="reference internal" href="../../installation_guide/60_conan.html">Building with Conan</a></li> </ul> @@ -108,10 +108,9 @@ <ul> <li class="toctree-l1"><a class="reference internal" href="../../user_guide/10_overview.html">Overview</a></li> <li class="toctree-l1"><a class="reference internal" href="../../user_guide/20_tutorials.html">Tutorials</a></li> -<li class="toctree-l1"><a class="reference internal" href="../../user_guide/30_gui_plugins.html">GUI Plugins</a></li> -<li class="toctree-l1"><a class="reference internal" href="../../user_guide/40_configs_in_depth.html">Configs in Depth</a></li> -<li class="toctree-l1"><a class="reference internal" href="../../user_guide/50_outputs_in_depth.html">Outputs in Depth</a></li> -<li class="toctree-l1"><a class="reference internal" href="../../user_guide/60_scenario_simulation.html">Simulator</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../user_guide/30_configs_in_depth.html">Configs in Depth</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../user_guide/40_outputs_in_depth.html">Outputs in Depth</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../user_guide/50_scenario_simulation.html">Simulator</a></li> </ul> <p class="caption"><span class="caption-text">Advanced topics</span></p> <ul class="current"> @@ -119,6 +118,7 @@ <li class="toctree-l2"><a class="reference internal" href="agent_components.html">Agent Components</a></li> <li class="toctree-l2"><a class="reference internal" href="coordinate_systems.html">Coordinate Systems</a></li> <li class="toctree-l2"><a class="reference internal" href="event_detector.html">EventDetector</a></li> +<li class="toctree-l2"><a class="reference internal" href="scenario_actions.html">Mapping of OpenSCENARIO Actions</a></li> <li class="toctree-l2"><a class="reference internal" href="simulation.html">Simulation</a></li> <li class="toctree-l2"><a class="reference internal" href="spawner_features.html">Spawner Features</a></li> <li class="toctree-l2 current"><a class="current reference internal" href="#">World_OSI</a><ul> @@ -141,12 +141,14 @@ <ul> <li class="toctree-l1"><a class="reference internal" href="../../developer_information/10_ide_support.html">IDE Support</a></li> <li class="toctree-l1"><a class="reference internal" href="../../developer_information/20_documentation.html">Documentation Concept</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../developer_information/30_coding_conventions.html">Coding Guidelines</a></li> </ul> <p class="caption"><span class="caption-text">Other Information</span></p> <ul> <li class="toctree-l1"><a class="reference internal" href="../../other_information/10_external_dependencies.html">External Dependencies</a></li> <li class="toctree-l1"><a class="reference internal" href="../../other_information/20_glossary.html">Glossary</a></li> -<li class="toctree-l1"><a class="reference internal" href="../../other_information/30_license.html">License</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../other_information/30_gui_plugins.html">GUI Plugins</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../other_information/40_license.html">License</a></li> </ul> @@ -992,7 +994,7 @@ <div role="contentinfo"> <p> - © Copyright 2023 OpenPASS Working Group. + © Copyright 2023 openPASS Working Group. </p> </div>
diff --git a/content/html/developer_information/10_ide_support.html b/content/html/developer_information/10_ide_support.html index 3b1541e..94ace1c 100644 --- a/content/html/developer_information/10_ide_support.html +++ b/content/html/developer_information/10_ide_support.html
@@ -7,7 +7,7 @@ <meta name="viewport" content="width=device-width, initial-scale=1.0" /> - <title>IDE Support — OpenPASS Documentation</title> + <title>IDE Support — openPASS Documentation</title> @@ -70,7 +70,7 @@ <div class="version"> - "openPASS v0.11" + "develop_4d7f6d4f2e22c286789082dd8cbe3eb7f5b5af62" </div> @@ -100,7 +100,7 @@ <li class="toctree-l1"><a class="reference internal" href="../installation_guide/10_getting_started.html">Getting Started</a></li> <li class="toctree-l1"><a class="reference internal" href="../installation_guide/15_system_requirements.html">System Requirements</a></li> <li class="toctree-l1"><a class="reference internal" href="../installation_guide/20_install_prerequisites.html">Installing Prerequisites</a></li> -<li class="toctree-l1"><a class="reference internal" href="../installation_guide/30_install_openpass.html">Installing OpenPASS</a></li> +<li class="toctree-l1"><a class="reference internal" href="../installation_guide/30_install_openpass.html">Installing openPASS</a></li> <li class="toctree-l1"><a class="reference internal" href="../installation_guide/50_further_guidance.html">Further Guidance</a></li> <li class="toctree-l1"><a class="reference internal" href="../installation_guide/60_conan.html">Building with Conan</a></li> </ul> @@ -108,10 +108,9 @@ <ul> <li class="toctree-l1"><a class="reference internal" href="../user_guide/10_overview.html">Overview</a></li> <li class="toctree-l1"><a class="reference internal" href="../user_guide/20_tutorials.html">Tutorials</a></li> -<li class="toctree-l1"><a class="reference internal" href="../user_guide/30_gui_plugins.html">GUI Plugins</a></li> -<li class="toctree-l1"><a class="reference internal" href="../user_guide/40_configs_in_depth.html">Configs in Depth</a></li> -<li class="toctree-l1"><a class="reference internal" href="../user_guide/50_outputs_in_depth.html">Outputs in Depth</a></li> -<li class="toctree-l1"><a class="reference internal" href="../user_guide/60_scenario_simulation.html">Simulator</a></li> +<li class="toctree-l1"><a class="reference internal" href="../user_guide/30_configs_in_depth.html">Configs in Depth</a></li> +<li class="toctree-l1"><a class="reference internal" href="../user_guide/40_outputs_in_depth.html">Outputs in Depth</a></li> +<li class="toctree-l1"><a class="reference internal" href="../user_guide/50_scenario_simulation.html">Simulator</a></li> </ul> <p class="caption"><span class="caption-text">Advanced topics</span></p> <ul> @@ -126,12 +125,14 @@ </ul> </li> <li class="toctree-l1"><a class="reference internal" href="20_documentation.html">Documentation Concept</a></li> +<li class="toctree-l1"><a class="reference internal" href="30_coding_conventions.html">Coding Guidelines</a></li> </ul> <p class="caption"><span class="caption-text">Other Information</span></p> <ul> <li class="toctree-l1"><a class="reference internal" href="../other_information/10_external_dependencies.html">External Dependencies</a></li> <li class="toctree-l1"><a class="reference internal" href="../other_information/20_glossary.html">Glossary</a></li> -<li class="toctree-l1"><a class="reference internal" href="../other_information/30_license.html">License</a></li> +<li class="toctree-l1"><a class="reference internal" href="../other_information/30_gui_plugins.html">GUI Plugins</a></li> +<li class="toctree-l1"><a class="reference internal" href="../other_information/40_license.html">License</a></li> </ul> @@ -224,7 +225,7 @@ <div role="contentinfo"> <p> - © Copyright 2023 OpenPASS Working Group. + © Copyright 2023 openPASS Working Group. </p> </div>
diff --git a/content/html/developer_information/20_documentation.html b/content/html/developer_information/20_documentation.html index 2b3f851..daf3d47 100644 --- a/content/html/developer_information/20_documentation.html +++ b/content/html/developer_information/20_documentation.html
@@ -7,7 +7,7 @@ <meta name="viewport" content="width=device-width, initial-scale=1.0" /> - <title>Documentation Concept — OpenPASS Documentation</title> + <title>Documentation Concept — openPASS Documentation</title> @@ -42,7 +42,7 @@ <link rel="index" title="Index" href="../genindex.html" /> <link rel="search" title="Search" href="../search.html" /> - <link rel="next" title="External Dependencies" href="../other_information/10_external_dependencies.html" /> + <link rel="next" title="Coding Guidelines" href="30_coding_conventions.html" /> <link rel="prev" title="Working with Visual Studio Code" href="ide_support/30_vscode.html" /> </head> @@ -70,7 +70,7 @@ <div class="version"> - "openPASS v0.11" + "develop_4d7f6d4f2e22c286789082dd8cbe3eb7f5b5af62" </div> @@ -100,7 +100,7 @@ <li class="toctree-l1"><a class="reference internal" href="../installation_guide/10_getting_started.html">Getting Started</a></li> <li class="toctree-l1"><a class="reference internal" href="../installation_guide/15_system_requirements.html">System Requirements</a></li> <li class="toctree-l1"><a class="reference internal" href="../installation_guide/20_install_prerequisites.html">Installing Prerequisites</a></li> -<li class="toctree-l1"><a class="reference internal" href="../installation_guide/30_install_openpass.html">Installing OpenPASS</a></li> +<li class="toctree-l1"><a class="reference internal" href="../installation_guide/30_install_openpass.html">Installing openPASS</a></li> <li class="toctree-l1"><a class="reference internal" href="../installation_guide/50_further_guidance.html">Further Guidance</a></li> <li class="toctree-l1"><a class="reference internal" href="../installation_guide/60_conan.html">Building with Conan</a></li> </ul> @@ -108,10 +108,9 @@ <ul> <li class="toctree-l1"><a class="reference internal" href="../user_guide/10_overview.html">Overview</a></li> <li class="toctree-l1"><a class="reference internal" href="../user_guide/20_tutorials.html">Tutorials</a></li> -<li class="toctree-l1"><a class="reference internal" href="../user_guide/30_gui_plugins.html">GUI Plugins</a></li> -<li class="toctree-l1"><a class="reference internal" href="../user_guide/40_configs_in_depth.html">Configs in Depth</a></li> -<li class="toctree-l1"><a class="reference internal" href="../user_guide/50_outputs_in_depth.html">Outputs in Depth</a></li> -<li class="toctree-l1"><a class="reference internal" href="../user_guide/60_scenario_simulation.html">Simulator</a></li> +<li class="toctree-l1"><a class="reference internal" href="../user_guide/30_configs_in_depth.html">Configs in Depth</a></li> +<li class="toctree-l1"><a class="reference internal" href="../user_guide/40_outputs_in_depth.html">Outputs in Depth</a></li> +<li class="toctree-l1"><a class="reference internal" href="../user_guide/50_scenario_simulation.html">Simulator</a></li> </ul> <p class="caption"><span class="caption-text">Advanced topics</span></p> <ul> @@ -124,14 +123,17 @@ <li class="toctree-l1 current"><a class="current reference internal" href="#">Documentation Concept</a><ul> <li class="toctree-l2"><a class="reference internal" href="#basic-build-mechanics">Basic Build Mechanics</a></li> <li class="toctree-l2"><a class="reference internal" href="#openpass-as-submodule">openPASS as Submodule</a></li> +<li class="toctree-l2"><a class="reference internal" href="#docker-image">Docker Image</a></li> </ul> </li> +<li class="toctree-l1"><a class="reference internal" href="30_coding_conventions.html">Coding Guidelines</a></li> </ul> <p class="caption"><span class="caption-text">Other Information</span></p> <ul> <li class="toctree-l1"><a class="reference internal" href="../other_information/10_external_dependencies.html">External Dependencies</a></li> <li class="toctree-l1"><a class="reference internal" href="../other_information/20_glossary.html">Glossary</a></li> -<li class="toctree-l1"><a class="reference internal" href="../other_information/30_license.html">License</a></li> +<li class="toctree-l1"><a class="reference internal" href="../other_information/30_gui_plugins.html">GUI Plugins</a></li> +<li class="toctree-l1"><a class="reference internal" href="../other_information/40_license.html">License</a></li> </ul> @@ -201,13 +203,13 @@ <div class="section" id="documentation-concept"> <span id="documentation"></span><h1>Documentation Concept<a class="headerlink" href="#documentation-concept" title="Permalink to this headline">¶</a></h1> -<p><strong>OpenPASS</strong> (Open Source) is developed under the Eclipse Public License and as such private and commercial use is allowed under certain rules (see <a class="reference external" href="https://www.eclipse.org/legal/epl-2.0/">EPL 2.0</a>). +<p><strong>openPASS</strong> (Open Source) is developed under the Eclipse Public License and as such private and commercial use is allowed under certain rules (see <a class="reference external" href="https://www.eclipse.org/legal/epl-2.0/">EPL 2.0</a>). The basic documentation concept facilitates this by providing a way to include custom content which is not necessarily part of the <strong>openPASS</strong> (Open Source) distribution. This results in certain restrictions on how documentation is to be written. The following sections describe this restrictions and the process of integrating proprietary documentation into the <strong>openPASS</strong> (Open Source) documentation build.</p> <div class="section" id="basic-build-mechanics"> <h2>Basic Build Mechanics<a class="headerlink" href="#basic-build-mechanics" title="Permalink to this headline">¶</a></h2> -<p>The required steps to build the documentation are described in <a class="reference internal" href="../installation_guide/30_install_openpass.html#download-and-install-openpass"><span class="std std-ref">Installing OpenPASS</span></a>, provided by CMake files using the build option <code class="docutils literal notranslate"><span class="pre">WITH_GUI=ON</span></code>. +<p>The required steps to build the documentation are described in <a class="reference internal" href="../installation_guide/30_install_openpass.html#download-and-install-openpass"><span class="std std-ref">Installing openPASS</span></a>. Before building, a temporary copy of the original documentation is made. This temporary copy acts as <em>seam</em> for custom extension, as proprietary content is simply copied into the temporary folder (see below). This mechanism keeps contents clearly separated during development and allows easy transition from closed to open source if desired.</p> @@ -217,11 +219,10 @@ <blockquote> <div><ul class="simple"> <li><p><em>@</em><em>OP_REL_ROOT</em><em>@</em> - Root of repository (<code class="docutils literal notranslate"><span class="pre">.</span></code>)</p></li> -<li><p><em>@</em><em>OP_REL_GUI</em><em>@</em> - Folder <code class="docutils literal notranslate"><span class="pre">./gui</span></code></p></li> <li><p><em>@</em><em>OP_REL_SIM</em><em>@</em> - Folder <code class="docutils literal notranslate"><span class="pre">./sim</span></code></p></li> </ul> </div></blockquote> -<p>This placeholders must be used when files outside of the documentation root shall be referenced. +<p>These placeholders must be used when files outside of the documentation root shall be referenced. Note that this also makes sources more readable.</p> <p><strong>Example</strong></p> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o">..</span> <span class="n">literalinclude</span><span class="p">::</span> <span class="nd">@OP_REL_SIM</span><span class="o">@/</span><span class="n">contrib</span><span class="o">/</span><span class="n">examples</span><span class="o">/</span><span class="n">Common</span><span class="o">/</span><span class="n">SceneryConfiguration</span><span class="o">.</span><span class="n">xodr</span> @@ -263,29 +264,28 @@ <p>This diff highlights the important parts in comparison to the original <code class="docutils literal notranslate"><span class="pre">PrepareDoc.cmake</span></code>, used in the open source documentation build:</p> <div class="highlight-udiff notranslate"><div class="highlight"><pre><span></span><span class="gd">--- W:/repo/doc/PrepareDoc.cmake</span> <span class="gi">+++ W:/build/doc/source/developer_information/_static/custom_doc/PrepareDocCustom.cmake</span> -<span class="gu">@@ -20,6 +20,7 @@</span> +<span class="gu">@@ -19,6 +19,7 @@</span> + # Currently supported PLACEHOLDERS # - @OP_REL_ROOT@ => relative path to root of the openpass repository - # - @OP_REL_GUI@ => resolves to @OP_REL_ROOT@/gui # - @OP_REL_SIM@ => resolves to @OP_REL_ROOT@/sim <span class="gi">+# - @CUSTOM_REL_SIM@ => relative path to the "custom" root (.)</span> macro(copy_documentation source destination) message(VERBOSE "Copy ${source} to ${destination}") -<span class="gu">@@ -34,9 +35,10 @@</span> +<span class="gu">@@ -33,8 +34,9 @@</span> string(REGEX REPLACE "(.*)/$" "\\1" target ${target}) # Placeholder for conf.py: no initial '/' => real relative paths <span class="gd">- set(OP_REL_ROOT ../${target}) # relative path to repository root</span> <span class="gi">+ set(OP_REL_ROOT ../${target}/deps/os) # relative path to the openPASS open source code, with prefix '../${target}' pointing to the custom repository root if this file is located at <root>/doc</span> - set(OP_REL_GUI ${OP_REL_ROOT}/gui) # relative path to gui root set(OP_REL_SIM ${OP_REL_ROOT}/sim) # relative path to simulation root <span class="gi">+ set(CUSTOM_REL_SIM ../${target}) # relative path to the custom repository root (here, equal to custom sim root)</span> configure_file(${destination}/source/conf.py ${destination}/source/conf.py @ONLY) -<span class="gu">@@ -46,6 +48,7 @@</span> +<span class="gu">@@ -43,6 +45,7 @@</span> + # Override old one, because we want to use the same placeholder in both contexts set(OP_REL_ROOT /${OP_REL_ROOT}) - set(OP_REL_GUI /${OP_REL_GUI}) set(OP_REL_SIM /${OP_REL_SIM}) <span class="gi">+ set(CUSTOM_REL_SIM /${CUSTOM_REL_SIM})</span> @@ -347,6 +347,23 @@ </li> </ol> </div> +<div class="section" id="docker-image"> +<h2>Docker Image<a class="headerlink" href="#docker-image" title="Permalink to this headline">¶</a></h2> +<p>This documentation provides an overview of the Dockerfile used to build an image containing all the necessary packages required for building <strong>openPASS</strong> (Open Source). The resulting image can be used as a development environment.</p> +<p><strong>Usage</strong></p> +<ol class="arabic"> +<li><p>Clone the <strong>openPASS</strong> (Open Source) project</p></li> +<li><p>At the root level (the folder containing the repo), execute the following command</p> +<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">docker</span> <span class="n">build</span> <span class="o">-</span><span class="n">f</span> <span class="o">./</span><span class="n">repo</span><span class="o">/</span><span class="n">utils</span><span class="o">/</span><span class="n">Dockerfile</span> <span class="o">-</span><span class="n">t</span> <span class="o"><</span><span class="n">DockerImageName</span><span class="o">></span> <span class="o">.</span> +</pre></div> +</div> +<div class="admonition note"> +<p class="admonition-title">Note</p> +<p>The Dockerfile assumes the name of the repository as “repo”. The command and the Dockerfile should be modified accordingly, if different name is used</p> +</div> +</li> +</ol> +</div> </div> @@ -355,7 +372,7 @@ </div> <footer> <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> - <a href="../other_information/10_external_dependencies.html" class="btn btn-neutral float-right" title="External Dependencies" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a> + <a href="30_coding_conventions.html" class="btn btn-neutral float-right" title="Coding Guidelines" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a> <a href="ide_support/30_vscode.html" class="btn btn-neutral float-left" title="Working with Visual Studio Code" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a> </div> @@ -363,7 +380,7 @@ <div role="contentinfo"> <p> - © Copyright 2023 OpenPASS Working Group. + © Copyright 2023 openPASS Working Group. </p> </div>
diff --git a/content/html/developer_information/30_coding_conventions.html b/content/html/developer_information/30_coding_conventions.html new file mode 100644 index 0000000..f6ffe9a --- /dev/null +++ b/content/html/developer_information/30_coding_conventions.html
@@ -0,0 +1,593 @@ + + +<!DOCTYPE html> +<html class="writer-html5" lang="en" > +<head> + <meta charset="utf-8" /> + + <meta name="viewport" content="width=device-width, initial-scale=1.0" /> + + <title>Coding Guidelines — openPASS Documentation</title> + + + + <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" /> + <link rel="stylesheet" href="../_static/pygments.css" type="text/css" /> + <link rel="stylesheet" href="../_static/tabs.css" type="text/css" /> + <link rel="stylesheet" href="../_static/css/custom.css" type="text/css" /> + + + + <link rel="shortcut icon" href="../_static/openPASS.ico"/> + + + + + + + + + <!--[if lt IE 9]> + <script src="../_static/js/html5shiv.min.js"></script> + <![endif]--> + + + <script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script> + <script src="../_static/jquery.js"></script> + <script src="../_static/underscore.js"></script> + <script src="../_static/doctools.js"></script> + <script src="../_static/tabs.js"></script> + + <script type="text/javascript" src="../_static/js/theme.js"></script> + + + <link rel="index" title="Index" href="../genindex.html" /> + <link rel="search" title="Search" href="../search.html" /> + <link rel="next" title="External Dependencies" href="../other_information/10_external_dependencies.html" /> + <link rel="prev" title="Documentation Concept" href="20_documentation.html" /> +</head> + +<body class="wy-body-for-nav"> + + + <div class="wy-grid-for-nav"> + + <nav data-toggle="wy-nav-shift" class="wy-nav-side"> + <div class="wy-side-scroll"> + <div class="wy-side-nav-search" > + + + + <a href="../index.html" class="icon icon-home"> openPASS + + + + + <img src="../_static/openPASS.png" class="logo" alt="Logo"/> + + </a> + + + + + <div class="version"> + "develop_4d7f6d4f2e22c286789082dd8cbe3eb7f5b5af62" + </div> + + + + +<div role="search"> + <form id="rtd-search-form" class="wy-form" action="../search.html" method="get"> + <input type="text" name="q" placeholder="Search docs" /> + <input type="hidden" name="check_keywords" value="yes" /> + <input type="hidden" name="area" value="default" /> + </form> +</div> + + + </div> + + + <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation"> + + + + + + + <p class="caption"><span class="caption-text">Installation Guide</span></p> +<ul> +<li class="toctree-l1"><a class="reference internal" href="../installation_guide/10_getting_started.html">Getting Started</a></li> +<li class="toctree-l1"><a class="reference internal" href="../installation_guide/15_system_requirements.html">System Requirements</a></li> +<li class="toctree-l1"><a class="reference internal" href="../installation_guide/20_install_prerequisites.html">Installing Prerequisites</a></li> +<li class="toctree-l1"><a class="reference internal" href="../installation_guide/30_install_openpass.html">Installing openPASS</a></li> +<li class="toctree-l1"><a class="reference internal" href="../installation_guide/50_further_guidance.html">Further Guidance</a></li> +<li class="toctree-l1"><a class="reference internal" href="../installation_guide/60_conan.html">Building with Conan</a></li> +</ul> +<p class="caption"><span class="caption-text">User Guides</span></p> +<ul> +<li class="toctree-l1"><a class="reference internal" href="../user_guide/10_overview.html">Overview</a></li> +<li class="toctree-l1"><a class="reference internal" href="../user_guide/20_tutorials.html">Tutorials</a></li> +<li class="toctree-l1"><a class="reference internal" href="../user_guide/30_configs_in_depth.html">Configs in Depth</a></li> +<li class="toctree-l1"><a class="reference internal" href="../user_guide/40_outputs_in_depth.html">Outputs in Depth</a></li> +<li class="toctree-l1"><a class="reference internal" href="../user_guide/50_scenario_simulation.html">Simulator</a></li> +</ul> +<p class="caption"><span class="caption-text">Advanced topics</span></p> +<ul> +<li class="toctree-l1"><a class="reference internal" href="../advanced_topics/20_simulator_advanced.html">Simulator</a></li> +<li class="toctree-l1"><a class="reference internal" href="../advanced_topics/30_testing.html">EndToEnd Test Framework</a></li> +</ul> +<p class="caption"><span class="caption-text">Developer Information</span></p> +<ul class="current"> +<li class="toctree-l1"><a class="reference internal" href="10_ide_support.html">IDE Support</a></li> +<li class="toctree-l1"><a class="reference internal" href="20_documentation.html">Documentation Concept</a></li> +<li class="toctree-l1 current"><a class="current reference internal" href="#">Coding Guidelines</a><ul> +<li class="toctree-l2"><a class="reference internal" href="#general">General</a></li> +<li class="toctree-l2"><a class="reference internal" href="#naming-conventions">Naming Conventions</a></li> +<li class="toctree-l2"><a class="reference internal" href="#clangformat">ClangFormat</a></li> +<li class="toctree-l2"><a class="reference internal" href="#commit-message-guidelines">Commit Message Guidelines</a></li> +</ul> +</li> +</ul> +<p class="caption"><span class="caption-text">Other Information</span></p> +<ul> +<li class="toctree-l1"><a class="reference internal" href="../other_information/10_external_dependencies.html">External Dependencies</a></li> +<li class="toctree-l1"><a class="reference internal" href="../other_information/20_glossary.html">Glossary</a></li> +<li class="toctree-l1"><a class="reference internal" href="../other_information/30_gui_plugins.html">GUI Plugins</a></li> +<li class="toctree-l1"><a class="reference internal" href="../other_information/40_license.html">License</a></li> +</ul> + + + + </div> + + </div> + </nav> + + <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> + + + <nav class="wy-nav-top" aria-label="top navigation"> + + <i data-toggle="wy-nav-top" class="fa fa-bars"></i> + <a href="../index.html">openPASS</a> + + </nav> + + + <div class="wy-nav-content"> + + <div class="rst-content"> + + + + + + + + + + + + + + + + + + + +<div role="navigation" aria-label="breadcrumbs navigation"> + + <ul class="wy-breadcrumbs"> + + <li><a href="../index.html" class="icon icon-home"></a> »</li> + + <li>Coding Guidelines</li> + + + <li class="wy-breadcrumbs-aside"> + + + <a href="../_sources/developer_information/30_coding_conventions.rst.txt" rel="nofollow"> View page source</a> + + + </li> + + </ul> + + + <hr/> +</div> + <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> + <div itemprop="articleBody"> + + <div class="section" id="coding-guidelines"> +<span id="coding-conventions"></span><h1>Coding Guidelines<a class="headerlink" href="#coding-guidelines" title="Permalink to this headline">¶</a></h1> +<div class="section" id="general"> +<h2>General<a class="headerlink" href="#general" title="Permalink to this headline">¶</a></h2> +<p><strong>openPASS</strong> (Open Source) is based on modern C++ (currently C++17). For coding guidelines, please refer to <a class="reference external" href="https://github.com/isocpp/CppCoreGuidelines">ISO C++ Core Guidelines</a>.</p> +<p><strong>Headers/Sources</strong></p> +<blockquote> +<div><ul class="simple"> +<li><p>Use <code class="docutils literal notranslate"><span class="pre">*.h</span></code> as file extension for header files</p></li> +<li><p>Use <code class="docutils literal notranslate"><span class="pre">*.cpp</span></code> as file extension for source files</p></li> +</ul> +</div></blockquote> +</div> +<div class="section" id="naming-conventions"> +<h2>Naming Conventions<a class="headerlink" href="#naming-conventions" title="Permalink to this headline">¶</a></h2> +<p>Concise summarized Naming Conventions +.. literalinclude:: _static/custom_doc/NamingConventions.txt</p> +<p><strong>Namespaces</strong></p> +<blockquote> +<div><ol class="arabic simple"> +<li><p>Use lowercase for namespaces</p></li> +<li><p>Use singular form for namespaces where appropriate</p></li> +<li><p>Use base namespace <code class="docutils literal notranslate"><span class="pre">openpass</span></code></p></li> +<li><p>Core uses <code class="docutils literal notranslate"><span class="pre">openpass::core::*</span></code></p></li> +<li><p>Components use <code class="docutils literal notranslate"><span class="pre">openpass::component::*</span></code></p></li> +<li><p>Use the appropriate namespace for the type your component +* <code class="docutils literal notranslate"><span class="pre">openpass::component::algorithm</span></code> +* <code class="docutils literal notranslate"><span class="pre">openpass::component::sensor</span></code> +* <code class="docutils literal notranslate"><span class="pre">openpass::component::dynamics</span></code> +* <code class="docutils literal notranslate"><span class="pre">openpass::component::driver</span></code> +* …</p></li> +<li><p>Code with shared scope (e.g. <code class="docutils literal notranslate"><span class="pre">common</span></code>) namespaces are separated in +* For everyone <code class="docutils literal notranslate"><span class="pre">openpass::common</span></code> e.g. <code class="docutils literal notranslate"><span class="pre">openpass::common::XmlParser</span></code> +* Common for components <code class="docutils literal notranslate"><span class="pre">openpass::component::common</span></code> e.g. <code class="docutils literal notranslate"><span class="pre">openpass::components::Ports</span></code> +* For the core only <code class="docutils literal notranslate"><span class="pre">openpass::core::common</span></code> e.g. <code class="docutils literal notranslate"><span class="pre">openpass::core::common::Parameters</span></code></p></li> +<li><p>Discussion: <code class="docutils literal notranslate"><span class="pre">openpass::type::*</span></code> +Example: <code class="docutils literal notranslate"><span class="pre">openpass::type::Vector2D,</span> <span class="pre">openpass::type::OpenDriveId</span></code></p></li> +</ol> +</div></blockquote> +<p><strong>Interfaces</strong></p> +<blockquote> +<div><ol class="arabic"> +<li><p>Interfaces should be named descriptively according to the functionality they outline with an <code class="docutils literal notranslate"><span class="pre">UpperCamelCase</span></code> name</p> +<p>Example: Interface for the <strong>world</strong> = <code class="docutils literal notranslate"><span class="pre">class</span> <span class="pre">WorldInterface</span></code></p> +</li> +<li><dl class="simple"> +<dt>Interfaces are abstract classes, and as such provide pure virtual functions only, withtout any default implementation. For example:</dt><dd><p><code class="docutils literal notranslate"><span class="pre">virtual</span> <span class="pre">double</span> <span class="pre">GetDistance()</span> <span class="pre">const</span> <span class="pre">=</span> <span class="pre">0;</span></code></p> +</dd> +</dl> +</li> +<li><p>Interface methods <strong>do not</strong> exibit default parameters.</p></li> +<li><p>We excessively use <strong>gmock</strong>, so for every interface a fake interface should be provided</p> +<p>Example: <code class="docutils literal notranslate"><span class="pre">class</span> <span class="pre">FakeWorld</span> <span class="pre">:</span> <span class="pre">public</span> <span class="pre">WorldInterface</span> <span class="pre">{...};</span></code></p> +<p>Note: Following <strong>*Roy Osherove*</strong>, we use Fake instead of Mock, whick allows to distinguish Mocks and +Stubs more easily in the code</p> +</li> +</ol> +</div></blockquote> +<p><strong>Classes</strong></p> +<blockquote> +<div><ol class="arabic"> +<li><p>Classes should be named descriptively according to the functionality they implement with an <code class="docutils literal notranslate"><span class="pre">UpperCamelCase</span></code> name</p></li> +<li><p>A Class implementing an Interface should have the Interfaces name (see below), with the Interface portion removed. For example: +.. code-block:</p> +<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="k">class</span> <span class="nc">AgentBlueprint</span> <span class="p">:</span> <span class="n">public</span> <span class="n">AgentBlueprintInterface</span> <span class="p">{</span><span class="o">...</span><span class="p">};</span> +</pre></div> +</div> +</li> +</ol> +</div></blockquote> +<p><strong>Methods</strong></p> +<blockquote> +<div><ol class="arabic"> +<li><p>Methods should be descriptively named in <code class="docutils literal notranslate"><span class="pre">UpperCamelCase</span></code></p> +<p>Example: Method for retrieving the time of day should be named <code class="docutils literal notranslate"><span class="pre">GetTimeOfDay()</span></code></p> +</li> +</ol> +</div></blockquote> +<p><strong>Member Variables</strong></p> +<blockquote> +<div><ol class="arabic"> +<li><p>Member variables should be descriptively named in <code class="docutils literal notranslate"><span class="pre">lowerCamelCase</span></code></p></li> +<li><p>Normally, it is sufficient to use the classes name directly.</p> +<p>Example: The member variable containing the AgentNetwork should be named <code class="docutils literal notranslate"><span class="pre">agentNetwork</span></code></p> +</li> +</ol> +</div></blockquote> +<p><strong>Input / Output Signal Naming</strong></p> +<blockquote> +<div><ol class="arabic"> +<li><p>Components use a special form of signal transmission. For easier use, the following abstraction is recommended: +.. code-block:</p> +<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">std</span><span class="p">::</span><span class="nb">map</span><span class="o"><</span><span class="nb">int</span><span class="p">,</span> <span class="n">ComponentPort</span> <span class="o">*></span> <span class="n">outputPorts</span><span class="p">;</span> +<span class="nb">bool</span> <span class="n">success</span> <span class="o">=</span> <span class="n">outputPorts</span><span class="o">.</span><span class="n">at</span><span class="p">(</span><span class="n">localLinkId</span><span class="p">)</span><span class="o">-></span><span class="n">SetSignalValue</span><span class="p">(</span><span class="n">data</span><span class="p">);</span> +</pre></div> +</div> +<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">std</span><span class="p">::</span><span class="nb">map</span><span class="o"><</span><span class="nb">int</span><span class="p">,</span> <span class="n">ComponentPort</span> <span class="o">*></span> <span class="n">inputPorts</span><span class="p">;</span> +<span class="nb">bool</span> <span class="n">success</span> <span class="o">=</span> <span class="n">inputPorts</span><span class="o">.</span><span class="n">at</span><span class="p">(</span><span class="n">localLinkId</span><span class="p">)</span><span class="o">-></span><span class="n">GetSignalValue</span><span class="p">(</span><span class="n">data</span><span class="p">);</span> +</pre></div> +</div> +</li> +<li><p>Discussion: Wrap in <code class="docutils literal notranslate"><span class="pre">openpass::components::common::Port</span></code> and further +<code class="docutils literal notranslate"><span class="pre">openpass::components::common::Ports</span></code></p></li> +</ol> +</div></blockquote> +<p><strong>Additional Information</strong></p> +<blockquote> +<div><ol class="arabic simple"> +<li><p>Use <code class="docutils literal notranslate"><span class="pre">UpperCamelCase</span></code> for abbreviations used in files, classes, methods, or variables</p></li> +<li><p>This does not apply if the abbreviation is the entire name or the beginning of the name - in such a case the name is written with the rules for the appropriate type</p> +<ul class="simple"> +<li><p>int ID→int id</p></li> +<li><p>class AgentID→ class AgentId</p></li> +<li><p>ADASDriver.cpp→adasDriver.cpp</p></li> +</ul> +</li> +<li><p>Avoid public class data members. If unavoidable, use <code class="docutils literal notranslate"><span class="pre">lowerCamelCase</span></code></p></li> +<li><p>Enums should be preferably defined as enum class; as such, enum names should be in <code class="docutils literal notranslate"><span class="pre">UpperCamelCase</span></code></p></li> +<li><p>Decorate container by type aliases and use UpperCamelCase. For example:</p></li> +</ol> +<blockquote> +<div><div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">using</span> <span class="n">FooParts</span> <span class="o">=</span> <span class="n">std</span><span class="p">::</span><span class="n">vector</span><span class="o"><</span><span class="n">FooPart</span><span class="o">></span><span class="p">;</span> +</pre></div> +</div> +</div></blockquote> +</div></blockquote> +<p><strong>Avoid</strong></p> +<blockquote> +<div><ol class="arabic simple"> +<li><p>Do <strong>not</strong> use Hungarian notation for variables names (iCounter → counter)</p></li> +<li><p>Do <strong>not</strong> specify the type of the underlying implementation (partMap→ parts)</p></li> +<li><p>Do <strong>not</strong> use magic numbers in the code; explicitly define constants instead</p></li> +<li><p>Do <strong>not</strong> use global variables</p></li> +</ol> +</div></blockquote> +<p><strong>Exceptions</strong></p> +<blockquote> +<div><ol class="arabic"> +<li><p>Autogenerated code does not need to follow the coding conventions</p> +<p>Example:: Signals/Slots (QT): <code class="docutils literal notranslate"><span class="pre">void</span> <span class="pre">on_button_clicked();</span></code></p> +</li> +</ol> +</div></blockquote> +<p><strong>Documentation</strong></p> +<blockquote> +<div><ol class="arabic"> +<li><p>The following should be documented +* Public functions and class methods +* Classes +* File headers +* Constants +* Private functions or methods with more than 3 arguments and/or complex functionality??</p></li> +<li><p>Language +* Document “what” it does rather than describing “why” +* Third-person singular verbs should be used to describe what it does</p></li> +<li><p>Use the below methods to comment in source code. The below 2 syntaxes must be placed just above an entity.</p> +<p>Multi line comments</p> +<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>//! … comments… +//! … comments… +//! … comments… +</pre></div> +</div> +<p>Single line comments</p> +<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o">///</span> <span class="n">Comments</span><span class="o">.</span> +</pre></div> +</div> +</li> +<li><p>Use the following structural commands</p> +<table class="colwidths-given docutils align-default"> +<colgroup> +<col style="width: 33%" /> +<col style="width: 67%" /> +</colgroup> +<thead> +<tr class="row-odd"><th class="head"><p>Syntax</p></th> +<th class="head"><p>Definition</p></th> +</tr> +</thead> +<tbody> +<tr class="row-even"><td><p>@file</p></td> +<td><p>The file name must be present in the file header</p></td> +</tr> +<tr class="row-odd"><td><p>@param[in/out]</p></td> +<td><p>Parameter documentation for functions</p></td> +</tr> +<tr class="row-even"><td><p>@page</p></td> +<td><p>Markdown page name</p></td> +</tr> +</tbody> +</table> +</li> +<li><p>Use the following syntax for parameter description</p> +<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="nd">@param</span><span class="p">[</span><span class="ow">in</span><span class="o">/</span><span class="n">out</span><span class="p">]</span> <span class="o"><</span><span class="n">variable</span> <span class="n">name</span><span class="o">></span> <span class="o"><</span><span class="n">variable</span> <span class="n">description</span><span class="o">></span> +</pre></div> +</div> +</li> +<li><p>All parameters description should be aligned as shown below to make them more readable.</p> +<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="nd">@param</span><span class="p">[</span><span class="ow">in</span><span class="p">]</span> <span class="n">shortName</span> <span class="n">Description</span><span class="o">.</span> +<span class="nd">@param</span><span class="p">[</span><span class="ow">in</span><span class="p">]</span> <span class="n">longerName</span> <span class="n">Description</span><span class="o">.</span> +<span class="nd">@param</span><span class="p">[</span><span class="n">out</span><span class="p">]</span> <span class="n">veryLongName</span> <span class="n">Description</span><span class="o">.</span> +</pre></div> +</div> +</li> +<li><p>Example</p> +<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>/// @file main.c +#include<stdio.h> + +/// Mathematical constant PI +#define PI 3.1415 + +/// Radius in meters +#define RADIUS_M 7.82 + +//! Calculates the area of the circle. +//! +//! @param[in] radius Radius of the circle +//! @param[out] area Area of the circle +float CalculateArea(float radius) +{ + float area; + area = PI * radius * radius; + return area; +} +</pre></div> +</div> +</li> +<li><p>Do not comment on polymorph methods (virtual base → override), unless there is a severe change</p></li> +</ol> +</div></blockquote> +<p><strong>End Of Line</strong></p> +<blockquote> +<div><ol class="arabic simple"> +<li><p>Native end of line (EOL) should be used in the working directory</p></li> +<li><p>The <code class="docutils literal notranslate"><span class="pre">.gitattributes</span></code> configuration file provides correct EOL handling for <code class="docutils literal notranslate"><span class="pre">git</span></code> related commands and actions</p></li> +<li><p>When editing files</p> +<ul class="simple"> +<li><p>Trim trailing whitespaces</p></li> +<li><p>Single EOL at end of files</p></li> +<li><p>Use spaces for tabs (use tab size according to coding guidelines or existing file contents)</p></li> +</ul> +</li> +</ol> +</div></blockquote> +<p>See <a class="reference internal" href="ide_support/30_vscode.html#vscode-user-settings"><span class="std std-ref">Example VSCode user settings</span></a>.</p> +</div> +<div class="section" id="clangformat"> +<h2>ClangFormat<a class="headerlink" href="#clangformat" title="Permalink to this headline">¶</a></h2> +<p>To ensure consistent and readable code across the project, <strong>ClangFormat</strong> is recommended.</p> +<div class="admonition note"> +<p class="admonition-title">Note</p> +<p>The following guidelines are based on ClangFormat version 15.0.7</p> +</div> +<p><strong>Installing ClangFormat</strong></p> +<p>To install <strong>ClangFormat 15.0.7</strong>, execute the following command depending on the operating system.</p> +<div class="sphinx-tabs docutils container"> +<div aria-label="Tabbed content" class="closeable" role="tablist"><button aria-controls="panel-0-0-0" aria-selected="true" class="sphinx-tabs-tab" id="tab-0-0-0" name="0-0" role="tab" tabindex="0">Windows</button><button aria-controls="panel-0-0-1" aria-selected="false" class="sphinx-tabs-tab" id="tab-0-0-1" name="0-1" role="tab" tabindex="-1">Linux (Debian Bookworm or Ubuntu 22.04)</button></div><div aria-labelledby="tab-0-0-0" class="sphinx-tabs-panel" id="panel-0-0-0" name="0-0" role="tabpanel" tabindex="0"><div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">pacman</span> <span class="o">-</span><span class="n">S</span> <span class="n">mingw</span><span class="o">-</span><span class="n">w64</span><span class="o">-</span><span class="n">x86_64</span><span class="o">-</span><span class="n">clang</span> +</pre></div> +</div> +</div><div aria-labelledby="tab-0-0-1" class="sphinx-tabs-panel" hidden="true" id="panel-0-0-1" name="0-1" role="tabpanel" tabindex="0"><div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">apt</span> <span class="o">-</span><span class="n">y</span> <span class="n">install</span> <span class="n">clang</span><span class="o">-</span><span class="nb">format</span> +</pre></div> +</div> +</div></div> +<p><strong>Configuring ClangFormat</strong></p> +<p>To configure ClangFormat, create a <cite>.clang-format</cite> file in the root directory of your project. Below is the configuration used in <strong>openPASS</strong> (Open Source):</p> +<blockquote> +<div><div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o">---</span> +<span class="n">BasedOnStyle</span><span class="p">:</span> <span class="n">Google</span> +<span class="n">AccessModifierOffset</span><span class="p">:</span> <span class="o">-</span><span class="mi">2</span> +<span class="n">AllowShortFunctionsOnASingleLine</span><span class="p">:</span> <span class="n">Inline</span> +<span class="n">AlignOperands</span><span class="p">:</span> <span class="n">AlignAfterOperator</span> +<span class="n">BinPackArguments</span><span class="p">:</span> <span class="n">false</span> +<span class="n">BinPackParameters</span><span class="p">:</span> <span class="n">false</span> +<span class="n">BreakBeforeBraces</span><span class="p">:</span> <span class="n">Allman</span> +<span class="n">BreakBeforeBinaryOperators</span><span class="p">:</span> <span class="n">All</span> +<span class="n">ColumnLimit</span><span class="p">:</span> <span class="mi">120</span> +<span class="n">SpacesInLineCommentPrefix</span><span class="p">:</span> + <span class="n">Minimum</span><span class="p">:</span> <span class="mi">0</span> + <span class="n">Maximum</span><span class="p">:</span> <span class="mi">1</span> +<span class="n">CommentPragmas</span><span class="p">:</span> <span class="s1">'^</span><span class="se">\\</span><span class="s1">.+'</span> +<span class="n">IncludeCategories</span><span class="p">:</span> + <span class="o">-</span> <span class="n">Regex</span><span class="p">:</span> <span class="s1">'^((<|")(gtest|gmock)/)'</span> + <span class="n">Priority</span><span class="p">:</span> <span class="o">-</span><span class="mi">1</span> + <span class="o">-</span> <span class="n">Regex</span><span class="p">:</span> <span class="s1">'^<[^Q]'</span> + <span class="n">Priority</span><span class="p">:</span> <span class="mi">1</span> + <span class="o">-</span> <span class="n">Regex</span><span class="p">:</span> <span class="s1">'^<Q'</span> + <span class="n">Priority</span><span class="p">:</span> <span class="mi">2</span> +</pre></div> +</div> +</div></blockquote> +<p><strong>Running ClangFormat</strong></p> +<p>To format the code using ClangFormat, run the following command in the terminal:</p> +<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>clang-format -i <span class="o">[</span>source_file<span class="o">(</span>s<span class="o">)]</span> +</pre></div> +</div> +<p>Replace <cite>[source_file(s)]</cite> with the path(s) to the file(s) to format. The <cite>-i</cite> option tells ClangFormat to modify the files in-place.</p> +</div> +<div class="section" id="commit-message-guidelines"> +<h2>Commit Message Guidelines<a class="headerlink" href="#commit-message-guidelines" title="Permalink to this headline">¶</a></h2> +<p><strong>Overview</strong></p> +<p>This section outlines the guidelines for writing commit messages in openPASS repository. Following these guidelines ensures that commit messages are clear, descriptive, and help facilitate collaboration among team members. +This section uses excerpts from <a class="reference external" href="https://www.conventionalcommits.org/en/v1.0.0/">Conventional Commits</a> licensed under <a class="reference external" href="https://creativecommons.org/licenses/by/3.0/">CC BY 3.0</a> by it’s authors.</p> +<p><strong>Commit Message Format</strong></p> +<p>Each commit message should consist of a single short summary line (recommended, up to 50 characters) followed by a more detailed description (if necessary). +The message should adhere to the following format:</p> +<blockquote> +<div><blockquote> +<div><div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o"><</span><span class="nb">type</span><span class="o">></span><span class="p">[</span><span class="n">optional</span> <span class="n">scope</span><span class="p">]:</span> <span class="o"><</span><span class="n">description</span><span class="o">></span> + +<span class="p">[</span><span class="n">optional</span> <span class="n">body</span><span class="p">]</span> + +<span class="p">[</span><span class="n">optional</span> <span class="n">footer</span><span class="p">(</span><span class="n">s</span><span class="p">)]</span> +</pre></div> +</div> +</div></blockquote> +<ol class="arabic simple"> +<li><p>The <code class="docutils literal notranslate"><span class="pre"><type></span></code> part represents the type of the commit, which helps in categorizing the nature of the changes. The following types are allowed:</p> +<ul class="simple"> +<li><p><code class="docutils literal notranslate"><span class="pre">feat</span></code>: A new feature or enhancement.</p></li> +<li><p><code class="docutils literal notranslate"><span class="pre">fix</span></code>: A bug fix.</p></li> +<li><p><code class="docutils literal notranslate"><span class="pre">docs</span></code>: Documentation-related changes.</p></li> +<li><p><code class="docutils literal notranslate"><span class="pre">style</span></code>: Code style changes (e.g., formatting, spacing).</p></li> +<li><p><code class="docutils literal notranslate"><span class="pre">refactor</span></code>: Code refactoring without adding new features or fixing bugs.</p></li> +<li><p><code class="docutils literal notranslate"><span class="pre">test</span></code>: Adding or improving tests.</p></li> +<li><p><code class="docutils literal notranslate"><span class="pre">chore</span></code>: Maintenance tasks, build changes, or other non-functional modifications.</p></li> +<li><p><code class="docutils literal notranslate"><span class="pre">ci</span></code>: Changes related to CI.</p></li> +<li><p><code class="docutils literal notranslate"><span class="pre">build</span></code>: Modifications related to build step.</p></li> +<li><p><code class="docutils literal notranslate"><span class="pre">perf</span></code>: Modifications related to performance improvements.</p></li> +<li><p><code class="docutils literal notranslate"><span class="pre">revert</span></code>: Revert any code changes.</p></li> +</ul> +</li> +<li><p>The <code class="docutils literal notranslate"><span class="pre"><optional</span> <span class="pre">scope></span></code> section is optional but is used to provide additional contextual information and is contained within parenthesis.</p></li> +<li><p>The <code class="docutils literal notranslate"><span class="pre"><description></span></code> is a brief description of the changes made in the commit. It should be concise yet informative and is recommended to not exceed 50 characters.</p></li> +<li><p>The <code class="docutils literal notranslate"><span class="pre"><optional</span> <span class="pre">body></span></code> section is optional but recommended, especially for complex changes or when further explanation is needed. This section should provide additional context, justification, and details about the changes made. Use bullet points for better readability when necessary.</p></li> +<li><p>The <code class="docutils literal notranslate"><span class="pre"><optional</span> <span class="pre">footer></span></code> section is also optional but can be used to provide supplementary information related to the commit.</p></li> +</ol> +</div></blockquote> +</div> +</div> + + + </div> + + </div> + <footer> + <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> + <a href="../other_information/10_external_dependencies.html" class="btn btn-neutral float-right" title="External Dependencies" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a> + <a href="20_documentation.html" class="btn btn-neutral float-left" title="Documentation Concept" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a> + </div> + + <hr/> + + <div role="contentinfo"> + <p> + © Copyright 2023 openPASS Working Group. + + </p> + </div> + + + + Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a + + <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a> + + provided by <a href="https://readthedocs.org">Read the Docs</a>. + +</footer> + </div> + </div> + + </section> + + </div> + + + <script type="text/javascript"> + jQuery(function () { + SphinxRtdTheme.Navigation.enable(true); + }); + </script> + + + + + + +</body> +</html> \ No newline at end of file
diff --git a/content/html/developer_information/ide_support/20_qt_creator.html b/content/html/developer_information/ide_support/20_qt_creator.html index 06421f1..74521bc 100644 --- a/content/html/developer_information/ide_support/20_qt_creator.html +++ b/content/html/developer_information/ide_support/20_qt_creator.html
@@ -7,7 +7,7 @@ <meta name="viewport" content="width=device-width, initial-scale=1.0" /> - <title>Working with Qt Creator — OpenPASS Documentation</title> + <title>Working with Qt Creator — openPASS Documentation</title> @@ -70,7 +70,7 @@ <div class="version"> - "openPASS v0.11" + "develop_4d7f6d4f2e22c286789082dd8cbe3eb7f5b5af62" </div> @@ -100,7 +100,7 @@ <li class="toctree-l1"><a class="reference internal" href="../../installation_guide/10_getting_started.html">Getting Started</a></li> <li class="toctree-l1"><a class="reference internal" href="../../installation_guide/15_system_requirements.html">System Requirements</a></li> <li class="toctree-l1"><a class="reference internal" href="../../installation_guide/20_install_prerequisites.html">Installing Prerequisites</a></li> -<li class="toctree-l1"><a class="reference internal" href="../../installation_guide/30_install_openpass.html">Installing OpenPASS</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../installation_guide/30_install_openpass.html">Installing openPASS</a></li> <li class="toctree-l1"><a class="reference internal" href="../../installation_guide/50_further_guidance.html">Further Guidance</a></li> <li class="toctree-l1"><a class="reference internal" href="../../installation_guide/60_conan.html">Building with Conan</a></li> </ul> @@ -108,10 +108,9 @@ <ul> <li class="toctree-l1"><a class="reference internal" href="../../user_guide/10_overview.html">Overview</a></li> <li class="toctree-l1"><a class="reference internal" href="../../user_guide/20_tutorials.html">Tutorials</a></li> -<li class="toctree-l1"><a class="reference internal" href="../../user_guide/30_gui_plugins.html">GUI Plugins</a></li> -<li class="toctree-l1"><a class="reference internal" href="../../user_guide/40_configs_in_depth.html">Configs in Depth</a></li> -<li class="toctree-l1"><a class="reference internal" href="../../user_guide/50_outputs_in_depth.html">Outputs in Depth</a></li> -<li class="toctree-l1"><a class="reference internal" href="../../user_guide/60_scenario_simulation.html">Simulator</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../user_guide/30_configs_in_depth.html">Configs in Depth</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../user_guide/40_outputs_in_depth.html">Outputs in Depth</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../user_guide/50_scenario_simulation.html">Simulator</a></li> </ul> <p class="caption"><span class="caption-text">Advanced topics</span></p> <ul> @@ -139,12 +138,14 @@ </ul> </li> <li class="toctree-l1"><a class="reference internal" href="../20_documentation.html">Documentation Concept</a></li> +<li class="toctree-l1"><a class="reference internal" href="../30_coding_conventions.html">Coding Guidelines</a></li> </ul> <p class="caption"><span class="caption-text">Other Information</span></p> <ul> <li class="toctree-l1"><a class="reference internal" href="../../other_information/10_external_dependencies.html">External Dependencies</a></li> <li class="toctree-l1"><a class="reference internal" href="../../other_information/20_glossary.html">Glossary</a></li> -<li class="toctree-l1"><a class="reference internal" href="../../other_information/30_license.html">License</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../other_information/30_gui_plugins.html">GUI Plugins</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../other_information/40_license.html">License</a></li> </ul> @@ -266,7 +267,7 @@ <div class="admonition-todo admonition" id="id1"> <p class="admonition-title">Todo</p> <p>The configuration is still “itchy”, as Qt creator changes the interface with every version -See <a class="reference external" href="https://gitlab.eclipse.org/eclipse/simopenpass/simopenpass/-/issues/149">https://gitlab.eclipse.org/eclipse/simopenpass/simopenpass/-/issues/149</a></p> +See <a class="reference external" href="https://gitlab.eclipse.org/eclipse/openpass/opSimulation/-/issues/149">https://gitlab.eclipse.org/eclipse/openpass/opSimulation/-/issues/149</a></p> </div> </li> </ol> @@ -287,7 +288,7 @@ <div class="admonition-todo admonition" id="id3"> <p class="admonition-title">Todo</p> <p>The configuration is still “itchy”, as Qt creator changes the interface with every version -See <a class="reference external" href="https://gitlab.eclipse.org/eclipse/simopenpass/simopenpass/-/issues/149">https://gitlab.eclipse.org/eclipse/simopenpass/simopenpass/-/issues/149</a></p> +See <a class="reference external" href="https://gitlab.eclipse.org/eclipse/openpass/opSimulation/-/issues/149">https://gitlab.eclipse.org/eclipse/openpass/opSimulation/-/issues/149</a></p> </div> </li> </ol> @@ -346,7 +347,7 @@ <div role="contentinfo"> <p> - © Copyright 2023 OpenPASS Working Group. + © Copyright 2023 openPASS Working Group. </p> </div>
diff --git a/content/html/developer_information/ide_support/30_vscode.html b/content/html/developer_information/ide_support/30_vscode.html index 4ad76db..411918f 100644 --- a/content/html/developer_information/ide_support/30_vscode.html +++ b/content/html/developer_information/ide_support/30_vscode.html
@@ -7,7 +7,7 @@ <meta name="viewport" content="width=device-width, initial-scale=1.0" /> - <title>Working with Visual Studio Code — OpenPASS Documentation</title> + <title>Working with Visual Studio Code — openPASS Documentation</title> @@ -71,7 +71,7 @@ <div class="version"> - "openPASS v0.11" + "develop_4d7f6d4f2e22c286789082dd8cbe3eb7f5b5af62" </div> @@ -101,7 +101,7 @@ <li class="toctree-l1"><a class="reference internal" href="../../installation_guide/10_getting_started.html">Getting Started</a></li> <li class="toctree-l1"><a class="reference internal" href="../../installation_guide/15_system_requirements.html">System Requirements</a></li> <li class="toctree-l1"><a class="reference internal" href="../../installation_guide/20_install_prerequisites.html">Installing Prerequisites</a></li> -<li class="toctree-l1"><a class="reference internal" href="../../installation_guide/30_install_openpass.html">Installing OpenPASS</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../installation_guide/30_install_openpass.html">Installing openPASS</a></li> <li class="toctree-l1"><a class="reference internal" href="../../installation_guide/50_further_guidance.html">Further Guidance</a></li> <li class="toctree-l1"><a class="reference internal" href="../../installation_guide/60_conan.html">Building with Conan</a></li> </ul> @@ -109,10 +109,9 @@ <ul> <li class="toctree-l1"><a class="reference internal" href="../../user_guide/10_overview.html">Overview</a></li> <li class="toctree-l1"><a class="reference internal" href="../../user_guide/20_tutorials.html">Tutorials</a></li> -<li class="toctree-l1"><a class="reference internal" href="../../user_guide/30_gui_plugins.html">GUI Plugins</a></li> -<li class="toctree-l1"><a class="reference internal" href="../../user_guide/40_configs_in_depth.html">Configs in Depth</a></li> -<li class="toctree-l1"><a class="reference internal" href="../../user_guide/50_outputs_in_depth.html">Outputs in Depth</a></li> -<li class="toctree-l1"><a class="reference internal" href="../../user_guide/60_scenario_simulation.html">Simulator</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../user_guide/30_configs_in_depth.html">Configs in Depth</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../user_guide/40_outputs_in_depth.html">Outputs in Depth</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../user_guide/50_scenario_simulation.html">Simulator</a></li> </ul> <p class="caption"><span class="caption-text">Advanced topics</span></p> <ul> @@ -141,12 +140,14 @@ </ul> </li> <li class="toctree-l1"><a class="reference internal" href="../20_documentation.html">Documentation Concept</a></li> +<li class="toctree-l1"><a class="reference internal" href="../30_coding_conventions.html">Coding Guidelines</a></li> </ul> <p class="caption"><span class="caption-text">Other Information</span></p> <ul> <li class="toctree-l1"><a class="reference internal" href="../../other_information/10_external_dependencies.html">External Dependencies</a></li> <li class="toctree-l1"><a class="reference internal" href="../../other_information/20_glossary.html">Glossary</a></li> -<li class="toctree-l1"><a class="reference internal" href="../../other_information/30_license.html">License</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../other_information/30_gui_plugins.html">GUI Plugins</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../other_information/40_license.html">License</a></li> </ul> @@ -262,7 +263,7 @@ </tbody> </table> <ol class="arabic simple" start="3"> -<li><p>Open the repository as folder, e.g. by calling <code class="docutils literal notranslate"><span class="pre">code</span> <span class="pre">simopenpass</span></code> after checking out. +<li><p>Open the repository as folder, e.g. by calling <code class="docutils literal notranslate"><span class="pre">code</span> <span class="pre">openpass</span></code> after checking out. Say yes, when CMake Tools ask to configure the project. This creates a <code class="docutils literal notranslate"><span class="pre">build</span></code> folder, <strong>but fails</strong> (well, we need to config some stages).</p></li> </ol> @@ -278,6 +279,12 @@ Windows will then look for DLLs within the msys64 folders, allowing native execution. <code class="docutils literal notranslate"><span class="pre">CHERE_INVOKING</span></code> makes sure the shell stays in the current working directory. As investigated recently, the <code class="docutils literal notranslate"><span class="pre">C:\msys64\usr\bin``must</span> <span class="pre">also</span> <span class="pre">be</span> <span class="pre">added</span> <span class="pre">to</span> <span class="pre">the</span> <span class="pre">``PATH</span></code> environment variable in order to resolve dependencies to <code class="docutils literal notranslate"><span class="pre">cygpath.exe</span></code>.</p> +<div class="admonition note"> +<p class="admonition-title">Note</p> +<p>If <code class="docutils literal notranslate"><span class="pre">C:\msys64</span></code> is not already listed in <code class="docutils literal notranslate"><span class="pre">PATH</span></code> variable, then add <code class="docutils literal notranslate"><span class="pre">C:\msys64</span></code> in <code class="docutils literal notranslate"><span class="pre">PATH</span></code> variable before adding <code class="docutils literal notranslate"><span class="pre">C:\msys64\usr\bin</span></code> to the <code class="docutils literal notranslate"><span class="pre">PATH</span></code> variable. +If there are any other Unix like environments installed on Windows operating systems (example: cygwin), there might even be file collisions when calling certain cmake commands. +Therefore, it is suggested to add <code class="docutils literal notranslate"><span class="pre">C:\msys64</span></code> in <code class="docutils literal notranslate"><span class="pre">PATH</span></code> variable before any other Unix like environmental calls.</p> +</div> <p>Either set environment variable through the <code class="docutils literal notranslate"><span class="pre">Windows</span> <span class="pre">PowerShell</span></code></p> <div class="highlight-shell notranslate"><div class="highlight"><pre><span></span><span class="c1"># check if set</span> <span class="nb">echo</span> <span class="si">${</span><span class="nv">env</span><span class="p">:</span><span class="nv">path</span><span class="si">}</span> @@ -357,7 +364,7 @@ </div></div> </div> <div class="section" id="user-settings"> -<h3>User Settings<a class="headerlink" href="#user-settings" title="Permalink to this headline">¶</a></h3> +<span id="vscode-user-settings"></span><h3>User Settings<a class="headerlink" href="#user-settings" title="Permalink to this headline">¶</a></h3> <ol class="arabic"> <li><p>Execute <code class="docutils literal notranslate"><span class="pre">Ctrl+Shift+P</span></code>: <code class="docutils literal notranslate"><span class="pre">Preferences</span> <span class="pre">Open</span> <span class="pre">Workspace</span> <span class="pre">Settings</span> <span class="pre">(JSON)</span></code></p></li> <li><p>Insert/Update:</p> @@ -438,7 +445,13 @@ <span class="normal">72</span> <span class="normal">73</span> <span class="normal">74</span> -<span class="normal">75</span></pre></div></td><td class="code"><div class="highlight"><pre><span></span><span class="p">{</span> +<span class="normal">75</span> +<span class="normal">76</span> +<span class="normal">77</span> +<span class="normal">78</span> +<span class="normal">79</span> +<span class="normal">80</span> +<span class="normal">81</span></pre></div></td><td class="code"><div class="highlight"><pre><span></span><span class="p">{</span> <span class="c1">//</span> <span class="c1">// CMAKE</span> <span class="c1">//</span> @@ -453,12 +466,11 @@ <span class="s2">"cmake.parallelJobs"</span><span class="o">:</span> <span class="mf">4</span><span class="p">,</span> <span class="c1">// See openPASS documentation for individual WITH_* settings</span> <span class="s2">"cmake.configureArgs"</span><span class="o">:</span> <span class="p">[</span> - <span class="s2">"-DCMAKE_INSTALL_PREFIX=C:\\OpenPASS\\bin\\core"</span><span class="p">,</span> + <span class="s2">"-DCMAKE_INSTALL_PREFIX=C:\\openPASS\\bin\\core"</span><span class="p">,</span> <span class="c1">// Adjust paths depending on your system</span> - <span class="s2">"-DCMAKE_PREFIX_PATH=${workspaceRoot}/deps/thirdParty/win64/FMILibrary;${workspaceRoot}/deps/thirdParty/win64/osi;${workspaceRoot}/deps/thirdParty/win64/minizip;${command:mingw64.root};${command:mingw64.root}/bin;${command:mingw64.root}/lib"</span><span class="p">,</span> + <span class="s2">"-DCMAKE_PREFIX_PATH=${workspaceFolder}/deps/thirdParty/win64/minizip;${workspaceFolder}/deps/thirdParty/win64/FMILibrary;${workspaceFolder}/deps/thirdParty/win64/protobuf-shared;${workspaceFolder}/deps/thirdParty/win64/protobuf;${workspaceFolder}/deps/thirdParty/win64/zlib;${workspaceFolder}/deps/thirdParty/win64/osi;${workspaceFolder}/deps/thirdParty/win64/units;${workspaceFolder}/deps/thirdParty/win64/googletest;${workspaceFolder}/deps/thirdParty/win64/scenario_api;${workspaceFolder}/deps/thirdParty/win64/openScenario.v1_0.API;${workspaceFolder}/deps/thirdParty/win64/openScenarioEngine/release;${command:mingw64.root};${command:mingw64.root}/bin;${command:mingw64.root}/lib"</span><span class="p">,</span> <span class="s2">"-DUSE_CCACHE=ON"</span><span class="p">,</span> <span class="s2">"-DCMAKE_BUILD_TYPE=Debug"</span><span class="p">,</span> - <span class="s2">"-DWITH_GUI=OFF"</span><span class="p">,</span> <span class="s2">"-DWITH_SIMCORE=ON"</span><span class="p">,</span> <span class="s2">"-DWITH_TESTS=ON"</span><span class="p">,</span> <span class="s2">"-DWITH_DOC=OFF"</span><span class="p">,</span> @@ -476,16 +488,16 @@ <span class="s2">"testMate.cpp.test.parallelExecutionOfExecutableLimit"</span><span class="o">:</span> <span class="mf">2</span><span class="p">,</span> <span class="c1">// Optional: Set, if you like to debug test discovery and test start issues</span> <span class="s2">"testMate.cpp.log.logfile"</span><span class="o">:</span> <span class="s2">"C:\\temp\\cpp.testmate.log"</span><span class="p">,</span> - <span class="c1">// Optional: As CTest triggers the install step, dependencies between test executables </span> + <span class="c1">// Optional: As CTest triggers the install step, dependencies between test executables</span> <span class="c1">// and openpass libraries can be resolved by linking text executables to</span> <span class="c1">// openpass install directory</span> - <span class="c1">// Alternative: Check dependencies of test executables by 'ldd <_Tests.exe> and copy </span> + <span class="c1">// Alternative: Check dependencies of test executables by 'ldd <_Tests.exe> and copy</span> <span class="c1">// libraries right next to test executable within build direcory</span> <span class="s2">"testMate.cpp.test.advancedExecutables"</span><span class="o">:</span> <span class="p">[</span> <span class="p">{</span> <span class="s2">"pattern"</span><span class="o">:</span> <span class="s2">"build/**/*{tests,Tests,TESTS}*"</span><span class="p">,</span> <span class="s2">"env"</span><span class="o">:</span> <span class="p">{</span> - <span class="s2">"Path"</span><span class="o">:</span> <span class="s2">"C:\\msys64\\mingw64\\bin;C:\\OpenPASS\\bin\\core;C:\\OpenPASS\\bin\\core\\lib;${os_env:PATH};${workspaceFolder}\\deps\\thirdParty\\win64\\FMILibrary\\lib;${workspaceFolder}\\deps\\thirdParty\\win64\\osi\\lib\\osi3"</span> + <span class="s2">"Path"</span><span class="o">:</span> <span class="s2">"C:\\msys64\\mingw64\\bin;C:\\openPASS\\bin\\core;C:\\openPASS\\bin\\core\\lib;${os_env:PATH};${workspaceFolder}\\deps\\thirdParty\\win64\\FMILibrary\\lib;${workspaceFolder}\\deps\\thirdParty\\win64\\osi\\lib\\osi3"</span> <span class="p">}</span> <span class="p">}</span> <span class="p">],</span> @@ -511,7 +523,14 @@ <span class="s2">"terminal.integrated.defaultProfile.windows"</span><span class="o">:</span> <span class="s2">"MinGW64"</span><span class="p">,</span> <span class="c1">// Enforce usage of .clang-format of modified code</span> <span class="s2">"editor.formatOnSave"</span><span class="o">:</span> <span class="kc">true</span><span class="p">,</span> - <span class="s2">"editor.formatOnSaveMode"</span><span class="o">:</span> <span class="s2">"modifications"</span> + <span class="s2">"editor.formatOnSaveMode"</span><span class="o">:</span> <span class="s2">"modifications"</span><span class="p">,</span> + <span class="c1">// EOL and whitespace enforcement</span> + <span class="s2">"editor.detectIndentation"</span><span class="o">:</span> <span class="kc">true</span><span class="p">,</span> + <span class="s2">"editor.insertSpaces"</span><span class="o">:</span> <span class="kc">true</span><span class="p">,</span> + <span class="s2">"editor.renderFinalNewline"</span><span class="o">:</span> <span class="s2">"dimmed"</span><span class="p">,</span> + <span class="s2">"files.insertFinalNewline"</span><span class="o">:</span> <span class="kc">true</span><span class="p">,</span> + <span class="s2">"files.trimFinalNewlines"</span><span class="o">:</span> <span class="kc">true</span><span class="p">,</span> + <span class="s2">"files.trimTrailingWhitespace"</span><span class="o">:</span> <span class="kc">true</span> <span class="p">}</span> </pre></div> </td></tr></table></div> @@ -552,7 +571,15 @@ <span class="normal">31</span> <span class="normal">32</span> <span class="normal">33</span> -<span class="normal">34</span></pre></div></td><td class="code"><div class="highlight"><pre><span></span><span class="p">{</span> +<span class="normal">34</span> +<span class="normal">35</span> +<span class="normal">36</span> +<span class="normal">37</span> +<span class="normal">38</span> +<span class="normal">39</span> +<span class="normal">40</span> +<span class="normal">41</span> +<span class="normal">42</span></pre></div></td><td class="code"><div class="highlight"><pre><span></span><span class="p">{</span> <span class="c1">//</span> <span class="c1">// CMAKE</span> <span class="c1">//</span> @@ -562,9 +589,8 @@ <span class="s2">"cmake.configureArgs"</span><span class="o">:</span> <span class="p">[</span> <span class="s2">"-DCMAKE_INSTALL_PREFIX=/openPASS/bin/core"</span><span class="p">,</span> <span class="c1">// Adjust paths depending on your system</span> - <span class="s2">"-DCMAKE_PREFIX_PATH=${workspaceRoot}/deps/thirdParty/linux64/FMILibrary;${workspaceRoot}/deps/thirdParty/linux64/osi;${workspaceRoot}/deps/thirdParty/linux64/minizip"</span><span class="p">,</span> + <span class="s2">"-DCMAKE_PREFIX_PATH=${workspaceFolder}/deps/thirdParty/linux64/minizip;${workspaceFolder}/deps/thirdParty/linux64/FMILibrary;${workspaceFolder}/deps/thirdParty/linux64/protobuf-shared;${workspaceFolder}/deps/thirdParty/linux64/protobuf;${workspaceFolder}/deps/thirdParty/linux64/boost;${workspaceFolder}/deps/thirdParty/linux64/zlib;${workspaceFolder}/deps/thirdParty/linux64/osi;${workspaceFolder}/deps/thirdParty/linux64/units;${workspaceFolder}/deps/thirdParty/linux64/googletest;${workspaceFolder}/deps/thirdParty/linux64/scenario_api;${workspaceFolder}/deps/thirdParty/linux64/openScenario.v1_0.API;${workspaceFolder}/deps/thirdParty/linux64/openScenarioEngine/release"</span><span class="p">,</span> <span class="s2">"-DUSE_CCACHE=ON"</span><span class="p">,</span> - <span class="s2">"-DWITH_GUI=OFF"</span><span class="p">,</span> <span class="s2">"-DWITH_SIMCORE=ON"</span><span class="p">,</span> <span class="s2">"-DWITH_TESTS=ON"</span><span class="p">,</span> <span class="s2">"-DWITH_DOC=OFF"</span><span class="p">,</span> @@ -584,7 +610,16 @@ <span class="c1">//</span> <span class="c1">// Enforce usage of .clang-format of modified code</span> <span class="s2">"editor.formatOnSave"</span><span class="o">:</span> <span class="kc">true</span><span class="p">,</span> - <span class="s2">"editor.formatOnSaveMode"</span><span class="o">:</span> <span class="s2">"modifications"</span> + <span class="s2">"editor.formatOnSaveMode"</span><span class="o">:</span> <span class="s2">"modifications"</span><span class="p">,</span> + <span class="c1">// EOL and whitespace enforcement</span> + <span class="s2">"editor.detectIndentation"</span><span class="o">:</span> <span class="kc">true</span><span class="p">,</span> + <span class="s2">"editor.insertSpaces"</span><span class="o">:</span> <span class="kc">true</span><span class="p">,</span> + <span class="s2">"editor.renderFinalNewline"</span><span class="o">:</span> <span class="s2">"dimmed"</span><span class="p">,</span> + <span class="s2">"editor.renderWhitespace"</span><span class="o">:</span> <span class="s2">"all"</span><span class="p">,</span> + <span class="s2">"editor.trimAutoWhitespace"</span><span class="o">:</span> <span class="kc">true</span><span class="p">,</span> + <span class="s2">"files.insertFinalNewline"</span><span class="o">:</span> <span class="kc">true</span><span class="p">,</span> + <span class="s2">"files.trimFinalNewlines"</span><span class="o">:</span> <span class="kc">true</span><span class="p">,</span> + <span class="s2">"files.trimTrailingWhitespace"</span><span class="o">:</span> <span class="kc">true</span> <span class="p">}</span> </pre></div> </td></tr></table></div> @@ -615,7 +650,7 @@ <span class="normal">13</span></pre></div></td><td class="code"><div class="highlight"><pre><span></span><span class="p">{</span> <span class="s2">"configurations"</span><span class="o">:</span> <span class="p">[</span> <span class="p">{</span> - <span class="s2">"name"</span><span class="o">:</span> <span class="s2">"simopenpass"</span><span class="p">,</span> + <span class="s2">"name"</span><span class="o">:</span> <span class="s2">"openpass"</span><span class="p">,</span> <span class="s2">"cStandard"</span><span class="o">:</span> <span class="s2">"c99"</span><span class="p">,</span> <span class="s2">"cppStandard"</span><span class="o">:</span> <span class="s2">"c++17"</span><span class="p">,</span> <span class="s2">"configurationProvider"</span><span class="o">:</span> <span class="s2">"ms-vscode.cmake-tools"</span><span class="p">,</span> @@ -757,10 +792,10 @@ <span class="s2">"name"</span><span class="o">:</span> <span class="s2">"opsimulation"</span><span class="p">,</span> <span class="s2">"type"</span><span class="o">:</span> <span class="s2">"cppdbg"</span><span class="p">,</span> <span class="s2">"request"</span><span class="o">:</span> <span class="s2">"launch"</span><span class="p">,</span> - <span class="s2">"program"</span><span class="o">:</span> <span class="s2">"C:\\OpenPASS\\bin\\core\\opSimulation.exe"</span><span class="p">,</span> + <span class="s2">"program"</span><span class="o">:</span> <span class="s2">"C:\\openPASS\\bin\\core\\opSimulation.exe"</span><span class="p">,</span> <span class="s2">"args"</span><span class="o">:</span> <span class="p">[],</span> <span class="s2">"stopAtEntry"</span><span class="o">:</span> <span class="kc">false</span><span class="p">,</span> - <span class="s2">"cwd"</span><span class="o">:</span> <span class="s2">"C:\\OpenPASS\\bin\\core"</span><span class="p">,</span> + <span class="s2">"cwd"</span><span class="o">:</span> <span class="s2">"C:\\openPASS\\bin\\core"</span><span class="p">,</span> <span class="s2">"environment"</span><span class="o">:</span> <span class="p">[</span> <span class="p">{</span> <span class="s2">"name"</span><span class="o">:</span> <span class="s2">"PATH"</span><span class="p">,</span> @@ -923,7 +958,7 @@ <div role="contentinfo"> <p> - © Copyright 2023 OpenPASS Working Group. + © Copyright 2023 openPASS Working Group. </p> </div>
diff --git a/content/html/genindex.html b/content/html/genindex.html index ffb940d..63a43f9 100644 --- a/content/html/genindex.html +++ b/content/html/genindex.html
@@ -7,7 +7,7 @@ <meta name="viewport" content="width=device-width, initial-scale=1.0" /> - <title>Index — OpenPASS Documentation</title> + <title>Index — openPASS Documentation</title> @@ -69,7 +69,7 @@ <div class="version"> - "openPASS v0.11" + "develop_4d7f6d4f2e22c286789082dd8cbe3eb7f5b5af62" </div> @@ -99,7 +99,7 @@ <li class="toctree-l1"><a class="reference internal" href="installation_guide/10_getting_started.html">Getting Started</a></li> <li class="toctree-l1"><a class="reference internal" href="installation_guide/15_system_requirements.html">System Requirements</a></li> <li class="toctree-l1"><a class="reference internal" href="installation_guide/20_install_prerequisites.html">Installing Prerequisites</a></li> -<li class="toctree-l1"><a class="reference internal" href="installation_guide/30_install_openpass.html">Installing OpenPASS</a></li> +<li class="toctree-l1"><a class="reference internal" href="installation_guide/30_install_openpass.html">Installing openPASS</a></li> <li class="toctree-l1"><a class="reference internal" href="installation_guide/50_further_guidance.html">Further Guidance</a></li> <li class="toctree-l1"><a class="reference internal" href="installation_guide/60_conan.html">Building with Conan</a></li> </ul> @@ -107,10 +107,9 @@ <ul> <li class="toctree-l1"><a class="reference internal" href="user_guide/10_overview.html">Overview</a></li> <li class="toctree-l1"><a class="reference internal" href="user_guide/20_tutorials.html">Tutorials</a></li> -<li class="toctree-l1"><a class="reference internal" href="user_guide/30_gui_plugins.html">GUI Plugins</a></li> -<li class="toctree-l1"><a class="reference internal" href="user_guide/40_configs_in_depth.html">Configs in Depth</a></li> -<li class="toctree-l1"><a class="reference internal" href="user_guide/50_outputs_in_depth.html">Outputs in Depth</a></li> -<li class="toctree-l1"><a class="reference internal" href="user_guide/60_scenario_simulation.html">Simulator</a></li> +<li class="toctree-l1"><a class="reference internal" href="user_guide/30_configs_in_depth.html">Configs in Depth</a></li> +<li class="toctree-l1"><a class="reference internal" href="user_guide/40_outputs_in_depth.html">Outputs in Depth</a></li> +<li class="toctree-l1"><a class="reference internal" href="user_guide/50_scenario_simulation.html">Simulator</a></li> </ul> <p class="caption"><span class="caption-text">Advanced topics</span></p> <ul> @@ -121,12 +120,14 @@ <ul> <li class="toctree-l1"><a class="reference internal" href="developer_information/10_ide_support.html">IDE Support</a></li> <li class="toctree-l1"><a class="reference internal" href="developer_information/20_documentation.html">Documentation Concept</a></li> +<li class="toctree-l1"><a class="reference internal" href="developer_information/30_coding_conventions.html">Coding Guidelines</a></li> </ul> <p class="caption"><span class="caption-text">Other Information</span></p> <ul> <li class="toctree-l1"><a class="reference internal" href="other_information/10_external_dependencies.html">External Dependencies</a></li> <li class="toctree-l1"><a class="reference internal" href="other_information/20_glossary.html">Glossary</a></li> -<li class="toctree-l1"><a class="reference internal" href="other_information/30_license.html">License</a></li> +<li class="toctree-l1"><a class="reference internal" href="other_information/30_gui_plugins.html">GUI Plugins</a></li> +<li class="toctree-l1"><a class="reference internal" href="other_information/40_license.html">License</a></li> </ul> @@ -333,7 +334,7 @@ <div role="contentinfo"> <p> - © Copyright 2023 OpenPASS Working Group. + © Copyright 2023 openPASS Working Group. </p> </div>
diff --git a/content/html/index.html b/content/html/index.html index faf4b74..9780fb2 100644 --- a/content/html/index.html +++ b/content/html/index.html
@@ -7,7 +7,7 @@ <meta name="viewport" content="width=device-width, initial-scale=1.0" /> - <title>OpenPASS Documentation — OpenPASS Documentation</title> + <title>openPASS Documentation — openPASS Documentation</title> @@ -69,7 +69,7 @@ <div class="version"> - "openPASS v0.11" + "develop_4d7f6d4f2e22c286789082dd8cbe3eb7f5b5af62" </div> @@ -99,7 +99,7 @@ <li class="toctree-l1"><a class="reference internal" href="installation_guide/10_getting_started.html">Getting Started</a></li> <li class="toctree-l1"><a class="reference internal" href="installation_guide/15_system_requirements.html">System Requirements</a></li> <li class="toctree-l1"><a class="reference internal" href="installation_guide/20_install_prerequisites.html">Installing Prerequisites</a></li> -<li class="toctree-l1"><a class="reference internal" href="installation_guide/30_install_openpass.html">Installing OpenPASS</a></li> +<li class="toctree-l1"><a class="reference internal" href="installation_guide/30_install_openpass.html">Installing openPASS</a></li> <li class="toctree-l1"><a class="reference internal" href="installation_guide/50_further_guidance.html">Further Guidance</a></li> <li class="toctree-l1"><a class="reference internal" href="installation_guide/60_conan.html">Building with Conan</a></li> </ul> @@ -107,10 +107,9 @@ <ul> <li class="toctree-l1"><a class="reference internal" href="user_guide/10_overview.html">Overview</a></li> <li class="toctree-l1"><a class="reference internal" href="user_guide/20_tutorials.html">Tutorials</a></li> -<li class="toctree-l1"><a class="reference internal" href="user_guide/30_gui_plugins.html">GUI Plugins</a></li> -<li class="toctree-l1"><a class="reference internal" href="user_guide/40_configs_in_depth.html">Configs in Depth</a></li> -<li class="toctree-l1"><a class="reference internal" href="user_guide/50_outputs_in_depth.html">Outputs in Depth</a></li> -<li class="toctree-l1"><a class="reference internal" href="user_guide/60_scenario_simulation.html">Simulator</a></li> +<li class="toctree-l1"><a class="reference internal" href="user_guide/30_configs_in_depth.html">Configs in Depth</a></li> +<li class="toctree-l1"><a class="reference internal" href="user_guide/40_outputs_in_depth.html">Outputs in Depth</a></li> +<li class="toctree-l1"><a class="reference internal" href="user_guide/50_scenario_simulation.html">Simulator</a></li> </ul> <p class="caption"><span class="caption-text">Advanced topics</span></p> <ul> @@ -121,12 +120,14 @@ <ul> <li class="toctree-l1"><a class="reference internal" href="developer_information/10_ide_support.html">IDE Support</a></li> <li class="toctree-l1"><a class="reference internal" href="developer_information/20_documentation.html">Documentation Concept</a></li> +<li class="toctree-l1"><a class="reference internal" href="developer_information/30_coding_conventions.html">Coding Guidelines</a></li> </ul> <p class="caption"><span class="caption-text">Other Information</span></p> <ul> <li class="toctree-l1"><a class="reference internal" href="other_information/10_external_dependencies.html">External Dependencies</a></li> <li class="toctree-l1"><a class="reference internal" href="other_information/20_glossary.html">Glossary</a></li> -<li class="toctree-l1"><a class="reference internal" href="other_information/30_license.html">License</a></li> +<li class="toctree-l1"><a class="reference internal" href="other_information/30_gui_plugins.html">GUI Plugins</a></li> +<li class="toctree-l1"><a class="reference internal" href="other_information/40_license.html">License</a></li> </ul> @@ -175,7 +176,7 @@ <li><a href="#" class="icon icon-home"></a> »</li> - <li>OpenPASS Documentation</li> + <li>openPASS Documentation</li> <li class="wy-breadcrumbs-aside"> @@ -195,23 +196,27 @@ <div itemprop="articleBody"> <div class="section" id="openpass-documentation"> -<h1>OpenPASS Documentation<a class="headerlink" href="#openpass-documentation" title="Permalink to this headline">¶</a></h1> -<p>The OpenPASS (Open Platform for Assessment of Safety Systems) tool is a developed framework for the simulation of interaction between traffic participants to evaluate and parametrize active safety systems. +<h1>openPASS Documentation<a class="headerlink" href="#openpass-documentation" title="Permalink to this headline">¶</a></h1> +<p>The openPASS (Open Platform for Assessment of Safety Systems) tool is a developed framework for the simulation of interaction between traffic participants to evaluate and parametrize active safety systems. The simulation is based on a specific situation configuration and can contain several simulation runs, which differ due to random parameters.</p> <p>The software suite of openPASS started as a set of stand-alone applications, which can be installed and configured individually. Over time, especially the graphical user interface evolved to a single entry point, enabling the average user to use openPASS as a “monolithic” tool.</p> -<p>This guide contains information about installation, configuration and usage of all tools in the <strong>OpenPASS</strong> environment.</p> +<p>This guide contains information about installation, configuration and usage of all tools in the <strong>openPASS</strong> environment.</p> <div class="toctree-wrapper compound"> <p class="caption"><span class="caption-text">Installation Guide</span></p> <ul> <li class="toctree-l1"><a class="reference internal" href="installation_guide/10_getting_started.html">Getting Started</a></li> <li class="toctree-l1"><a class="reference internal" href="installation_guide/15_system_requirements.html">System Requirements</a></li> <li class="toctree-l1"><a class="reference internal" href="installation_guide/20_install_prerequisites.html">Installing Prerequisites</a></li> -<li class="toctree-l1"><a class="reference internal" href="installation_guide/30_install_openpass.html">Installing OpenPASS</a></li> +<li class="toctree-l1"><a class="reference internal" href="installation_guide/30_install_openpass.html">Installing openPASS</a></li> <li class="toctree-l1"><a class="reference internal" href="installation_guide/50_further_guidance.html">Further Guidance</a></li> <li class="toctree-l1"><a class="reference internal" href="installation_guide/60_conan.html">Building with Conan</a></li> </ul> </div> +<div class="admonition-todo admonition" id="id1"> +<p class="admonition-title">Todo</p> +<p>Update section for new react GUI.</p> +</div> <p>The GUI lets the user configure the simulation and generate configuration files from all set parameters. Based on these the simulation core calculates different simulation runs and compiles trace files for further processing.</p> <div class="toctree-wrapper compound"> @@ -219,10 +224,9 @@ <ul> <li class="toctree-l1"><a class="reference internal" href="user_guide/10_overview.html">Overview</a></li> <li class="toctree-l1"><a class="reference internal" href="user_guide/20_tutorials.html">Tutorials</a></li> -<li class="toctree-l1"><a class="reference internal" href="user_guide/30_gui_plugins.html">GUI Plugins</a></li> -<li class="toctree-l1"><a class="reference internal" href="user_guide/40_configs_in_depth.html">Configs in Depth</a></li> -<li class="toctree-l1"><a class="reference internal" href="user_guide/50_outputs_in_depth.html">Outputs in Depth</a></li> -<li class="toctree-l1"><a class="reference internal" href="user_guide/60_scenario_simulation.html">Simulator</a></li> +<li class="toctree-l1"><a class="reference internal" href="user_guide/30_configs_in_depth.html">Configs in Depth</a></li> +<li class="toctree-l1"><a class="reference internal" href="user_guide/40_outputs_in_depth.html">Outputs in Depth</a></li> +<li class="toctree-l1"><a class="reference internal" href="user_guide/50_scenario_simulation.html">Simulator</a></li> </ul> </div> <div class="toctree-wrapper compound"> @@ -237,6 +241,7 @@ <ul> <li class="toctree-l1"><a class="reference internal" href="developer_information/10_ide_support.html">IDE Support</a></li> <li class="toctree-l1"><a class="reference internal" href="developer_information/20_documentation.html">Documentation Concept</a></li> +<li class="toctree-l1"><a class="reference internal" href="developer_information/30_coding_conventions.html">Coding Guidelines</a></li> </ul> </div> <div class="toctree-wrapper compound"> @@ -244,7 +249,8 @@ <ul> <li class="toctree-l1"><a class="reference internal" href="other_information/10_external_dependencies.html">External Dependencies</a></li> <li class="toctree-l1"><a class="reference internal" href="other_information/20_glossary.html">Glossary</a></li> -<li class="toctree-l1"><a class="reference internal" href="other_information/30_license.html">License</a></li> +<li class="toctree-l1"><a class="reference internal" href="other_information/30_gui_plugins.html">GUI Plugins</a></li> +<li class="toctree-l1"><a class="reference internal" href="other_information/40_license.html">License</a></li> </ul> </div> </div> @@ -253,22 +259,32 @@ <div class="admonition-todo admonition"> <p class="admonition-title">Todo</p> <p>The configuration is still “itchy”, as Qt creator changes the interface with every version -See <a class="reference external" href="https://gitlab.eclipse.org/eclipse/simopenpass/simopenpass/-/issues/149">https://gitlab.eclipse.org/eclipse/simopenpass/simopenpass/-/issues/149</a></p> +See <a class="reference external" href="https://gitlab.eclipse.org/eclipse/openpass/opSimulation/-/issues/149">https://gitlab.eclipse.org/eclipse/openpass/opSimulation/-/issues/149</a></p> </div> <p class="todo-source">(The <a class="reference internal" href="developer_information/ide_support/20_qt_creator.html#id1"><em>original entry</em></a> is located in W:/build/doc/source/developer_information/ide_support/20_qt_creator.rst, line 77.)</p> <div class="admonition-todo admonition"> <p class="admonition-title">Todo</p> <p>The configuration is still “itchy”, as Qt creator changes the interface with every version -See <a class="reference external" href="https://gitlab.eclipse.org/eclipse/simopenpass/simopenpass/-/issues/149">https://gitlab.eclipse.org/eclipse/simopenpass/simopenpass/-/issues/149</a></p> +See <a class="reference external" href="https://gitlab.eclipse.org/eclipse/openpass/opSimulation/-/issues/149">https://gitlab.eclipse.org/eclipse/openpass/opSimulation/-/issues/149</a></p> </div> <p class="todo-source">(The <a class="reference internal" href="developer_information/ide_support/20_qt_creator.html#id3"><em>original entry</em></a> is located in W:/build/doc/source/developer_information/ide_support/20_qt_creator.rst, line 99.)</p> <div class="admonition-todo admonition"> <p class="admonition-title">Todo</p> +<p>Update section for new react GUI.</p> +</div> +<p class="todo-source">(The <a class="reference internal" href="#id1"><em>original entry</em></a> is located in W:/build/doc/source/index.rst, line 31.)</p> +<div class="admonition-todo admonition"> +<p class="admonition-title">Todo</p> <p>We also need a way to better communicate, who is publishing what. This should directly come out of the source code, to keep the documentation up to date. -See <a class="reference external" href="https://gitlab.eclipse.org/eclipse/simopenpass/simopenpass/-/issues/148">https://gitlab.eclipse.org/eclipse/simopenpass/simopenpass/-/issues/148</a></p> +See <a class="reference external" href="https://gitlab.eclipse.org/eclipse/openpass/opSimulation/-/issues/148">https://gitlab.eclipse.org/eclipse/openpass/opSimulation/-/issues/148</a></p> </div> -<p class="todo-source">(The <a class="reference internal" href="user_guide/outputs/observation_log.html#id2"><em>original entry</em></a> is located in W:/build/doc/source/user_guide/outputs/observation_log.rst, line 62.)</p> +<p class="todo-source">(The <a class="reference internal" href="user_guide/outputs/observation_log.html#id2"><em>original entry</em></a> is located in W:/build/doc/source/user_guide/outputs/observation_log.rst, line 78.)</p> +<div class="admonition-todo admonition"> +<p class="admonition-title">Todo</p> +<p>Update this paragraph for the new react GUI.</p> +</div> +<p class="todo-source">(The <a class="reference internal" href="user_guide/tutorials/10_scenario_simulation.html#id2"><em>original entry</em></a> is located in W:/build/doc/source/user_guide/tutorials/10_scenario_simulation.rst, line 27.)</p> <div class="admonition-todo admonition"> <p class="admonition-title">Todo</p> <p>Write tutorial for PCM simulation</p>
diff --git a/content/html/index.html.bak b/content/html/index.html.bak deleted file mode 100644 index d583dab..0000000 --- a/content/html/index.html.bak +++ /dev/null
@@ -1,326 +0,0 @@ - - -<!DOCTYPE html> -<html class="writer-html5" lang="en" > -<head> - <meta charset="utf-8" /> - - <meta name="viewport" content="width=device-width, initial-scale=1.0" /> - - <title>OpenPASS Documentation — OpenPASS Documentation</title> - - - - <link rel="stylesheet" href="_static/css/theme.css" type="text/css" /> - <link rel="stylesheet" href="_static/pygments.css" type="text/css" /> - <link rel="stylesheet" href="_static/tabs.css" type="text/css" /> - <link rel="stylesheet" href="_static/css/custom.css" type="text/css" /> - - - - <link rel="shortcut icon" href="_static/openPASS.ico"/> - - - - - - - - - <!--[if lt IE 9]> - <script src="_static/js/html5shiv.min.js"></script> - <![endif]--> - - - <script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script> - <script src="_static/jquery.js"></script> - <script src="_static/underscore.js"></script> - <script src="_static/doctools.js"></script> - - <script type="text/javascript" src="_static/js/theme.js"></script> - - - <link rel="index" title="Index" href="genindex.html" /> - <link rel="search" title="Search" href="search.html" /> - <link rel="next" title="Getting Started" href="installation_guide/10_getting_started.html" /> -</head> - -<body class="wy-body-for-nav"> - - - <div class="wy-grid-for-nav"> - - <nav data-toggle="wy-nav-shift" class="wy-nav-side"> - <div class="wy-side-scroll"> - <div class="wy-side-nav-search" > - - - - <a href="#" class="icon icon-home"> openPASS - - - - - <img src="_static/openPASS.png" class="logo" alt="Logo"/> - - </a> - - - - - <div class="version"> - "openPASS v0.11" - </div> - - - - -<div role="search"> - <form id="rtd-search-form" class="wy-form" action="search.html" method="get"> - <input type="text" name="q" placeholder="Search docs" /> - <input type="hidden" name="check_keywords" value="yes" /> - <input type="hidden" name="area" value="default" /> - </form> -</div> - - - </div> - - - <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation"> - - - - - - - <p class="caption"><span class="caption-text">Installation Guide</span></p> -<ul> -<li class="toctree-l1"><a class="reference internal" href="installation_guide/10_getting_started.html">Getting Started</a></li> -<li class="toctree-l1"><a class="reference internal" href="installation_guide/15_system_requirements.html">System Requirements</a></li> -<li class="toctree-l1"><a class="reference internal" href="installation_guide/20_install_prerequisites.html">Installing Prerequisites</a></li> -<li class="toctree-l1"><a class="reference internal" href="installation_guide/30_install_openpass.html">Installing OpenPASS</a></li> -<li class="toctree-l1"><a class="reference internal" href="installation_guide/50_further_guidance.html">Further Guidance</a></li> -<li class="toctree-l1"><a class="reference internal" href="installation_guide/60_conan.html">Building with Conan</a></li> -</ul> -<p class="caption"><span class="caption-text">User Guides</span></p> -<ul> -<li class="toctree-l1"><a class="reference internal" href="user_guide/10_overview.html">Overview</a></li> -<li class="toctree-l1"><a class="reference internal" href="user_guide/20_tutorials.html">Tutorials</a></li> -<li class="toctree-l1"><a class="reference internal" href="user_guide/30_gui_plugins.html">GUI Plugins</a></li> -<li class="toctree-l1"><a class="reference internal" href="user_guide/40_configs_in_depth.html">Configs in Depth</a></li> -<li class="toctree-l1"><a class="reference internal" href="user_guide/50_outputs_in_depth.html">Outputs in Depth</a></li> -<li class="toctree-l1"><a class="reference internal" href="user_guide/60_scenario_simulation.html">Simulator</a></li> -</ul> -<p class="caption"><span class="caption-text">Advanced topics</span></p> -<ul> -<li class="toctree-l1"><a class="reference internal" href="advanced_topics/20_simulator_advanced.html">Simulator</a></li> -<li class="toctree-l1"><a class="reference internal" href="advanced_topics/30_testing.html">EndToEnd Test Framework</a></li> -</ul> -<p class="caption"><span class="caption-text">Developer Information</span></p> -<ul> -<li class="toctree-l1"><a class="reference internal" href="developer_information/10_ide_support.html">IDE Support</a></li> -<li class="toctree-l1"><a class="reference internal" href="developer_information/20_documentation.html">Documentation Concept</a></li> -</ul> -<p class="caption"><span class="caption-text">Other Information</span></p> -<ul> -<li class="toctree-l1"><a class="reference internal" href="other_information/10_external_dependencies.html">External Dependencies</a></li> -<li class="toctree-l1"><a class="reference internal" href="other_information/20_glossary.html">Glossary</a></li> -<li class="toctree-l1"><a class="reference internal" href="other_information/30_license.html">License</a></li> -</ul> - - - - </div> - - </div> - </nav> - - <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> - - - <nav class="wy-nav-top" aria-label="top navigation"> - - <i data-toggle="wy-nav-top" class="fa fa-bars"></i> - <a href="#">openPASS</a> - - </nav> - - - <div class="wy-nav-content"> - - <div class="rst-content"> - - - - - - - - - - - - - - - - - - - -<div role="navigation" aria-label="breadcrumbs navigation"> - - <ul class="wy-breadcrumbs"> - - <li><a href="#" class="icon icon-home"></a> »</li> - - <li>OpenPASS Documentation</li> - - - <li class="wy-breadcrumbs-aside"> - - - <a href="_sources/index.rst.txt" rel="nofollow"> View page source</a> - - - </li> - - </ul> - - - <hr/> -</div> - <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> - <div itemprop="articleBody"> - - <div class="section" id="openpass-documentation"> -<h1>OpenPASS Documentation<a class="headerlink" href="#openpass-documentation" title="Permalink to this headline">¶</a></h1> -<p>The OpenPASS (Open Platform for Assessment of Safety Systems) tool is a developed framework for the simulation of interaction between traffic participants to evaluate and parametrize active safety systems. -The simulation is based on a specific situation configuration and can contain several simulation runs, which differ due to random parameters.</p> -<p>The software suite of openPASS started as a set of stand-alone applications, which can be installed and configured individually. -Over time, especially the graphical user interface evolved to a single entry point, enabling the average user to use openPASS as a “monolithic” tool.</p> -<p>This guide contains information about installation, configuration and usage of all tools in the <strong>OpenPASS</strong> environment.</p> -<div class="toctree-wrapper compound"> -<p class="caption"><span class="caption-text">Installation Guide</span></p> -<ul> -<li class="toctree-l1"><a class="reference internal" href="installation_guide/10_getting_started.html">Getting Started</a></li> -<li class="toctree-l1"><a class="reference internal" href="installation_guide/15_system_requirements.html">System Requirements</a></li> -<li class="toctree-l1"><a class="reference internal" href="installation_guide/20_install_prerequisites.html">Installing Prerequisites</a></li> -<li class="toctree-l1"><a class="reference internal" href="installation_guide/30_install_openpass.html">Installing OpenPASS</a></li> -<li class="toctree-l1"><a class="reference internal" href="installation_guide/50_further_guidance.html">Further Guidance</a></li> -<li class="toctree-l1"><a class="reference internal" href="installation_guide/60_conan.html">Building with Conan</a></li> -</ul> -</div> -<p>The GUI lets the user configure the simulation and generate configuration files from all set parameters. -Based on these the simulation core calculates different simulation runs and compiles trace files for further processing.</p> -<div class="toctree-wrapper compound"> -<p class="caption"><span class="caption-text">User Guides</span></p> -<ul> -<li class="toctree-l1"><a class="reference internal" href="user_guide/10_overview.html">Overview</a></li> -<li class="toctree-l1"><a class="reference internal" href="user_guide/20_tutorials.html">Tutorials</a></li> -<li class="toctree-l1"><a class="reference internal" href="user_guide/30_gui_plugins.html">GUI Plugins</a></li> -<li class="toctree-l1"><a class="reference internal" href="user_guide/40_configs_in_depth.html">Configs in Depth</a></li> -<li class="toctree-l1"><a class="reference internal" href="user_guide/50_outputs_in_depth.html">Outputs in Depth</a></li> -<li class="toctree-l1"><a class="reference internal" href="user_guide/60_scenario_simulation.html">Simulator</a></li> -</ul> -</div> -<div class="toctree-wrapper compound"> -<p class="caption"><span class="caption-text">Advanced topics</span></p> -<ul> -<li class="toctree-l1"><a class="reference internal" href="advanced_topics/20_simulator_advanced.html">Simulator</a></li> -<li class="toctree-l1"><a class="reference internal" href="advanced_topics/30_testing.html">EndToEnd Test Framework</a></li> -</ul> -</div> -<div class="toctree-wrapper compound"> -<p class="caption"><span class="caption-text">Developer Information</span></p> -<ul> -<li class="toctree-l1"><a class="reference internal" href="developer_information/10_ide_support.html">IDE Support</a></li> -<li class="toctree-l1"><a class="reference internal" href="developer_information/20_documentation.html">Documentation Concept</a></li> -</ul> -</div> -<div class="toctree-wrapper compound"> -<p class="caption"><span class="caption-text">Other Information</span></p> -<ul> -<li class="toctree-l1"><a class="reference internal" href="other_information/10_external_dependencies.html">External Dependencies</a></li> -<li class="toctree-l1"><a class="reference internal" href="other_information/20_glossary.html">Glossary</a></li> -<li class="toctree-l1"><a class="reference internal" href="other_information/30_license.html">License</a></li> -</ul> -</div> -</div> -<div class="section" id="todolist"> -<h1>Todolist<a class="headerlink" href="#todolist" title="Permalink to this headline">¶</a></h1> -<div class="admonition-todo admonition"> -<p class="admonition-title">Todo</p> -<p>The configuration is still “itchy”, as Qt creator changes the interface with every version -See <a class="reference external" href="https://gitlab.eclipse.org/eclipse/simopenpass/simopenpass/-/issues/149">https://gitlab.eclipse.org/eclipse/simopenpass/simopenpass/-/issues/149</a></p> -</div> -<p class="todo-source">(The <a class="reference internal" href="developer_information/ide_support/20_qt_creator.html#id1"><em>original entry</em></a> is located in W:/build/doc/source/developer_information/ide_support/20_qt_creator.rst, line 77.)</p> -<div class="admonition-todo admonition"> -<p class="admonition-title">Todo</p> -<p>The configuration is still “itchy”, as Qt creator changes the interface with every version -See <a class="reference external" href="https://gitlab.eclipse.org/eclipse/simopenpass/simopenpass/-/issues/149">https://gitlab.eclipse.org/eclipse/simopenpass/simopenpass/-/issues/149</a></p> -</div> -<p class="todo-source">(The <a class="reference internal" href="developer_information/ide_support/20_qt_creator.html#id3"><em>original entry</em></a> is located in W:/build/doc/source/developer_information/ide_support/20_qt_creator.rst, line 99.)</p> -<div class="admonition-todo admonition"> -<p class="admonition-title">Todo</p> -<p>We also need a way to better communicate, who is publishing what. -This should directly come out of the source code, to keep the documentation up to date. -See <a class="reference external" href="https://gitlab.eclipse.org/eclipse/simopenpass/simopenpass/-/issues/148">https://gitlab.eclipse.org/eclipse/simopenpass/simopenpass/-/issues/148</a></p> -</div> -<p class="todo-source">(The <a class="reference internal" href="user_guide/outputs/observation_log.html#id2"><em>original entry</em></a> is located in W:/build/doc/source/user_guide/outputs/observation_log.rst, line 62.)</p> -<div class="admonition-todo admonition"> -<p class="admonition-title">Todo</p> -<p>Write tutorial for PCM simulation</p> -</div> -<p class="todo-source">(The <a class="reference internal" href="user_guide/tutorials/20_pcm_simulation.html#id1"><em>original entry</em></a> is located in W:/build/doc/source/user_guide/tutorials/20_pcm_simulation.rst, line 17.)</p> -</div> - - - </div> - - </div> - <footer> - <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> - <a href="installation_guide/10_getting_started.html" class="btn btn-neutral float-right" title="Getting Started" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a> - </div> - - <hr/> - - <div role="contentinfo"> - <p> - © Copyright 2023 OpenPASS Working Group. - - </p> - </div> - - - - Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a - - <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a> - - provided by <a href="https://readthedocs.org">Read the Docs</a>. - -</footer> - </div> - </div> - - </section> - - </div> - - - <script type="text/javascript"> - jQuery(function () { - SphinxRtdTheme.Navigation.enable(true); - }); - </script> - - - - - - -</body> -</html> \ No newline at end of file
diff --git a/content/html/installation_guide/10_getting_started.html b/content/html/installation_guide/10_getting_started.html index 7dd5d36..42d92ca 100644 --- a/content/html/installation_guide/10_getting_started.html +++ b/content/html/installation_guide/10_getting_started.html
@@ -7,7 +7,7 @@ <meta name="viewport" content="width=device-width, initial-scale=1.0" /> - <title>Getting Started — OpenPASS Documentation</title> + <title>Getting Started — openPASS Documentation</title> @@ -44,7 +44,7 @@ <link rel="index" title="Index" href="../genindex.html" /> <link rel="search" title="Search" href="../search.html" /> <link rel="next" title="System Requirements" href="15_system_requirements.html" /> - <link rel="prev" title="OpenPASS Documentation" href="../index.html" /> + <link rel="prev" title="openPASS Documentation" href="../index.html" /> </head> <body class="wy-body-for-nav"> @@ -71,7 +71,7 @@ <div class="version"> - "openPASS v0.11" + "develop_4d7f6d4f2e22c286789082dd8cbe3eb7f5b5af62" </div> @@ -101,7 +101,7 @@ <li class="toctree-l1 current"><a class="current reference internal" href="#">Getting Started</a></li> <li class="toctree-l1"><a class="reference internal" href="15_system_requirements.html">System Requirements</a></li> <li class="toctree-l1"><a class="reference internal" href="20_install_prerequisites.html">Installing Prerequisites</a></li> -<li class="toctree-l1"><a class="reference internal" href="30_install_openpass.html">Installing OpenPASS</a></li> +<li class="toctree-l1"><a class="reference internal" href="30_install_openpass.html">Installing openPASS</a></li> <li class="toctree-l1"><a class="reference internal" href="50_further_guidance.html">Further Guidance</a></li> <li class="toctree-l1"><a class="reference internal" href="60_conan.html">Building with Conan</a></li> </ul> @@ -109,10 +109,9 @@ <ul> <li class="toctree-l1"><a class="reference internal" href="../user_guide/10_overview.html">Overview</a></li> <li class="toctree-l1"><a class="reference internal" href="../user_guide/20_tutorials.html">Tutorials</a></li> -<li class="toctree-l1"><a class="reference internal" href="../user_guide/30_gui_plugins.html">GUI Plugins</a></li> -<li class="toctree-l1"><a class="reference internal" href="../user_guide/40_configs_in_depth.html">Configs in Depth</a></li> -<li class="toctree-l1"><a class="reference internal" href="../user_guide/50_outputs_in_depth.html">Outputs in Depth</a></li> -<li class="toctree-l1"><a class="reference internal" href="../user_guide/60_scenario_simulation.html">Simulator</a></li> +<li class="toctree-l1"><a class="reference internal" href="../user_guide/30_configs_in_depth.html">Configs in Depth</a></li> +<li class="toctree-l1"><a class="reference internal" href="../user_guide/40_outputs_in_depth.html">Outputs in Depth</a></li> +<li class="toctree-l1"><a class="reference internal" href="../user_guide/50_scenario_simulation.html">Simulator</a></li> </ul> <p class="caption"><span class="caption-text">Advanced topics</span></p> <ul> @@ -123,12 +122,14 @@ <ul> <li class="toctree-l1"><a class="reference internal" href="../developer_information/10_ide_support.html">IDE Support</a></li> <li class="toctree-l1"><a class="reference internal" href="../developer_information/20_documentation.html">Documentation Concept</a></li> +<li class="toctree-l1"><a class="reference internal" href="../developer_information/30_coding_conventions.html">Coding Guidelines</a></li> </ul> <p class="caption"><span class="caption-text">Other Information</span></p> <ul> <li class="toctree-l1"><a class="reference internal" href="../other_information/10_external_dependencies.html">External Dependencies</a></li> <li class="toctree-l1"><a class="reference internal" href="../other_information/20_glossary.html">Glossary</a></li> -<li class="toctree-l1"><a class="reference internal" href="../other_information/30_license.html">License</a></li> +<li class="toctree-l1"><a class="reference internal" href="../other_information/30_gui_plugins.html">GUI Plugins</a></li> +<li class="toctree-l1"><a class="reference internal" href="../other_information/40_license.html">License</a></li> </ul> @@ -209,7 +210,7 @@ </ul> <p><strong>Installation of the simulator</strong></p> <ul class="simple"> -<li><p><a class="reference internal" href="30_install_openpass.html#download-and-install-openpass"><span class="std std-ref">Installing OpenPASS</span></a> describes how to compile and run <strong>openPASS</strong> once all prerequisites are installed</p></li> +<li><p><a class="reference internal" href="30_install_openpass.html#download-and-install-openpass"><span class="std std-ref">Installing openPASS</span></a> describes how to compile and run <strong>openPASS</strong> once all prerequisites are installed</p></li> </ul> </div><div aria-labelledby="tab-0-0-1" class="sphinx-tabs-panel" hidden="true" id="panel-0-0-1" name="0-1" role="tabpanel" tabindex="0"><div class="admonition warning"> <p class="admonition-title">Warning</p> @@ -243,14 +244,14 @@ <footer> <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> <a href="15_system_requirements.html" class="btn btn-neutral float-right" title="System Requirements" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a> - <a href="../index.html" class="btn btn-neutral float-left" title="OpenPASS Documentation" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a> + <a href="../index.html" class="btn btn-neutral float-left" title="openPASS Documentation" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a> </div> <hr/> <div role="contentinfo"> <p> - © Copyright 2023 OpenPASS Working Group. + © Copyright 2023 openPASS Working Group. </p> </div>
diff --git a/content/html/installation_guide/15_system_requirements.html b/content/html/installation_guide/15_system_requirements.html index 74b330d..df0d63b 100644 --- a/content/html/installation_guide/15_system_requirements.html +++ b/content/html/installation_guide/15_system_requirements.html
@@ -7,7 +7,7 @@ <meta name="viewport" content="width=device-width, initial-scale=1.0" /> - <title>System Requirements — OpenPASS Documentation</title> + <title>System Requirements — openPASS Documentation</title> @@ -70,7 +70,7 @@ <div class="version"> - "openPASS v0.11" + "develop_4d7f6d4f2e22c286789082dd8cbe3eb7f5b5af62" </div> @@ -100,7 +100,7 @@ <li class="toctree-l1"><a class="reference internal" href="10_getting_started.html">Getting Started</a></li> <li class="toctree-l1 current"><a class="current reference internal" href="#">System Requirements</a></li> <li class="toctree-l1"><a class="reference internal" href="20_install_prerequisites.html">Installing Prerequisites</a></li> -<li class="toctree-l1"><a class="reference internal" href="30_install_openpass.html">Installing OpenPASS</a></li> +<li class="toctree-l1"><a class="reference internal" href="30_install_openpass.html">Installing openPASS</a></li> <li class="toctree-l1"><a class="reference internal" href="50_further_guidance.html">Further Guidance</a></li> <li class="toctree-l1"><a class="reference internal" href="60_conan.html">Building with Conan</a></li> </ul> @@ -108,10 +108,9 @@ <ul> <li class="toctree-l1"><a class="reference internal" href="../user_guide/10_overview.html">Overview</a></li> <li class="toctree-l1"><a class="reference internal" href="../user_guide/20_tutorials.html">Tutorials</a></li> -<li class="toctree-l1"><a class="reference internal" href="../user_guide/30_gui_plugins.html">GUI Plugins</a></li> -<li class="toctree-l1"><a class="reference internal" href="../user_guide/40_configs_in_depth.html">Configs in Depth</a></li> -<li class="toctree-l1"><a class="reference internal" href="../user_guide/50_outputs_in_depth.html">Outputs in Depth</a></li> -<li class="toctree-l1"><a class="reference internal" href="../user_guide/60_scenario_simulation.html">Simulator</a></li> +<li class="toctree-l1"><a class="reference internal" href="../user_guide/30_configs_in_depth.html">Configs in Depth</a></li> +<li class="toctree-l1"><a class="reference internal" href="../user_guide/40_outputs_in_depth.html">Outputs in Depth</a></li> +<li class="toctree-l1"><a class="reference internal" href="../user_guide/50_scenario_simulation.html">Simulator</a></li> </ul> <p class="caption"><span class="caption-text">Advanced topics</span></p> <ul> @@ -122,12 +121,14 @@ <ul> <li class="toctree-l1"><a class="reference internal" href="../developer_information/10_ide_support.html">IDE Support</a></li> <li class="toctree-l1"><a class="reference internal" href="../developer_information/20_documentation.html">Documentation Concept</a></li> +<li class="toctree-l1"><a class="reference internal" href="../developer_information/30_coding_conventions.html">Coding Guidelines</a></li> </ul> <p class="caption"><span class="caption-text">Other Information</span></p> <ul> <li class="toctree-l1"><a class="reference internal" href="../other_information/10_external_dependencies.html">External Dependencies</a></li> <li class="toctree-l1"><a class="reference internal" href="../other_information/20_glossary.html">Glossary</a></li> -<li class="toctree-l1"><a class="reference internal" href="../other_information/30_license.html">License</a></li> +<li class="toctree-l1"><a class="reference internal" href="../other_information/30_gui_plugins.html">GUI Plugins</a></li> +<li class="toctree-l1"><a class="reference internal" href="../other_information/40_license.html">License</a></li> </ul> @@ -215,7 +216,7 @@ </thead> <tbody> <tr class="row-even"><td><p>Operating System</p></td> -<td><p>Windows or Linux (Debian Bullseye or Ubuntu 20.10 recommended)</p></td> +<td><p>Windows or Linux (Debian Bookworm or Ubuntu 22.04 recommended)</p></td> <td><p>Windows 10</p></td> </tr> <tr class="row-odd"><td><p>CPU</p></td> @@ -252,7 +253,7 @@ <div role="contentinfo"> <p> - © Copyright 2023 OpenPASS Working Group. + © Copyright 2023 openPASS Working Group. </p> </div>
diff --git a/content/html/installation_guide/20_install_prerequisites.html b/content/html/installation_guide/20_install_prerequisites.html index 0d68600..76c4b87 100644 --- a/content/html/installation_guide/20_install_prerequisites.html +++ b/content/html/installation_guide/20_install_prerequisites.html
@@ -7,7 +7,7 @@ <meta name="viewport" content="width=device-width, initial-scale=1.0" /> - <title>Installing Prerequisites — OpenPASS Documentation</title> + <title>Installing Prerequisites — openPASS Documentation</title> @@ -43,7 +43,7 @@ <link rel="index" title="Index" href="../genindex.html" /> <link rel="search" title="Search" href="../search.html" /> - <link rel="next" title="Installing OpenPASS" href="30_install_openpass.html" /> + <link rel="next" title="Installing openPASS" href="30_install_openpass.html" /> <link rel="prev" title="System Requirements" href="15_system_requirements.html" /> </head> @@ -71,7 +71,7 @@ <div class="version"> - "openPASS v0.11" + "develop_4d7f6d4f2e22c286789082dd8cbe3eb7f5b5af62" </div> @@ -113,7 +113,7 @@ </li> </ul> </li> -<li class="toctree-l1"><a class="reference internal" href="30_install_openpass.html">Installing OpenPASS</a></li> +<li class="toctree-l1"><a class="reference internal" href="30_install_openpass.html">Installing openPASS</a></li> <li class="toctree-l1"><a class="reference internal" href="50_further_guidance.html">Further Guidance</a></li> <li class="toctree-l1"><a class="reference internal" href="60_conan.html">Building with Conan</a></li> </ul> @@ -121,10 +121,9 @@ <ul> <li class="toctree-l1"><a class="reference internal" href="../user_guide/10_overview.html">Overview</a></li> <li class="toctree-l1"><a class="reference internal" href="../user_guide/20_tutorials.html">Tutorials</a></li> -<li class="toctree-l1"><a class="reference internal" href="../user_guide/30_gui_plugins.html">GUI Plugins</a></li> -<li class="toctree-l1"><a class="reference internal" href="../user_guide/40_configs_in_depth.html">Configs in Depth</a></li> -<li class="toctree-l1"><a class="reference internal" href="../user_guide/50_outputs_in_depth.html">Outputs in Depth</a></li> -<li class="toctree-l1"><a class="reference internal" href="../user_guide/60_scenario_simulation.html">Simulator</a></li> +<li class="toctree-l1"><a class="reference internal" href="../user_guide/30_configs_in_depth.html">Configs in Depth</a></li> +<li class="toctree-l1"><a class="reference internal" href="../user_guide/40_outputs_in_depth.html">Outputs in Depth</a></li> +<li class="toctree-l1"><a class="reference internal" href="../user_guide/50_scenario_simulation.html">Simulator</a></li> </ul> <p class="caption"><span class="caption-text">Advanced topics</span></p> <ul> @@ -135,12 +134,14 @@ <ul> <li class="toctree-l1"><a class="reference internal" href="../developer_information/10_ide_support.html">IDE Support</a></li> <li class="toctree-l1"><a class="reference internal" href="../developer_information/20_documentation.html">Documentation Concept</a></li> +<li class="toctree-l1"><a class="reference internal" href="../developer_information/30_coding_conventions.html">Coding Guidelines</a></li> </ul> <p class="caption"><span class="caption-text">Other Information</span></p> <ul> <li class="toctree-l1"><a class="reference internal" href="../other_information/10_external_dependencies.html">External Dependencies</a></li> <li class="toctree-l1"><a class="reference internal" href="../other_information/20_glossary.html">Glossary</a></li> -<li class="toctree-l1"><a class="reference internal" href="../other_information/30_license.html">License</a></li> +<li class="toctree-l1"><a class="reference internal" href="../other_information/30_gui_plugins.html">GUI Plugins</a></li> +<li class="toctree-l1"><a class="reference internal" href="../other_information/40_license.html">License</a></li> </ul> @@ -256,9 +257,9 @@ </li> </ol> </div><div aria-labelledby="tab-0-0-1" class="sphinx-tabs-panel" hidden="true" id="panel-0-0-1" name="0-1" role="tabpanel" tabindex="0"> -<span id="building-under-linux"></span><p>On Linux, no special build environment is needed. <strong>OpenPASS</strong> is developed under Debian 64-Bit, +<span id="building-under-linux"></span><p>On Linux, no special build environment is needed. <strong>openPASS</strong> is developed under Debian 64-Bit, which means that developing under a recent Ubuntu distribution will also work. -Debian Bullseye or Ubuntu 20.10 is recommended. Debian uses <code class="docutils literal notranslate"><span class="pre">apt</span></code> (or <code class="docutils literal notranslate"><span class="pre">apt-get</span></code>) as package managing system. +Debian Bookworm or Ubuntu 22.04 LTS is recommended. Debian uses <code class="docutils literal notranslate"><span class="pre">apt</span></code> (or <code class="docutils literal notranslate"><span class="pre">apt-get</span></code>) as package managing system. Details will be given in <a class="reference internal" href="#binary-packages"><span class="std std-ref">Installing the Binary Packages</span></a> and <a class="reference internal" href="#building-prerequisites"><span class="std std-ref">Installing the Source Packages</span></a>.</p> </div></div> </div> @@ -266,7 +267,7 @@ <span id="binary-packages"></span><h2>Installing the Binary Packages<a class="headerlink" href="#installing-the-binary-packages" title="Permalink to this headline">¶</a></h2> <p>The first set of dependencies we need to install in order to successfully compile <strong>openPASS</strong> are the binary packages. These can be installed via appropiate package manager.</p> <div class="sphinx-tabs docutils container"> -<div aria-label="Tabbed content" class="closeable" role="tablist"><button aria-controls="panel-1-1-0" aria-selected="true" class="sphinx-tabs-tab" id="tab-1-1-0" name="1-0" role="tab" tabindex="0">Windows (MSYS2)</button><button aria-controls="panel-1-1-1" aria-selected="false" class="sphinx-tabs-tab" id="tab-1-1-1" name="1-1" role="tab" tabindex="-1">Linux (Debian Bullseye)</button></div><div aria-labelledby="tab-1-1-0" class="sphinx-tabs-panel" id="panel-1-1-0" name="1-0" role="tabpanel" tabindex="0"><ol class="arabic"> +<div aria-label="Tabbed content" class="closeable" role="tablist"><button aria-controls="panel-1-1-0" aria-selected="true" class="sphinx-tabs-tab" id="tab-1-1-0" name="1-0" role="tab" tabindex="0">Windows (MSYS2)</button><button aria-controls="panel-1-1-1" aria-selected="false" class="sphinx-tabs-tab" id="tab-1-1-1" name="1-1" role="tab" tabindex="-1">Linux (Debian Bookworm)</button></div><div aria-labelledby="tab-1-1-0" class="sphinx-tabs-panel" id="panel-1-1-0" name="1-0" role="tabpanel" tabindex="0"><ol class="arabic"> <li><p>Open <code class="docutils literal notranslate"><span class="pre">MSYS2</span> <span class="pre">MinGW</span> <span class="pre">64-bit</span></code> and execute the following package manager <code class="docutils literal notranslate"><span class="pre">pacman</span></code> commands to update the package repository and upgrade system packages:</p> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">pacman</span> <span class="o">-</span><span class="n">Syuu</span> </pre></div> @@ -278,41 +279,44 @@ </li> <li><p>Required packages (can be specified in single command line if desired):</p> <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span><span class="c1"># for simulator</span> -mingw-w64-x86_64-boost <span class="c1"># Tested with 1.81.0-7</span> -mingw-w64-x86_64-ccache <span class="c1"># Tested with 4.8-1</span> -mingw-w64-x86_64-cmake <span class="c1"># Tested with 3.26.4-1</span> -mingw-w64-x86_64-doxygen <span class="c1"># Tested with 1.9.7-1</span> -mingw-w64-x86_64-gcc <span class="c1"># Tested with 13.1.0-6</span> -mingw-w64-x86_64-gdb <span class="c1"># Tested with 13.1-4</span> -mingw-w64-x86_64-graphviz <span class="c1"># Tested with 2.44.1-9</span> -mingw-w64-x86_64-gtest <span class="c1"># Tested with 1.13.0-1</span> -mingw-w64-x86_64-qt5 <span class="c1"># Tested with 5.15.9-1</span> -make <span class="c1"># Tested with 4.4.1-1</span> +pacman -S mingw-w64-x86_64-boost <span class="c1"># Tested with 1.72.0</span> +pacman -S mingw-w64-x86_64-ccache <span class="c1"># Tested with 4.7.4-1</span> +pacman -S mingw-w64-x86_64-cmake <span class="c1"># Tested with 3.27.3</span> +pacman -S mingw-w64-x86_64-doxygen <span class="c1"># Tested with 1.9.6-2</span> +pacman -S mingw-w64-x86_64-gcc <span class="c1"># Tested with 13.2.0</span> +pacman -S mingw-w64-x86_64-gdb <span class="c1"># Tested with 13.2.0</span> +pacman -S mingw-w64-x86_64-graphviz <span class="c1"># Tested with 2.44.1-12</span> +pacman -S mingw-w64-x86_64-gtest <span class="c1"># Tested with 1.14.0</span> +pacman -S mingw-w64-x86_64-make <span class="c1"># Tested with 4.4-2</span> +pacman -S mingw-w64-x86_64-qt5-base <span class="c1"># Tested with 5.15.3</span> +pacman -S mingw-w64-x86_64-qt5-xmlpatterns <span class="c1"># Tested with 5.15.3</span> <span class="c1"># for documentation</span> -mingw-w64-x86_64-python <span class="c1"># Tested with 3.10.11-1</span> -mingw-w64-x86_64-python-pip <span class="c1"># Tested with 23.1.2-1</span> -mingw-w64-x86_64-python-lxml <span class="c1"># Tested with 4.9.2-1</span> +pacman -S mingw-w64-x86_64-python <span class="c1"># Tested with 3.10.9-2</span> +pacman -S mingw-w64-x86_64-python-pip <span class="c1"># Tested with 22.3.1-1</span> +pacman -S mingw-w64-x86_64-python-lxml <span class="c1"># Tested with 4.9.2-1</span> <span class="c1"># fonts and equation rendering in the documentation</span> -mingw-w64-x86_64-texlive-bin <span class="c1"># Tested with 2023.20230523-1</span> -mingw-w64-x86_64-texlive-core <span class="c1"># Tested with 2023.20230404-1</span> -mingw-w64-x86_64-texlive-font-utils <span class="c1"># Tested with 2023.20230404-1</span> -mingw-w64-x86_64-texlive-latex-extra <span class="c1"># Tested with 2023.20230404-1</span> -mingw-w64-x86_64-zziplib <span class="c1"># Tested with 0.13.72-3</span> +pacman -S mingw-w64-x86_64-texlive-bin <span class="c1"># Tested with 2022.20220501-4</span> +pacman -S mingw-w64-x86_64-texlive-core <span class="c1"># Tested with 2022.20220501-2</span> +pacman -S mingw-w64-x86_64-texlive-font-utils <span class="c1"># Tested with 2022.20220501-1</span> +pacman -S mingw-w64-x86_64-texlive-latex-extra <span class="c1"># Tested with 2022.20220501-1</span> +pacman -S mingw-w64-x86_64-zziplib <span class="c1"># Tested with 0.13.72-3</span> -<span class="c1"># for sphinx/exhale</span> -libxslt-devel <span class="c1"># Tested with 1.1.37-1</span> +<span class="c1"># documentation with only pacman</span> +pacman -S libxslt-devel <span class="c1"># Tested with 1.1.37-1</span> +pacman -S mingw-w64-x86_64-python-sphinx <span class="c1"># Tested with 5.3.0-1</span> +pacman -S mingw-w64-x86_64-python-sphinx-tabs <span class="c1"># Tested with 3.4.1-1</span> +pacman -S mingw-w64-x86_64-python-sphinx_rtd_theme <span class="c1"># Tested with 1.1.1-1</span> +pacman -S mingw-w64-x86_64-python-setuptools <span class="c1"># Tested with 66.1.0-1</span> +pacman -S mingw-w64-x86_64-python-myst-parser <span class="c1"># Tested with 0.18.1-1</span> -<span class="c1"># additional recommendations</span> -diffutils -dos2unix -git -vim -mingw-w64-x86_64-ag -mingw-w64-x86_64-ninja -mingw-w64-x86_64-qt5-debug -zlib-devel +<span class="c1"># for testing (optional)</span> +pacman -S mingw-w64-x86_64-python-pytest <span class="c1"># Tested with 7.2.1-1</span> +pacman -S mingw-w64-x86_64-python-pandas <span class="c1"># Tested with 1.5.3-1</span> + +<span class="c1"># for developing purposes (optional)</span> +pacman -S mingw-w64-x86_64-clang </pre></div> </div> <div class="admonition-versions admonition"> @@ -322,9 +326,24 @@ <div class="line">Tested packages - at time of writing - have been listed above as comment.</div> <div class="line">If in doubt, download the package in the right version from the <a class="reference external" href="http://repo.msys2.org/mingw/x86_64/">MSYS2 package repository</a>.</div> <div class="line">Install with <code class="docutils literal notranslate"><span class="pre">pacman</span> <span class="pre">-U</span> <span class="pre"><package-filename></span></code></div> +<div class="line">If there is no old enough MSYS2 Package Version available in the package Repository you can download specific versions with python-pip</div> +<div class="line">Install with <code class="docutils literal notranslate"><span class="pre">pip3</span> <span class="pre">install</span> <span class="pre"><package-filename>==<version></span></code></div> </div> </div> </li> +<li><p>Optional Packages</p> +<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">pacman</span> <span class="o">-</span><span class="n">S</span> <span class="n">git</span> +<span class="n">pacman</span> <span class="o">-</span><span class="n">S</span> <span class="n">diffutils</span> +<span class="n">pacman</span> <span class="o">-</span><span class="n">S</span> <span class="n">patch</span> +<span class="n">pacman</span> <span class="o">-</span><span class="n">S</span> <span class="n">mingw</span><span class="o">-</span><span class="n">w64</span><span class="o">-</span><span class="n">x86_64</span><span class="o">-</span><span class="n">ag</span> +<span class="n">pacman</span> <span class="o">-</span><span class="n">S</span> <span class="n">mingw</span><span class="o">-</span><span class="n">w64</span><span class="o">-</span><span class="n">x86_64</span><span class="o">-</span><span class="n">qt5</span><span class="o">-</span><span class="n">debug</span> +<span class="n">pacman</span> <span class="o">-</span><span class="n">S</span> <span class="n">zlib</span><span class="o">-</span><span class="n">devel</span> + +<span class="c1"># for api documentation (optional)</span> +<span class="n">pip3</span> <span class="n">install</span> <span class="n">breathe</span> <span class="n">exhale</span> +</pre></div> +</div> +</li> </ol> <div class="admonition-git-ssh admonition"> <p class="admonition-title">GIT/SSH</p> @@ -344,22 +363,25 @@ </li> <li><p>Install required binary packages</p> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="c1"># for simulator</span> -<span class="n">apt</span> <span class="n">install</span> <span class="n">ccache</span> -<span class="n">apt</span> <span class="n">install</span> <span class="n">cmake</span> -<span class="n">apt</span> <span class="n">install</span> <span class="n">doxygen</span> -<span class="n">apt</span> <span class="n">install</span> <span class="n">googletest</span> -<span class="n">apt</span> <span class="n">install</span> <span class="n">gcc</span> -<span class="n">apt</span> <span class="n">install</span> <span class="n">g</span><span class="o">++</span> -<span class="n">apt</span> <span class="n">install</span> <span class="n">graphviz</span> -<span class="n">apt</span> <span class="n">install</span> <span class="n">libboost</span><span class="o">-</span><span class="n">dev</span> -<span class="n">apt</span> <span class="n">install</span> <span class="n">libqt5xmlpatterns5</span><span class="o">-</span><span class="n">dev</span> -<span class="n">apt</span> <span class="n">install</span> <span class="n">qtbase5</span><span class="o">-</span><span class="n">dev</span> -<span class="n">apt</span> <span class="n">install</span> <span class="n">qtchooser</span> -<span class="n">apt</span> <span class="n">install</span> <span class="n">zlib1g</span><span class="o">-</span><span class="n">dev</span> +<span class="n">apt</span> <span class="o">-</span><span class="n">y</span> <span class="n">install</span> <span class="n">ccache</span> +<span class="n">apt</span> <span class="o">-</span><span class="n">y</span> <span class="n">install</span> <span class="n">cmake</span> +<span class="n">apt</span> <span class="o">-</span><span class="n">y</span> <span class="n">install</span> <span class="n">doxygen</span> +<span class="n">apt</span> <span class="o">-</span><span class="n">y</span> <span class="n">install</span> <span class="n">googletest</span> +<span class="n">apt</span> <span class="o">-</span><span class="n">y</span> <span class="n">install</span> <span class="n">gcc</span> +<span class="n">apt</span> <span class="o">-</span><span class="n">y</span> <span class="n">install</span> <span class="n">g</span><span class="o">++</span> +<span class="n">apt</span> <span class="o">-</span><span class="n">y</span> <span class="n">install</span> <span class="n">graphviz</span> +<span class="n">apt</span> <span class="o">-</span><span class="n">y</span> <span class="n">install</span> <span class="n">libboost</span><span class="o">-</span><span class="n">dev</span> +<span class="n">apt</span> <span class="o">-</span><span class="n">y</span> <span class="n">install</span> <span class="n">libqt5xmlpatterns5</span><span class="o">-</span><span class="n">dev</span> +<span class="n">apt</span> <span class="o">-</span><span class="n">y</span> <span class="n">install</span> <span class="n">qtbase5</span><span class="o">-</span><span class="n">dev</span> +<span class="n">apt</span> <span class="o">-</span><span class="n">y</span> <span class="n">install</span> <span class="n">qtchooser</span> +<span class="n">apt</span> <span class="o">-</span><span class="n">y</span> <span class="n">install</span> <span class="n">zlib1g</span><span class="o">-</span><span class="n">dev</span> <span class="c1"># for documentation</span> -<span class="n">sudo</span> <span class="n">apt</span> <span class="n">install</span> <span class="n">doxygen</span> <span class="n">python3</span> <span class="n">python3</span><span class="o">-</span><span class="n">pip</span> <span class="n">libenchant</span><span class="o">-</span><span class="mi">2</span><span class="o">-</span><span class="mi">2</span> <span class="n">dvipng</span> <span class="n">dos2unix</span> -<span class="n">pip3</span> <span class="n">install</span> <span class="n">sphinx</span> <span class="n">sphinx</span><span class="o">-</span><span class="n">rtd</span><span class="o">-</span><span class="n">theme</span> <span class="n">sphinx</span><span class="o">-</span><span class="n">tabs</span> <span class="n">breathe</span> <span class="n">exhale</span> <span class="n">sphinxcontrib</span><span class="o">-</span><span class="n">spelling</span> +<span class="n">sudo</span> <span class="n">apt</span> <span class="n">install</span> <span class="n">python3</span> <span class="n">python3</span><span class="o">-</span><span class="n">pip</span> <span class="n">libenchant</span><span class="o">-</span><span class="mi">2</span><span class="o">-</span><span class="mi">2</span> <span class="n">dvipng</span> +<span class="n">pip3</span> <span class="n">install</span> <span class="n">sphinx</span> <span class="n">sphinx</span><span class="o">-</span><span class="n">rtd</span><span class="o">-</span><span class="n">theme</span> <span class="n">sphinx</span><span class="o">-</span><span class="n">tabs</span> <span class="n">breathe</span> <span class="n">exhale</span> <span class="n">sphinxcontrib</span><span class="o">-</span><span class="n">spelling</span> <span class="n">myst</span><span class="o">-</span><span class="n">parser</span> + +<span class="c1"># for testing</span> +<span class="n">pip3</span> <span class="n">install</span> <span class="n">pytest</span> <span class="n">pandas</span> </pre></div> </div> <p>Under Linux, it is deliberate that the googletest package only installs the header files to the system, @@ -394,7 +416,7 @@ <p>The <strong>openPASS</strong> repository isn’t needed yet.</p> </div> <div class="sphinx-tabs docutils container"> -<div aria-label="Tabbed content" class="closeable" role="tablist"><button aria-controls="panel-2-2-0" aria-selected="true" class="sphinx-tabs-tab" id="tab-2-2-0" name="2-0" role="tab" tabindex="0">Windows</button><button aria-controls="panel-2-2-1" aria-selected="false" class="sphinx-tabs-tab" id="tab-2-2-1" name="2-1" role="tab" tabindex="-1">Linux</button></div><div aria-labelledby="tab-2-2-0" class="sphinx-tabs-panel" id="panel-2-2-0" name="2-0" role="tabpanel" tabindex="0"><div class="highlight-default notranslate"><div class="highlight"><pre><span></span>C:\OpenPASS\thirdParty +<div aria-label="Tabbed content" class="closeable" role="tablist"><button aria-controls="panel-2-2-0" aria-selected="true" class="sphinx-tabs-tab" id="tab-2-2-0" name="2-0" role="tab" tabindex="0">Windows</button><button aria-controls="panel-2-2-1" aria-selected="false" class="sphinx-tabs-tab" id="tab-2-2-1" name="2-1" role="tab" tabindex="-1">Linux</button></div><div aria-labelledby="tab-2-2-0" class="sphinx-tabs-panel" id="panel-2-2-0" name="2-0" role="tabpanel" tabindex="0"><div class="highlight-default notranslate"><div class="highlight"><pre><span></span>C:\openpass\thirdParty ├── FMILibrary │ ├── include │ └── lib @@ -416,12 +438,12 @@ </div> <p>In the folder structure above:</p> <ul class="simple"> -<li><p><code class="docutils literal notranslate"><span class="pre">C:\OpenPASS\thirdParty</span></code> refers to a temporary directory used to built the prerequisites from source, <strong>not</strong> the <code class="docutils literal notranslate"><span class="pre">simopenpass</span></code> repository</p></li> +<li><p><code class="docutils literal notranslate"><span class="pre">C:\openpass\thirdParty</span></code> refers to a temporary directory used to built the prerequisites from source, <strong>not</strong> the <code class="docutils literal notranslate"><span class="pre">openpass</span></code> repository</p></li> <li><p><code class="docutils literal notranslate"><span class="pre">FMILibrary</span></code> is the install directory of the <a class="reference internal" href="../other_information/20_glossary.html#term-FMI"><span class="xref std std-term">Functional Mock-up Interface (FMI)</span></a> when build from source</p></li> <li><p><code class="docutils literal notranslate"><span class="pre">osi</span></code> is the install directory of the <a class="reference internal" href="../other_information/20_glossary.html#term-OSI"><span class="xref std std-term">Open Simulation Interface (OSI)</span></a> when build from source.</p></li> <li><p><code class="docutils literal notranslate"><span class="pre">protobuf</span></code> and <code class="docutils literal notranslate"><span class="pre">protobuf-shared</span></code> are the install directories of <code class="docutils literal notranslate"><span class="pre">Google</span> <span class="pre">Protocol</span> <span class="pre">Buffers</span></code> for shared and static builds, respectively.</p></li> </ul> -</div><div aria-labelledby="tab-2-2-1" class="sphinx-tabs-panel" hidden="true" id="panel-2-2-1" name="2-1" role="tabpanel" tabindex="0"><div class="highlight-default notranslate"><div class="highlight"><pre><span></span>~/OpenPASS/thirdParty +</div><div aria-labelledby="tab-2-2-1" class="sphinx-tabs-panel" hidden="true" id="panel-2-2-1" name="2-1" role="tabpanel" tabindex="0"><div class="highlight-default notranslate"><div class="highlight"><pre><span></span>~/openpass/thirdParty ├── FMILibrary │ ├── include │ └── lib @@ -443,7 +465,7 @@ </div> <p>In the folder structure above:</p> <ul class="simple"> -<li><p><code class="docutils literal notranslate"><span class="pre">~/OpenPASS/thirdParty</span></code> refers to a temporary directory used to built the prerequisites from source, <strong>not</strong> the <code class="docutils literal notranslate"><span class="pre">simopenpass</span></code> repository</p></li> +<li><p><code class="docutils literal notranslate"><span class="pre">~/openpass/thirdParty</span></code> refers to a temporary directory used to built the prerequisites from source, <strong>not</strong> the <code class="docutils literal notranslate"><span class="pre">openpass</span></code> repository</p></li> <li><p><code class="docutils literal notranslate"><span class="pre">FMILibrary</span></code> is the install directory of the <a class="reference internal" href="../other_information/20_glossary.html#term-FMI"><span class="xref std std-term">Functional Mock-up Interface (FMI)</span></a> when build from source</p></li> <li><p><code class="docutils literal notranslate"><span class="pre">osi</span></code> is the install directory of the <a class="reference internal" href="../other_information/20_glossary.html#term-OSI"><span class="xref std std-term">Open Simulation Interface (OSI)</span></a> when build from source.</p></li> <li><p><code class="docutils literal notranslate"><span class="pre">protobuf</span></code> and <code class="docutils literal notranslate"><span class="pre">protobuf-shared</span></code> are the install directories of <code class="docutils literal notranslate"><span class="pre">Google</span> <span class="pre">Protocol</span> <span class="pre">Buffers</span></code> for shared and static builds, respectively.</p></li> @@ -454,25 +476,25 @@ <div class="section" id="build-and-install-protobuf"> <span id="building-protobuf"></span><h3>Build and Install Protobuf<a class="headerlink" href="#build-and-install-protobuf" title="Permalink to this headline">¶</a></h3> <p>Google Protocol Buffers provide the foundation of <a class="reference internal" href="../other_information/20_glossary.html#term-OSI"><span class="xref std std-term">OSI</span></a> (see also <a class="reference internal" href="#building-osi"><span class="std std-ref">Build and Install OSI</span></a>). -Due to the usage of OSI different situations (<strong>OpenPASS</strong> executables, libraries, tests, <a class="reference internal" href="../other_information/20_glossary.html#term-FMU"><span class="xref std std-term">FMUs</span></a>, etc.) static and shared libraries of protobuf have to be provided. -This section gives instructions, how to compile version 3.17.3. and hook it into the <strong>openPASS</strong> build. +Due to the usage of OSI different situations (<strong>openPASS</strong> executables, libraries, tests, <a class="reference internal" href="../other_information/20_glossary.html#term-FMU"><span class="xref std std-term">FMUs</span></a>, etc.) static and shared libraries of protobuf have to be provided. +This section gives instructions, how to compile version 3.20.0. and hook it into the <strong>openPASS</strong> build. This currently applies to the <strong>openPASS</strong> build, as static and shared libraries of Protobuf are required.</p> <ol class="arabic"> -<li><p>Download release 3.17.3 from <a class="reference external" href="https://github.com/protocolbuffers/protobuf/releases">https://github.com/protocolbuffers/protobuf/releases</a></p></li> +<li><p>Download release 3.20.0 from <a class="reference external" href="https://github.com/protocolbuffers/protobuf/releases">https://github.com/protocolbuffers/protobuf/releases</a></p></li> <li><p>Extract</p> <ul class="simple"> -<li><p>for Windows to <code class="docutils literal notranslate"><span class="pre">C:\OpenPASS\thirdParty\sources\protobuf-cpp-3.17.3</span></code></p></li> -<li><p>for Linux to <code class="docutils literal notranslate"><span class="pre">~/OpenPASS/thirdParty/sources/protobuf-cpp-3.17.3</span></code></p></li> +<li><p>for Windows to <code class="docutils literal notranslate"><span class="pre">C:\openpass\thirdParty\sources\protobuf-cpp-3.20.0</span></code></p></li> +<li><p>for Linux to <code class="docutils literal notranslate"><span class="pre">~/openpass/thirdParty/sources/protobuf-cpp-3.20.0</span></code></p></li> </ul> </li> <li><p>Navigate to the extracted folder</p> <div class="sphinx-tabs docutils container"> <div aria-label="Tabbed content" class="closeable" role="tablist"><button aria-controls="panel-3-3-0" aria-selected="true" class="sphinx-tabs-tab" id="tab-3-3-0" name="3-0" role="tab" tabindex="0">Windows</button><button aria-controls="panel-3-3-1" aria-selected="false" class="sphinx-tabs-tab" id="tab-3-3-1" name="3-1" role="tab" tabindex="-1">Linux</button></div><div aria-labelledby="tab-3-3-0" class="sphinx-tabs-panel" id="panel-3-3-0" name="3-0" role="tabpanel" tabindex="0"><p>Start <code class="docutils literal notranslate"><span class="pre">MinGW</span> <span class="pre">64-bit</span></code> shell</p> -<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">cd</span> <span class="o">/</span><span class="n">C</span><span class="o">/</span><span class="n">OpenPASS</span><span class="o">/</span><span class="n">thirdParty</span><span class="o">/</span><span class="n">sources</span><span class="o">/</span><span class="n">protobuf</span><span class="o">-</span><span class="n">cpp</span><span class="o">-</span><span class="mf">3.17</span><span class="o">.</span><span class="mi">3</span> +<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">cd</span> <span class="o">/</span><span class="n">C</span><span class="o">/</span><span class="n">openpass</span><span class="o">/</span><span class="n">thirdParty</span><span class="o">/</span><span class="n">sources</span><span class="o">/</span><span class="n">protobuf</span><span class="o">-</span><span class="n">cpp</span><span class="o">-</span><span class="mf">3.20</span><span class="o">.</span><span class="mi">0</span> </pre></div> </div> </div><div aria-labelledby="tab-3-3-1" class="sphinx-tabs-panel" hidden="true" id="panel-3-3-1" name="3-1" role="tabpanel" tabindex="0"><p>Start <code class="docutils literal notranslate"><span class="pre">Bash</span></code> shell</p> -<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">cd</span> <span class="o">~/</span><span class="n">OpenPASS</span><span class="o">/</span><span class="n">thirdParty</span><span class="o">/</span><span class="n">sources</span><span class="o">/</span><span class="n">protobuf</span><span class="o">-</span><span class="n">cpp</span><span class="o">-</span><span class="mf">3.17</span><span class="o">.</span><span class="mi">3</span> +<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">cd</span> <span class="o">~/</span><span class="n">openpass</span><span class="o">/</span><span class="n">thirdParty</span><span class="o">/</span><span class="n">sources</span><span class="o">/</span><span class="n">protobuf</span><span class="o">-</span><span class="n">cpp</span><span class="o">-</span><span class="mf">3.20</span><span class="o">.</span><span class="mi">0</span> </pre></div> </div> </div></div> @@ -488,7 +510,7 @@ <div class="sphinx-tabs docutils container"> <div aria-label="Tabbed content" class="closeable" role="tablist"><button aria-controls="panel-4-4-0" aria-selected="true" class="sphinx-tabs-tab" id="tab-4-4-0" name="4-0" role="tab" tabindex="0">Windows</button><button aria-controls="panel-4-4-1" aria-selected="false" class="sphinx-tabs-tab" id="tab-4-4-1" name="4-1" role="tab" tabindex="-1">Linux</button></div><div aria-labelledby="tab-4-4-0" class="sphinx-tabs-panel" id="panel-4-4-0" name="4-0" role="tabpanel" tabindex="0"><div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">cmake</span> <span class="o">-</span><span class="n">G</span> <span class="s2">"MSYS Makefiles"</span> \ <span class="o">-</span><span class="n">DCMAKE_BUILD_TYPE</span><span class="o">=</span><span class="n">Release</span> \ - <span class="o">-</span><span class="n">DCMAKE_INSTALL_PREFIX</span><span class="o">=</span><span class="n">C</span><span class="p">:</span><span class="o">/</span><span class="n">OpenPASS</span><span class="o">/</span><span class="n">thirdParty</span><span class="o">/</span><span class="n">protobuf</span> \ + <span class="o">-</span><span class="n">DCMAKE_INSTALL_PREFIX</span><span class="o">=</span><span class="n">C</span><span class="p">:</span><span class="o">/</span><span class="n">openpass</span><span class="o">/</span><span class="n">thirdParty</span><span class="o">/</span><span class="n">protobuf</span> \ <span class="o">-</span><span class="n">Dprotobuf_BUILD_SHARED_LIBS</span><span class="o">=</span><span class="n">OFF</span> \ <span class="o">-</span><span class="n">Dprotobuf_BUILD_TESTS</span><span class="o">=</span><span class="n">OFF</span> \ <span class="hll"> <span class="o">-</span><span class="n">DCMAKE_CXX_FLAGS</span><span class="o">=-</span><span class="n">fPIC</span> \ @@ -496,7 +518,7 @@ </pre></div> </div> </div><div aria-labelledby="tab-4-4-1" class="sphinx-tabs-panel" hidden="true" id="panel-4-4-1" name="4-1" role="tabpanel" tabindex="0"><div class="highlight-default notranslate"><div class="highlight"><pre><span></span>cmake -DCMAKE_BUILD_TYPE=Release \ - -DCMAKE_INSTALL_PREFIX=$HOME/OpenPASS/thirdParty/protobuf \ + -DCMAKE_INSTALL_PREFIX=$HOME/openpass/thirdParty/protobuf \ -Dprotobuf_BUILD_SHARED_LIBS=OFF \ -Dprotobuf_BUILD_TESTS=OFF \ <span class="hll"> -DCMAKE_CXX_FLAGS=-fPIC \ @@ -525,7 +547,7 @@ <p>After completion, <strong>repeat the steps described above</strong> with the following changes applied to the CMake call:</p> <ol class="arabic simple"> <li><p>Set <code class="docutils literal notranslate"><span class="pre">protobuf_BUILD_SHARED_LIBS</span></code> to <code class="docutils literal notranslate"><span class="pre">ON</span></code> and remove -DCMAKE_CXX_FLAGS=-fPIC flag.</p></li> -<li><p>Use <code class="docutils literal notranslate"><span class="pre">$HOME/OpenPASS/thirdParty/protobuf-shared</span></code> as <code class="docutils literal notranslate"><span class="pre">CMAKE_INSTALL_PREFIX</span></code></p></li> +<li><p>Use <code class="docutils literal notranslate"><span class="pre">$HOME/openpass/thirdParty/protobuf-shared</span></code> as <code class="docutils literal notranslate"><span class="pre">CMAKE_INSTALL_PREFIX</span></code></p></li> </ol> <p>This creates and installs the Protobuf libraries, as the Protobuf dynamic and static libs are required for the openPASS build.</p> </div> @@ -536,18 +558,18 @@ OSI itself uses <code class="docutils literal notranslate"><span class="pre">protobuf</span></code> to describe data structures in a platform independent way by means of <cite>*.proto</cite> files. When building OSI, these files are converted into C++ headers and sources, using the protobuf compiler <code class="docutils literal notranslate"><span class="pre">protoc</span></code>. Finally, the sources are then compiled into a library. -<strong>OpenPASS</strong> finally uses the library and the generated headers to interface the library.</p> +<strong>openPASS</strong> finally uses the library and the generated headers to interface the library.</p> <ol class="arabic"> <li><p>Open and create directory structure</p> <div class="sphinx-tabs docutils container"> <div aria-label="Tabbed content" class="closeable" role="tablist"><button aria-controls="panel-5-5-0" aria-selected="true" class="sphinx-tabs-tab" id="tab-5-5-0" name="5-0" role="tab" tabindex="0">Windows</button><button aria-controls="panel-5-5-1" aria-selected="false" class="sphinx-tabs-tab" id="tab-5-5-1" name="5-1" role="tab" tabindex="-1">Linux</button></div><div aria-labelledby="tab-5-5-0" class="sphinx-tabs-panel" id="panel-5-5-0" name="5-0" role="tabpanel" tabindex="0"><p>Start <code class="docutils literal notranslate"><span class="pre">MinGW</span> <span class="pre">64-bit</span></code> shell</p> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">cd</span> <span class="o">/</span><span class="n">C</span><span class="o">/</span> -<span class="n">mkdir</span> <span class="o">-</span><span class="n">p</span> <span class="n">OpenPASS</span><span class="o">/</span><span class="n">thirdParty</span><span class="o">/</span><span class="n">sources</span> +<span class="n">mkdir</span> <span class="o">-</span><span class="n">p</span> <span class="n">openpass</span><span class="o">/</span><span class="n">thirdParty</span><span class="o">/</span><span class="n">sources</span> </pre></div> </div> </div><div aria-labelledby="tab-5-5-1" class="sphinx-tabs-panel" hidden="true" id="panel-5-5-1" name="5-1" role="tabpanel" tabindex="0"><p>Start <code class="docutils literal notranslate"><span class="pre">Bash</span></code> shell</p> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">cd</span> <span class="o">~</span> -<span class="n">mkdir</span> <span class="o">-</span><span class="n">p</span> <span class="n">OpenPASS</span><span class="o">/</span><span class="n">thirdParty</span><span class="o">/</span><span class="n">sources</span> +<span class="n">mkdir</span> <span class="o">-</span><span class="n">p</span> <span class="n">openpass</span><span class="o">/</span><span class="n">thirdParty</span><span class="o">/</span><span class="n">sources</span> </pre></div> </div> </div></div> @@ -555,16 +577,16 @@ <li><p>Download release 3.5.0 from <a class="reference external" href="https://github.com/OpenSimulationInterface/open-simulation-interface">https://github.com/OpenSimulationInterface/open-simulation-interface</a></p></li> <li><p>Extract</p> <ul class="simple"> -<li><p>for Windows to <code class="docutils literal notranslate"><span class="pre">C:\OpenPASS\thirdParty\sources\open-simulation-interface-3.5.0</span></code></p></li> -<li><p>for Linux to <code class="docutils literal notranslate"><span class="pre">~/OpenPASS/thirdParty/sources/open-simulation-interface-3.5.0</span></code></p></li> +<li><p>for Windows to <code class="docutils literal notranslate"><span class="pre">C:\openpass\thirdParty\sources\open-simulation-interface-3.5.0</span></code></p></li> +<li><p>for Linux to <code class="docutils literal notranslate"><span class="pre">~/openpass/thirdParty/sources/open-simulation-interface-3.5.0</span></code></p></li> </ul> </li> <li><p>Navigate to the extracted folder</p> <div class="sphinx-tabs docutils container"> -<div aria-label="Tabbed content" class="closeable" role="tablist"><button aria-controls="panel-6-6-0" aria-selected="true" class="sphinx-tabs-tab" id="tab-6-6-0" name="6-0" role="tab" tabindex="0">Windows</button><button aria-controls="panel-6-6-1" aria-selected="false" class="sphinx-tabs-tab" id="tab-6-6-1" name="6-1" role="tab" tabindex="-1">Linux</button></div><div aria-labelledby="tab-6-6-0" class="sphinx-tabs-panel" id="panel-6-6-0" name="6-0" role="tabpanel" tabindex="0"><div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">cd</span> <span class="o">/</span><span class="n">C</span><span class="o">/</span><span class="n">OpenPASS</span><span class="o">/</span><span class="n">thirdParty</span><span class="o">/</span><span class="n">sources</span><span class="o">/</span><span class="nb">open</span><span class="o">-</span><span class="n">simulation</span><span class="o">-</span><span class="n">interface</span><span class="o">-</span><span class="mf">3.5</span><span class="o">.</span><span class="mi">0</span> +<div aria-label="Tabbed content" class="closeable" role="tablist"><button aria-controls="panel-6-6-0" aria-selected="true" class="sphinx-tabs-tab" id="tab-6-6-0" name="6-0" role="tab" tabindex="0">Windows</button><button aria-controls="panel-6-6-1" aria-selected="false" class="sphinx-tabs-tab" id="tab-6-6-1" name="6-1" role="tab" tabindex="-1">Linux</button></div><div aria-labelledby="tab-6-6-0" class="sphinx-tabs-panel" id="panel-6-6-0" name="6-0" role="tabpanel" tabindex="0"><div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">cd</span> <span class="o">/</span><span class="n">C</span><span class="o">/</span><span class="n">openpass</span><span class="o">/</span><span class="n">thirdParty</span><span class="o">/</span><span class="n">sources</span><span class="o">/</span><span class="nb">open</span><span class="o">-</span><span class="n">simulation</span><span class="o">-</span><span class="n">interface</span><span class="o">-</span><span class="mf">3.5</span><span class="o">.</span><span class="mi">0</span> </pre></div> </div> -</div><div aria-labelledby="tab-6-6-1" class="sphinx-tabs-panel" hidden="true" id="panel-6-6-1" name="6-1" role="tabpanel" tabindex="0"><div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">cd</span> <span class="o">~/</span><span class="n">OpenPASS</span><span class="o">/</span><span class="n">thirdParty</span><span class="o">/</span><span class="n">sources</span><span class="o">/</span><span class="nb">open</span><span class="o">-</span><span class="n">simulation</span><span class="o">-</span><span class="n">interface</span><span class="o">-</span><span class="mf">3.5</span><span class="o">.</span><span class="mi">0</span> +</div><div aria-labelledby="tab-6-6-1" class="sphinx-tabs-panel" hidden="true" id="panel-6-6-1" name="6-1" role="tabpanel" tabindex="0"><div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">cd</span> <span class="o">~/</span><span class="n">openpass</span><span class="o">/</span><span class="n">thirdParty</span><span class="o">/</span><span class="n">sources</span><span class="o">/</span><span class="nb">open</span><span class="o">-</span><span class="n">simulation</span><span class="o">-</span><span class="n">interface</span><span class="o">-</span><span class="mf">3.5</span><span class="o">.</span><span class="mi">0</span> </pre></div> </div> </div></div> @@ -572,12 +594,12 @@ <li><p>Optional: Enable Arenas</p> <p>For better performance, <strong>openPASS</strong> supports protobuf Arenas allocation (<a class="reference external" href="https://developers.google.com/protocol-buffers/docs/reference/arenas">https://developers.google.com/protocol-buffers/docs/reference/arenas</a>). To use this feature, OSI and <strong>openPASS</strong> needs to be compiled with Arenas support. -See <a class="reference internal" href="further_guidance/10_cmake.html#cmake-protobuf-arenas"><span class="std std-ref">WITH_EXTENDED_OSI</span></a> how this feature is enabled in <strong>openPASS</strong>.</p> +See <a class="reference internal" href="further_guidance/10_cmake.html#cmake-protobuf-arenas"><span class="std std-ref">WITH_PROTOBUF_ARENA</span></a> how this feature is enabled in <strong>openPASS</strong>.</p> <p>To enable Arenas support for OSI, the line <code class="docutils literal notranslate"><span class="pre">option</span> <span class="pre">cc_enable_arenas</span> <span class="pre">=</span> <span class="pre">true;</span></code> needs to be added <strong>manually</strong> to all OSI proto files before compilation.</p> <p>This can be achieved in two ways. Either the line <code class="docutils literal notranslate"><span class="pre">option</span> <span class="pre">cc_enable_arenas</span> <span class="pre">=</span> <span class="pre">true;</span></code> gets added manually <strong>after the second line</strong> of each PROTO file</p> <ul class="simple"> -<li><p>for Windows in <code class="docutils literal notranslate"><span class="pre">C:\OpenPASS\thirdParty\sources\open-simulation-interface</span></code></p></li> -<li><p>for Linux in <code class="docutils literal notranslate"><span class="pre">~/OpenPASS/thirdParty/sources/open-simulation-interface</span></code></p></li> +<li><p>for Windows in <code class="docutils literal notranslate"><span class="pre">C:\openpass\thirdParty\sources\open-simulation-interface</span></code></p></li> +<li><p>for Linux in <code class="docutils literal notranslate"><span class="pre">~/openpass/thirdParty/sources/open-simulation-interface</span></code></p></li> </ul> <p>by using a text editor or one makes use of the stream editor in the shell:</p> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">find</span> <span class="o">.</span> <span class="o">-</span><span class="n">maxdepth</span> <span class="mi">1</span> <span class="o">-</span><span class="n">name</span> <span class="s1">'*.proto'</span> <span class="o">-</span><span class="n">exec</span> <span class="n">sed</span> <span class="o">-</span><span class="n">i</span> <span class="s1">'2i option cc_enable_arenas = true;'</span> <span class="p">{}</span> \<span class="p">;</span> @@ -599,14 +621,14 @@ <div class="sphinx-tabs docutils container"> <div aria-label="Tabbed content" class="closeable" role="tablist"><button aria-controls="panel-7-7-0" aria-selected="true" class="sphinx-tabs-tab" id="tab-7-7-0" name="7-0" role="tab" tabindex="0">Windows</button><button aria-controls="panel-7-7-1" aria-selected="false" class="sphinx-tabs-tab" id="tab-7-7-1" name="7-1" role="tab" tabindex="-1">Linux</button></div><div aria-labelledby="tab-7-7-0" class="sphinx-tabs-panel" id="panel-7-7-0" name="7-0" role="tabpanel" tabindex="0"><div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">cmake</span> <span class="o">-</span><span class="n">G</span> <span class="s2">"MSYS Makefiles"</span> \ <span class="o">-</span><span class="n">DCMAKE_BUILD_TYPE</span><span class="o">=</span><span class="n">Release</span> \ - <span class="o">-</span><span class="n">DCMAKE_INSTALL_PREFIX</span><span class="o">=</span><span class="n">C</span><span class="p">:</span><span class="o">/</span><span class="n">OpenPASS</span><span class="o">/</span><span class="n">thirdParty</span><span class="o">/</span><span class="n">osi</span> \ - <span class="o">-</span><span class="n">DCMAKE_PREFIX_PATH</span><span class="o">=</span><span class="n">C</span><span class="p">:</span><span class="o">/</span><span class="n">OpenPASS</span><span class="o">/</span><span class="n">thirdParty</span><span class="o">/</span><span class="n">protobuf</span><span class="o">-</span><span class="n">shared</span><span class="o">/</span> + <span class="o">-</span><span class="n">DCMAKE_INSTALL_PREFIX</span><span class="o">=</span><span class="n">C</span><span class="p">:</span><span class="o">/</span><span class="n">openpass</span><span class="o">/</span><span class="n">thirdParty</span><span class="o">/</span><span class="n">osi</span> \ + <span class="o">-</span><span class="n">DCMAKE_PREFIX_PATH</span><span class="o">=</span><span class="n">C</span><span class="p">:</span><span class="o">/</span><span class="n">openpass</span><span class="o">/</span><span class="n">thirdParty</span><span class="o">/</span><span class="n">protobuf</span><span class="o">-</span><span class="n">shared</span><span class="o">/</span> <span class="o">..</span> </pre></div> </div> </div><div aria-labelledby="tab-7-7-1" class="sphinx-tabs-panel" hidden="true" id="panel-7-7-1" name="7-1" role="tabpanel" tabindex="0"><div class="highlight-default notranslate"><div class="highlight"><pre><span></span>cmake -DCMAKE_BUILD_TYPE=Release \ - -DCMAKE_INSTALL_PREFIX=$HOME/OpenPASS/thirdParty/osi \ - -DCMAKE_PREFIX_PATH=$HOME/OpenPASS/thirdParty/protobuf-shared/ + -DCMAKE_INSTALL_PREFIX=$HOME/openpass/thirdParty/osi \ + -DCMAKE_PREFIX_PATH=$HOME/openpass/thirdParty/protobuf-shared/ .. </pre></div> </div> @@ -625,7 +647,7 @@ <p>and check if correct protobuf version is used.</p> <div class="admonition note"> <p class="admonition-title">Note</p> -<p>If no protobuf is found the path to protoc needs to be first set manually in the terminal. <code class="docutils literal notranslate"><span class="pre">export</span> <span class="pre">PATH=$HOME/OpenPASS/thirdParty/protobuf-shared/bin:$PATH</span></code></p> +<p>If no protobuf is found the path to protoc needs to be first set manually in the terminal. <code class="docutils literal notranslate"><span class="pre">export</span> <span class="pre">PATH=$HOME/openpass/thirdParty/protobuf-shared/bin:$PATH</span></code></p> </div> </div> </li> @@ -654,18 +676,18 @@ <ol class="arabic"> <li><p>Extract</p> <ul class="simple"> -<li><p>for Windows to <code class="docutils literal notranslate"><span class="pre">C:\OpenPASS\thirdParty\sources\fmi-library-2.0.3</span></code></p></li> -<li><p>for Linux to <code class="docutils literal notranslate"><span class="pre">~/OpenPASS/thirdParty/sources/fmi-library-2.0.3</span></code></p></li> +<li><p>for Windows to <code class="docutils literal notranslate"><span class="pre">C:\openpass\thirdParty\sources\fmi-library-2.0.3</span></code></p></li> +<li><p>for Linux to <code class="docutils literal notranslate"><span class="pre">~/openpass/thirdParty/sources/fmi-library-2.0.3</span></code></p></li> </ul> </li> <li><p>Navigate to the extracted folder</p> <div class="sphinx-tabs docutils container"> <div aria-label="Tabbed content" class="closeable" role="tablist"><button aria-controls="panel-8-8-0" aria-selected="true" class="sphinx-tabs-tab" id="tab-8-8-0" name="8-0" role="tab" tabindex="0">Windows</button><button aria-controls="panel-8-8-1" aria-selected="false" class="sphinx-tabs-tab" id="tab-8-8-1" name="8-1" role="tab" tabindex="-1">Linux</button></div><div aria-labelledby="tab-8-8-0" class="sphinx-tabs-panel" id="panel-8-8-0" name="8-0" role="tabpanel" tabindex="0"><p>Start <code class="docutils literal notranslate"><span class="pre">MinGW</span> <span class="pre">64-bit</span></code> shell</p> -<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">cd</span> <span class="o">/</span><span class="n">C</span><span class="o">/</span><span class="n">OpenPASS</span><span class="o">/</span><span class="n">thirdParty</span><span class="o">/</span><span class="n">sources</span><span class="o">/</span><span class="n">fmi</span><span class="o">-</span><span class="n">library</span><span class="o">-</span><span class="mf">2.0</span><span class="o">.</span><span class="mi">3</span> +<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">cd</span> <span class="o">/</span><span class="n">C</span><span class="o">/</span><span class="n">openpass</span><span class="o">/</span><span class="n">thirdParty</span><span class="o">/</span><span class="n">sources</span><span class="o">/</span><span class="n">fmi</span><span class="o">-</span><span class="n">library</span><span class="o">-</span><span class="mf">2.0</span><span class="o">.</span><span class="mi">3</span> </pre></div> </div> </div><div aria-labelledby="tab-8-8-1" class="sphinx-tabs-panel" hidden="true" id="panel-8-8-1" name="8-1" role="tabpanel" tabindex="0"><p>Start <code class="docutils literal notranslate"><span class="pre">Bash</span></code> shell</p> -<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">cd</span> <span class="o">~/</span><span class="n">OpenPASS</span><span class="o">/</span><span class="n">thirdParty</span><span class="o">/</span><span class="n">sources</span><span class="o">/</span><span class="n">fmi</span><span class="o">-</span><span class="n">library</span><span class="o">-</span><span class="mf">2.0</span><span class="o">.</span><span class="mi">3</span> +<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">cd</span> <span class="o">~/</span><span class="n">openpass</span><span class="o">/</span><span class="n">thirdParty</span><span class="o">/</span><span class="n">sources</span><span class="o">/</span><span class="n">fmi</span><span class="o">-</span><span class="n">library</span><span class="o">-</span><span class="mf">2.0</span><span class="o">.</span><span class="mi">3</span> </pre></div> </div> </div></div> @@ -679,14 +701,14 @@ <li><p>Run Cmake</p> <div class="sphinx-tabs docutils container"> <div aria-label="Tabbed content" class="closeable" role="tablist"><button aria-controls="panel-9-9-0" aria-selected="true" class="sphinx-tabs-tab" id="tab-9-9-0" name="9-0" role="tab" tabindex="0">Windows</button><button aria-controls="panel-9-9-1" aria-selected="false" class="sphinx-tabs-tab" id="tab-9-9-1" name="9-1" role="tab" tabindex="-1">Linux</button></div><div aria-labelledby="tab-9-9-0" class="sphinx-tabs-panel" id="panel-9-9-0" name="9-0" role="tabpanel" tabindex="0"><div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">cmake</span> <span class="o">-</span><span class="n">G</span> <span class="s2">"MSYS Makefiles"</span> \ - <span class="o">-</span><span class="n">DFMILIB_INSTALL_PREFIX</span><span class="o">=</span><span class="n">C</span><span class="p">:</span><span class="o">/</span><span class="n">OpenPASS</span><span class="o">/</span><span class="n">thirdParty</span><span class="o">/</span><span class="n">FMILibrary</span> \ + <span class="o">-</span><span class="n">DFMILIB_INSTALL_PREFIX</span><span class="o">=</span><span class="n">C</span><span class="p">:</span><span class="o">/</span><span class="n">openpass</span><span class="o">/</span><span class="n">thirdParty</span><span class="o">/</span><span class="n">FMILibrary</span> \ <span class="o">-</span><span class="n">DCMAKE_BUILD_TYPE</span><span class="o">=</span><span class="n">Release</span> \ <span class="o">-</span><span class="n">DFMILIB_BUILD_STATIC_LIB</span><span class="o">=</span><span class="n">OFF</span> \ <span class="o">-</span><span class="n">DFMILIB_BUILD_SHARED_LIB</span><span class="o">=</span><span class="n">ON</span> \ <span class="o">..</span> </pre></div> </div> -</div><div aria-labelledby="tab-9-9-1" class="sphinx-tabs-panel" hidden="true" id="panel-9-9-1" name="9-1" role="tabpanel" tabindex="0"><div class="highlight-default notranslate"><div class="highlight"><pre><span></span>cmake -DFMILIB_INSTALL_PREFIX=$HOME/OpenPASS/thirdParty/FMILibrary \ +</div><div aria-labelledby="tab-9-9-1" class="sphinx-tabs-panel" hidden="true" id="panel-9-9-1" name="9-1" role="tabpanel" tabindex="0"><div class="highlight-default notranslate"><div class="highlight"><pre><span></span>cmake -DFMILIB_INSTALL_PREFIX=$HOME/openpass/thirdParty/FMILibrary \ -DCMAKE_BUILD_TYPE=Release \ -DFMILIB_BUILD_STATIC_LIB=OFF \ -DFMILIB_BUILD_SHARED_LIB=ON \ @@ -705,15 +727,9 @@ <ul class="simple"> <li><p><a class="reference download internal" download="" href="../_downloads/d1dbc0ee423132666374fa73f6c0f165/fmi-library-2.0.3-fixes.patch"><code class="xref download docutils literal notranslate"><span class="pre">Windows/Linux</span> <span class="pre">Patch</span></code></a></p></li> </ul> -<div class="sphinx-tabs docutils container"> -<div aria-label="Tabbed content" class="closeable" role="tablist"><button aria-controls="panel-10-10-0" aria-selected="true" class="sphinx-tabs-tab" id="tab-10-10-0" name="10-0" role="tab" tabindex="0">Windows</button><button aria-controls="panel-10-10-1" aria-selected="false" class="sphinx-tabs-tab" id="tab-10-10-1" name="10-1" role="tab" tabindex="-1">Linux</button></div><div aria-labelledby="tab-10-10-0" class="sphinx-tabs-panel" id="panel-10-10-0" name="10-0" role="tabpanel" tabindex="0"><div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">git</span> <span class="n">apply</span> <span class="o">--</span><span class="n">ignore</span><span class="o">-</span><span class="n">whitespace</span> <span class="s2">"<path/to>/fmi-library-2.0.3-fixes.patch"</span> +<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">git</span> <span class="n">apply</span> <span class="o">--</span><span class="n">ignore</span><span class="o">-</span><span class="n">whitespace</span> <span class="s2">"<path/to>/fmi-library-2.0.3-fixes.patch"</span> </pre></div> </div> -</div><div aria-labelledby="tab-10-10-1" class="sphinx-tabs-panel" hidden="true" id="panel-10-10-1" name="10-1" role="tabpanel" tabindex="0"><div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">dos2unix</span> <span class="n">src</span><span class="o">/</span><span class="n">Import</span><span class="o">/</span><span class="n">src</span><span class="o">/</span><span class="n">FMI1</span><span class="o">/</span><span class="n">fmi1_import_capi</span><span class="o">.</span><span class="n">c</span> <span class="n">src</span><span class="o">/</span><span class="n">Import</span><span class="o">/</span><span class="n">src</span><span class="o">/</span><span class="n">FMI2</span><span class="o">/</span><span class="n">fmi2_import_capi</span><span class="o">.</span><span class="n">c</span> <span class="n">src</span><span class="o">/</span><span class="n">Util</span><span class="o">/</span><span class="n">include</span><span class="o">/</span><span class="n">JM</span><span class="o">/</span><span class="n">jm_portability</span><span class="o">.</span><span class="n">h</span> -<span class="n">git</span> <span class="n">apply</span> <span class="o">--</span><span class="n">ignore</span><span class="o">-</span><span class="n">whitespace</span> <span class="s2">"<path/to>/fmi-library-2.0.3-fixes.patch"</span> -</pre></div> -</div> -</div></div> </li> <li><p>Enter build directory</p> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">cd</span> <span class="n">build</span> @@ -739,14 +755,14 @@ <ol class="arabic"> <li><p>Open and create directory structure</p> <div class="sphinx-tabs docutils container"> -<div aria-label="Tabbed content" class="closeable" role="tablist"><button aria-controls="panel-11-11-0" aria-selected="true" class="sphinx-tabs-tab" id="tab-11-11-0" name="11-0" role="tab" tabindex="0">Windows</button><button aria-controls="panel-11-11-1" aria-selected="false" class="sphinx-tabs-tab" id="tab-11-11-1" name="11-1" role="tab" tabindex="-1">Linux</button></div><div aria-labelledby="tab-11-11-0" class="sphinx-tabs-panel" id="panel-11-11-0" name="11-0" role="tabpanel" tabindex="0"><p>Start <code class="docutils literal notranslate"><span class="pre">MinGW</span> <span class="pre">64-bit</span></code> shell</p> +<div aria-label="Tabbed content" class="closeable" role="tablist"><button aria-controls="panel-10-10-0" aria-selected="true" class="sphinx-tabs-tab" id="tab-10-10-0" name="10-0" role="tab" tabindex="0">Windows</button><button aria-controls="panel-10-10-1" aria-selected="false" class="sphinx-tabs-tab" id="tab-10-10-1" name="10-1" role="tab" tabindex="-1">Linux</button></div><div aria-labelledby="tab-10-10-0" class="sphinx-tabs-panel" id="panel-10-10-0" name="10-0" role="tabpanel" tabindex="0"><p>Start <code class="docutils literal notranslate"><span class="pre">MinGW</span> <span class="pre">64-bit</span></code> shell</p> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">cd</span> <span class="o">/</span><span class="n">C</span><span class="o">/</span> -<span class="n">mkdir</span> <span class="o">-</span><span class="n">p</span> <span class="n">OpenPASS</span><span class="o">/</span><span class="n">thirdParty</span><span class="o">/</span><span class="n">sources</span> +<span class="n">mkdir</span> <span class="o">-</span><span class="n">p</span> <span class="n">openpass</span><span class="o">/</span><span class="n">thirdParty</span><span class="o">/</span> </pre></div> </div> -</div><div aria-labelledby="tab-11-11-1" class="sphinx-tabs-panel" hidden="true" id="panel-11-11-1" name="11-1" role="tabpanel" tabindex="0"><p>Start <code class="docutils literal notranslate"><span class="pre">Bash</span></code> shell</p> +</div><div aria-labelledby="tab-10-10-1" class="sphinx-tabs-panel" hidden="true" id="panel-10-10-1" name="10-1" role="tabpanel" tabindex="0"><p>Start <code class="docutils literal notranslate"><span class="pre">Bash</span></code> shell</p> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">cd</span> <span class="o">~</span> -<span class="n">mkdir</span> <span class="o">-</span><span class="n">p</span> <span class="n">OpenPASS</span><span class="o">/</span><span class="n">thirdParty</span><span class="o">/</span><span class="n">sources</span> +<span class="n">mkdir</span> <span class="o">-</span><span class="n">p</span> <span class="n">openpass</span><span class="o">/</span><span class="n">thirdParty</span><span class="o">/</span> </pre></div> </div> </div></div> @@ -754,8 +770,8 @@ <li><p>Download release v1.2.12 from <a class="reference external" href="https://github.com/madler/zlib">https://github.com/madler/zlib</a></p></li> <li><p>Extract</p> <ul class="simple"> -<li><p>for Windows to <code class="docutils literal notranslate"><span class="pre">C:\OpenPASS\thirdParty\sources\zlib</span></code></p></li> -<li><p>for Linux to <code class="docutils literal notranslate"><span class="pre">~/OpenPASS/thirdParty/sources/zlib</span></code></p></li> +<li><p>for Windows to <code class="docutils literal notranslate"><span class="pre">C:\openpass\thirdParty\zlib</span></code></p></li> +<li><p>for Linux to <code class="docutils literal notranslate"><span class="pre">~/openpass/thirdParty/zlib</span></code></p></li> </ul> </li> </ol> @@ -769,7 +785,7 @@ </div> <footer> <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> - <a href="30_install_openpass.html" class="btn btn-neutral float-right" title="Installing OpenPASS" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a> + <a href="30_install_openpass.html" class="btn btn-neutral float-right" title="Installing openPASS" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a> <a href="15_system_requirements.html" class="btn btn-neutral float-left" title="System Requirements" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a> </div> @@ -777,7 +793,7 @@ <div role="contentinfo"> <p> - © Copyright 2023 OpenPASS Working Group. + © Copyright 2023 openPASS Working Group. </p> </div>
diff --git a/content/html/installation_guide/30_install_openpass.html b/content/html/installation_guide/30_install_openpass.html index 6ca6828..ce4cb0d 100644 --- a/content/html/installation_guide/30_install_openpass.html +++ b/content/html/installation_guide/30_install_openpass.html
@@ -7,7 +7,7 @@ <meta name="viewport" content="width=device-width, initial-scale=1.0" /> - <title>Installing OpenPASS — OpenPASS Documentation</title> + <title>Installing openPASS — openPASS Documentation</title> @@ -71,7 +71,7 @@ <div class="version"> - "openPASS v0.11" + "develop_4d7f6d4f2e22c286789082dd8cbe3eb7f5b5af62" </div> @@ -101,7 +101,7 @@ <li class="toctree-l1"><a class="reference internal" href="10_getting_started.html">Getting Started</a></li> <li class="toctree-l1"><a class="reference internal" href="15_system_requirements.html">System Requirements</a></li> <li class="toctree-l1"><a class="reference internal" href="20_install_prerequisites.html">Installing Prerequisites</a></li> -<li class="toctree-l1 current"><a class="current reference internal" href="#">Installing OpenPASS</a></li> +<li class="toctree-l1 current"><a class="current reference internal" href="#">Installing openPASS</a></li> <li class="toctree-l1"><a class="reference internal" href="50_further_guidance.html">Further Guidance</a></li> <li class="toctree-l1"><a class="reference internal" href="60_conan.html">Building with Conan</a></li> </ul> @@ -109,10 +109,9 @@ <ul> <li class="toctree-l1"><a class="reference internal" href="../user_guide/10_overview.html">Overview</a></li> <li class="toctree-l1"><a class="reference internal" href="../user_guide/20_tutorials.html">Tutorials</a></li> -<li class="toctree-l1"><a class="reference internal" href="../user_guide/30_gui_plugins.html">GUI Plugins</a></li> -<li class="toctree-l1"><a class="reference internal" href="../user_guide/40_configs_in_depth.html">Configs in Depth</a></li> -<li class="toctree-l1"><a class="reference internal" href="../user_guide/50_outputs_in_depth.html">Outputs in Depth</a></li> -<li class="toctree-l1"><a class="reference internal" href="../user_guide/60_scenario_simulation.html">Simulator</a></li> +<li class="toctree-l1"><a class="reference internal" href="../user_guide/30_configs_in_depth.html">Configs in Depth</a></li> +<li class="toctree-l1"><a class="reference internal" href="../user_guide/40_outputs_in_depth.html">Outputs in Depth</a></li> +<li class="toctree-l1"><a class="reference internal" href="../user_guide/50_scenario_simulation.html">Simulator</a></li> </ul> <p class="caption"><span class="caption-text">Advanced topics</span></p> <ul> @@ -123,12 +122,14 @@ <ul> <li class="toctree-l1"><a class="reference internal" href="../developer_information/10_ide_support.html">IDE Support</a></li> <li class="toctree-l1"><a class="reference internal" href="../developer_information/20_documentation.html">Documentation Concept</a></li> +<li class="toctree-l1"><a class="reference internal" href="../developer_information/30_coding_conventions.html">Coding Guidelines</a></li> </ul> <p class="caption"><span class="caption-text">Other Information</span></p> <ul> <li class="toctree-l1"><a class="reference internal" href="../other_information/10_external_dependencies.html">External Dependencies</a></li> <li class="toctree-l1"><a class="reference internal" href="../other_information/20_glossary.html">Glossary</a></li> -<li class="toctree-l1"><a class="reference internal" href="../other_information/30_license.html">License</a></li> +<li class="toctree-l1"><a class="reference internal" href="../other_information/30_gui_plugins.html">GUI Plugins</a></li> +<li class="toctree-l1"><a class="reference internal" href="../other_information/40_license.html">License</a></li> </ul> @@ -177,7 +178,7 @@ <li><a href="../index.html" class="icon icon-home"></a> »</li> - <li>Installing OpenPASS</li> + <li>Installing openPASS</li> <li class="wy-breadcrumbs-aside"> @@ -197,33 +198,33 @@ <div itemprop="articleBody"> <div class="section" id="installing-openpass"> -<span id="download-and-install-openpass"></span><h1>Installing OpenPASS<a class="headerlink" href="#installing-openpass" title="Permalink to this headline">¶</a></h1> +<span id="download-and-install-openpass"></span><h1>Installing openPASS<a class="headerlink" href="#installing-openpass" title="Permalink to this headline">¶</a></h1> <p>This section describes how compile and run <strong>openPASS</strong>. Please make sure that all prerequisites have been properly installed according to section <a class="reference internal" href="20_install_prerequisites.html#prerequisites"><span class="std std-ref">Installing Prerequisites</span></a>. If you have strictly followed the instructions, the installed source packages should be located on your machine under -<code class="docutils literal notranslate"><span class="pre">C:\OpenPASS\thirdParty</span></code> for <strong>Windows</strong> and <code class="docutils literal notranslate"><span class="pre">~/OpenPASS/thirdParty</span></code> for <strong>Linux</strong>. If there is a path deviation, +<code class="docutils literal notranslate"><span class="pre">C:\openpass\thirdParty</span></code> for <strong>Windows</strong> and <code class="docutils literal notranslate"><span class="pre">~/openpass/thirdParty</span></code> for <strong>Linux</strong>. If there is a path deviation, the following commands must be adjusted.</p> <p>To keep the installation process of <strong>openPASS</strong> as simple as possible, we again recommend a specific folder structure. If you have strictly followed and will follow the recommended paths of this guide, no command modifications are necessary.</p> <div class="sphinx-tabs docutils container"> <div aria-label="Tabbed content" class="closeable" role="tablist"><button aria-controls="panel-0-0-0" aria-selected="true" class="sphinx-tabs-tab" id="tab-0-0-0" name="0-0" role="tab" tabindex="0">Notes for Windows</button><button aria-controls="panel-0-0-1" aria-selected="false" class="sphinx-tabs-tab" id="tab-0-0-1" name="0-1" role="tab" tabindex="-1">Notes for Linux</button></div><div aria-labelledby="tab-0-0-0" class="sphinx-tabs-panel" id="panel-0-0-0" name="0-0" role="tabpanel" tabindex="0"><ul class="simple"> -<li><p>Recommended checkout path of <strong>openPASS</strong> repository: <code class="docutils literal notranslate"><span class="pre">C:\simopenpass</span></code></p></li> -<li><p>Recommended dependency directory within the <strong>openPASS</strong> repository: <code class="docutils literal notranslate"><span class="pre">C:\simopenpass\deps\thirdParty</span></code></p></li> -<li><p>Recommended installation directory of <strong>openPASS</strong>: <code class="docutils literal notranslate"><span class="pre">C:\OpenPASS\bin\core</span></code></p></li> +<li><p>Recommended checkout path of <strong>openPASS</strong> repository: <code class="docutils literal notranslate"><span class="pre">C:\openpass</span></code></p></li> +<li><p>Recommended dependency directory within the <strong>openPASS</strong> repository: <code class="docutils literal notranslate"><span class="pre">C:\openpass\deps\thirdParty</span></code></p></li> +<li><p>Recommended installation directory of <strong>openPASS</strong>: <code class="docutils literal notranslate"><span class="pre">C:\openPASS\bin\core</span></code></p></li> </ul> </div><div aria-labelledby="tab-0-0-1" class="sphinx-tabs-panel" hidden="true" id="panel-0-0-1" name="0-1" role="tabpanel" tabindex="0"><ul class="simple"> -<li><p>Recommended checkout path of <strong>openPASS</strong> repository: <code class="docutils literal notranslate"><span class="pre">~/simopenpass</span></code></p></li> -<li><p>Recommended dependency directory within the <strong>openPASS</strong> repository: <code class="docutils literal notranslate"><span class="pre">~/simopenpass/deps/thirdParty</span></code></p></li> -<li><p>Recommended installation directory of <strong>openPASS</strong>: <code class="docutils literal notranslate"><span class="pre">/usr/local/OpenPASS/bin/core</span></code></p></li> +<li><p>Recommended checkout path of <strong>openPASS</strong> repository: <code class="docutils literal notranslate"><span class="pre">~/openpass</span></code></p></li> +<li><p>Recommended dependency directory within the <strong>openPASS</strong> repository: <code class="docutils literal notranslate"><span class="pre">~/openpass/deps/thirdParty</span></code></p></li> +<li><p>Recommended installation directory of <strong>openPASS</strong>: <code class="docutils literal notranslate"><span class="pre">/usr/local/openPASS/bin/core</span></code></p></li> </ul> </div></div> <p>The above directory structure will be created by following the instructions of this guide.</p> <ol class="arabic"> -<li><p>Clone <strong>OpenPASS</strong> repository</p> -<p>As described above, the checkout path of the repository is assumed to be the default <code class="docutils literal notranslate"><span class="pre">simopenpass</span></code>.</p> +<li><p>Clone <strong>openPASS</strong> repository</p> +<p>As described above, the checkout path of the repository is assumed to be the default <code class="docutils literal notranslate"><span class="pre">openpass</span></code>.</p> <div class="sphinx-tabs docutils container"> <div aria-label="Tabbed content" class="closeable" role="tablist"><button aria-controls="panel-1-1-0" aria-selected="true" class="sphinx-tabs-tab" id="tab-1-1-0" name="1-0" role="tab" tabindex="0">Windows</button><button aria-controls="panel-1-1-1" aria-selected="false" class="sphinx-tabs-tab" id="tab-1-1-1" name="1-1" role="tab" tabindex="-1">Linux</button></div><div aria-labelledby="tab-1-1-0" class="sphinx-tabs-panel" id="panel-1-1-0" name="1-0" role="tabpanel" tabindex="0"><p>Start <code class="docutils literal notranslate"><span class="pre">MinGW</span> <span class="pre">64-bit</span></code> shell</p> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">cd</span> <span class="o">/</span><span class="n">C</span><span class="o">/</span> -<span class="n">git</span> <span class="n">clone</span> <span class="n">https</span><span class="p">:</span><span class="o">//</span><span class="n">gitlab</span><span class="o">.</span><span class="n">eclipse</span><span class="o">.</span><span class="n">org</span><span class="o">/</span><span class="n">eclipse</span><span class="o">/</span><span class="n">simopenpass</span><span class="o">/</span><span class="n">simopenpass</span><span class="o">.</span><span class="n">git</span> +<span class="n">git</span> <span class="n">clone</span> <span class="n">https</span><span class="p">:</span><span class="o">//</span><span class="n">gitlab</span><span class="o">.</span><span class="n">eclipse</span><span class="o">.</span><span class="n">org</span><span class="o">/</span><span class="n">eclipse</span><span class="o">/</span><span class="n">openpass</span><span class="o">/</span><span class="n">opSimulation</span><span class="o">.</span><span class="n">git</span> <span class="n">openpass</span> </pre></div> </div> <div class="admonition note"> @@ -235,13 +236,13 @@ </div> </div><div aria-labelledby="tab-1-1-1" class="sphinx-tabs-panel" hidden="true" id="panel-1-1-1" name="1-1" role="tabpanel" tabindex="0"><p>Start <code class="docutils literal notranslate"><span class="pre">Bash</span></code> shell</p> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">cd</span> <span class="o">~</span> -<span class="n">git</span> <span class="n">clone</span> <span class="n">https</span><span class="p">:</span><span class="o">//</span><span class="n">gitlab</span><span class="o">.</span><span class="n">eclipse</span><span class="o">.</span><span class="n">org</span><span class="o">/</span><span class="n">eclipse</span><span class="o">/</span><span class="n">simopenpass</span><span class="o">/</span><span class="n">simopenpass</span><span class="o">.</span><span class="n">git</span> +<span class="n">git</span> <span class="n">clone</span> <span class="n">https</span><span class="p">:</span><span class="o">//</span><span class="n">gitlab</span><span class="o">.</span><span class="n">eclipse</span><span class="o">.</span><span class="n">org</span><span class="o">/</span><span class="n">eclipse</span><span class="o">/</span><span class="n">openpass</span><span class="o">/</span><span class="n">opSimulation</span><span class="o">.</span><span class="n">git</span> <span class="n">openpass</span> </pre></div> </div> </div></div> </li> <li><p>Navigate into repository and checkout main branch</p> -<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">cd</span> <span class="n">simopenpass</span> +<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">cd</span> <span class="n">openpass</span> <span class="n">git</span> <span class="n">checkout</span> <span class="n">main</span> </pre></div> </div> @@ -253,36 +254,36 @@ </li> <li><p>Navigate into directory where installed prerequisites are located</p> <div class="sphinx-tabs docutils container"> -<div aria-label="Tabbed content" class="closeable" role="tablist"><button aria-controls="panel-2-2-0" aria-selected="true" class="sphinx-tabs-tab" id="tab-2-2-0" name="2-0" role="tab" tabindex="0">Windows</button><button aria-controls="panel-2-2-1" aria-selected="false" class="sphinx-tabs-tab" id="tab-2-2-1" name="2-1" role="tab" tabindex="-1">Linux</button></div><div aria-labelledby="tab-2-2-0" class="sphinx-tabs-panel" id="panel-2-2-0" name="2-0" role="tabpanel" tabindex="0"><div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">cd</span> <span class="o">/</span><span class="n">C</span><span class="o">/</span><span class="n">OpenPASS</span><span class="o">/</span><span class="n">thirdParty</span> +<div aria-label="Tabbed content" class="closeable" role="tablist"><button aria-controls="panel-2-2-0" aria-selected="true" class="sphinx-tabs-tab" id="tab-2-2-0" name="2-0" role="tab" tabindex="0">Windows</button><button aria-controls="panel-2-2-1" aria-selected="false" class="sphinx-tabs-tab" id="tab-2-2-1" name="2-1" role="tab" tabindex="-1">Linux</button></div><div aria-labelledby="tab-2-2-0" class="sphinx-tabs-panel" id="panel-2-2-0" name="2-0" role="tabpanel" tabindex="0"><div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">cd</span> <span class="o">/</span><span class="n">C</span><span class="o">/</span><span class="n">openpass</span><span class="o">/</span><span class="n">thirdParty</span> </pre></div> </div> -</div><div aria-labelledby="tab-2-2-1" class="sphinx-tabs-panel" hidden="true" id="panel-2-2-1" name="2-1" role="tabpanel" tabindex="0"><div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">cd</span> <span class="o">~/</span><span class="n">OpenPASS</span><span class="o">/</span><span class="n">thirdParty</span> +</div><div aria-labelledby="tab-2-2-1" class="sphinx-tabs-panel" hidden="true" id="panel-2-2-1" name="2-1" role="tabpanel" tabindex="0"><div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">cd</span> <span class="o">~/</span><span class="n">openpass</span><span class="o">/</span><span class="n">thirdParty</span> </pre></div> </div> </div></div> </li> <li><p>Copy prerequisites into repository (c.f. <a class="reference internal" href="20_install_prerequisites.html#prerequisites"><span class="std std-ref">Installing Prerequisites</span></a>)</p> <div class="sphinx-tabs docutils container"> -<div aria-label="Tabbed content" class="closeable" role="tablist"><button aria-controls="panel-3-3-0" aria-selected="true" class="sphinx-tabs-tab" id="tab-3-3-0" name="3-0" role="tab" tabindex="0">Windows</button><button aria-controls="panel-3-3-1" aria-selected="false" class="sphinx-tabs-tab" id="tab-3-3-1" name="3-1" role="tab" tabindex="-1">Linux</button></div><div aria-labelledby="tab-3-3-0" class="sphinx-tabs-panel" id="panel-3-3-0" name="3-0" role="tabpanel" tabindex="0"><div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">cp</span> <span class="o">-</span><span class="n">r</span> <span class="n">osi</span> <span class="o">/</span><span class="n">C</span><span class="o">/</span><span class="n">simopenpass</span><span class="o">/</span><span class="n">deps</span><span class="o">/</span><span class="n">thirdParty</span> -<span class="n">cp</span> <span class="o">-</span><span class="n">r</span> <span class="n">protobuf</span> <span class="o">/</span><span class="n">C</span><span class="o">/</span><span class="n">simopenpass</span><span class="o">/</span><span class="n">deps</span><span class="o">/</span><span class="n">thirdParty</span> -<span class="n">cp</span> <span class="o">-</span><span class="n">r</span> <span class="n">protobuf</span><span class="o">-</span><span class="n">shared</span> <span class="o">/</span><span class="n">C</span><span class="o">/</span><span class="n">simopenpass</span><span class="o">/</span><span class="n">deps</span><span class="o">/</span><span class="n">thirdParty</span> -<span class="n">cp</span> <span class="o">-</span><span class="n">r</span> <span class="n">FMILibrary</span> <span class="o">/</span><span class="n">C</span><span class="o">/</span><span class="n">simopenpass</span><span class="o">/</span><span class="n">deps</span><span class="o">/</span><span class="n">thirdParty</span> -<span class="n">cp</span> <span class="o">-</span><span class="n">r</span> <span class="n">zlib</span><span class="o">/</span><span class="n">contrib</span><span class="o">/</span><span class="n">minizip</span> <span class="o">/</span><span class="n">C</span><span class="o">/</span><span class="n">simopenpass</span><span class="o">/</span><span class="n">deps</span><span class="o">/</span><span class="n">thirdParty</span> +<div aria-label="Tabbed content" class="closeable" role="tablist"><button aria-controls="panel-3-3-0" aria-selected="true" class="sphinx-tabs-tab" id="tab-3-3-0" name="3-0" role="tab" tabindex="0">Windows</button><button aria-controls="panel-3-3-1" aria-selected="false" class="sphinx-tabs-tab" id="tab-3-3-1" name="3-1" role="tab" tabindex="-1">Linux</button></div><div aria-labelledby="tab-3-3-0" class="sphinx-tabs-panel" id="panel-3-3-0" name="3-0" role="tabpanel" tabindex="0"><div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">cp</span> <span class="o">-</span><span class="n">r</span> <span class="n">osi</span> <span class="o">/</span><span class="n">C</span><span class="o">/</span><span class="n">openpass</span><span class="o">/</span><span class="n">deps</span><span class="o">/</span><span class="n">thirdParty</span> +<span class="n">cp</span> <span class="o">-</span><span class="n">r</span> <span class="n">protobuf</span> <span class="o">/</span><span class="n">C</span><span class="o">/</span><span class="n">openpass</span><span class="o">/</span><span class="n">deps</span><span class="o">/</span><span class="n">thirdParty</span> +<span class="n">cp</span> <span class="o">-</span><span class="n">r</span> <span class="n">protobuf</span><span class="o">-</span><span class="n">shared</span> <span class="o">/</span><span class="n">C</span><span class="o">/</span><span class="n">openpass</span><span class="o">/</span><span class="n">deps</span><span class="o">/</span><span class="n">thirdParty</span> +<span class="n">cp</span> <span class="o">-</span><span class="n">r</span> <span class="n">FMILibrary</span> <span class="o">/</span><span class="n">C</span><span class="o">/</span><span class="n">openpass</span><span class="o">/</span><span class="n">deps</span><span class="o">/</span><span class="n">thirdParty</span> +<span class="n">cp</span> <span class="o">-</span><span class="n">r</span> <span class="n">zlib</span><span class="o">/</span><span class="n">contrib</span><span class="o">/</span><span class="n">minizip</span> <span class="o">/</span><span class="n">C</span><span class="o">/</span><span class="n">openpass</span><span class="o">/</span><span class="n">deps</span><span class="o">/</span><span class="n">thirdParty</span> </pre></div> </div> -</div><div aria-labelledby="tab-3-3-1" class="sphinx-tabs-panel" hidden="true" id="panel-3-3-1" name="3-1" role="tabpanel" tabindex="0"><div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">cp</span> <span class="o">-</span><span class="n">r</span> <span class="n">osi</span> <span class="o">~/</span><span class="n">simopenpass</span><span class="o">/</span><span class="n">deps</span><span class="o">/</span><span class="n">thirdParty</span> -<span class="n">cp</span> <span class="o">-</span><span class="n">r</span> <span class="n">protobuf</span> <span class="o">~/</span><span class="n">simopenpass</span><span class="o">/</span><span class="n">deps</span><span class="o">/</span><span class="n">thirdParty</span> -<span class="n">cp</span> <span class="o">-</span><span class="n">r</span> <span class="n">protobuf</span><span class="o">-</span><span class="n">shared</span> <span class="o">~/</span><span class="n">simopenpass</span><span class="o">/</span><span class="n">deps</span><span class="o">/</span><span class="n">thirdParty</span> -<span class="n">cp</span> <span class="o">-</span><span class="n">r</span> <span class="n">FMILibrary</span> <span class="o">~/</span><span class="n">simopenpass</span><span class="o">/</span><span class="n">deps</span><span class="o">/</span><span class="n">thirdParty</span> -<span class="n">cp</span> <span class="o">-</span><span class="n">r</span> <span class="n">zlib</span><span class="o">/</span><span class="n">contrib</span><span class="o">/</span><span class="n">minizip</span> <span class="o">/</span><span class="n">C</span><span class="o">/</span><span class="n">simopenpass</span><span class="o">/</span><span class="n">deps</span><span class="o">/</span><span class="n">thirdParty</span> +</div><div aria-labelledby="tab-3-3-1" class="sphinx-tabs-panel" hidden="true" id="panel-3-3-1" name="3-1" role="tabpanel" tabindex="0"><div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">cp</span> <span class="o">-</span><span class="n">r</span> <span class="n">osi</span> <span class="o">~/</span><span class="n">openpass</span><span class="o">/</span><span class="n">deps</span><span class="o">/</span><span class="n">thirdParty</span> +<span class="n">cp</span> <span class="o">-</span><span class="n">r</span> <span class="n">protobuf</span> <span class="o">~/</span><span class="n">openpass</span><span class="o">/</span><span class="n">deps</span><span class="o">/</span><span class="n">thirdParty</span> +<span class="n">cp</span> <span class="o">-</span><span class="n">r</span> <span class="n">protobuf</span><span class="o">-</span><span class="n">shared</span> <span class="o">~/</span><span class="n">openpass</span><span class="o">/</span><span class="n">deps</span><span class="o">/</span><span class="n">thirdParty</span> +<span class="n">cp</span> <span class="o">-</span><span class="n">r</span> <span class="n">FMILibrary</span> <span class="o">~/</span><span class="n">openpass</span><span class="o">/</span><span class="n">deps</span><span class="o">/</span><span class="n">thirdParty</span> +<span class="n">cp</span> <span class="o">-</span><span class="n">r</span> <span class="n">zlib</span><span class="o">/</span><span class="n">contrib</span><span class="o">/</span><span class="n">minizip</span> <span class="o">/</span><span class="n">C</span><span class="o">/</span><span class="n">openpass</span><span class="o">/</span><span class="n">deps</span><span class="o">/</span><span class="n">thirdParty</span> </pre></div> </div> </div></div> -<p id="ref-prerequisites">Once prerequisites are in place, all third party dependencies within <code class="docutils literal notranslate"><span class="pre">simopenpass</span></code> can be resolved by <code class="docutils literal notranslate"><span class="pre">CMake</span></code>. +<p id="ref-prerequisites">Once prerequisites are in place, all third party dependencies within <code class="docutils literal notranslate"><span class="pre">openpass</span></code> can be resolved by <code class="docutils literal notranslate"><span class="pre">CMake</span></code>. For <code class="docutils literal notranslate"><span class="pre">CMake</span></code> builds, each installed prerequisite, which is located in its own subdirectory under</p> <ul class="simple"> -<li><p><code class="docutils literal notranslate"><span class="pre">C:\simopenpass\deps\thirdParty</span></code> for Windows and</p></li> -<li><p><code class="docutils literal notranslate"><span class="pre">~/simopenpass/deps/thirdParty</span></code> for Linux,</p></li> +<li><p><code class="docutils literal notranslate"><span class="pre">C:\openpass\deps\thirdParty</span></code> for Windows and</p></li> +<li><p><code class="docutils literal notranslate"><span class="pre">~/openpass/deps/thirdParty</span></code> for Linux,</p></li> </ul> <p>can be referenced by its path. The reference is made via the <a class="reference internal" href="further_guidance/10_cmake.html#cmake-prefix-path"><span class="std std-ref">CMAKE_PREFIX_PATH</span></a> environmental variable, which holds a list of directories specifying the installed prerequisite. @@ -290,10 +291,10 @@ </li> <li><p>Navigate back into repository</p> <div class="sphinx-tabs docutils container"> -<div aria-label="Tabbed content" class="closeable" role="tablist"><button aria-controls="panel-4-4-0" aria-selected="true" class="sphinx-tabs-tab" id="tab-4-4-0" name="4-0" role="tab" tabindex="0">Windows</button><button aria-controls="panel-4-4-1" aria-selected="false" class="sphinx-tabs-tab" id="tab-4-4-1" name="4-1" role="tab" tabindex="-1">Linux</button></div><div aria-labelledby="tab-4-4-0" class="sphinx-tabs-panel" id="panel-4-4-0" name="4-0" role="tabpanel" tabindex="0"><div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">cd</span> <span class="o">/</span><span class="n">C</span><span class="o">/</span><span class="n">simopenpass</span> +<div aria-label="Tabbed content" class="closeable" role="tablist"><button aria-controls="panel-4-4-0" aria-selected="true" class="sphinx-tabs-tab" id="tab-4-4-0" name="4-0" role="tab" tabindex="0">Windows</button><button aria-controls="panel-4-4-1" aria-selected="false" class="sphinx-tabs-tab" id="tab-4-4-1" name="4-1" role="tab" tabindex="-1">Linux</button></div><div aria-labelledby="tab-4-4-0" class="sphinx-tabs-panel" id="panel-4-4-0" name="4-0" role="tabpanel" tabindex="0"><div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">cd</span> <span class="o">/</span><span class="n">C</span><span class="o">/</span><span class="n">openpass</span> </pre></div> </div> -</div><div aria-labelledby="tab-4-4-1" class="sphinx-tabs-panel" hidden="true" id="panel-4-4-1" name="4-1" role="tabpanel" tabindex="0"><div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">cd</span> <span class="o">~/</span><span class="n">simopenpass</span> +</div><div aria-labelledby="tab-4-4-1" class="sphinx-tabs-panel" hidden="true" id="panel-4-4-1" name="4-1" role="tabpanel" tabindex="0"><div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">cd</span> <span class="o">~/</span><span class="n">openpass</span> </pre></div> </div> </div></div> @@ -305,13 +306,13 @@ </div> </li> <li><p>Prepare build</p> -<p><strong>OpenPASS</strong> links against shared libraries, which are located in the paths specified by <code class="docutils literal notranslate"><span class="pre">CMAKE_PREFIX_PATH</span></code>. -To be able to install <strong>OpenPASS</strong> with resolved dependencies, all libraries found under the paths have to be copied right next to the executable during the installation step. +<p><strong>openPASS</strong> links against shared libraries, which are located in the paths specified by <code class="docutils literal notranslate"><span class="pre">CMAKE_PREFIX_PATH</span></code>. +To be able to install <strong>openPASS</strong> with resolved dependencies, all libraries found under the paths have to be copied right next to the executable during the installation step. This is done by setting <code class="docutils literal notranslate"><span class="pre">INSTALL_EXTRA_RUNTIME_DEPS=ON</span></code>. If you have followed the instructions strictly, no changes are necessary.</p> <div class="sphinx-tabs docutils container"> <div aria-label="Tabbed content" class="closeable" role="tablist"><button aria-controls="panel-5-5-0" aria-selected="true" class="sphinx-tabs-tab" id="tab-5-5-0" name="5-0" role="tab" tabindex="0">Windows</button><button aria-controls="panel-5-5-1" aria-selected="false" class="sphinx-tabs-tab" id="tab-5-5-1" name="5-1" role="tab" tabindex="-1">Linux</button></div><div aria-labelledby="tab-5-5-0" class="sphinx-tabs-panel" id="panel-5-5-0" name="5-0" role="tabpanel" tabindex="0"><div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">cmake</span> <span class="o">-</span><span class="n">G</span> <span class="s2">"MSYS Makefiles"</span> \ -<span class="o">-</span><span class="n">D</span> <span class="n">CMAKE_PREFIX_PATH</span><span class="o">=</span><span class="s2">"C:/simopenpass/deps/thirdParty/FMILibrary;C:/simopenpass/deps/thirdParty/osi;C:/simopenpass/deps/thirdParty/protobuf;C:/simopenpass/deps/thirdParty/protobuf-shared;C:/msys64/mingw64/bin"</span> \ -<span class="o">-</span><span class="n">D</span> <span class="n">CMAKE_INSTALL_PREFIX</span><span class="o">=</span><span class="n">C</span><span class="p">:</span><span class="o">/</span><span class="n">OpenPASS</span><span class="o">/</span><span class="nb">bin</span><span class="o">/</span><span class="n">core</span> \ +<span class="o">-</span><span class="n">D</span> <span class="n">CMAKE_PREFIX_PATH</span><span class="o">=</span><span class="s2">"C:/openpass/deps/thirdParty/FMILibrary;C:/openpass/deps/thirdParty/osi;C:/openpass/deps/thirdParty/protobuf;C:/openpass/deps/thirdParty/protobuf-shared;C:/msys64/mingw64/bin;C:/openpass/deps/thirdParty/minizip"</span> \ +<span class="o">-</span><span class="n">D</span> <span class="n">CMAKE_INSTALL_PREFIX</span><span class="o">=</span><span class="n">C</span><span class="p">:</span><span class="o">/</span><span class="n">openPASS</span><span class="o">/</span><span class="nb">bin</span><span class="o">/</span><span class="n">core</span> \ <span class="o">-</span><span class="n">D</span> <span class="n">CMAKE_BUILD_TYPE</span><span class="o">=</span><span class="n">Release</span> \ <span class="o">-</span><span class="n">D</span> <span class="n">USE_CCACHE</span><span class="o">=</span><span class="n">ON</span> \ <span class="o">-</span><span class="n">D</span> <span class="n">WITH_DEBUG_POSTFIX</span><span class="o">=</span><span class="n">OFF</span> \ @@ -327,8 +328,8 @@ <li><p>Make sure that the path <code class="docutils literal notranslate"><span class="pre">C:/msys64/mingw64/bin</span></code> is the last path in the CMAKE_PREFIX_PATH. Otherwise cmake might find and use local versions of required libraries instead of the ones listed in the thirdparties folder.</p></li> </ul> </div> -</div><div aria-labelledby="tab-5-5-1" class="sphinx-tabs-panel" hidden="true" id="panel-5-5-1" name="5-1" role="tabpanel" tabindex="0"><div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">cmake</span> <span class="o">-</span><span class="n">D</span> <span class="n">CMAKE_PREFIX_PATH</span><span class="o">=</span><span class="s2">"$HOME/simopenpass/deps/thirdParty/FMILibrary;$HOME/simopenpass/deps/thirdParty/osi;$HOME/simopenpass/deps/thirdParty/protobuf;$HOME/simopenpass/deps/thirdParty/protobuf-shared"</span> \ -<span class="o">-</span><span class="n">D</span> <span class="n">CMAKE_INSTALL_PREFIX</span><span class="o">=/</span><span class="n">usr</span><span class="o">/</span><span class="n">local</span><span class="o">/</span><span class="n">OpenPASS</span><span class="o">/</span><span class="nb">bin</span><span class="o">/</span><span class="n">core</span> \ +</div><div aria-labelledby="tab-5-5-1" class="sphinx-tabs-panel" hidden="true" id="panel-5-5-1" name="5-1" role="tabpanel" tabindex="0"><div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">cmake</span> <span class="o">-</span><span class="n">D</span> <span class="n">CMAKE_PREFIX_PATH</span><span class="o">=</span><span class="s2">"$HOME/openpass/deps/thirdParty/FMILibrary;$HOME/openpass/deps/thirdParty/osi;$HOME/openpass/deps/thirdParty/protobuf;$HOME/openpass/deps/thirdParty/protobuf-shared;$HOME/openpass/deps/thirdParty/minizip"</span> \ +<span class="o">-</span><span class="n">D</span> <span class="n">CMAKE_INSTALL_PREFIX</span><span class="o">=/</span><span class="n">usr</span><span class="o">/</span><span class="n">local</span><span class="o">/</span><span class="n">openPASS</span><span class="o">/</span><span class="nb">bin</span><span class="o">/</span><span class="n">core</span> \ <span class="o">-</span><span class="n">D</span> <span class="n">CMAKE_BUILD_TYPE</span><span class="o">=</span><span class="n">Release</span> \ <span class="o">-</span><span class="n">D</span> <span class="n">USE_CCACHE</span><span class="o">=</span><span class="n">ON</span> \ <span class="o">-</span><span class="n">D</span> <span class="n">WITH_DEBUG_POSTFIX</span><span class="o">=</span><span class="n">OFF</span> \ @@ -344,7 +345,7 @@ </div> </li> <li><p>Optional: Build and execute unit tests</p> -<p>Starting from <code class="docutils literal notranslate"><span class="pre">simopenpass/build</span></code>:</p> +<p>Starting from <code class="docutils literal notranslate"><span class="pre">openpass/build</span></code>:</p> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">make</span> <span class="n">test</span> <span class="n">ARGS</span><span class="o">=</span><span class="s2">"--output-on-failure -j3"</span> </pre></div> </div> @@ -355,7 +356,7 @@ </div> </li> <li><p>Build documentation</p> -<p>Starting from <code class="docutils literal notranslate"><span class="pre">simopenpass/build</span></code>:</p> +<p>Starting from <code class="docutils literal notranslate"><span class="pre">openpass/build</span></code>:</p> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">make</span> <span class="n">doc</span> </pre></div> </div> @@ -365,7 +366,7 @@ </div> </li> <li><p>Build simulation core</p> -<p>Starting from <code class="docutils literal notranslate"><span class="pre">simopenpass/build</span></code>:</p> +<p>Starting from <code class="docutils literal notranslate"><span class="pre">openpass/build</span></code>:</p> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">make</span> <span class="o">-</span><span class="n">j3</span> <span class="n">install</span> </pre></div> </div> @@ -391,7 +392,7 @@ <div role="contentinfo"> <p> - © Copyright 2023 OpenPASS Working Group. + © Copyright 2023 openPASS Working Group. </p> </div>
diff --git a/content/html/installation_guide/50_further_guidance.html b/content/html/installation_guide/50_further_guidance.html index f6b460b..ff2066c 100644 --- a/content/html/installation_guide/50_further_guidance.html +++ b/content/html/installation_guide/50_further_guidance.html
@@ -7,7 +7,7 @@ <meta name="viewport" content="width=device-width, initial-scale=1.0" /> - <title>Further Guidance — OpenPASS Documentation</title> + <title>Further Guidance — openPASS Documentation</title> @@ -43,7 +43,7 @@ <link rel="index" title="Index" href="../genindex.html" /> <link rel="search" title="Search" href="../search.html" /> <link rel="next" title="CMake Variables and Options" href="further_guidance/10_cmake.html" /> - <link rel="prev" title="Installing OpenPASS" href="30_install_openpass.html" /> + <link rel="prev" title="Installing openPASS" href="30_install_openpass.html" /> </head> <body class="wy-body-for-nav"> @@ -70,7 +70,7 @@ <div class="version"> - "openPASS v0.11" + "develop_4d7f6d4f2e22c286789082dd8cbe3eb7f5b5af62" </div> @@ -100,7 +100,7 @@ <li class="toctree-l1"><a class="reference internal" href="10_getting_started.html">Getting Started</a></li> <li class="toctree-l1"><a class="reference internal" href="15_system_requirements.html">System Requirements</a></li> <li class="toctree-l1"><a class="reference internal" href="20_install_prerequisites.html">Installing Prerequisites</a></li> -<li class="toctree-l1"><a class="reference internal" href="30_install_openpass.html">Installing OpenPASS</a></li> +<li class="toctree-l1"><a class="reference internal" href="30_install_openpass.html">Installing openPASS</a></li> <li class="toctree-l1 current"><a class="current reference internal" href="#">Further Guidance</a><ul> <li class="toctree-l2"><a class="reference internal" href="further_guidance/10_cmake.html">CMake Variables and Options</a></li> </ul> @@ -111,10 +111,9 @@ <ul> <li class="toctree-l1"><a class="reference internal" href="../user_guide/10_overview.html">Overview</a></li> <li class="toctree-l1"><a class="reference internal" href="../user_guide/20_tutorials.html">Tutorials</a></li> -<li class="toctree-l1"><a class="reference internal" href="../user_guide/30_gui_plugins.html">GUI Plugins</a></li> -<li class="toctree-l1"><a class="reference internal" href="../user_guide/40_configs_in_depth.html">Configs in Depth</a></li> -<li class="toctree-l1"><a class="reference internal" href="../user_guide/50_outputs_in_depth.html">Outputs in Depth</a></li> -<li class="toctree-l1"><a class="reference internal" href="../user_guide/60_scenario_simulation.html">Simulator</a></li> +<li class="toctree-l1"><a class="reference internal" href="../user_guide/30_configs_in_depth.html">Configs in Depth</a></li> +<li class="toctree-l1"><a class="reference internal" href="../user_guide/40_outputs_in_depth.html">Outputs in Depth</a></li> +<li class="toctree-l1"><a class="reference internal" href="../user_guide/50_scenario_simulation.html">Simulator</a></li> </ul> <p class="caption"><span class="caption-text">Advanced topics</span></p> <ul> @@ -125,12 +124,14 @@ <ul> <li class="toctree-l1"><a class="reference internal" href="../developer_information/10_ide_support.html">IDE Support</a></li> <li class="toctree-l1"><a class="reference internal" href="../developer_information/20_documentation.html">Documentation Concept</a></li> +<li class="toctree-l1"><a class="reference internal" href="../developer_information/30_coding_conventions.html">Coding Guidelines</a></li> </ul> <p class="caption"><span class="caption-text">Other Information</span></p> <ul> <li class="toctree-l1"><a class="reference internal" href="../other_information/10_external_dependencies.html">External Dependencies</a></li> <li class="toctree-l1"><a class="reference internal" href="../other_information/20_glossary.html">Glossary</a></li> -<li class="toctree-l1"><a class="reference internal" href="../other_information/30_license.html">License</a></li> +<li class="toctree-l1"><a class="reference internal" href="../other_information/30_gui_plugins.html">GUI Plugins</a></li> +<li class="toctree-l1"><a class="reference internal" href="../other_information/40_license.html">License</a></li> </ul> @@ -216,14 +217,14 @@ <footer> <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> <a href="further_guidance/10_cmake.html" class="btn btn-neutral float-right" title="CMake Variables and Options" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a> - <a href="30_install_openpass.html" class="btn btn-neutral float-left" title="Installing OpenPASS" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a> + <a href="30_install_openpass.html" class="btn btn-neutral float-left" title="Installing openPASS" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a> </div> <hr/> <div role="contentinfo"> <p> - © Copyright 2023 OpenPASS Working Group. + © Copyright 2023 openPASS Working Group. </p> </div>
diff --git a/content/html/installation_guide/60_conan.html b/content/html/installation_guide/60_conan.html index e2e92bd..c5cab34 100644 --- a/content/html/installation_guide/60_conan.html +++ b/content/html/installation_guide/60_conan.html
@@ -7,7 +7,7 @@ <meta name="viewport" content="width=device-width, initial-scale=1.0" /> - <title>Building with Conan — OpenPASS Documentation</title> + <title>Building with Conan — openPASS Documentation</title> @@ -71,7 +71,7 @@ <div class="version"> - "openPASS v0.11" + "develop_4d7f6d4f2e22c286789082dd8cbe3eb7f5b5af62" </div> @@ -101,18 +101,14 @@ <li class="toctree-l1"><a class="reference internal" href="10_getting_started.html">Getting Started</a></li> <li class="toctree-l1"><a class="reference internal" href="15_system_requirements.html">System Requirements</a></li> <li class="toctree-l1"><a class="reference internal" href="20_install_prerequisites.html">Installing Prerequisites</a></li> -<li class="toctree-l1"><a class="reference internal" href="30_install_openpass.html">Installing OpenPASS</a></li> +<li class="toctree-l1"><a class="reference internal" href="30_install_openpass.html">Installing openPASS</a></li> <li class="toctree-l1"><a class="reference internal" href="50_further_guidance.html">Further Guidance</a></li> <li class="toctree-l1 current"><a class="current reference internal" href="#">Building with Conan</a><ul> <li class="toctree-l2"><a class="reference internal" href="#general">General</a></li> <li class="toctree-l2"><a class="reference internal" href="#additional-prerequisites">Additional Prerequisites</a></li> -<li class="toctree-l2"><a class="reference internal" href="#export-recipes">Export Recipes</a><ul> -<li class="toctree-l3"><a class="reference internal" href="#conan-export">Conan Export</a></li> -<li class="toctree-l3"><a class="reference internal" href="#conan-install">Conan Install</a></li> -<li class="toctree-l3"><a class="reference internal" href="#conan-create">Conan Create</a></li> -</ul> -</li> -<li class="toctree-l2"><a class="reference internal" href="#build-op">Build <strong>openPASS</strong></a></li> +<li class="toctree-l2"><a class="reference internal" href="#conan-recipes">Conan Recipes</a></li> +<li class="toctree-l2"><a class="reference internal" href="#conan-create">Conan Create</a></li> +<li class="toctree-l2"><a class="reference internal" href="#conan-install">Conan Install</a></li> <li class="toctree-l2"><a class="reference internal" href="#build-only-thirdparties">Build only ThirdParties</a></li> </ul> </li> @@ -121,10 +117,9 @@ <ul> <li class="toctree-l1"><a class="reference internal" href="../user_guide/10_overview.html">Overview</a></li> <li class="toctree-l1"><a class="reference internal" href="../user_guide/20_tutorials.html">Tutorials</a></li> -<li class="toctree-l1"><a class="reference internal" href="../user_guide/30_gui_plugins.html">GUI Plugins</a></li> -<li class="toctree-l1"><a class="reference internal" href="../user_guide/40_configs_in_depth.html">Configs in Depth</a></li> -<li class="toctree-l1"><a class="reference internal" href="../user_guide/50_outputs_in_depth.html">Outputs in Depth</a></li> -<li class="toctree-l1"><a class="reference internal" href="../user_guide/60_scenario_simulation.html">Simulator</a></li> +<li class="toctree-l1"><a class="reference internal" href="../user_guide/30_configs_in_depth.html">Configs in Depth</a></li> +<li class="toctree-l1"><a class="reference internal" href="../user_guide/40_outputs_in_depth.html">Outputs in Depth</a></li> +<li class="toctree-l1"><a class="reference internal" href="../user_guide/50_scenario_simulation.html">Simulator</a></li> </ul> <p class="caption"><span class="caption-text">Advanced topics</span></p> <ul> @@ -135,12 +130,14 @@ <ul> <li class="toctree-l1"><a class="reference internal" href="../developer_information/10_ide_support.html">IDE Support</a></li> <li class="toctree-l1"><a class="reference internal" href="../developer_information/20_documentation.html">Documentation Concept</a></li> +<li class="toctree-l1"><a class="reference internal" href="../developer_information/30_coding_conventions.html">Coding Guidelines</a></li> </ul> <p class="caption"><span class="caption-text">Other Information</span></p> <ul> <li class="toctree-l1"><a class="reference internal" href="../other_information/10_external_dependencies.html">External Dependencies</a></li> <li class="toctree-l1"><a class="reference internal" href="../other_information/20_glossary.html">Glossary</a></li> -<li class="toctree-l1"><a class="reference internal" href="../other_information/30_license.html">License</a></li> +<li class="toctree-l1"><a class="reference internal" href="../other_information/30_gui_plugins.html">GUI Plugins</a></li> +<li class="toctree-l1"><a class="reference internal" href="../other_information/40_license.html">License</a></li> </ul> @@ -218,135 +215,114 @@ </div> <div class="section" id="additional-prerequisites"> <h2>Additional Prerequisites<a class="headerlink" href="#additional-prerequisites" title="Permalink to this headline">¶</a></h2> -<p>To be able to work with Conan it´s necessary to add additional packages.</p> +<p>To be able to work with Conan it is necessary to add additional packages.</p> <div class="sphinx-tabs docutils container"> -<div aria-label="Tabbed content" class="closeable" role="tablist"><button aria-controls="panel-0-0-0" aria-selected="true" class="sphinx-tabs-tab" id="tab-0-0-0" name="0-0" role="tab" tabindex="0">Windows (MSYS2)</button><button aria-controls="panel-0-0-1" aria-selected="false" class="sphinx-tabs-tab" id="tab-0-0-1" name="0-1" role="tab" tabindex="-1">Linux (Debian Bullseye)</button></div><div aria-labelledby="tab-0-0-0" class="sphinx-tabs-panel" id="panel-0-0-0" name="0-0" role="tabpanel" tabindex="0"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>pip install conan +<div aria-label="Tabbed content" class="closeable" role="tablist"><button aria-controls="panel-0-0-0" aria-selected="true" class="sphinx-tabs-tab" id="tab-0-0-0" name="0-0" role="tab" tabindex="0">Windows (MSYS2)</button><button aria-controls="panel-0-0-1" aria-selected="false" class="sphinx-tabs-tab" id="tab-0-0-1" name="0-1" role="tab" tabindex="-1">Linux (Debian Bookworm)</button></div><div aria-labelledby="tab-0-0-0" class="sphinx-tabs-panel" id="panel-0-0-0" name="0-0" role="tabpanel" tabindex="0"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>pip install <span class="s2">"conan>=1.0,<2.0"</span> </pre></div> </div> -</div><div aria-labelledby="tab-0-0-1" class="sphinx-tabs-panel" hidden="true" id="panel-0-0-1" name="0-1" role="tabpanel" tabindex="0"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>apt install conan +</div><div aria-labelledby="tab-0-0-1" class="sphinx-tabs-panel" hidden="true" id="panel-0-0-1" name="0-1" role="tabpanel" tabindex="0"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>apt install <span class="s2">"conan>=1.0,<2.0"</span> </pre></div> </div> </div></div> </div> -<div class="section" id="export-recipes"> -<h2>Export Recipes<a class="headerlink" href="#export-recipes" title="Permalink to this headline">¶</a></h2> -<div class="admonition note"> -<p class="admonition-title">Note</p> +<div class="section" id="conan-recipes"> +<h2>Conan Recipes<a class="headerlink" href="#conan-recipes" title="Permalink to this headline">¶</a></h2> <p>A <em>recipe</em> is python file, which is used by conan to build and create a package. In this file there are several hooks available, which can be used for several tasks. E.g. Retrieving the source files, building from source, configuring dependencies, packaging, etc. Visit <a class="reference external" href="https://conan.io/">Conan</a>. for detailed information about <em>recipes</em>.</p> </div> -<p>To make Conan aware and to use the custom recipes for the ThirdParty libraries, these recipes have to be exported to the <em>local cache</em> of Conan. -This can be done in different ways.</p> -<div class="section" id="conan-export"> -<h3>Conan Export<a class="headerlink" href="#conan-export" title="Permalink to this headline">¶</a></h3> -<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span><span class="nb">cd</span> <path to conanfile.py of recipe> -conan <span class="nb">export</span> . <optional user>/<optional channel> +<div class="section" id="conan-create"> +<h2>Conan Create<a class="headerlink" href="#conan-create" title="Permalink to this headline">¶</a></h2> +<p>The <cite>conan create</cite> command is used to create Conan packages from source code. It involves building the source code, packaging the resulting binaries and artifacts, and generating the necessary metadata to publish the package. +The basic syntax of the command is as follows:</p> +<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>$ conan create <path_to_recipe> <pkg/version@user/channel> </pre></div> </div> -<p>The optional user and channel flags can be used to export a recipe while it´s still in development. -In that case there could be several different versions and their corresponding binaries of the same library available at the same time. -The <em>local cache</em> could then show the following packages. -E.g.</p> -<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>packagename/3.2.0 -packagename/3.2.0@openpassWG/stable -packagename/3.3.0@myUserName/testing +<ul class="simple"> +<li><p><cite><path_to_source></cite>: The path to the conan recipe of that corresponding package.</p></li> +<li><p><cite><pkg/version@user/channel></cite>: The user and channel specify the namespace under which the package with the corresponding version will be built.</p></li> +</ul> +<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>$ conan create openscenario_engine/0.1@openpass/testing </pre></div> </div> +<p>This command will build the package <cite>openscenario_engine</cite> with version <cite>1.0</cite> under the user <cite>openpass</cite> and channel <cite>testing</cite>.</p> +<p><strong>Optional Settings</strong></p> +<p>The <cite>-o</cite> option allows you to pass optional settings to the <cite>conan create</cite> command, which can be used to customize the build process of the package. These settings are defined in the <cite>conanfile.py</cite> recipe. +For example, you can specify build options, compiler flags, or any other configuration settings that influence the package creation process.</p> +<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>$ conan create openscenario_engine/0.1@openpass/testing -o <span class="nv">MantleAPI_version</span><span class="o">=</span><span class="m">0</span>.1 -o <span class="nv">Yase_version</span><span class="o">=</span><span class="m">0</span>.1 +</pre></div> +</div> +<p>In this example, the <cite>-o</cite> option is used to set the <cite>MantleAPI_version</cite> and <cite>Yase_version</cite> build options for the <cite>openscenario_engine</cite> package. These options will be considered during the package creation process.</p> <div class="admonition note"> <p class="admonition-title">Note</p> -<p>At least this step has to be done in prior before any ThirdParty library can be installed by Conan. -Every upcoming step is optional, but can be useful while developing or debugging. -Also with these steps it´s possible to install ThirdParty libraries separately.</p> +<p>For the packages MantleAPI, Yase, openscenario_api and openscenario_engine corresponding commit ids can be used instead of version when creating the package</p> </div> </div> <div class="section" id="conan-install"> -<h3>Conan Install<a class="headerlink" href="#conan-install" title="Permalink to this headline">¶</a></h3> -<p>Conan is now able to differentiate different version and the user can now install exactly the version he wishes to.</p> -<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>conan install <package_name> +<h2>Conan Install<a class="headerlink" href="#conan-install" title="Permalink to this headline">¶</a></h2> +<p>The <cite>conan install</cite> command is used to install Conan packages from a Conan recipe (a <cite>conanfile.py</cite> file) and its associated dependencies. It resolves and fetches the required packages from a remote Conan repository or local conan cache and installs them in the specified target location. +The basic syntax of the command is as follows:</p> +<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>$ conan install <pkg/version@user/channel> -g <generator> -s <<span class="nv">setting</span><span class="o">=</span>value> --build <missing<span class="p">|</span>outdated> --install-folder<span class="o">=</span><installation-path> </pre></div> </div> -<p>This command has a look into the <em>local cache</em> for the recipe and the binaries of the package and installs them into the <em>local cache</em>. -If no binaries where found an error is thrown.</p> -<div class="admonition note"> -<p class="admonition-title">Note</p> -<p>To make conan also build the package the command can be appended with the following argument: <code class="docutils literal notranslate"><span class="pre">--build=missing</span></code>.</p> -</div> -</div> -<div class="section" id="conan-create"> -<h3>Conan Create<a class="headerlink" href="#conan-create" title="Permalink to this headline">¶</a></h3> -<p>Both of the previous commands can be combined with the <code class="docutils literal notranslate"><span class="pre">create`</span></code> command. What it basically does is calling <code class="docutils literal notranslate"><span class="pre">export</span></code> and <code class="docutils literal notranslate"><span class="pre">install</span></code> after another.</p> -<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span><span class="nb">cd</span> <path to conanfile.py of recipe> -conan create . <optional user>/<optional channel> +<ul class="simple"> +<li><p><cite><pkg/version@user/channel></cite>: The user and channel specify the namespace under which the package with the corresponding version will be built.</p></li> +<li><p><cite>-g <generator></cite>: Specifies the build system generator (e.g., <cite>cmake</cite>, <cite>make</cite>, <cite>visual_studio</cite>) for generating build files.</p></li> +<li><p><cite>-s <setting=value></cite>: Overrides a Conan setting defined in the recipe with the given value.</p></li> +<li><p><cite>–build <missing|outdated></cite>: Specifies whether to build missing or outdated packages.</p></li> +</ul> +<p><strong>Generate Deployment Files</strong></p> +<p>The <cite>-g deploy</cite> option with the <cite>conan install</cite> command is used to generate deployment-related files and scripts for installing and running the package on a target system. +These files can include packaging scripts, installation scripts, and other artifacts required for deploying the package to a specific environment.</p> +<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>$ conan install openscenario_engine/0.1@openpass/testing -g deploy --install-folder<span class="o">=</span><span class="s2">"my/installation/path"</span> </pre></div> </div> -<p>At this step the binaries of this package are now available in the <em>local cache</em>.</p> +<p>This command will deploy the package <cite>openscenario_engine/0.1@openpass/testing</cite> at the installation path.</p> <div class="admonition note"> <p class="admonition-title">Note</p> <p>There are several additional commands, arguments and fields for these commands available. Please see <a class="reference external" href="https://docs.conan.io/en/latest/">Conan Docs</a> for additional information.</p> </div> </div> -</div> -<div class="section" id="build-op"> -<h2>Build <strong>openPASS</strong><a class="headerlink" href="#build-op" title="Permalink to this headline">¶</a></h2> -<p>If you followed the previous steps and export all dependencies and <strong>openPASS</strong> recipes to Conans <em>local cache</em>, then you can go on with the next steps. -If not then at least the <code class="docutils literal notranslate"><span class="pre">export</span></code> should be done. -Else Conan is not able to know how to build the dependencies and <strong>openPASS</strong>.</p> -<p><strong>openPASS</strong> can be build using a <code class="docutils literal notranslate"><span class="pre">conanfile.txt</span></code>. -It holds every Information which is needed to build and install <strong>openPASS</strong>.</p> -<p>The following file shows an example which can be used. -This example is also available in the <code class="docutils literal notranslate"><span class="pre">conan</span></code> folder in the <code class="docutils literal notranslate"><span class="pre">simopenpass</span></code> repository.</p> -<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">[</span><span class="n">requires</span><span class="p">]</span> - <span class="n">openpass</span><span class="o">/</span><span class="mf">0.8</span> - -<span class="p">[</span><span class="n">generators</span><span class="p">]</span> - <span class="n">cmake</span> - -<span class="p">[</span><span class="n">imports</span><span class="p">]</span> - <span class="o">.</span> <span class="p">,</span> <span class="o">*</span> <span class="o">-></span> <span class="n">C</span><span class="p">:</span><span class="o">/</span><span class="n">openpass</span> <span class="o">@</span> -</pre></div> -</div> -<p>The <code class="docutils literal notranslate"><span class="pre">requires</span></code> field describes what package with what version shall be installed. -It´s also possible to add more packages here or change the version.</p> -<p>The <code class="docutils literal notranslate"><span class="pre">generator</span></code> field is used to add different generators to the process. -In this example the <code class="docutils literal notranslate"><span class="pre">cmake</span></code> generator would generate cmake files, which describe where to find the <strong>openPASS</strong> in the <em>local cache</em>. -There are also other possibilities like a <code class="docutils literal notranslate"><span class="pre">cmake_find_package</span></code> generator, which generates <em>cmake</em> <em>FindPackage</em> files.</p> -<p>At this point <strong>openPASS</strong> only exists in the <em>local cache</em> of Conan. -With the <code class="docutils literal notranslate"><span class="pre">imports</span></code> field it´s possible to specify where and how the binaries shall be copied from the <em>local cache</em> to the <em>user space</em>. -The example follows the following pattern:</p> -<blockquote> -<div><p><source>, <pattern> -> <destination></p> -</div></blockquote> -<div class="admonition note"> -<p class="admonition-title">Note</p> -<p>It is possible to add several lines for more specific copying operations. -Also there are more field available than this simple example shows. -See <a class="reference external" href="https://docs.conan.io/en/latest/">Conan Docs</a> for additional information.</p> -</div> -<p>Conan can simply install <strong>openPASS</strong> with the following command. -If the dependencies or <strong>openPASS</strong> were not build in any previous step, the binaries will not be available in the <em>local cache</em> of Conan. -Conan can build them by adding <code class="docutils literal notranslate"><span class="pre">--build=missing</span></code> to the following command.</p> -<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>conan install <path to conanfile.txt> -</pre></div> -</div> -</div> <div class="section" id="build-only-thirdparties"> <h2>Build only ThirdParties<a class="headerlink" href="#build-only-thirdparties" title="Permalink to this headline">¶</a></h2> -<p>The ThirdParty libraries can be build and installed the same way.</p> +<p><strong>openPASS</strong> requires number of third parties libraries and they are listed in <code class="docutils literal notranslate"><span class="pre">conanfile.txt</span></code>. To install all the dependencies, the script <code class="docutils literal notranslate"><span class="pre">15_prepare_thirdParty.sh</span></code> can be used.</p> +<p>The following file shows an example which can be used. This example is also available in the conan folder in the opSimulation repository.</p> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">[</span><span class="n">requires</span><span class="p">]</span> - <span class="n">OSI</span><span class="o">/</span><span class="mf">3.5</span><span class="o">.</span><span class="mi">0</span> - <span class="n">FMILibrary</span><span class="o">/</span><span class="mf">2.0</span><span class="o">.</span><span class="mi">3</span> + <span class="n">zlib</span><span class="o">/</span><span class="mf">1.2</span><span class="o">.</span><span class="mi">12</span><span class="o">@</span> + <span class="n">qt</span><span class="o">/</span><span class="mf">5.15</span><span class="o">.</span><span class="mi">3</span><span class="o">@</span> + <span class="n">gtest</span><span class="o">/</span><span class="mf">1.11</span><span class="o">.</span><span class="mi">0</span><span class="nd">@openpass</span><span class="o">/</span><span class="n">testing</span> + <span class="n">FMILibrary</span><span class="o">/</span><span class="mf">2.0</span><span class="o">.</span><span class="mi">3</span><span class="nd">@openpass</span><span class="o">/</span><span class="n">testing</span> + <span class="n">protobuf</span><span class="o">/</span><span class="mf">3.20</span><span class="o">.</span><span class="mi">0</span><span class="o">@</span> + <span class="n">units</span><span class="o">/</span><span class="mf">2.3</span><span class="o">.</span><span class="mi">3</span><span class="nd">@openpass</span><span class="o">/</span><span class="n">testing</span> + <span class="nb">open</span><span class="o">-</span><span class="n">simulation</span><span class="o">-</span><span class="n">interface</span><span class="o">/</span><span class="mf">3.5</span><span class="o">.</span><span class="mi">0</span><span class="nd">@openpass</span><span class="o">/</span><span class="n">testing</span> + <span class="n">MantleAPI</span><span class="o">/</span><span class="mf">0.1</span><span class="nd">@openpass</span><span class="o">/</span><span class="n">testing</span> + <span class="n">Yase</span><span class="o">/</span><span class="mf">0.1</span><span class="nd">@openpass</span><span class="o">/</span><span class="n">testing</span> + <span class="n">openscenario_api</span><span class="o">/</span><span class="n">v1</span><span class="o">.</span><span class="mf">3.1</span><span class="nd">@openpass</span><span class="o">/</span><span class="n">testing</span> + <span class="n">openscenario_engine</span><span class="o">/</span><span class="mf">0.1</span><span class="nd">@openpass</span><span class="o">/</span><span class="n">testing</span> + +<span class="p">[</span><span class="n">options</span><span class="p">]</span> + <span class="n">qt</span><span class="p">:</span><span class="n">with_pq</span><span class="o">=</span><span class="kc">False</span> + <span class="n">qt</span><span class="p">:</span><span class="n">openssl</span><span class="o">=</span><span class="kc">False</span> + <span class="n">qt</span><span class="p">:</span><span class="n">opengl</span><span class="o">=</span><span class="n">no</span> + <span class="n">msys2</span><span class="p">:</span><span class="n">no_kill</span><span class="o">=</span><span class="kc">True</span> + <span class="n">qt</span><span class="p">:</span><span class="n">qtxmlpatterns</span><span class="o">=</span><span class="kc">True</span> + <span class="n">b2</span><span class="p">:</span><span class="n">use_cxx_env</span><span class="o">=</span><span class="kc">True</span> + <span class="n">b2</span><span class="p">:</span><span class="n">toolset</span><span class="o">=</span><span class="n">gcc</span> + <span class="n">protobuf</span><span class="p">:</span><span class="n">shared</span><span class="o">=</span><span class="kc">True</span> + <span class="n">openscenario_engine</span><span class="p">:</span><span class="n">MantleAPI_version</span><span class="o">=</span><span class="mi">515</span><span class="n">f156900f866e1004a53b352931547cf5a85f6</span> + <span class="n">openscenario_engine</span><span class="p">:</span><span class="n">Yase_version</span><span class="o">=</span><span class="n">d0c0e58d17358044cc9018c74308b45f6097ecfb</span> <span class="p">[</span><span class="n">generators</span><span class="p">]</span> + <span class="n">deploy</span> <span class="n">cmake_find_package</span> - <span class="n">cmake_paths</span> - -<span class="p">[</span><span class="n">imports</span><span class="p">]</span> - <span class="o">.</span> <span class="p">,</span> <span class="o">*</span> <span class="o">-></span> <span class="n">C</span><span class="p">:</span><span class="o">/</span><span class="n">openpass</span><span class="o">/</span><span class="n">ThirdParty</span> <span class="o">@</span> </pre></div> </div> +<div class="admonition note"> +<p class="admonition-title">Note</p> +<p>The exact list of dependency can be found in the source code.</p> +</div> </div> </div> @@ -364,7 +340,7 @@ <div role="contentinfo"> <p> - © Copyright 2023 OpenPASS Working Group. + © Copyright 2023 openPASS Working Group. </p> </div>
diff --git a/content/html/installation_guide/further_guidance/10_cmake.html b/content/html/installation_guide/further_guidance/10_cmake.html index fff996c..8d4678d 100644 --- a/content/html/installation_guide/further_guidance/10_cmake.html +++ b/content/html/installation_guide/further_guidance/10_cmake.html
@@ -7,7 +7,7 @@ <meta name="viewport" content="width=device-width, initial-scale=1.0" /> - <title>CMake Variables and Options — OpenPASS Documentation</title> + <title>CMake Variables and Options — openPASS Documentation</title> @@ -71,7 +71,7 @@ <div class="version"> - "openPASS v0.11" + "develop_4d7f6d4f2e22c286789082dd8cbe3eb7f5b5af62" </div> @@ -101,7 +101,7 @@ <li class="toctree-l1"><a class="reference internal" href="../10_getting_started.html">Getting Started</a></li> <li class="toctree-l1"><a class="reference internal" href="../15_system_requirements.html">System Requirements</a></li> <li class="toctree-l1"><a class="reference internal" href="../20_install_prerequisites.html">Installing Prerequisites</a></li> -<li class="toctree-l1"><a class="reference internal" href="../30_install_openpass.html">Installing OpenPASS</a></li> +<li class="toctree-l1"><a class="reference internal" href="../30_install_openpass.html">Installing openPASS</a></li> <li class="toctree-l1 current"><a class="reference internal" href="../50_further_guidance.html">Further Guidance</a><ul class="current"> <li class="toctree-l2 current"><a class="current reference internal" href="#">CMake Variables and Options</a><ul> <li class="toctree-l3"><a class="reference internal" href="#cmake-generator">CMake Generator</a></li> @@ -117,14 +117,13 @@ <li class="toctree-l3"><a class="reference internal" href="#with-doc">WITH_DOC</a></li> <li class="toctree-l3"><a class="reference internal" href="#with-api-doc">WITH_API_DOC</a></li> <li class="toctree-l3"><a class="reference internal" href="#with-coverage">WITH_COVERAGE</a></li> -<li class="toctree-l3"><a class="reference internal" href="#with-gui">WITH_GUI</a></li> <li class="toctree-l3"><a class="reference internal" href="#with-tests">WITH_TESTS</a></li> <li class="toctree-l3"><a class="reference internal" href="#with-endtoend-tests">WITH_ENDTOEND_TESTS</a></li> <li class="toctree-l3"><a class="reference internal" href="#openpass-adjust-output">OPENPASS_ADJUST_OUTPUT</a></li> -<li class="toctree-l3"><a class="reference internal" href="#with-extended-osi">WITH_EXTENDED_OSI</a></li> <li class="toctree-l3"><a class="reference internal" href="#with-protobuf-arena">WITH_PROTOBUF_ARENA</a></li> <li class="toctree-l3"><a class="reference internal" href="#install-system-runtime-deps">INSTALL_SYSTEM_RUNTIME_DEPS</a></li> <li class="toctree-l3"><a class="reference internal" href="#install-extra-runtime-deps">INSTALL_EXTRA_RUNTIME_DEPS</a></li> +<li class="toctree-l3"><a class="reference internal" href="#install-examples">INSTALL_EXAMPLES</a></li> <li class="toctree-l3"><a class="reference internal" href="#make-targets-commands">Make Targets/Commands</a><ul> <li class="toctree-l4"><a class="reference internal" href="#build-and-install">Build and Install</a></li> <li class="toctree-l4"><a class="reference internal" href="#executing-tests">Executing Tests</a></li> @@ -140,10 +139,9 @@ <ul> <li class="toctree-l1"><a class="reference internal" href="../../user_guide/10_overview.html">Overview</a></li> <li class="toctree-l1"><a class="reference internal" href="../../user_guide/20_tutorials.html">Tutorials</a></li> -<li class="toctree-l1"><a class="reference internal" href="../../user_guide/30_gui_plugins.html">GUI Plugins</a></li> -<li class="toctree-l1"><a class="reference internal" href="../../user_guide/40_configs_in_depth.html">Configs in Depth</a></li> -<li class="toctree-l1"><a class="reference internal" href="../../user_guide/50_outputs_in_depth.html">Outputs in Depth</a></li> -<li class="toctree-l1"><a class="reference internal" href="../../user_guide/60_scenario_simulation.html">Simulator</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../user_guide/30_configs_in_depth.html">Configs in Depth</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../user_guide/40_outputs_in_depth.html">Outputs in Depth</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../user_guide/50_scenario_simulation.html">Simulator</a></li> </ul> <p class="caption"><span class="caption-text">Advanced topics</span></p> <ul> @@ -154,12 +152,14 @@ <ul> <li class="toctree-l1"><a class="reference internal" href="../../developer_information/10_ide_support.html">IDE Support</a></li> <li class="toctree-l1"><a class="reference internal" href="../../developer_information/20_documentation.html">Documentation Concept</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../developer_information/30_coding_conventions.html">Coding Guidelines</a></li> </ul> <p class="caption"><span class="caption-text">Other Information</span></p> <ul> <li class="toctree-l1"><a class="reference internal" href="../../other_information/10_external_dependencies.html">External Dependencies</a></li> <li class="toctree-l1"><a class="reference internal" href="../../other_information/20_glossary.html">Glossary</a></li> -<li class="toctree-l1"><a class="reference internal" href="../../other_information/30_license.html">License</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../other_information/30_gui_plugins.html">GUI Plugins</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../other_information/40_license.html">License</a></li> </ul> @@ -231,7 +231,7 @@ <div class="section" id="cmake-variables-and-options"> <span id="cmake"></span><h1>CMake Variables and Options<a class="headerlink" href="#cmake-variables-and-options" title="Permalink to this headline">¶</a></h1> -<p><strong>OpenPASS</strong> uses CMake as default cross-platform build environment. +<p><strong>openPASS</strong> uses CMake as default cross-platform build environment. CMake varibles describe configuration settings, which can be overriden by the user. To override any build configuration, the CMake variables have to be provided when CMake gets run.</p> <p>If available, recommended options are shown in <strong>bold</strong>.</p> @@ -298,7 +298,7 @@ <h2>CMAKE_INSTALL_PREFIX<a class="headerlink" href="#cmake-install-prefix" title="Permalink to this headline">¶</a></h2> <ul class="simple"> <li><p>Install directory used by install, when invoking <code class="docutils literal notranslate"><span class="pre">make</span> <span class="pre">install</span></code></p></li> -<li><p>Recommendation: <code class="docutils literal notranslate"><span class="pre">/OpenPASS/bin/core</span></code> (Linux) | <code class="docutils literal notranslate"><span class="pre">C:/OpenPASS/bin/core</span></code> (Windows)</p></li> +<li><p>Recommendation: <code class="docutils literal notranslate"><span class="pre">/openPASS/bin/core</span></code> (Linux) | <code class="docutils literal notranslate"><span class="pre">C:/openPASS/bin/core</span></code> (Windows)</p></li> </ul> </div> <div class="section" id="cmake-with-debug-postix"> @@ -323,7 +323,7 @@ <div class="section" id="cmake-c-compiler"> <h2>CMAKE_C_COMPILER<a class="headerlink" href="#cmake-c-compiler" title="Permalink to this headline">¶</a></h2> <ul class="simple"> -<li><p>Options: <strong>gcc-10</strong> | gcc-9 | gcc-8</p></li> +<li><p>Options: <strong>gcc-13</strong> | gcc-12 | gcc-11 | gcc-10 | gcc-9 | gcc-8</p></li> <li><p>See: <a class="reference external" href="https://cmake.org/cmake/help/latest/variable/CMAKE_LANG_COMPILER.html">https://cmake.org/cmake/help/latest/variable/CMAKE_LANG_COMPILER.html</a></p></li> </ul> <div class="admonition note"> @@ -334,7 +334,7 @@ <div class="section" id="cmake-cxx-compiler"> <h2>CMAKE_CXX_COMPILER<a class="headerlink" href="#cmake-cxx-compiler" title="Permalink to this headline">¶</a></h2> <ul class="simple"> -<li><p>Options: <strong>g++-10</strong> | g++-9 | g++-8</p></li> +<li><p>Options: <strong>gcc-13</strong> | gcc-12 | gcc-11 | gcc-10 | gcc-9 | gcc-8</p></li> <li><p>See: <a class="reference external" href="https://cmake.org/cmake/help/latest/variable/CMAKE_LANG_COMPILER.html">https://cmake.org/cmake/help/latest/variable/CMAKE_LANG_COMPILER.html</a></p></li> </ul> <div class="admonition note"> @@ -398,17 +398,6 @@ Each test will be built without optimization, which will increase the testing run-time.</p> </div> </div> -<div class="section" id="with-gui"> -<h2>WITH_GUI<a class="headerlink" href="#with-gui" title="Permalink to this headline">¶</a></h2> -<ul class="simple"> -<li><p>Activates the additional build of the GUI provided with <strong>OpenPASS</strong> (open source).</p></li> -<li><p>Options: <strong>OFF</strong> | ON</p></li> -</ul> -<div class="admonition note"> -<p class="admonition-title">Note</p> -<p>Please refer to <a class="reference internal" href="../../user_guide/30_gui_plugins.html#gui-plugins"><span class="std std-ref">GUI Plugins</span></a> for information on the GUI.</p> -</div> -</div> <div class="section" id="with-tests"> <h2>WITH_TESTS<a class="headerlink" href="#with-tests" title="Permalink to this headline">¶</a></h2> <ul class="simple"> @@ -436,24 +425,8 @@ <p>When skipping <code class="docutils literal notranslate"><span class="pre">make</span> <span class="pre">install</span></code>, dependencies are not copied into the output folder, which could cause crashes due to missing or outdated libraries.</p> </div> </div> -<div class="section" id="with-extended-osi"> -<span id="cmake-protobuf-arenas"></span><h2>WITH_EXTENDED_OSI<a class="headerlink" href="#with-extended-osi" title="Permalink to this headline">¶</a></h2> -<ul> -<li><p>When set, assumes that extended version of OSI is available, by enabling the <code class="docutils literal notranslate"><span class="pre">USE_EXTENDED_OSI</span></code> preprocessor variable.</p></li> -<li><p>This variable can be used to enable e.g. customized OSI features:</p> -<blockquote> -<div><div class="highlight-c++ notranslate"><div class="highlight"><pre><span></span><span class="cp">#ifdef USE_EXTENDED OSI</span> -<span class="cp">#include</span> <span class="cpf"><osi3/osi_<custom_message></span><span class="c1">.pb.h></span><span class="cp"></span> -<span class="cp">#endif</span> -</pre></div> -</div> -</div></blockquote> -</li> -<li><p>Options: <strong>OFF</strong> | ON</p></li> -</ul> -</div> <div class="section" id="with-protobuf-arena"> -<h2>WITH_PROTOBUF_ARENA<a class="headerlink" href="#with-protobuf-arena" title="Permalink to this headline">¶</a></h2> +<span id="cmake-protobuf-arenas"></span><h2>WITH_PROTOBUF_ARENA<a class="headerlink" href="#with-protobuf-arena" title="Permalink to this headline">¶</a></h2> <ul> <li><div class="line-block"> <div class="line"><em>Arena allocation is a C++-only feature that helps you optimize your memory usage and improve performance when working with protocol buffers.</em></div> @@ -492,9 +465,16 @@ <li><p>Options: ON | <strong>OFF</strong></p></li> </ul> </div> +<div class="section" id="install-examples"> +<h2>INSTALL_EXAMPLES<a class="headerlink" href="#install-examples" title="Permalink to this headline">¶</a></h2> +<ul class="simple"> +<li><p>If <cite>ON</cite>, <strong>opSimulation</strong> configuration examples are copied to the <cite>examples</cite> folder inside the installation directory (during the installation step).</p></li> +<li><p>Options: <strong>ON</strong> | OFF</p></li> +</ul> +</div> <div class="section" id="make-targets-commands"> <h2>Make Targets/Commands<a class="headerlink" href="#make-targets-commands" title="Permalink to this headline">¶</a></h2> -<p><strong>OpenPASS</strong> defines build targets by major modules or components, such as <code class="docutils literal notranslate"><span class="pre">opSimulation</span></code> or <code class="docutils literal notranslate"><span class="pre">Algorithm_FmuWrapper</span></code>. +<p><strong>openPASS</strong> defines build targets by major modules or components, such as <code class="docutils literal notranslate"><span class="pre">opSimulation</span></code> or <code class="docutils literal notranslate"><span class="pre">Algorithm_FmuWrapper</span></code>. After calling CMake, simply build <strong>openPASS</strong> by calling <code class="docutils literal notranslate"><span class="pre">make</span></code>.</p> <div class="admonition-see-also admonition"> <p class="admonition-title">See also</p> @@ -533,7 +513,7 @@ <div role="contentinfo"> <p> - © Copyright 2023 OpenPASS Working Group. + © Copyright 2023 openPASS Working Group. </p> </div>
diff --git a/content/html/objects.inv b/content/html/objects.inv index 7fbd194..e5abd66 100644 --- a/content/html/objects.inv +++ b/content/html/objects.inv Binary files differ
diff --git a/content/html/other_information/10_external_dependencies.html b/content/html/other_information/10_external_dependencies.html index ed4fdee..4cd9cff 100644 --- a/content/html/other_information/10_external_dependencies.html +++ b/content/html/other_information/10_external_dependencies.html
@@ -7,7 +7,7 @@ <meta name="viewport" content="width=device-width, initial-scale=1.0" /> - <title>External Dependencies — OpenPASS Documentation</title> + <title>External Dependencies — openPASS Documentation</title> @@ -43,7 +43,7 @@ <link rel="index" title="Index" href="../genindex.html" /> <link rel="search" title="Search" href="../search.html" /> <link rel="next" title="Glossary" href="20_glossary.html" /> - <link rel="prev" title="Documentation Concept" href="../developer_information/20_documentation.html" /> + <link rel="prev" title="Coding Guidelines" href="../developer_information/30_coding_conventions.html" /> </head> <body class="wy-body-for-nav"> @@ -70,7 +70,7 @@ <div class="version"> - "openPASS v0.11" + "develop_4d7f6d4f2e22c286789082dd8cbe3eb7f5b5af62" </div> @@ -100,7 +100,7 @@ <li class="toctree-l1"><a class="reference internal" href="../installation_guide/10_getting_started.html">Getting Started</a></li> <li class="toctree-l1"><a class="reference internal" href="../installation_guide/15_system_requirements.html">System Requirements</a></li> <li class="toctree-l1"><a class="reference internal" href="../installation_guide/20_install_prerequisites.html">Installing Prerequisites</a></li> -<li class="toctree-l1"><a class="reference internal" href="../installation_guide/30_install_openpass.html">Installing OpenPASS</a></li> +<li class="toctree-l1"><a class="reference internal" href="../installation_guide/30_install_openpass.html">Installing openPASS</a></li> <li class="toctree-l1"><a class="reference internal" href="../installation_guide/50_further_guidance.html">Further Guidance</a></li> <li class="toctree-l1"><a class="reference internal" href="../installation_guide/60_conan.html">Building with Conan</a></li> </ul> @@ -108,10 +108,9 @@ <ul> <li class="toctree-l1"><a class="reference internal" href="../user_guide/10_overview.html">Overview</a></li> <li class="toctree-l1"><a class="reference internal" href="../user_guide/20_tutorials.html">Tutorials</a></li> -<li class="toctree-l1"><a class="reference internal" href="../user_guide/30_gui_plugins.html">GUI Plugins</a></li> -<li class="toctree-l1"><a class="reference internal" href="../user_guide/40_configs_in_depth.html">Configs in Depth</a></li> -<li class="toctree-l1"><a class="reference internal" href="../user_guide/50_outputs_in_depth.html">Outputs in Depth</a></li> -<li class="toctree-l1"><a class="reference internal" href="../user_guide/60_scenario_simulation.html">Simulator</a></li> +<li class="toctree-l1"><a class="reference internal" href="../user_guide/30_configs_in_depth.html">Configs in Depth</a></li> +<li class="toctree-l1"><a class="reference internal" href="../user_guide/40_outputs_in_depth.html">Outputs in Depth</a></li> +<li class="toctree-l1"><a class="reference internal" href="../user_guide/50_scenario_simulation.html">Simulator</a></li> </ul> <p class="caption"><span class="caption-text">Advanced topics</span></p> <ul> @@ -122,6 +121,7 @@ <ul> <li class="toctree-l1"><a class="reference internal" href="../developer_information/10_ide_support.html">IDE Support</a></li> <li class="toctree-l1"><a class="reference internal" href="../developer_information/20_documentation.html">Documentation Concept</a></li> +<li class="toctree-l1"><a class="reference internal" href="../developer_information/30_coding_conventions.html">Coding Guidelines</a></li> </ul> <p class="caption"><span class="caption-text">Other Information</span></p> <ul class="current"> @@ -146,7 +146,8 @@ </ul> </li> <li class="toctree-l1"><a class="reference internal" href="20_glossary.html">Glossary</a></li> -<li class="toctree-l1"><a class="reference internal" href="30_license.html">License</a></li> +<li class="toctree-l1"><a class="reference internal" href="30_gui_plugins.html">GUI Plugins</a></li> +<li class="toctree-l1"><a class="reference internal" href="40_license.html">License</a></li> </ul> @@ -216,7 +217,7 @@ <div class="section" id="external-dependencies"> <h1>External Dependencies<a class="headerlink" href="#external-dependencies" title="Permalink to this headline">¶</a></h1> -<p><strong>OpenPASS</strong> depends on a number of external dependencies. Installation of those dependencies is described in <a class="reference internal" href="../installation_guide/20_install_prerequisites.html#prerequisites"><span class="std std-ref">Installing Prerequisites</span></a>.</p> +<p><strong>openPASS</strong> depends on a number of external dependencies. Installation of those dependencies is described in <a class="reference internal" href="../installation_guide/20_install_prerequisites.html#prerequisites"><span class="std std-ref">Installing Prerequisites</span></a>.</p> <p>The third party software dependency of <strong>openPASS</strong> can be divided into:</p> <ul class="simple"> <li><p><strong>Build environment</strong>, which manages third party software and is used to compile and install <strong>openPASS</strong></p></li> @@ -228,8 +229,8 @@ <h2>Information on Binary Packages<a class="headerlink" href="#information-on-binary-packages" title="Permalink to this headline">¶</a></h2> <div class="section" id="gnu-compiler-collection-gcc"> <h3>GNU Compiler Collection (gcc)<a class="headerlink" href="#gnu-compiler-collection-gcc" title="Permalink to this headline">¶</a></h3> -<p>Version (latest tested): 10.2.3</p> -<p><strong>OpenPASS</strong> is developed on Linux and Windows (64-Bit) in <a class="reference external" href="https://isocpp.org/">C++17</a> using the GNU Compiler Collection (<a class="reference external" href="https://gcc.gnu.org/">gcc</a>).</p> +<p>Version (latest tested): 13.2.0</p> +<p><strong>openPASS</strong> is developed on Linux and Windows (64-Bit) in <a class="reference external" href="https://isocpp.org/">C++17</a> using the GNU Compiler Collection (<a class="reference external" href="https://gcc.gnu.org/">gcc</a>).</p> <div class="admonition-useful-hints admonition"> <p class="admonition-title">Useful hints</p> <ul> @@ -245,19 +246,19 @@ </div> <div class="section" id="gnu-debugger-gdb"> <h3>GNU Debugger (gdb)<a class="headerlink" href="#gnu-debugger-gdb" title="Permalink to this headline">¶</a></h3> -<p>Version (latest tested): 9.2</p> +<p>Version (latest tested): 13.2.0</p> <p>Debugging tools for gcc: <a class="reference external" href="https://www.gnu.org/savannah-checkouts/gnu/gdb/index.html">https://www.gnu.org/savannah-checkouts/gnu/gdb/index.html</a></p> </div> <div class="section" id="cmake"> <h3>CMake<a class="headerlink" href="#cmake" title="Permalink to this headline">¶</a></h3> -<p>Version (latest tested): 3.18.4</p> -<p><strong>OpenPASS</strong> uses <a class="reference external" href="https://cmake.org/">CMake</a> for building and testing. +<p>Version (latest tested): 3.27.3</p> +<p><strong>openPASS</strong> uses <a class="reference external" href="https://cmake.org/">CMake</a> for building and testing. For details on the provided options, see <a class="reference internal" href="../installation_guide/further_guidance/10_cmake.html#cmake"><span class="std std-ref">CMake Variables and Options</span></a>.</p> </div> <div class="section" id="ccache"> <span id="prerequisites-ccache"></span><h3>Ccache<a class="headerlink" href="#ccache" title="Permalink to this headline">¶</a></h3> -<p>Version (latest tested): 3.7.11</p> -<p><strong>OpenPASS</strong> supports the compiler cache <a class="reference external" href="https://ccache.dev/">Ccache</a> for faster recompilation. +<p>Version (latest tested): 4.7.4</p> +<p><strong>openPASS</strong> supports the compiler cache <a class="reference external" href="https://ccache.dev/">Ccache</a> for faster recompilation. Use only, if you need to recompile regularly.</p> <div class="admonition-useful-hints admonition"> <p class="admonition-title">Useful hints</p> @@ -269,7 +270,7 @@ </div> <div class="section" id="doxygen"> <h3>Doxygen<a class="headerlink" href="#doxygen" title="Permalink to this headline">¶</a></h3> -<p>Version (latest tested): 1.8.20</p> +<p>Version (latest tested): 1.9.6</p> <p>Documentation is created using <a class="reference external" href="https://www.doxygen.nl/index.html">Doxygen</a>.</p> <div class="admonition-useful-hints admonition"> <p class="admonition-title">Useful hints</p> @@ -284,14 +285,13 @@ </div> <div class="section" id="qt-framework"> <h3>Qt Framework<a class="headerlink" href="#qt-framework" title="Permalink to this headline">¶</a></h3> -<p>Version (officially supported): 5.12.3</p> -<p><strong>OpenPASS</strong> uses some features from the <a class="reference external" href="https://www.qt.io/">Qt</a> framework. -While the GUI of <strong>openPASS</strong> (Open Source) heavily relies on it, the simulator tries to stick to the C++ standard framework as far as possible.</p> +<p>Version (officially supported): 5.15.3</p> +<p><strong>openPASS</strong> uses some features from the <a class="reference external" href="https://www.qt.io/">Qt</a> framework. +A previous version of the GUI of <strong>openPASS</strong> relied on Qt. <strong>openPASS</strong> itself tries to stick to the C++ standard framework as far as possible, but still uses the Qt framework for some tasks, e.g. xml parsing.</p> <div class="admonition-note-on-versions admonition"> <p class="admonition-title">Note on Versions</p> <div class="line-block"> <div class="line">Versions starting from 5.4 should generally work, but are not officially supported anymore/yet.</div> -<div class="line">Version 5.15.1 has been reported to work well.</div> </div> </div> </div> @@ -306,8 +306,8 @@ </div> <div class="section" id="googletest"> <h3>googletest<a class="headerlink" href="#googletest" title="Permalink to this headline">¶</a></h3> -<p>Version (officially supported): 1.10.0</p> -<p>Tests are written in <a class="reference external" href="https://github.com/google/googletest">googletest</a> and <strong>OpenPASS</strong> makes use of the included <em>googletest</em> (gtest) C++ testing framework, as well as the included mocking framework <em>googlemock</em> (gmock).</p> +<p>Version (officially supported): 1.14.0</p> +<p>Tests are written in <a class="reference external" href="https://github.com/google/googletest">googletest</a> and <strong>openPASS</strong> makes use of the included <em>googletest</em> (gtest) C++ testing framework, as well as the included mocking framework <em>googlemock</em> (gmock).</p> <div class="admonition note"> <p class="admonition-title">Note</p> <p>The lastest major release brought several API changes, which made some code fixes necessary. @@ -334,21 +334,16 @@ Beyond that, <strong>openPASS</strong> holds data for non-sensor centric data, such as metainfo on lanes and roads.</p> <p>As shown, OSI itself depends on <a class="reference internal" href="#prerequisites-protobuf"><span class="std std-ref">Protocol Buffers (protobuf)</span></a>. If not already installed, the library and headers have to be built prior to OSI.</p> -<div class="admonition-note-on-versions admonition"> -<p class="admonition-title">Note on Versions</p> -<p><strong>OpenPASS</strong> supports <strong>integration of custom made or experimental versions</strong> of OSI (see <a class="reference internal" href="../installation_guide/20_install_prerequisites.html#building-osi"><span class="std std-ref">Build and Install OSI</span></a>). -For example, <cite>Algorithm_FmuWrapper</cite> and the wrapped <cite>OSMP</cite> FMUs use the proposed OSI messages <cite>MotionCommand</cite> and <cite>VehicleCommunicationData</cite>, not yet defined in OSI 3.5.0.</p> -</div> </div> <div class="section" id="protocol-buffers-protobuf"> <span id="prerequisites-protobuf"></span><h3>Protocol Buffers (protobuf)<a class="headerlink" href="#protocol-buffers-protobuf" title="Permalink to this headline">¶</a></h3> -<p>Supported Version (officially supported): 3.12.2</p> +<p>Supported Version (officially supported): 3.20.0</p> <p><a class="reference internal" href="#prerequisites-osi"><span class="std std-ref">Open Simulation Interface (OSI)</span></a> uses <a class="reference external" href="https://developers.google.com/protocol-buffers">Protocol Buffers</a> for describing and serialization of its datastructures.</p> <div class="admonition-note-on-versions admonition"> <p class="admonition-title">Note on Versions</p> <ul class="simple"> <li><p>So far, no version limitations known (including 2.x).</p></li> -<li><p><strong>OpenPASS</strong> lets you integrate your own protobuf libraries if necessary (see <a class="reference internal" href="../installation_guide/20_install_prerequisites.html#building-protobuf"><span class="std std-ref">Build and Install Protobuf</span></a>).</p></li> +<li><p><strong>openPASS</strong> lets you integrate your own protobuf libraries if necessary (see <a class="reference internal" href="../installation_guide/20_install_prerequisites.html#building-protobuf"><span class="std std-ref">Build and Install Protobuf</span></a>).</p></li> </ul> </div> </div> @@ -368,14 +363,14 @@ <footer> <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> <a href="20_glossary.html" class="btn btn-neutral float-right" title="Glossary" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a> - <a href="../developer_information/20_documentation.html" class="btn btn-neutral float-left" title="Documentation Concept" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a> + <a href="../developer_information/30_coding_conventions.html" class="btn btn-neutral float-left" title="Coding Guidelines" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a> </div> <hr/> <div role="contentinfo"> <p> - © Copyright 2023 OpenPASS Working Group. + © Copyright 2023 openPASS Working Group. </p> </div>
diff --git a/content/html/other_information/20_glossary.html b/content/html/other_information/20_glossary.html index 1c5c605..a987b9d 100644 --- a/content/html/other_information/20_glossary.html +++ b/content/html/other_information/20_glossary.html
@@ -7,7 +7,7 @@ <meta name="viewport" content="width=device-width, initial-scale=1.0" /> - <title>Glossary — OpenPASS Documentation</title> + <title>Glossary — openPASS Documentation</title> @@ -42,7 +42,7 @@ <link rel="index" title="Index" href="../genindex.html" /> <link rel="search" title="Search" href="../search.html" /> - <link rel="next" title="License" href="30_license.html" /> + <link rel="next" title="GUI Plugins" href="30_gui_plugins.html" /> <link rel="prev" title="External Dependencies" href="10_external_dependencies.html" /> </head> @@ -70,7 +70,7 @@ <div class="version"> - "openPASS v0.11" + "develop_4d7f6d4f2e22c286789082dd8cbe3eb7f5b5af62" </div> @@ -100,7 +100,7 @@ <li class="toctree-l1"><a class="reference internal" href="../installation_guide/10_getting_started.html">Getting Started</a></li> <li class="toctree-l1"><a class="reference internal" href="../installation_guide/15_system_requirements.html">System Requirements</a></li> <li class="toctree-l1"><a class="reference internal" href="../installation_guide/20_install_prerequisites.html">Installing Prerequisites</a></li> -<li class="toctree-l1"><a class="reference internal" href="../installation_guide/30_install_openpass.html">Installing OpenPASS</a></li> +<li class="toctree-l1"><a class="reference internal" href="../installation_guide/30_install_openpass.html">Installing openPASS</a></li> <li class="toctree-l1"><a class="reference internal" href="../installation_guide/50_further_guidance.html">Further Guidance</a></li> <li class="toctree-l1"><a class="reference internal" href="../installation_guide/60_conan.html">Building with Conan</a></li> </ul> @@ -108,10 +108,9 @@ <ul> <li class="toctree-l1"><a class="reference internal" href="../user_guide/10_overview.html">Overview</a></li> <li class="toctree-l1"><a class="reference internal" href="../user_guide/20_tutorials.html">Tutorials</a></li> -<li class="toctree-l1"><a class="reference internal" href="../user_guide/30_gui_plugins.html">GUI Plugins</a></li> -<li class="toctree-l1"><a class="reference internal" href="../user_guide/40_configs_in_depth.html">Configs in Depth</a></li> -<li class="toctree-l1"><a class="reference internal" href="../user_guide/50_outputs_in_depth.html">Outputs in Depth</a></li> -<li class="toctree-l1"><a class="reference internal" href="../user_guide/60_scenario_simulation.html">Simulator</a></li> +<li class="toctree-l1"><a class="reference internal" href="../user_guide/30_configs_in_depth.html">Configs in Depth</a></li> +<li class="toctree-l1"><a class="reference internal" href="../user_guide/40_outputs_in_depth.html">Outputs in Depth</a></li> +<li class="toctree-l1"><a class="reference internal" href="../user_guide/50_scenario_simulation.html">Simulator</a></li> </ul> <p class="caption"><span class="caption-text">Advanced topics</span></p> <ul> @@ -122,12 +121,14 @@ <ul> <li class="toctree-l1"><a class="reference internal" href="../developer_information/10_ide_support.html">IDE Support</a></li> <li class="toctree-l1"><a class="reference internal" href="../developer_information/20_documentation.html">Documentation Concept</a></li> +<li class="toctree-l1"><a class="reference internal" href="../developer_information/30_coding_conventions.html">Coding Guidelines</a></li> </ul> <p class="caption"><span class="caption-text">Other Information</span></p> <ul class="current"> <li class="toctree-l1"><a class="reference internal" href="10_external_dependencies.html">External Dependencies</a></li> <li class="toctree-l1 current"><a class="current reference internal" href="#">Glossary</a></li> -<li class="toctree-l1"><a class="reference internal" href="30_license.html">License</a></li> +<li class="toctree-l1"><a class="reference internal" href="30_gui_plugins.html">GUI Plugins</a></li> +<li class="toctree-l1"><a class="reference internal" href="40_license.html">License</a></li> </ul> @@ -237,7 +238,7 @@ <dt id="term-PCM">PCM<a class="headerlink" href="#term-PCM" title="Permalink to this term">¶</a></dt><dd><p>Pre-Crash Matrix is a specified format which can be used to describe the phase of a road traffic accident before the first collision happens (the so-called pre-crash phase). See <a class="reference external" href="https://www.vufo.de/pcm/?lang=en">https://www.vufo.de/pcm/?lang=en</a></p> </dd> -<dt id="term-PreCASE">PreCASE<a class="headerlink" href="#term-PreCASE" title="Permalink to this term">¶</a></dt><dd><p>Framework for the Simulative Evaluation of Active Safety Systems in Vehicles (OpenPASS predecessor).</p> +<dt id="term-PreCASE">PreCASE<a class="headerlink" href="#term-PreCASE" title="Permalink to this term">¶</a></dt><dd><p>Framework for the Simulative Evaluation of Active Safety Systems in Vehicles (openPASS predecessor).</p> </dd> <dt id="term-Scenario">Scenario<a class="headerlink" href="#term-Scenario" title="Permalink to this term">¶</a></dt><dd><p>A set of similar traffic situations.</p> </dd> @@ -252,7 +253,7 @@ </div> <footer> <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> - <a href="30_license.html" class="btn btn-neutral float-right" title="License" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a> + <a href="30_gui_plugins.html" class="btn btn-neutral float-right" title="GUI Plugins" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a> <a href="10_external_dependencies.html" class="btn btn-neutral float-left" title="External Dependencies" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a> </div> @@ -260,7 +261,7 @@ <div role="contentinfo"> <p> - © Copyright 2023 OpenPASS Working Group. + © Copyright 2023 openPASS Working Group. </p> </div>
diff --git a/content/html/user_guide/30_gui_plugins.html b/content/html/other_information/30_gui_plugins.html similarity index 77% rename from content/html/user_guide/30_gui_plugins.html rename to content/html/other_information/30_gui_plugins.html index 6781b0c..309abbe 100644 --- a/content/html/user_guide/30_gui_plugins.html +++ b/content/html/other_information/30_gui_plugins.html
@@ -7,7 +7,7 @@ <meta name="viewport" content="width=device-width, initial-scale=1.0" /> - <title>GUI Plugins — OpenPASS Documentation</title> + <title>GUI Plugins — openPASS Documentation</title> @@ -43,7 +43,7 @@ <link rel="index" title="Index" href="../genindex.html" /> <link rel="search" title="Search" href="../search.html" /> <link rel="next" title="Project" href="gui_user_guide/10_projects.html" /> - <link rel="prev" title="PCM Simulation" href="tutorials/20_pcm_simulation.html" /> + <link rel="prev" title="Glossary" href="20_glossary.html" /> </head> <body class="wy-body-for-nav"> @@ -70,7 +70,7 @@ <div class="version"> - "openPASS v0.11" + "develop_4d7f6d4f2e22c286789082dd8cbe3eb7f5b5af62" </div> @@ -100,25 +100,17 @@ <li class="toctree-l1"><a class="reference internal" href="../installation_guide/10_getting_started.html">Getting Started</a></li> <li class="toctree-l1"><a class="reference internal" href="../installation_guide/15_system_requirements.html">System Requirements</a></li> <li class="toctree-l1"><a class="reference internal" href="../installation_guide/20_install_prerequisites.html">Installing Prerequisites</a></li> -<li class="toctree-l1"><a class="reference internal" href="../installation_guide/30_install_openpass.html">Installing OpenPASS</a></li> +<li class="toctree-l1"><a class="reference internal" href="../installation_guide/30_install_openpass.html">Installing openPASS</a></li> <li class="toctree-l1"><a class="reference internal" href="../installation_guide/50_further_guidance.html">Further Guidance</a></li> <li class="toctree-l1"><a class="reference internal" href="../installation_guide/60_conan.html">Building with Conan</a></li> </ul> <p class="caption"><span class="caption-text">User Guides</span></p> -<ul class="current"> -<li class="toctree-l1"><a class="reference internal" href="10_overview.html">Overview</a></li> -<li class="toctree-l1"><a class="reference internal" href="20_tutorials.html">Tutorials</a></li> -<li class="toctree-l1 current"><a class="current reference internal" href="#">GUI Plugins</a><ul> -<li class="toctree-l2"><a class="reference internal" href="gui_user_guide/10_projects.html">Project</a></li> -<li class="toctree-l2"><a class="reference internal" href="gui_user_guide/20_system_editor.html">System Editor</a></li> -<li class="toctree-l2"><a class="reference internal" href="gui_user_guide/30_pcm_sim.html">PCM Simulation</a></li> -<li class="toctree-l2"><a class="reference internal" href="gui_user_guide/40_pcm_eval.html">PCM Evaluation</a></li> -<li class="toctree-l2"><a class="reference internal" href="gui_user_guide/50_result_visualization.html">Result Visualization</a></li> -</ul> -</li> -<li class="toctree-l1"><a class="reference internal" href="40_configs_in_depth.html">Configs in Depth</a></li> -<li class="toctree-l1"><a class="reference internal" href="50_outputs_in_depth.html">Outputs in Depth</a></li> -<li class="toctree-l1"><a class="reference internal" href="60_scenario_simulation.html">Simulator</a></li> +<ul> +<li class="toctree-l1"><a class="reference internal" href="../user_guide/10_overview.html">Overview</a></li> +<li class="toctree-l1"><a class="reference internal" href="../user_guide/20_tutorials.html">Tutorials</a></li> +<li class="toctree-l1"><a class="reference internal" href="../user_guide/30_configs_in_depth.html">Configs in Depth</a></li> +<li class="toctree-l1"><a class="reference internal" href="../user_guide/40_outputs_in_depth.html">Outputs in Depth</a></li> +<li class="toctree-l1"><a class="reference internal" href="../user_guide/50_scenario_simulation.html">Simulator</a></li> </ul> <p class="caption"><span class="caption-text">Advanced topics</span></p> <ul> @@ -129,12 +121,21 @@ <ul> <li class="toctree-l1"><a class="reference internal" href="../developer_information/10_ide_support.html">IDE Support</a></li> <li class="toctree-l1"><a class="reference internal" href="../developer_information/20_documentation.html">Documentation Concept</a></li> +<li class="toctree-l1"><a class="reference internal" href="../developer_information/30_coding_conventions.html">Coding Guidelines</a></li> </ul> <p class="caption"><span class="caption-text">Other Information</span></p> -<ul> -<li class="toctree-l1"><a class="reference internal" href="../other_information/10_external_dependencies.html">External Dependencies</a></li> -<li class="toctree-l1"><a class="reference internal" href="../other_information/20_glossary.html">Glossary</a></li> -<li class="toctree-l1"><a class="reference internal" href="../other_information/30_license.html">License</a></li> +<ul class="current"> +<li class="toctree-l1"><a class="reference internal" href="10_external_dependencies.html">External Dependencies</a></li> +<li class="toctree-l1"><a class="reference internal" href="20_glossary.html">Glossary</a></li> +<li class="toctree-l1 current"><a class="current reference internal" href="#">GUI Plugins</a><ul> +<li class="toctree-l2"><a class="reference internal" href="gui_user_guide/10_projects.html">Project</a></li> +<li class="toctree-l2"><a class="reference internal" href="gui_user_guide/20_system_editor.html">System Editor</a></li> +<li class="toctree-l2"><a class="reference internal" href="gui_user_guide/30_pcm_sim.html">PCM Simulation</a></li> +<li class="toctree-l2"><a class="reference internal" href="gui_user_guide/40_pcm_eval.html">PCM Evaluation</a></li> +<li class="toctree-l2"><a class="reference internal" href="gui_user_guide/50_result_visualization.html">Result Visualization</a></li> +</ul> +</li> +<li class="toctree-l1"><a class="reference internal" href="40_license.html">License</a></li> </ul> @@ -189,7 +190,7 @@ <li class="wy-breadcrumbs-aside"> - <a href="../_sources/user_guide/30_gui_plugins.rst.txt" rel="nofollow"> View page source</a> + <a href="../_sources/other_information/30_gui_plugins.rst.txt" rel="nofollow"> View page source</a> </li> @@ -204,6 +205,12 @@ <div class="section" id="gui-plugins"> <span id="id1"></span><h1>GUI Plugins<a class="headerlink" href="#gui-plugins" title="Permalink to this headline">¶</a></h1> +<blockquote> +<div><ul class="simple"> +<li><p>The deprecated “Qt GUI” for simulation configuration based on Qt mainly aimed to edit PCM-based openPASS experiments was part of minor releases v0.5 – v0.11.</p></li> +<li><p>The latest version of this deprecated GUI can be found here: <a class="reference external" href="https://ci.eclipse.org/openpass/job/openPASS_simulator_build/view/tags/job/openPASS_0.11/">https://ci.eclipse.org/openpass/job/openPASS_simulator_build/view/tags/job/openPASS_0.11/</a></p></li> +</ul> +</div></blockquote> <div class="toctree-wrapper compound"> <ul> <li class="toctree-l1"><a class="reference internal" href="gui_user_guide/10_projects.html">Project</a></li> @@ -213,13 +220,6 @@ <li class="toctree-l1"><a class="reference internal" href="gui_user_guide/50_result_visualization.html">Result Visualization</a></li> </ul> </div> -<p>Additionally, the following plugins are currently work in progress:</p> -<blockquote> -<div><ul class="simple"> -<li><p>agentConfiguration</p></li> -<li><p>trafficSimulation</p></li> -</ul> -</div></blockquote> </div> @@ -229,14 +229,14 @@ <footer> <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> <a href="gui_user_guide/10_projects.html" class="btn btn-neutral float-right" title="Project" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a> - <a href="tutorials/20_pcm_simulation.html" class="btn btn-neutral float-left" title="PCM Simulation" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a> + <a href="20_glossary.html" class="btn btn-neutral float-left" title="Glossary" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a> </div> <hr/> <div role="contentinfo"> <p> - © Copyright 2023 OpenPASS Working Group. + © Copyright 2023 openPASS Working Group. </p> </div>
diff --git a/content/html/other_information/30_license.html b/content/html/other_information/40_license.html similarity index 86% rename from content/html/other_information/30_license.html rename to content/html/other_information/40_license.html index 9634816..06546a8 100644 --- a/content/html/other_information/30_license.html +++ b/content/html/other_information/40_license.html
@@ -7,7 +7,7 @@ <meta name="viewport" content="width=device-width, initial-scale=1.0" /> - <title>License — OpenPASS Documentation</title> + <title>License — openPASS Documentation</title> @@ -42,7 +42,7 @@ <link rel="index" title="Index" href="../genindex.html" /> <link rel="search" title="Search" href="../search.html" /> - <link rel="prev" title="Glossary" href="20_glossary.html" /> + <link rel="prev" title="TimePlot" href="gui_user_guide/result_visualization/20_timePlot.html" /> </head> <body class="wy-body-for-nav"> @@ -69,7 +69,7 @@ <div class="version"> - "openPASS v0.11" + "develop_4d7f6d4f2e22c286789082dd8cbe3eb7f5b5af62" </div> @@ -99,7 +99,7 @@ <li class="toctree-l1"><a class="reference internal" href="../installation_guide/10_getting_started.html">Getting Started</a></li> <li class="toctree-l1"><a class="reference internal" href="../installation_guide/15_system_requirements.html">System Requirements</a></li> <li class="toctree-l1"><a class="reference internal" href="../installation_guide/20_install_prerequisites.html">Installing Prerequisites</a></li> -<li class="toctree-l1"><a class="reference internal" href="../installation_guide/30_install_openpass.html">Installing OpenPASS</a></li> +<li class="toctree-l1"><a class="reference internal" href="../installation_guide/30_install_openpass.html">Installing openPASS</a></li> <li class="toctree-l1"><a class="reference internal" href="../installation_guide/50_further_guidance.html">Further Guidance</a></li> <li class="toctree-l1"><a class="reference internal" href="../installation_guide/60_conan.html">Building with Conan</a></li> </ul> @@ -107,10 +107,9 @@ <ul> <li class="toctree-l1"><a class="reference internal" href="../user_guide/10_overview.html">Overview</a></li> <li class="toctree-l1"><a class="reference internal" href="../user_guide/20_tutorials.html">Tutorials</a></li> -<li class="toctree-l1"><a class="reference internal" href="../user_guide/30_gui_plugins.html">GUI Plugins</a></li> -<li class="toctree-l1"><a class="reference internal" href="../user_guide/40_configs_in_depth.html">Configs in Depth</a></li> -<li class="toctree-l1"><a class="reference internal" href="../user_guide/50_outputs_in_depth.html">Outputs in Depth</a></li> -<li class="toctree-l1"><a class="reference internal" href="../user_guide/60_scenario_simulation.html">Simulator</a></li> +<li class="toctree-l1"><a class="reference internal" href="../user_guide/30_configs_in_depth.html">Configs in Depth</a></li> +<li class="toctree-l1"><a class="reference internal" href="../user_guide/40_outputs_in_depth.html">Outputs in Depth</a></li> +<li class="toctree-l1"><a class="reference internal" href="../user_guide/50_scenario_simulation.html">Simulator</a></li> </ul> <p class="caption"><span class="caption-text">Advanced topics</span></p> <ul> @@ -121,11 +120,13 @@ <ul> <li class="toctree-l1"><a class="reference internal" href="../developer_information/10_ide_support.html">IDE Support</a></li> <li class="toctree-l1"><a class="reference internal" href="../developer_information/20_documentation.html">Documentation Concept</a></li> +<li class="toctree-l1"><a class="reference internal" href="../developer_information/30_coding_conventions.html">Coding Guidelines</a></li> </ul> <p class="caption"><span class="caption-text">Other Information</span></p> <ul class="current"> <li class="toctree-l1"><a class="reference internal" href="10_external_dependencies.html">External Dependencies</a></li> <li class="toctree-l1"><a class="reference internal" href="20_glossary.html">Glossary</a></li> +<li class="toctree-l1"><a class="reference internal" href="30_gui_plugins.html">GUI Plugins</a></li> <li class="toctree-l1 current"><a class="current reference internal" href="#">License</a></li> </ul> @@ -181,7 +182,7 @@ <li class="wy-breadcrumbs-aside"> - <a href="../_sources/other_information/30_license.rst.txt" rel="nofollow"> View page source</a> + <a href="../_sources/other_information/40_license.rst.txt" rel="nofollow"> View page source</a> </li> @@ -206,14 +207,14 @@ </div> <footer> <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> - <a href="20_glossary.html" class="btn btn-neutral float-left" title="Glossary" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a> + <a href="gui_user_guide/result_visualization/20_timePlot.html" class="btn btn-neutral float-left" title="TimePlot" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a> </div> <hr/> <div role="contentinfo"> <p> - © Copyright 2023 OpenPASS Working Group. + © Copyright 2023 openPASS Working Group. </p> </div>
diff --git a/content/html/user_guide/gui_user_guide/10_projects.html b/content/html/other_information/gui_user_guide/10_projects.html similarity index 85% rename from content/html/user_guide/gui_user_guide/10_projects.html rename to content/html/other_information/gui_user_guide/10_projects.html index e29bd3b..0485685 100644 --- a/content/html/user_guide/gui_user_guide/10_projects.html +++ b/content/html/other_information/gui_user_guide/10_projects.html
@@ -7,7 +7,7 @@ <meta name="viewport" content="width=device-width, initial-scale=1.0" /> - <title>Project — OpenPASS Documentation</title> + <title>Project — openPASS Documentation</title> @@ -70,7 +70,7 @@ <div class="version"> - "openPASS v0.11" + "develop_4d7f6d4f2e22c286789082dd8cbe3eb7f5b5af62" </div> @@ -100,14 +100,33 @@ <li class="toctree-l1"><a class="reference internal" href="../../installation_guide/10_getting_started.html">Getting Started</a></li> <li class="toctree-l1"><a class="reference internal" href="../../installation_guide/15_system_requirements.html">System Requirements</a></li> <li class="toctree-l1"><a class="reference internal" href="../../installation_guide/20_install_prerequisites.html">Installing Prerequisites</a></li> -<li class="toctree-l1"><a class="reference internal" href="../../installation_guide/30_install_openpass.html">Installing OpenPASS</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../installation_guide/30_install_openpass.html">Installing openPASS</a></li> <li class="toctree-l1"><a class="reference internal" href="../../installation_guide/50_further_guidance.html">Further Guidance</a></li> <li class="toctree-l1"><a class="reference internal" href="../../installation_guide/60_conan.html">Building with Conan</a></li> </ul> <p class="caption"><span class="caption-text">User Guides</span></p> +<ul> +<li class="toctree-l1"><a class="reference internal" href="../../user_guide/10_overview.html">Overview</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../user_guide/20_tutorials.html">Tutorials</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../user_guide/30_configs_in_depth.html">Configs in Depth</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../user_guide/40_outputs_in_depth.html">Outputs in Depth</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../user_guide/50_scenario_simulation.html">Simulator</a></li> +</ul> +<p class="caption"><span class="caption-text">Advanced topics</span></p> +<ul> +<li class="toctree-l1"><a class="reference internal" href="../../advanced_topics/20_simulator_advanced.html">Simulator</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../advanced_topics/30_testing.html">EndToEnd Test Framework</a></li> +</ul> +<p class="caption"><span class="caption-text">Developer Information</span></p> +<ul> +<li class="toctree-l1"><a class="reference internal" href="../../developer_information/10_ide_support.html">IDE Support</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../developer_information/20_documentation.html">Documentation Concept</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../developer_information/30_coding_conventions.html">Coding Guidelines</a></li> +</ul> +<p class="caption"><span class="caption-text">Other Information</span></p> <ul class="current"> -<li class="toctree-l1"><a class="reference internal" href="../10_overview.html">Overview</a></li> -<li class="toctree-l1"><a class="reference internal" href="../20_tutorials.html">Tutorials</a></li> +<li class="toctree-l1"><a class="reference internal" href="../10_external_dependencies.html">External Dependencies</a></li> +<li class="toctree-l1"><a class="reference internal" href="../20_glossary.html">Glossary</a></li> <li class="toctree-l1 current"><a class="reference internal" href="../30_gui_plugins.html">GUI Plugins</a><ul class="current"> <li class="toctree-l2 current"><a class="current reference internal" href="#">Project</a><ul> <li class="toctree-l3"><a class="reference internal" href="#general">General</a></li> @@ -121,25 +140,7 @@ <li class="toctree-l2"><a class="reference internal" href="50_result_visualization.html">Result Visualization</a></li> </ul> </li> -<li class="toctree-l1"><a class="reference internal" href="../40_configs_in_depth.html">Configs in Depth</a></li> -<li class="toctree-l1"><a class="reference internal" href="../50_outputs_in_depth.html">Outputs in Depth</a></li> -<li class="toctree-l1"><a class="reference internal" href="../60_scenario_simulation.html">Simulator</a></li> -</ul> -<p class="caption"><span class="caption-text">Advanced topics</span></p> -<ul> -<li class="toctree-l1"><a class="reference internal" href="../../advanced_topics/20_simulator_advanced.html">Simulator</a></li> -<li class="toctree-l1"><a class="reference internal" href="../../advanced_topics/30_testing.html">EndToEnd Test Framework</a></li> -</ul> -<p class="caption"><span class="caption-text">Developer Information</span></p> -<ul> -<li class="toctree-l1"><a class="reference internal" href="../../developer_information/10_ide_support.html">IDE Support</a></li> -<li class="toctree-l1"><a class="reference internal" href="../../developer_information/20_documentation.html">Documentation Concept</a></li> -</ul> -<p class="caption"><span class="caption-text">Other Information</span></p> -<ul> -<li class="toctree-l1"><a class="reference internal" href="../../other_information/10_external_dependencies.html">External Dependencies</a></li> -<li class="toctree-l1"><a class="reference internal" href="../../other_information/20_glossary.html">Glossary</a></li> -<li class="toctree-l1"><a class="reference internal" href="../../other_information/30_license.html">License</a></li> +<li class="toctree-l1"><a class="reference internal" href="../40_license.html">License</a></li> </ul> @@ -196,7 +197,7 @@ <li class="wy-breadcrumbs-aside"> - <a href="../../_sources/user_guide/gui_user_guide/10_projects.rst.txt" rel="nofollow"> View page source</a> + <a href="../../_sources/other_information/gui_user_guide/10_projects.rst.txt" rel="nofollow"> View page source</a> </li> @@ -211,6 +212,12 @@ <div class="section" id="project"> <span id="id1"></span><h1>Project<a class="headerlink" href="#project" title="Permalink to this headline">¶</a></h1> +<blockquote> +<div><ul class="simple"> +<li><p>The deprecated “Qt GUI” for simulation configuration based on Qt mainly aimed to edit PCM-based openPASS experiments was part of minor releases v0.5 – v0.11.</p></li> +<li><p>The latest version of this deprecated GUI can be found here: <a class="reference external" href="https://ci.eclipse.org/openpass/job/openPASS_simulator_build/view/tags/job/openPASS_0.11/">https://ci.eclipse.org/openpass/job/openPASS_simulator_build/view/tags/job/openPASS_0.11/</a></p></li> +</ul> +</div></blockquote> <p>The Project Plugin can be used to simply start a simulation from the gui.</p> <img alt="../../_images/overview.png" src="../../_images/overview.png" /> <p>Before the simulation adjustments begin, the user is obligated to load or create a “Simulation Manager Configuration” (<cite>opSimulationManager.xml</cite>). @@ -226,8 +233,8 @@ <img alt="../../_images/pathSettings.png" src="../../_images/pathSettings.png" /> <p>The next step is path settings. These will change depending on where your openPASS.exe is located. -In the screen shot above the openPASS.exe is located at <code class="docutils literal notranslate"><span class="pre">C:/OpenPASS</span></code>. -For easier use of this tutorial it is recommended to save the Demo Folder in <code class="docutils literal notranslate"><span class="pre">C:/</span></code> and name it <em>OpenPASS</em>. +In the screen shot above the openPASS.exe is located at <code class="docutils literal notranslate"><span class="pre">C:openPASS</span></code>. +For easier use of this tutorial it is recommended to save the Demo Folder in <code class="docutils literal notranslate"><span class="pre">C:/</span></code> and name it <em>openPASS</em>. On to the settings. As you can see three paths need to be set. The library comes with openPASS. @@ -235,7 +242,7 @@ The Simulation Path references the opSimulation.exe, the file to execute the simulation. If you are using the provided Demo, there is no need for you to change it. The only path you need to set is the path of the Configuration Files. -In the Demo it will be located at <code class="docutils literal notranslate"><span class="pre">[directory</span> <span class="pre">of</span> <span class="pre">openPASS.exe]/configs</span></code>, so in this case it would be <code class="docutils literal notranslate"><span class="pre">C:/OpenPASS/configs</span></code>.</p> +In the Demo it will be located at <code class="docutils literal notranslate"><span class="pre">[directory</span> <span class="pre">of</span> <span class="pre">openPASS.exe]/configs</span></code>, so in this case it would be <code class="docutils literal notranslate"><span class="pre">C:/openPASS/configs</span></code>.</p> </div> <div class="section" id="simulation-output-settings"> <h2>Simulation Output Settings<a class="headerlink" href="#simulation-output-settings" title="Permalink to this headline">¶</a></h2> @@ -248,7 +255,7 @@ The results path specifies the folder in which the results of a successful simulation will be saved.</p> <div class="admonition note"> <p class="admonition-title">Note</p> -<p>It is recommended to create a new folder in C:/OpenPASS called “results” and set it as the results path as in the picture above.</p> +<p>It is recommended to create a new folder in C:/openPASS called “results” and set it as the results path as in the picture above.</p> </div> </div> </div> @@ -267,7 +274,7 @@ <div role="contentinfo"> <p> - © Copyright 2023 OpenPASS Working Group. + © Copyright 2023 openPASS Working Group. </p> </div>
diff --git a/content/html/user_guide/gui_user_guide/20_system_editor.html b/content/html/other_information/gui_user_guide/20_system_editor.html similarity index 84% rename from content/html/user_guide/gui_user_guide/20_system_editor.html rename to content/html/other_information/gui_user_guide/20_system_editor.html index 73f9e13..693f8f4 100644 --- a/content/html/user_guide/gui_user_guide/20_system_editor.html +++ b/content/html/other_information/gui_user_guide/20_system_editor.html
@@ -7,7 +7,7 @@ <meta name="viewport" content="width=device-width, initial-scale=1.0" /> - <title>System Editor — OpenPASS Documentation</title> + <title>System Editor — openPASS Documentation</title> @@ -70,7 +70,7 @@ <div class="version"> - "openPASS v0.11" + "develop_4d7f6d4f2e22c286789082dd8cbe3eb7f5b5af62" </div> @@ -100,25 +100,17 @@ <li class="toctree-l1"><a class="reference internal" href="../../installation_guide/10_getting_started.html">Getting Started</a></li> <li class="toctree-l1"><a class="reference internal" href="../../installation_guide/15_system_requirements.html">System Requirements</a></li> <li class="toctree-l1"><a class="reference internal" href="../../installation_guide/20_install_prerequisites.html">Installing Prerequisites</a></li> -<li class="toctree-l1"><a class="reference internal" href="../../installation_guide/30_install_openpass.html">Installing OpenPASS</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../installation_guide/30_install_openpass.html">Installing openPASS</a></li> <li class="toctree-l1"><a class="reference internal" href="../../installation_guide/50_further_guidance.html">Further Guidance</a></li> <li class="toctree-l1"><a class="reference internal" href="../../installation_guide/60_conan.html">Building with Conan</a></li> </ul> <p class="caption"><span class="caption-text">User Guides</span></p> -<ul class="current"> -<li class="toctree-l1"><a class="reference internal" href="../10_overview.html">Overview</a></li> -<li class="toctree-l1"><a class="reference internal" href="../20_tutorials.html">Tutorials</a></li> -<li class="toctree-l1 current"><a class="reference internal" href="../30_gui_plugins.html">GUI Plugins</a><ul class="current"> -<li class="toctree-l2"><a class="reference internal" href="10_projects.html">Project</a></li> -<li class="toctree-l2 current"><a class="current reference internal" href="#">System Editor</a></li> -<li class="toctree-l2"><a class="reference internal" href="30_pcm_sim.html">PCM Simulation</a></li> -<li class="toctree-l2"><a class="reference internal" href="40_pcm_eval.html">PCM Evaluation</a></li> -<li class="toctree-l2"><a class="reference internal" href="50_result_visualization.html">Result Visualization</a></li> -</ul> -</li> -<li class="toctree-l1"><a class="reference internal" href="../40_configs_in_depth.html">Configs in Depth</a></li> -<li class="toctree-l1"><a class="reference internal" href="../50_outputs_in_depth.html">Outputs in Depth</a></li> -<li class="toctree-l1"><a class="reference internal" href="../60_scenario_simulation.html">Simulator</a></li> +<ul> +<li class="toctree-l1"><a class="reference internal" href="../../user_guide/10_overview.html">Overview</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../user_guide/20_tutorials.html">Tutorials</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../user_guide/30_configs_in_depth.html">Configs in Depth</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../user_guide/40_outputs_in_depth.html">Outputs in Depth</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../user_guide/50_scenario_simulation.html">Simulator</a></li> </ul> <p class="caption"><span class="caption-text">Advanced topics</span></p> <ul> @@ -129,12 +121,21 @@ <ul> <li class="toctree-l1"><a class="reference internal" href="../../developer_information/10_ide_support.html">IDE Support</a></li> <li class="toctree-l1"><a class="reference internal" href="../../developer_information/20_documentation.html">Documentation Concept</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../developer_information/30_coding_conventions.html">Coding Guidelines</a></li> </ul> <p class="caption"><span class="caption-text">Other Information</span></p> -<ul> -<li class="toctree-l1"><a class="reference internal" href="../../other_information/10_external_dependencies.html">External Dependencies</a></li> -<li class="toctree-l1"><a class="reference internal" href="../../other_information/20_glossary.html">Glossary</a></li> -<li class="toctree-l1"><a class="reference internal" href="../../other_information/30_license.html">License</a></li> +<ul class="current"> +<li class="toctree-l1"><a class="reference internal" href="../10_external_dependencies.html">External Dependencies</a></li> +<li class="toctree-l1"><a class="reference internal" href="../20_glossary.html">Glossary</a></li> +<li class="toctree-l1 current"><a class="reference internal" href="../30_gui_plugins.html">GUI Plugins</a><ul class="current"> +<li class="toctree-l2"><a class="reference internal" href="10_projects.html">Project</a></li> +<li class="toctree-l2 current"><a class="current reference internal" href="#">System Editor</a></li> +<li class="toctree-l2"><a class="reference internal" href="30_pcm_sim.html">PCM Simulation</a></li> +<li class="toctree-l2"><a class="reference internal" href="40_pcm_eval.html">PCM Evaluation</a></li> +<li class="toctree-l2"><a class="reference internal" href="50_result_visualization.html">Result Visualization</a></li> +</ul> +</li> +<li class="toctree-l1"><a class="reference internal" href="../40_license.html">License</a></li> </ul> @@ -191,7 +192,7 @@ <li class="wy-breadcrumbs-aside"> - <a href="../../_sources/user_guide/gui_user_guide/20_system_editor.rst.txt" rel="nofollow"> View page source</a> + <a href="../../_sources/other_information/gui_user_guide/20_system_editor.rst.txt" rel="nofollow"> View page source</a> </li> @@ -206,6 +207,12 @@ <div class="section" id="system-editor"> <span id="id1"></span><h1>System Editor<a class="headerlink" href="#system-editor" title="Permalink to this headline">¶</a></h1> +<blockquote> +<div><ul class="simple"> +<li><p>The deprecated “Qt GUI” for simulation configuration based on Qt mainly aimed to edit PCM-based openPASS experiments was part of minor releases v0.5 – v0.11.</p></li> +<li><p>The latest version of this deprecated GUI can be found here: <a class="reference external" href="https://ci.eclipse.org/openpass/job/openPASS_simulator_build/view/tags/job/openPASS_0.11/">https://ci.eclipse.org/openpass/job/openPASS_simulator_build/view/tags/job/openPASS_0.11/</a></p></li> +</ul> +</div></blockquote> <p>The System Editor helps building the system configuration (systemConfig) in the GUI. This file is also a XML-file and specifies the components of an agent and systems used, in this case advanced driver assistance systems.</p> <p>The editing of the System Configuration has two modes: the static and dynamic mode.</p> @@ -231,7 +238,7 @@ <div role="contentinfo"> <p> - © Copyright 2023 OpenPASS Working Group. + © Copyright 2023 openPASS Working Group. </p> </div>
diff --git a/content/html/user_guide/gui_user_guide/30_pcm_sim.html b/content/html/other_information/gui_user_guide/30_pcm_sim.html similarity index 91% rename from content/html/user_guide/gui_user_guide/30_pcm_sim.html rename to content/html/other_information/gui_user_guide/30_pcm_sim.html index a3f0b9f..851af08 100644 --- a/content/html/user_guide/gui_user_guide/30_pcm_sim.html +++ b/content/html/other_information/gui_user_guide/30_pcm_sim.html
@@ -7,7 +7,7 @@ <meta name="viewport" content="width=device-width, initial-scale=1.0" /> - <title>PCM Simulation — OpenPASS Documentation</title> + <title>PCM Simulation — openPASS Documentation</title> @@ -70,7 +70,7 @@ <div class="version"> - "openPASS v0.11" + "develop_4d7f6d4f2e22c286789082dd8cbe3eb7f5b5af62" </div> @@ -100,14 +100,33 @@ <li class="toctree-l1"><a class="reference internal" href="../../installation_guide/10_getting_started.html">Getting Started</a></li> <li class="toctree-l1"><a class="reference internal" href="../../installation_guide/15_system_requirements.html">System Requirements</a></li> <li class="toctree-l1"><a class="reference internal" href="../../installation_guide/20_install_prerequisites.html">Installing Prerequisites</a></li> -<li class="toctree-l1"><a class="reference internal" href="../../installation_guide/30_install_openpass.html">Installing OpenPASS</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../installation_guide/30_install_openpass.html">Installing openPASS</a></li> <li class="toctree-l1"><a class="reference internal" href="../../installation_guide/50_further_guidance.html">Further Guidance</a></li> <li class="toctree-l1"><a class="reference internal" href="../../installation_guide/60_conan.html">Building with Conan</a></li> </ul> <p class="caption"><span class="caption-text">User Guides</span></p> +<ul> +<li class="toctree-l1"><a class="reference internal" href="../../user_guide/10_overview.html">Overview</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../user_guide/20_tutorials.html">Tutorials</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../user_guide/30_configs_in_depth.html">Configs in Depth</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../user_guide/40_outputs_in_depth.html">Outputs in Depth</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../user_guide/50_scenario_simulation.html">Simulator</a></li> +</ul> +<p class="caption"><span class="caption-text">Advanced topics</span></p> +<ul> +<li class="toctree-l1"><a class="reference internal" href="../../advanced_topics/20_simulator_advanced.html">Simulator</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../advanced_topics/30_testing.html">EndToEnd Test Framework</a></li> +</ul> +<p class="caption"><span class="caption-text">Developer Information</span></p> +<ul> +<li class="toctree-l1"><a class="reference internal" href="../../developer_information/10_ide_support.html">IDE Support</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../developer_information/20_documentation.html">Documentation Concept</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../developer_information/30_coding_conventions.html">Coding Guidelines</a></li> +</ul> +<p class="caption"><span class="caption-text">Other Information</span></p> <ul class="current"> -<li class="toctree-l1"><a class="reference internal" href="../10_overview.html">Overview</a></li> -<li class="toctree-l1"><a class="reference internal" href="../20_tutorials.html">Tutorials</a></li> +<li class="toctree-l1"><a class="reference internal" href="../10_external_dependencies.html">External Dependencies</a></li> +<li class="toctree-l1"><a class="reference internal" href="../20_glossary.html">Glossary</a></li> <li class="toctree-l1 current"><a class="reference internal" href="../30_gui_plugins.html">GUI Plugins</a><ul class="current"> <li class="toctree-l2"><a class="reference internal" href="10_projects.html">Project</a></li> <li class="toctree-l2"><a class="reference internal" href="20_system_editor.html">System Editor</a></li> @@ -125,25 +144,7 @@ <li class="toctree-l2"><a class="reference internal" href="50_result_visualization.html">Result Visualization</a></li> </ul> </li> -<li class="toctree-l1"><a class="reference internal" href="../40_configs_in_depth.html">Configs in Depth</a></li> -<li class="toctree-l1"><a class="reference internal" href="../50_outputs_in_depth.html">Outputs in Depth</a></li> -<li class="toctree-l1"><a class="reference internal" href="../60_scenario_simulation.html">Simulator</a></li> -</ul> -<p class="caption"><span class="caption-text">Advanced topics</span></p> -<ul> -<li class="toctree-l1"><a class="reference internal" href="../../advanced_topics/20_simulator_advanced.html">Simulator</a></li> -<li class="toctree-l1"><a class="reference internal" href="../../advanced_topics/30_testing.html">EndToEnd Test Framework</a></li> -</ul> -<p class="caption"><span class="caption-text">Developer Information</span></p> -<ul> -<li class="toctree-l1"><a class="reference internal" href="../../developer_information/10_ide_support.html">IDE Support</a></li> -<li class="toctree-l1"><a class="reference internal" href="../../developer_information/20_documentation.html">Documentation Concept</a></li> -</ul> -<p class="caption"><span class="caption-text">Other Information</span></p> -<ul> -<li class="toctree-l1"><a class="reference internal" href="../../other_information/10_external_dependencies.html">External Dependencies</a></li> -<li class="toctree-l1"><a class="reference internal" href="../../other_information/20_glossary.html">Glossary</a></li> -<li class="toctree-l1"><a class="reference internal" href="../../other_information/30_license.html">License</a></li> +<li class="toctree-l1"><a class="reference internal" href="../40_license.html">License</a></li> </ul> @@ -200,7 +201,7 @@ <li class="wy-breadcrumbs-aside"> - <a href="../../_sources/user_guide/gui_user_guide/30_pcm_sim.rst.txt" rel="nofollow"> View page source</a> + <a href="../../_sources/other_information/gui_user_guide/30_pcm_sim.rst.txt" rel="nofollow"> View page source</a> </li> @@ -215,6 +216,12 @@ <div class="section" id="pcm-simulation"> <span id="pcm-sim"></span><h1>PCM Simulation<a class="headerlink" href="#pcm-simulation" title="Permalink to this headline">¶</a></h1> +<blockquote> +<div><ul class="simple"> +<li><p>The deprecated “Qt GUI” for simulation configuration based on Qt mainly aimed to edit PCM-based openPASS experiments was part of minor releases v0.5 – v0.11.</p></li> +<li><p>The latest version of this deprecated GUI can be found here: <a class="reference external" href="https://ci.eclipse.org/openpass/job/openPASS_simulator_build/view/tags/job/openPASS_0.11/">https://ci.eclipse.org/openpass/job/openPASS_simulator_build/view/tags/job/openPASS_0.11/</a></p></li> +</ul> +</div></blockquote> <p>This plugin is used to configure and start a simulation based pcm data or simulation configuration sets of previous simulations.</p> <div class="section" id="simulation-input"> <h2>Simulation Input<a class="headerlink" href="#simulation-input" title="Permalink to this headline">¶</a></h2> @@ -379,7 +386,7 @@ <div role="contentinfo"> <p> - © Copyright 2023 OpenPASS Working Group. + © Copyright 2023 openPASS Working Group. </p> </div>
diff --git a/content/html/user_guide/gui_user_guide/40_pcm_eval.html b/content/html/other_information/gui_user_guide/40_pcm_eval.html similarity index 85% rename from content/html/user_guide/gui_user_guide/40_pcm_eval.html rename to content/html/other_information/gui_user_guide/40_pcm_eval.html index fab1770..c620892 100644 --- a/content/html/user_guide/gui_user_guide/40_pcm_eval.html +++ b/content/html/other_information/gui_user_guide/40_pcm_eval.html
@@ -7,7 +7,7 @@ <meta name="viewport" content="width=device-width, initial-scale=1.0" /> - <title>PCM Evaluation — OpenPASS Documentation</title> + <title>PCM Evaluation — openPASS Documentation</title> @@ -70,7 +70,7 @@ <div class="version"> - "openPASS v0.11" + "develop_4d7f6d4f2e22c286789082dd8cbe3eb7f5b5af62" </div> @@ -100,14 +100,33 @@ <li class="toctree-l1"><a class="reference internal" href="../../installation_guide/10_getting_started.html">Getting Started</a></li> <li class="toctree-l1"><a class="reference internal" href="../../installation_guide/15_system_requirements.html">System Requirements</a></li> <li class="toctree-l1"><a class="reference internal" href="../../installation_guide/20_install_prerequisites.html">Installing Prerequisites</a></li> -<li class="toctree-l1"><a class="reference internal" href="../../installation_guide/30_install_openpass.html">Installing OpenPASS</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../installation_guide/30_install_openpass.html">Installing openPASS</a></li> <li class="toctree-l1"><a class="reference internal" href="../../installation_guide/50_further_guidance.html">Further Guidance</a></li> <li class="toctree-l1"><a class="reference internal" href="../../installation_guide/60_conan.html">Building with Conan</a></li> </ul> <p class="caption"><span class="caption-text">User Guides</span></p> +<ul> +<li class="toctree-l1"><a class="reference internal" href="../../user_guide/10_overview.html">Overview</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../user_guide/20_tutorials.html">Tutorials</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../user_guide/30_configs_in_depth.html">Configs in Depth</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../user_guide/40_outputs_in_depth.html">Outputs in Depth</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../user_guide/50_scenario_simulation.html">Simulator</a></li> +</ul> +<p class="caption"><span class="caption-text">Advanced topics</span></p> +<ul> +<li class="toctree-l1"><a class="reference internal" href="../../advanced_topics/20_simulator_advanced.html">Simulator</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../advanced_topics/30_testing.html">EndToEnd Test Framework</a></li> +</ul> +<p class="caption"><span class="caption-text">Developer Information</span></p> +<ul> +<li class="toctree-l1"><a class="reference internal" href="../../developer_information/10_ide_support.html">IDE Support</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../developer_information/20_documentation.html">Documentation Concept</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../developer_information/30_coding_conventions.html">Coding Guidelines</a></li> +</ul> +<p class="caption"><span class="caption-text">Other Information</span></p> <ul class="current"> -<li class="toctree-l1"><a class="reference internal" href="../10_overview.html">Overview</a></li> -<li class="toctree-l1"><a class="reference internal" href="../20_tutorials.html">Tutorials</a></li> +<li class="toctree-l1"><a class="reference internal" href="../10_external_dependencies.html">External Dependencies</a></li> +<li class="toctree-l1"><a class="reference internal" href="../20_glossary.html">Glossary</a></li> <li class="toctree-l1 current"><a class="reference internal" href="../30_gui_plugins.html">GUI Plugins</a><ul class="current"> <li class="toctree-l2"><a class="reference internal" href="10_projects.html">Project</a></li> <li class="toctree-l2"><a class="reference internal" href="20_system_editor.html">System Editor</a></li> @@ -120,25 +139,7 @@ <li class="toctree-l2"><a class="reference internal" href="50_result_visualization.html">Result Visualization</a></li> </ul> </li> -<li class="toctree-l1"><a class="reference internal" href="../40_configs_in_depth.html">Configs in Depth</a></li> -<li class="toctree-l1"><a class="reference internal" href="../50_outputs_in_depth.html">Outputs in Depth</a></li> -<li class="toctree-l1"><a class="reference internal" href="../60_scenario_simulation.html">Simulator</a></li> -</ul> -<p class="caption"><span class="caption-text">Advanced topics</span></p> -<ul> -<li class="toctree-l1"><a class="reference internal" href="../../advanced_topics/20_simulator_advanced.html">Simulator</a></li> -<li class="toctree-l1"><a class="reference internal" href="../../advanced_topics/30_testing.html">EndToEnd Test Framework</a></li> -</ul> -<p class="caption"><span class="caption-text">Developer Information</span></p> -<ul> -<li class="toctree-l1"><a class="reference internal" href="../../developer_information/10_ide_support.html">IDE Support</a></li> -<li class="toctree-l1"><a class="reference internal" href="../../developer_information/20_documentation.html">Documentation Concept</a></li> -</ul> -<p class="caption"><span class="caption-text">Other Information</span></p> -<ul> -<li class="toctree-l1"><a class="reference internal" href="../../other_information/10_external_dependencies.html">External Dependencies</a></li> -<li class="toctree-l1"><a class="reference internal" href="../../other_information/20_glossary.html">Glossary</a></li> -<li class="toctree-l1"><a class="reference internal" href="../../other_information/30_license.html">License</a></li> +<li class="toctree-l1"><a class="reference internal" href="../40_license.html">License</a></li> </ul> @@ -195,7 +196,7 @@ <li class="wy-breadcrumbs-aside"> - <a href="../../_sources/user_guide/gui_user_guide/40_pcm_eval.rst.txt" rel="nofollow"> View page source</a> + <a href="../../_sources/other_information/gui_user_guide/40_pcm_eval.rst.txt" rel="nofollow"> View page source</a> </li> @@ -210,6 +211,12 @@ <div class="section" id="pcm-evaluation"> <span id="pcm-eval"></span><h1>PCM Evaluation<a class="headerlink" href="#pcm-evaluation" title="Permalink to this headline">¶</a></h1> +<blockquote> +<div><ul class="simple"> +<li><p>The deprecated “Qt GUI” for simulation configuration based on Qt mainly aimed to edit PCM-based openPASS experiments was part of minor releases v0.5 – v0.11.</p></li> +<li><p>The latest version of this deprecated GUI can be found here: <a class="reference external" href="https://ci.eclipse.org/openpass/job/openPASS_simulator_build/view/tags/job/openPASS_0.11/">https://ci.eclipse.org/openpass/job/openPASS_simulator_build/view/tags/job/openPASS_0.11/</a></p></li> +</ul> +</div></blockquote> <p>This plugin is used to load results of previous simulations.</p> <div class="section" id="loading-results"> <h2>Loading Results<a class="headerlink" href="#loading-results" title="Permalink to this headline">¶</a></h2> @@ -251,7 +258,7 @@ <div role="contentinfo"> <p> - © Copyright 2023 OpenPASS Working Group. + © Copyright 2023 openPASS Working Group. </p> </div>
diff --git a/content/html/user_guide/gui_user_guide/50_result_visualization.html b/content/html/other_information/gui_user_guide/50_result_visualization.html similarity index 83% rename from content/html/user_guide/gui_user_guide/50_result_visualization.html rename to content/html/other_information/gui_user_guide/50_result_visualization.html index 476c033..91df0fd 100644 --- a/content/html/user_guide/gui_user_guide/50_result_visualization.html +++ b/content/html/other_information/gui_user_guide/50_result_visualization.html
@@ -7,7 +7,7 @@ <meta name="viewport" content="width=device-width, initial-scale=1.0" /> - <title>Result Visualization — OpenPASS Documentation</title> + <title>Result Visualization — openPASS Documentation</title> @@ -70,7 +70,7 @@ <div class="version"> - "openPASS v0.11" + "develop_4d7f6d4f2e22c286789082dd8cbe3eb7f5b5af62" </div> @@ -100,14 +100,33 @@ <li class="toctree-l1"><a class="reference internal" href="../../installation_guide/10_getting_started.html">Getting Started</a></li> <li class="toctree-l1"><a class="reference internal" href="../../installation_guide/15_system_requirements.html">System Requirements</a></li> <li class="toctree-l1"><a class="reference internal" href="../../installation_guide/20_install_prerequisites.html">Installing Prerequisites</a></li> -<li class="toctree-l1"><a class="reference internal" href="../../installation_guide/30_install_openpass.html">Installing OpenPASS</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../installation_guide/30_install_openpass.html">Installing openPASS</a></li> <li class="toctree-l1"><a class="reference internal" href="../../installation_guide/50_further_guidance.html">Further Guidance</a></li> <li class="toctree-l1"><a class="reference internal" href="../../installation_guide/60_conan.html">Building with Conan</a></li> </ul> <p class="caption"><span class="caption-text">User Guides</span></p> +<ul> +<li class="toctree-l1"><a class="reference internal" href="../../user_guide/10_overview.html">Overview</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../user_guide/20_tutorials.html">Tutorials</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../user_guide/30_configs_in_depth.html">Configs in Depth</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../user_guide/40_outputs_in_depth.html">Outputs in Depth</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../user_guide/50_scenario_simulation.html">Simulator</a></li> +</ul> +<p class="caption"><span class="caption-text">Advanced topics</span></p> +<ul> +<li class="toctree-l1"><a class="reference internal" href="../../advanced_topics/20_simulator_advanced.html">Simulator</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../advanced_topics/30_testing.html">EndToEnd Test Framework</a></li> +</ul> +<p class="caption"><span class="caption-text">Developer Information</span></p> +<ul> +<li class="toctree-l1"><a class="reference internal" href="../../developer_information/10_ide_support.html">IDE Support</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../developer_information/20_documentation.html">Documentation Concept</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../developer_information/30_coding_conventions.html">Coding Guidelines</a></li> +</ul> +<p class="caption"><span class="caption-text">Other Information</span></p> <ul class="current"> -<li class="toctree-l1"><a class="reference internal" href="../10_overview.html">Overview</a></li> -<li class="toctree-l1"><a class="reference internal" href="../20_tutorials.html">Tutorials</a></li> +<li class="toctree-l1"><a class="reference internal" href="../10_external_dependencies.html">External Dependencies</a></li> +<li class="toctree-l1"><a class="reference internal" href="../20_glossary.html">Glossary</a></li> <li class="toctree-l1 current"><a class="reference internal" href="../30_gui_plugins.html">GUI Plugins</a><ul class="current"> <li class="toctree-l2"><a class="reference internal" href="10_projects.html">Project</a></li> <li class="toctree-l2"><a class="reference internal" href="20_system_editor.html">System Editor</a></li> @@ -120,25 +139,7 @@ </li> </ul> </li> -<li class="toctree-l1"><a class="reference internal" href="../40_configs_in_depth.html">Configs in Depth</a></li> -<li class="toctree-l1"><a class="reference internal" href="../50_outputs_in_depth.html">Outputs in Depth</a></li> -<li class="toctree-l1"><a class="reference internal" href="../60_scenario_simulation.html">Simulator</a></li> -</ul> -<p class="caption"><span class="caption-text">Advanced topics</span></p> -<ul> -<li class="toctree-l1"><a class="reference internal" href="../../advanced_topics/20_simulator_advanced.html">Simulator</a></li> -<li class="toctree-l1"><a class="reference internal" href="../../advanced_topics/30_testing.html">EndToEnd Test Framework</a></li> -</ul> -<p class="caption"><span class="caption-text">Developer Information</span></p> -<ul> -<li class="toctree-l1"><a class="reference internal" href="../../developer_information/10_ide_support.html">IDE Support</a></li> -<li class="toctree-l1"><a class="reference internal" href="../../developer_information/20_documentation.html">Documentation Concept</a></li> -</ul> -<p class="caption"><span class="caption-text">Other Information</span></p> -<ul> -<li class="toctree-l1"><a class="reference internal" href="../../other_information/10_external_dependencies.html">External Dependencies</a></li> -<li class="toctree-l1"><a class="reference internal" href="../../other_information/20_glossary.html">Glossary</a></li> -<li class="toctree-l1"><a class="reference internal" href="../../other_information/30_license.html">License</a></li> +<li class="toctree-l1"><a class="reference internal" href="../40_license.html">License</a></li> </ul> @@ -195,7 +196,7 @@ <li class="wy-breadcrumbs-aside"> - <a href="../../_sources/user_guide/gui_user_guide/50_result_visualization.rst.txt" rel="nofollow"> View page source</a> + <a href="../../_sources/other_information/gui_user_guide/50_result_visualization.rst.txt" rel="nofollow"> View page source</a> </li> @@ -210,6 +211,12 @@ <div class="section" id="result-visualization"> <span id="id1"></span><h1>Result Visualization<a class="headerlink" href="#result-visualization" title="Permalink to this headline">¶</a></h1> +<blockquote> +<div><ul class="simple"> +<li><p>The deprecated “Qt GUI” for simulation configuration based on Qt mainly aimed to edit PCM-based openPASS experiments was part of minor releases v0.5 – v0.11.</p></li> +<li><p>The latest version of this deprecated GUI can be found here: <a class="reference external" href="https://ci.eclipse.org/openpass/job/openPASS_simulator_build/view/tags/job/openPASS_0.11/">https://ci.eclipse.org/openpass/job/openPASS_simulator_build/view/tags/job/openPASS_0.11/</a></p></li> +</ul> +</div></blockquote> <img alt="../../_images/select2.png" src="../../_images/select2.png" /> <div class="toctree-wrapper compound"> <ul> @@ -233,7 +240,7 @@ <div role="contentinfo"> <p> - © Copyright 2023 OpenPASS Working Group. + © Copyright 2023 openPASS Working Group. </p> </div>
diff --git a/content/html/user_guide/gui_user_guide/result_visualization/10_statistics.html b/content/html/other_information/gui_user_guide/result_visualization/10_statistics.html similarity index 91% rename from content/html/user_guide/gui_user_guide/result_visualization/10_statistics.html rename to content/html/other_information/gui_user_guide/result_visualization/10_statistics.html index c6b1cf9..18f7550 100644 --- a/content/html/user_guide/gui_user_guide/result_visualization/10_statistics.html +++ b/content/html/other_information/gui_user_guide/result_visualization/10_statistics.html
@@ -7,7 +7,7 @@ <meta name="viewport" content="width=device-width, initial-scale=1.0" /> - <title>Statistics — OpenPASS Documentation</title> + <title>Statistics — openPASS Documentation</title> @@ -70,7 +70,7 @@ <div class="version"> - "openPASS v0.11" + "develop_4d7f6d4f2e22c286789082dd8cbe3eb7f5b5af62" </div> @@ -100,14 +100,33 @@ <li class="toctree-l1"><a class="reference internal" href="../../../installation_guide/10_getting_started.html">Getting Started</a></li> <li class="toctree-l1"><a class="reference internal" href="../../../installation_guide/15_system_requirements.html">System Requirements</a></li> <li class="toctree-l1"><a class="reference internal" href="../../../installation_guide/20_install_prerequisites.html">Installing Prerequisites</a></li> -<li class="toctree-l1"><a class="reference internal" href="../../../installation_guide/30_install_openpass.html">Installing OpenPASS</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../../installation_guide/30_install_openpass.html">Installing openPASS</a></li> <li class="toctree-l1"><a class="reference internal" href="../../../installation_guide/50_further_guidance.html">Further Guidance</a></li> <li class="toctree-l1"><a class="reference internal" href="../../../installation_guide/60_conan.html">Building with Conan</a></li> </ul> <p class="caption"><span class="caption-text">User Guides</span></p> +<ul> +<li class="toctree-l1"><a class="reference internal" href="../../../user_guide/10_overview.html">Overview</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../../user_guide/20_tutorials.html">Tutorials</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../../user_guide/30_configs_in_depth.html">Configs in Depth</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../../user_guide/40_outputs_in_depth.html">Outputs in Depth</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../../user_guide/50_scenario_simulation.html">Simulator</a></li> +</ul> +<p class="caption"><span class="caption-text">Advanced topics</span></p> +<ul> +<li class="toctree-l1"><a class="reference internal" href="../../../advanced_topics/20_simulator_advanced.html">Simulator</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../../advanced_topics/30_testing.html">EndToEnd Test Framework</a></li> +</ul> +<p class="caption"><span class="caption-text">Developer Information</span></p> +<ul> +<li class="toctree-l1"><a class="reference internal" href="../../../developer_information/10_ide_support.html">IDE Support</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../../developer_information/20_documentation.html">Documentation Concept</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../../developer_information/30_coding_conventions.html">Coding Guidelines</a></li> +</ul> +<p class="caption"><span class="caption-text">Other Information</span></p> <ul class="current"> -<li class="toctree-l1"><a class="reference internal" href="../../10_overview.html">Overview</a></li> -<li class="toctree-l1"><a class="reference internal" href="../../20_tutorials.html">Tutorials</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../10_external_dependencies.html">External Dependencies</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../20_glossary.html">Glossary</a></li> <li class="toctree-l1 current"><a class="reference internal" href="../../30_gui_plugins.html">GUI Plugins</a><ul class="current"> <li class="toctree-l2"><a class="reference internal" href="../10_projects.html">Project</a></li> <li class="toctree-l2"><a class="reference internal" href="../20_system_editor.html">System Editor</a></li> @@ -124,25 +143,7 @@ </li> </ul> </li> -<li class="toctree-l1"><a class="reference internal" href="../../40_configs_in_depth.html">Configs in Depth</a></li> -<li class="toctree-l1"><a class="reference internal" href="../../50_outputs_in_depth.html">Outputs in Depth</a></li> -<li class="toctree-l1"><a class="reference internal" href="../../60_scenario_simulation.html">Simulator</a></li> -</ul> -<p class="caption"><span class="caption-text">Advanced topics</span></p> -<ul> -<li class="toctree-l1"><a class="reference internal" href="../../../advanced_topics/20_simulator_advanced.html">Simulator</a></li> -<li class="toctree-l1"><a class="reference internal" href="../../../advanced_topics/30_testing.html">EndToEnd Test Framework</a></li> -</ul> -<p class="caption"><span class="caption-text">Developer Information</span></p> -<ul> -<li class="toctree-l1"><a class="reference internal" href="../../../developer_information/10_ide_support.html">IDE Support</a></li> -<li class="toctree-l1"><a class="reference internal" href="../../../developer_information/20_documentation.html">Documentation Concept</a></li> -</ul> -<p class="caption"><span class="caption-text">Other Information</span></p> -<ul> -<li class="toctree-l1"><a class="reference internal" href="../../../other_information/10_external_dependencies.html">External Dependencies</a></li> -<li class="toctree-l1"><a class="reference internal" href="../../../other_information/20_glossary.html">Glossary</a></li> -<li class="toctree-l1"><a class="reference internal" href="../../../other_information/30_license.html">License</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../40_license.html">License</a></li> </ul> @@ -201,7 +202,7 @@ <li class="wy-breadcrumbs-aside"> - <a href="../../../_sources/user_guide/gui_user_guide/result_visualization/10_statistics.rst.txt" rel="nofollow"> View page source</a> + <a href="../../../_sources/other_information/gui_user_guide/result_visualization/10_statistics.rst.txt" rel="nofollow"> View page source</a> </li> @@ -282,7 +283,7 @@ <div role="contentinfo"> <p> - © Copyright 2023 OpenPASS Working Group. + © Copyright 2023 openPASS Working Group. </p> </div>
diff --git a/content/html/user_guide/gui_user_guide/result_visualization/20_timePlot.html b/content/html/other_information/gui_user_guide/result_visualization/20_timePlot.html similarity index 89% rename from content/html/user_guide/gui_user_guide/result_visualization/20_timePlot.html rename to content/html/other_information/gui_user_guide/result_visualization/20_timePlot.html index e5045cc..205efb5 100644 --- a/content/html/user_guide/gui_user_guide/result_visualization/20_timePlot.html +++ b/content/html/other_information/gui_user_guide/result_visualization/20_timePlot.html
@@ -7,7 +7,7 @@ <meta name="viewport" content="width=device-width, initial-scale=1.0" /> - <title>TimePlot — OpenPASS Documentation</title> + <title>TimePlot — openPASS Documentation</title> @@ -42,7 +42,7 @@ <link rel="index" title="Index" href="../../../genindex.html" /> <link rel="search" title="Search" href="../../../search.html" /> - <link rel="next" title="Configs in Depth" href="../../40_configs_in_depth.html" /> + <link rel="next" title="License" href="../../40_license.html" /> <link rel="prev" title="Statistics" href="10_statistics.html" /> </head> @@ -70,7 +70,7 @@ <div class="version"> - "openPASS v0.11" + "develop_4d7f6d4f2e22c286789082dd8cbe3eb7f5b5af62" </div> @@ -100,14 +100,33 @@ <li class="toctree-l1"><a class="reference internal" href="../../../installation_guide/10_getting_started.html">Getting Started</a></li> <li class="toctree-l1"><a class="reference internal" href="../../../installation_guide/15_system_requirements.html">System Requirements</a></li> <li class="toctree-l1"><a class="reference internal" href="../../../installation_guide/20_install_prerequisites.html">Installing Prerequisites</a></li> -<li class="toctree-l1"><a class="reference internal" href="../../../installation_guide/30_install_openpass.html">Installing OpenPASS</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../../installation_guide/30_install_openpass.html">Installing openPASS</a></li> <li class="toctree-l1"><a class="reference internal" href="../../../installation_guide/50_further_guidance.html">Further Guidance</a></li> <li class="toctree-l1"><a class="reference internal" href="../../../installation_guide/60_conan.html">Building with Conan</a></li> </ul> <p class="caption"><span class="caption-text">User Guides</span></p> +<ul> +<li class="toctree-l1"><a class="reference internal" href="../../../user_guide/10_overview.html">Overview</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../../user_guide/20_tutorials.html">Tutorials</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../../user_guide/30_configs_in_depth.html">Configs in Depth</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../../user_guide/40_outputs_in_depth.html">Outputs in Depth</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../../user_guide/50_scenario_simulation.html">Simulator</a></li> +</ul> +<p class="caption"><span class="caption-text">Advanced topics</span></p> +<ul> +<li class="toctree-l1"><a class="reference internal" href="../../../advanced_topics/20_simulator_advanced.html">Simulator</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../../advanced_topics/30_testing.html">EndToEnd Test Framework</a></li> +</ul> +<p class="caption"><span class="caption-text">Developer Information</span></p> +<ul> +<li class="toctree-l1"><a class="reference internal" href="../../../developer_information/10_ide_support.html">IDE Support</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../../developer_information/20_documentation.html">Documentation Concept</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../../developer_information/30_coding_conventions.html">Coding Guidelines</a></li> +</ul> +<p class="caption"><span class="caption-text">Other Information</span></p> <ul class="current"> -<li class="toctree-l1"><a class="reference internal" href="../../10_overview.html">Overview</a></li> -<li class="toctree-l1"><a class="reference internal" href="../../20_tutorials.html">Tutorials</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../10_external_dependencies.html">External Dependencies</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../20_glossary.html">Glossary</a></li> <li class="toctree-l1 current"><a class="reference internal" href="../../30_gui_plugins.html">GUI Plugins</a><ul class="current"> <li class="toctree-l2"><a class="reference internal" href="../10_projects.html">Project</a></li> <li class="toctree-l2"><a class="reference internal" href="../20_system_editor.html">System Editor</a></li> @@ -124,25 +143,7 @@ </li> </ul> </li> -<li class="toctree-l1"><a class="reference internal" href="../../40_configs_in_depth.html">Configs in Depth</a></li> -<li class="toctree-l1"><a class="reference internal" href="../../50_outputs_in_depth.html">Outputs in Depth</a></li> -<li class="toctree-l1"><a class="reference internal" href="../../60_scenario_simulation.html">Simulator</a></li> -</ul> -<p class="caption"><span class="caption-text">Advanced topics</span></p> -<ul> -<li class="toctree-l1"><a class="reference internal" href="../../../advanced_topics/20_simulator_advanced.html">Simulator</a></li> -<li class="toctree-l1"><a class="reference internal" href="../../../advanced_topics/30_testing.html">EndToEnd Test Framework</a></li> -</ul> -<p class="caption"><span class="caption-text">Developer Information</span></p> -<ul> -<li class="toctree-l1"><a class="reference internal" href="../../../developer_information/10_ide_support.html">IDE Support</a></li> -<li class="toctree-l1"><a class="reference internal" href="../../../developer_information/20_documentation.html">Documentation Concept</a></li> -</ul> -<p class="caption"><span class="caption-text">Other Information</span></p> -<ul> -<li class="toctree-l1"><a class="reference internal" href="../../../other_information/10_external_dependencies.html">External Dependencies</a></li> -<li class="toctree-l1"><a class="reference internal" href="../../../other_information/20_glossary.html">Glossary</a></li> -<li class="toctree-l1"><a class="reference internal" href="../../../other_information/30_license.html">License</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../40_license.html">License</a></li> </ul> @@ -201,7 +202,7 @@ <li class="wy-breadcrumbs-aside"> - <a href="../../../_sources/user_guide/gui_user_guide/result_visualization/20_timePlot.rst.txt" rel="nofollow"> View page source</a> + <a href="../../../_sources/other_information/gui_user_guide/result_visualization/20_timePlot.rst.txt" rel="nofollow"> View page source</a> </li> @@ -265,7 +266,7 @@ </div> <footer> <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> - <a href="../../40_configs_in_depth.html" class="btn btn-neutral float-right" title="Configs in Depth" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a> + <a href="../../40_license.html" class="btn btn-neutral float-right" title="License" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a> <a href="10_statistics.html" class="btn btn-neutral float-left" title="Statistics" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a> </div> @@ -273,7 +274,7 @@ <div role="contentinfo"> <p> - © Copyright 2023 OpenPASS Working Group. + © Copyright 2023 openPASS Working Group. </p> </div>
diff --git a/content/html/search.html b/content/html/search.html index 2487421..0fee2a9 100644 --- a/content/html/search.html +++ b/content/html/search.html
@@ -7,7 +7,7 @@ <meta name="viewport" content="width=device-width, initial-scale=1.0" /> - <title>Search — OpenPASS Documentation</title> + <title>Search — openPASS Documentation</title> @@ -72,7 +72,7 @@ <div class="version"> - "openPASS v0.11" + "develop_4d7f6d4f2e22c286789082dd8cbe3eb7f5b5af62" </div> @@ -102,7 +102,7 @@ <li class="toctree-l1"><a class="reference internal" href="installation_guide/10_getting_started.html">Getting Started</a></li> <li class="toctree-l1"><a class="reference internal" href="installation_guide/15_system_requirements.html">System Requirements</a></li> <li class="toctree-l1"><a class="reference internal" href="installation_guide/20_install_prerequisites.html">Installing Prerequisites</a></li> -<li class="toctree-l1"><a class="reference internal" href="installation_guide/30_install_openpass.html">Installing OpenPASS</a></li> +<li class="toctree-l1"><a class="reference internal" href="installation_guide/30_install_openpass.html">Installing openPASS</a></li> <li class="toctree-l1"><a class="reference internal" href="installation_guide/50_further_guidance.html">Further Guidance</a></li> <li class="toctree-l1"><a class="reference internal" href="installation_guide/60_conan.html">Building with Conan</a></li> </ul> @@ -110,10 +110,9 @@ <ul> <li class="toctree-l1"><a class="reference internal" href="user_guide/10_overview.html">Overview</a></li> <li class="toctree-l1"><a class="reference internal" href="user_guide/20_tutorials.html">Tutorials</a></li> -<li class="toctree-l1"><a class="reference internal" href="user_guide/30_gui_plugins.html">GUI Plugins</a></li> -<li class="toctree-l1"><a class="reference internal" href="user_guide/40_configs_in_depth.html">Configs in Depth</a></li> -<li class="toctree-l1"><a class="reference internal" href="user_guide/50_outputs_in_depth.html">Outputs in Depth</a></li> -<li class="toctree-l1"><a class="reference internal" href="user_guide/60_scenario_simulation.html">Simulator</a></li> +<li class="toctree-l1"><a class="reference internal" href="user_guide/30_configs_in_depth.html">Configs in Depth</a></li> +<li class="toctree-l1"><a class="reference internal" href="user_guide/40_outputs_in_depth.html">Outputs in Depth</a></li> +<li class="toctree-l1"><a class="reference internal" href="user_guide/50_scenario_simulation.html">Simulator</a></li> </ul> <p class="caption"><span class="caption-text">Advanced topics</span></p> <ul> @@ -124,12 +123,14 @@ <ul> <li class="toctree-l1"><a class="reference internal" href="developer_information/10_ide_support.html">IDE Support</a></li> <li class="toctree-l1"><a class="reference internal" href="developer_information/20_documentation.html">Documentation Concept</a></li> +<li class="toctree-l1"><a class="reference internal" href="developer_information/30_coding_conventions.html">Coding Guidelines</a></li> </ul> <p class="caption"><span class="caption-text">Other Information</span></p> <ul> <li class="toctree-l1"><a class="reference internal" href="other_information/10_external_dependencies.html">External Dependencies</a></li> <li class="toctree-l1"><a class="reference internal" href="other_information/20_glossary.html">Glossary</a></li> -<li class="toctree-l1"><a class="reference internal" href="other_information/30_license.html">License</a></li> +<li class="toctree-l1"><a class="reference internal" href="other_information/30_gui_plugins.html">GUI Plugins</a></li> +<li class="toctree-l1"><a class="reference internal" href="other_information/40_license.html">License</a></li> </ul> @@ -215,7 +216,7 @@ <div role="contentinfo"> <p> - © Copyright 2023 OpenPASS Working Group. + © Copyright 2023 openPASS Working Group. </p> </div>
diff --git a/content/html/searchindex.js b/content/html/searchindex.js index d35ac28..23bbc81 100644 --- a/content/html/searchindex.js +++ b/content/html/searchindex.js
@@ -1 +1 @@ -Search.setIndex({docnames:["advanced_topics/20_simulator_advanced","advanced_topics/30_testing","advanced_topics/simulator/agent_components","advanced_topics/simulator/coordinate_systems","advanced_topics/simulator/event_detector","advanced_topics/simulator/simulation","advanced_topics/simulator/spawner_features","advanced_topics/simulator/world_osi","developer_information/10_ide_support","developer_information/20_documentation","developer_information/ide_support/20_qt_creator","developer_information/ide_support/30_vscode","index","installation_guide/10_getting_started","installation_guide/15_system_requirements","installation_guide/20_install_prerequisites","installation_guide/30_install_openpass","installation_guide/50_further_guidance","installation_guide/60_conan","installation_guide/further_guidance/10_cmake","other_information/10_external_dependencies","other_information/20_glossary","other_information/30_license","user_guide/10_overview","user_guide/20_tutorials","user_guide/30_gui_plugins","user_guide/40_configs_in_depth","user_guide/50_outputs_in_depth","user_guide/60_scenario_simulation","user_guide/configs/profilescatalog","user_guide/configs/scenario","user_guide/configs/scenery","user_guide/configs/simulationconfig","user_guide/configs/staticsystemconfig","user_guide/configs/systemconfigblueprint","user_guide/gui_user_guide/10_projects","user_guide/gui_user_guide/20_system_editor","user_guide/gui_user_guide/30_pcm_sim","user_guide/gui_user_guide/40_pcm_eval","user_guide/gui_user_guide/50_result_visualization","user_guide/gui_user_guide/result_visualization/10_statistics","user_guide/gui_user_guide/result_visualization/20_timePlot","user_guide/outputs/observation_log","user_guide/outputs/observation_repository","user_guide/sim_user_guide/10_overview","user_guide/sim_user_guide/20_components","user_guide/sim_user_guide/components/driver","user_guide/sim_user_guide/components/spawner","user_guide/sim_user_guide/components/vehicle","user_guide/tutorials/10_scenario_simulation","user_guide/tutorials/20_pcm_simulation"],envversion:{"sphinx.domains.c":2,"sphinx.domains.changeset":1,"sphinx.domains.citation":1,"sphinx.domains.cpp":3,"sphinx.domains.index":1,"sphinx.domains.javascript":2,"sphinx.domains.math":2,"sphinx.domains.python":2,"sphinx.domains.rst":2,"sphinx.domains.std":2,"sphinx.ext.todo":2,sphinx:56},filenames:["advanced_topics/20_simulator_advanced.rst","advanced_topics/30_testing.rst","advanced_topics/simulator/agent_components.rst","advanced_topics/simulator/coordinate_systems.rst","advanced_topics/simulator/event_detector.rst","advanced_topics/simulator/simulation.rst","advanced_topics/simulator/spawner_features.rst","advanced_topics/simulator/world_osi.rst","developer_information/10_ide_support.rst","developer_information/20_documentation.rst","developer_information/ide_support/20_qt_creator.rst","developer_information/ide_support/30_vscode.rst","index.rst","installation_guide/10_getting_started.rst","installation_guide/15_system_requirements.rst","installation_guide/20_install_prerequisites.rst","installation_guide/30_install_openpass.rst","installation_guide/50_further_guidance.rst","installation_guide/60_conan.rst","installation_guide/further_guidance/10_cmake.rst","other_information/10_external_dependencies.rst","other_information/20_glossary.rst","other_information/30_license.rst","user_guide/10_overview.rst","user_guide/20_tutorials.rst","user_guide/30_gui_plugins.rst","user_guide/40_configs_in_depth.rst","user_guide/50_outputs_in_depth.rst","user_guide/60_scenario_simulation.rst","user_guide/configs/profilescatalog.rst","user_guide/configs/scenario.rst","user_guide/configs/scenery.rst","user_guide/configs/simulationconfig.rst","user_guide/configs/staticsystemconfig.rst","user_guide/configs/systemconfigblueprint.rst","user_guide/gui_user_guide/10_projects.rst","user_guide/gui_user_guide/20_system_editor.rst","user_guide/gui_user_guide/30_pcm_sim.rst","user_guide/gui_user_guide/40_pcm_eval.rst","user_guide/gui_user_guide/50_result_visualization.rst","user_guide/gui_user_guide/result_visualization/10_statistics.rst","user_guide/gui_user_guide/result_visualization/20_timePlot.rst","user_guide/outputs/observation_log.rst","user_guide/outputs/observation_repository.rst","user_guide/sim_user_guide/10_overview.rst","user_guide/sim_user_guide/20_components.rst","user_guide/sim_user_guide/components/driver.rst","user_guide/sim_user_guide/components/spawner.rst","user_guide/sim_user_guide/components/vehicle.rst","user_guide/tutorials/10_scenario_simulation.rst","user_guide/tutorials/20_pcm_simulation.rst"],objects:{},objnames:{},objtypes:{},terms:{"000":[7,31],"0000000000000000e":31,"0002177":46,"001":[7,48],"0028500000000000066":31,"003":31,"011":7,"015":2,"100":[1,2,30,31,34,42],"1000":47,"10000":1,"100000":43,"100001":43,"100002":43,"100003":43,"100004":43,"100005":43,"100006":43,"100007":43,"100008":43,"100009":43,"100010":43,"1000208":37,"1004":7,"100m":7,"101":2,"102":2,"103":42,"10310u":14,"105":47,"10_quickstart":9,"110":30,"120":34,"12204699500415":31,"123":32,"125":32,"1350":2,"1415":30,"143":31,"1472558076":30,"148":[12,42],"149":[10,12,34],"150":[2,34],"15m":7,"180":[2,30],"1805":46,"1813":34,"1824":46,"183":31,"199":34,"1km":7,"1x3":1,"200":[34,42],"2000":46,"200000":43,"200001":43,"200002":43,"200003":43,"200004":43,"200005":43,"200006":43,"2007":31,"2009":7,"2009r1r2":7,"200m":7,"2015840166":30,"20200903":15,"2021":9,"2023":15,"20230404":15,"20230523":15,"204":42,"205":7,"206":7,"20_pcm_simul":12,"20_qt_creator":12,"20g":20,"20km":7,"2222222":29,"230":30,"250":[32,34],"255":19,"265":47,"267":7,"270":7,"274":7,"275":7,"276":7,"277":7,"278":7,"279":7,"280":7,"281":7,"282":7,"285":31,"2928":29,"293":7,"294":7,"299":34,"300":[32,42,48],"300m":7,"301":7,"306":7,"307":7,"3083973":30,"30km":7,"310":[7,34],"311":7,"325":7,"32bit":48,"330":[7,34],"333":7,"3333":29,"3350391612494":31,"350":[1,34],"351":34,"360":2,"398":34,"399":34,"3x1":1,"400":[32,34],"4000":31,"40612500000000096":31,"4280":31,"4285":31,"4422":31,"4468":31,"4476":31,"448":7,"449":7,"450":7,"475":47,"500":34,"5000":2,"500m":7,"5039":31,"50b":7,"50c":7,"50d":7,"5139":31,"531":7,"532725206":32,"570796326":30,"571":31,"620":14,"629710830536482":31,"6651848689908":31,"685":47,"694":31,"7188686309816":31,"7188686309819":31,"7453292519943295":31,"7777777":29,"800":1,"820":47,"8224":29,"88624436808436":31,"92972377559829977":31,"9323279193268":31,"9900":34,"999":[42,48],"abstract":21,"boolean":[2,48],"break":49,"case":[0,1,4,7,18,23,29,30,35,36,37,42,47,49],"class":[2,15],"default":[1,5,11,13,15,16,19,29,30,32,37,43,46,47,48,49],"enum":48,"export":15,"final":[2,5,7,15,23,47,48],"function":[0,5,7,11,15,20,21,23,48,49],"import":[9,15,18,19,23,29,34,48],"int":[2,29,48],"long":[1,2,19,23],"new":[2,5,10,23,34,35,37,40,47,49],"public":[9,22],"return":[7,30],"short":[15,16],"static":[2,15,23,26,29,31,34,36,48,49],"switch":2,"throw":48,"true":[1,2,6,7,11,15,29,30,31,42,47,48,49],"try":[1,30,46],"while":[2,10,18,20,29,30,46],AND:11,Adding:40,But:[11,29],FOR:11,For:[1,2,3,7,10,11,15,16,20,23,29,30,32,34,35,37,40,41,42,44,46,48],Has:48,IDE:[12,17],IDEs:[11,19],IDs:42,Ids:[4,7,30],Its:23,Not:[11,13],One:[2,47],Such:[23,30,35],That:23,The:[1,2,3,4,5,6,7,9,10,11,12,13,15,16,18,19,20,23,29,30,31,32,33,34,35,36,37,41,42,43,45,46,47,48,49],Then:[47,48],There:[4,7,18,19,20,29,30,35,45,46,48],These:[2,7,9,15,23,29,30,35,42,47,48],Use:[1,15,19,20],Used:[0,19,32,34],Will:[34,48],With:[18,23,34],Yes:29,_detectedag:[32,42],_persist:[32,43],_run_:[32,43],_static:9,_test:11,_visibleag:[32,42],abi:48,abl:[10,11,15,16,18,35,37,48],abort:31,about:[2,12,13,15,18,23,32,42,43,48,49],abov:[1,2,9,10,15,16,35,43,48],absolut:[3,5,9,30,46,48],absolutetargetlan:30,absolutetargetspe:30,absoultetargetspe:30,acceler:[2,3,30,34,46,48],accelerationego:[32,42,48],accelerationpedalposit:[32,42],accelerationpedalpositionego:48,accelerationsign:[2,34,48],accelerationsignal_acceler:48,accept:11,access:[4,15,48],accid:[21,23,42],accompani:[9,22],accomplish:1,accord:[2,3,7,11,16,23,29,30,31,46,48],accordingli:4,account:[4,6,37],accumul:6,accuraci:7,achiev:[1,2,7,15,29,30],acoust:48,acquireglobalposit:34,acquireposit:30,acquirepositionact:30,across:7,act1:30,act:[1,7,9,19,23,30,42,45,47,48],action:[2,23,34,35,36],action_longitudinaldriv:[0,34],action_secondarydriv:0,action_secondarydrivertask:34,actionlongitudinaldriv:34,actionlongitudinaldrivermodul:34,actionprimari:34,actionsecondarydrivertask:34,actionsecondarydrivertasksmodul:34,activ:[1,2,12,19,20,21,23,30,42,46,47,48,49],actual:[2,7,19,23,30,46],ada:[2,3,21,23,29,34],adapt:[11,46],adasstatesign:2,add:[1,3,9,10,11,15,18,19,29,30,31,32,40],add_custom_target:9,added:[11,15,30,40,48],adding:[18,32],addit:[1,7,9,10,11,15,19,29,30,31,37,42,45,48],addition:[23,25,29,37],additional_make_clean_fil:9,adher:[7,30],adjust:[10,11,15,16,19,30,34,35,49],advanc:[21,23,36],advancedexecut:11,aeb1:48,aeb:[21,29,34,45,49],aeb_cutin:49,aebprofil:29,affect:[1,2,30,42],affectedent:[1,42],aforement:[30,44],aforment:5,after:[1,2,4,5,7,10,11,15,18,19,30,35,37,47,48,49],afterward:[5,7,47,48],again:[16,23,45],against:16,agent:[0,1,5,7,21,23,29,32,33,34,36,37,46,47,48,49],agentconfigur:25,agentfollowingdriv:29,agentid:1,agentinfront:[30,32,42],agentinterfac:[2,48],agentnetwork:42,agentprofil:[34,47],agenttyp:1,agenttypegroupnam:[1,42],agenttypenam:[1,42],agentupdat:[0,34],aggreg:[1,2,7],ahigh:21,aim:7,air:[2,46],aka:7,algebra:7,algorithm:[2,7,34,36],algorithm_fmuwrapp:[19,20],algorithm_later:[0,34],algorithm_lateralafdm:46,algorithm_lateralvehicleafdm:34,algorithm_longitudin:0,algorithm_longitudinalafdm:[34,46],algorithm_longitudinalvehiclecompon:34,algorithm_steeringvehiclecompon:34,algorithmagentfollowingdrivermodel:[34,45],algorithmautonomousemergencybrak:34,algorithmcar2xsend:[0,34],algorithmfmuwrapp:34,algorithmlateraldriv:34,algorithmlateralmodul:46,algorithmlongitudin:2,algorithmlongitudinaldriv:34,algorithmlongitudinalmodul:46,algorithmlongitudinalvehiclecompon:34,align:7,all:[1,2,3,4,5,6,7,9,10,11,12,13,15,16,18,19,23,26,27,29,30,31,32,34,40,41,42,43,45,47,48,49],alloc:[15,19],allow:[1,2,7,9,11,21,29,30,34,48],almost:7,alon:12,along:[1,2,3,7,14,30,48],alongrout:30,alreadi:[15,20],also:[1,2,3,6,7,9,10,11,12,15,16,17,18,20,23,29,30,34,36,42,43,46,47,48,49],alter:30,altern:[11,33],although:[30,35,48],alwai:[2,7,30,46,48],among:[11,48],analysi:[1,6,19],angl:[2,4,30,36,37,42,46,48],ani:[2,5,7,9,18,19,23,29,30,35,47,48,49],announcehighwayexit:7,announceleftlaneend:7,announcerightlaneend:7,anoth:[9,11,18,29,30,49],another_kei:32,anotherprofil:29,ansgar:46,anymor:[20,37],anywher:34,api:[19,20],append:[9,18],appendix:7,appli:[1,5,15,16,30,34,47],applic:[12,14,21,42,48],approach:[19,46],appropi:15,appropri:47,approxim:[1,2,46],apt:[15,18],arbitrari:[1,6,30,48],arc:[7,31],architectur:[14,34,48],area:[2,38,47],areal:2,arena:[15,19],arg:[1,11,16,19],argument:[0,1,18,32],aris:47,arm:[2,48],around:[2,19,23,30,49],arrow:7,artifact:1,arxiv:46,asam:[23,30,31],ascii:9,ask:11,ass:23,assess:[12,21],assign:[2,7,30,34,48],assignrouteact:30,assist:[2,21,23,29,36],associ:[1,23],assum:[2,15,16,19,32],attempt:47,attribut:[7,29,30,31,32,34,42,43,48],audienc:26,augment:47,author:48,autom:21,automat:[1,6,11,19],automaticdeactiv:48,autonom:[21,48,49],avail:[1,2,4,9,11,13,15,16,18,19,20,22,23,30,32,44,45,46,48,49],averag:12,avoid:[9,48],awar:[18,46],axi:[3,7,41,48],axl:[2,3,7],back:[2,3,16,19,47],backend:[15,20],background:[23,40,45],barrier:43,barrier_01:43,base:[1,2,5,7,11,12,15,16,19,20,21,23,24,30,32,34,37,43,44,47,48],bash:[11,15,16,21],basi:[15,49],basic:[0,2,6,11,13,18,32,42,48],basictrajectoryfollow:48,bast:7,bast_2017:7,bbox:2,beam:2,becaus:[7,10,30],becom:[1,9],been:[1,15,16,20,23,49],befor:[1,5,9,11,15,16,18,20,21,35,47,48],begin:[3,4,35],beginn:23,behav:[23,30],behavior:[1,30,42,46,47],behind:2,being:[1,6,9,15,23,42,46,47],belong:[30,42],below:[1,2,7,9,14,32,34,41,42,43,46,48],best:[2,19],better:[11,12,15,23,42],between:[0,1,2,5,6,7,11,12,20,23,30,32,34,36,42,46,47,48],beyond:[16,20],bicycl:30,bigger:2,bin:[1,11,15,16,19,49],binari:[1,18,48],bit:[0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31,32,33,34,35,36,37,38,39,40,41,42,43,44,45,46,47,48,49,50],blank:30,block:2,blue:[2,7],blueprint:23,bmw:29,bold:[7,19],bool:[29,32,42,47,48],boost:15,bootstrap:5,border:31,both:[2,6,7,9,18,23,30,31,43,47,48],bottom:11,bound:[2,4,7,30,32,42,47,48],boundari:[2,7,20,30,48],box:[4,7,11,30,42,48],brake:[2,21,36,46,48],brakelight:[32,42],brakepedalposit:[32,42],brakepedalpositionego:48,branch:[15,16],breath:15,breviti:11,bright:2,broadcast:2,broken:[7,31,43],brought:20,brows:38,buffer:[15,19,48],buggi:10,build:[8,10,12,13,14,16,20,21,36],buildkit:11,built:[1,11,15,16,19,20],bulb:42,bullsey:[14,15,18],bundl:23,bus:30,button:37,byentiti:1,byentitycondit:30,byvaluecondit:30,c99:11,c_cpp_properti:11,c_w:2,cach:[11,18,20],calcul:[2,3,4,7,12,20,21,30,37,40,42,46,47,48],calculatedparamet:48,call:[5,7,11,15,18,19,21,23,30,35,42,46,47,48,49],camera:[29,48],can:[1,2,4,5,7,9,11,12,15,16,18,19,20,21,23,29,30,31,32,34,35,37,40,41,42,45,46,47,48,49],cannot:[2,7,11],cap:6,capabl:[44,49],captur:7,car1:37,car1_index:37,car2:37,car2_index:37,car2xsend:2,car:[3,23,47],car_bmw_3:30,car_bmw_7:[29,42],car_bmw_7_1:30,car_bmw_7_2:30,car_bmw_i3:30,car_mini_coop:30,care:[2,48],carlo:44,carri:[1,7,23],cartesian:7,cast:2,catalog:23,catalogloc:30,catalognam:30,catalogrefer:30,categori:42,caus:[11,19],cc_enable_arena:15,ccach:[15,19],cdot:[2,46,48],center:[3,7,21,31,42,48],centimet:7,central:23,centric:20,centripet:48,centripetalaccelerationego:48,certain:[1,9,29,30,42],chain:6,chanc:32,chang:[5,9,10,11,12,15,16,18,20,23,32,35,37,42,43,49],changeabl:5,channel:[2,18,21,48],chapter:[20,23,30],charact:42,character:46,chart:23,check:[1,2,4,6,10,11,13,15,23,30,48],checker:15,checkout:[1,16,20,49],chere_invok:11,china:[7,29],china_gb_5768:7,choic:[1,15],choos:[11,35,37,38,40,41],chosen:[31,32,37,49],circl:2,circular:2,clang:[11,20],clean:9,clear:[11,40],clearli:9,click:[35,38,40,41,49],clock:14,clone:[9,16],close:[2,9,23,30,43],closer:42,closest:47,clothoid:7,cmake:[1,9,13,15,16,17,18],cmake_:19,cmake_binary_dir:9,cmake_build_typ:16,cmake_command:9,cmake_current_list_dir:9,cmake_echo_color:9,cmake_export_compile_command:11,cmake_find_packag:18,cmake_install_prefix:[9,15,16],cmake_lang_compil:19,cmake_make_program:11,cmake_path:18,cmake_prefix_path:[11,16],cmake_verbose_makefil:11,cmakelist:[9,10],cmakepath:11,coars:[34,44],code:[1,8,9,12,13,15,16,19,20,36,37,42,48],coeffici:2,coexist:9,cog:21,collect:[1,2,21,23],collid:[1,4],collis:[1,2,4,9,21,23,30,48],collisiondetectionlateralboundari:48,collisiondetectionlongitudinalboundari:48,collisiondetector:0,collisionev:4,collisionmanipul:4,collisionwithag:1,color:[7,31],column:[1,40,41,42,43],com:[11,15,19,48],combin:[2,18,37,41],come:[7,10,12,32,35,42,43,47],comma:[37,40,41,48],command:[0,9,11,15,16,18,30,32],comment:[9,15],commerci:9,common:[1,4,5,6,7,9,15,23,30,40,42,43,47,49],commonli:[2,14],commun:[2,12,15,34,42,48],compar:[1,2,7,38,44],comparison:[1,9],compat:[19,21,30,48],compctrlsignal_movementdomain:48,compctrlsignal_warningact:48,compctrlsignal_warningdirect:48,compctrlsignal_warningintens:48,compctrlsignal_warninglevel:48,compctrlsignal_warningtyp:48,compctrltovehiclecompsign:2,compens:46,compil:[1,10,11,12,13,15,16,19,48],compile_command:11,compilecommand:11,complain:15,complement:49,complet:[1,2,15,21,23,26,36,49],complianc:15,compon:[0,5,15,19,21,23,28,34,36,42,46,48,49],componentcontrol:[0,30,34],componentnam:29,componentrepositori:5,componentschannelcommunicationdiagram:2,componentst:[2,48],componentstatechang:30,componentstatechangemanipul:30,componentstatesign:2,compos:[2,23,45],composit:[23,29],conan:[12,13],conanfil:18,concaten:[32,43],concept:[2,12],concret:23,cond:46,condit:[1,5,21,23,34,42,44,47,49],conditionedg:30,conditiongroup:[1,30],cone:48,conf:9,config:[1,2,5,9,11,12,23,32,35,48,49],config_folder_1:1,config_folder_2:1,config_folder_3:1,config_folder_4:1,config_set:1,config_set_1:1,config_set_2:1,config_set_3:1,configuir:1,configur:[2,5,6,9,10,12,15,18,19,23,29,30,33,34,35,36,42,47,48,49],configurationprovid:11,configure_fil:9,configurearg:11,configureset:11,confin:2,conform:23,conftest:1,congest:46,conjunct:19,connect:[2,5,6,7,21,23,48],connectingramp:47,connector:32,consecut:43,consequ:[2,7],conserv:2,consid:[4,15,30],consider:47,consist:[2,3,7,21,29,30,32,34,40,42,48],consol:[1,49],consolid:[32,43],constant:[2,7,9,30,42,46,48],constantli:10,constel:49,constraint:2,construct:2,consum:[20,34],contact:11,contain:[1,2,4,6,7,12,13,21,23,29,30,32,34,35,40,41,42,43,47,48,49],content:[2,9,23,30,34,40],continu:[7,23,30,47,48],contrib:[9,15,16,30,48,49],contribut:15,control:[2,7,23,30,34,45,48],controllercatalog:30,conveni:30,convent:[23,43],convers:0,convert:[2,3,7,15,48],convex:2,cooper:29,coordin:[0,2,6,7,29,30,37,48],copi:[1,9,11,15,16,18,19,49],copy_document:9,copyright:9,core:[1,5,11,12,14,15,16,19,23,30,32,45],corner:[2,7],correct:[2,6,15],correctli:[11,37,47],correspond:[1,2,5,7,9,11,18,27,30,34,40,42,49],corridor:29,could:[2,18,19,23,29,48],count:[1,37],counterclockwis:3,countri:29,cover:[2,6,36,44],coverag:19,coverage_exclud:19,cpp:[11,15,42],cppdbg:11,cppstandard:11,cpu:14,crash:[19,21,23],creat:[4,7,10,11,15,16,20,23,35,42,47,48,49],creator:[8,11,12,13,19],credenti:15,critic:47,crop:47,cross:[6,7,13,19,43],crosswalk:7,cruis:[2,46],cstandard:11,csv:[23,32,40,41,42,48,49],csvoutput:48,ctest:11,ctrl:[11,37,41],cubic:7,current:[1,2,3,7,11,15,16,19,20,23,25,29,30,32,34,36,37,42,46,47,48,49],curvatur:[7,31,48],curvend:31,curvstart:31,custom:[9,11,18,19,20,30],custom_doc:9,custom_messag:19,custom_rel_sim:9,customcommandact:[30,34],customparamet:[30,34],cut:49,cwd:11,cxx:11,cycl:[2,4,34],cyclic:[1,23,34,49],cyclics_run_000:[23,42],cyclics_run_:23,cyclics_run_xxx:49,cyclicsfil:42,cygpath:11,cygwin:[11,21],dai:32,danger:21,data:[1,2,3,15,20,21,30,34,37,42,48],databas:[15,23,37],databuff:[5,42],dataflow:2,datafram:1,datastructur:20,datatyp:48,date:[12,15,31,42],dcmake_build_typ:[11,15],dcmake_cxx_flag:15,dcmake_export_compile_command:11,dcmake_install_prefix:[11,15],dcmake_prefix_path:[11,15],ddst:9,deactiv:[2,30,48,49],debian:[14,15,18],debug:[1,5,10,15,18,19,20,37],debugg:10,deceler:[2,46],decentr:18,decid:30,declar:30,decreas:[23,46],dedic:20,defaultpreruncommon:[32,47],defaultprofil:11,defaultruntimecommon:[32,47],defin:[1,2,3,5,7,19,20,23,29,30,32,34,37,42,43,44,47,48,49],definilti:20,definit:[1,7,23,29,30,31,32],delai:[2,30,34],delet:[5,9,11,48],deleteentityact:30,deliber:[2,15],deliv:34,delta:[7,30,37,46],delta_left:7,demo:[35,36,49],densiti:2,dep:[9,11,16,19],depend:[1,2,5,7,11,12,15,16,18,19,21,23,29,30,32,34,35,37],depic:7,depict:2,deprec:20,depth:[12,21,23,28,32,49],deptict:23,deriv:2,describ:[2,3,7,9,11,13,15,16,18,19,20,21,23,26,27,30,31,32,33,34,42,43,45,46,47,48,49],descript:[0,1,2,11,23,29,30,32,34,35,42,43,46,47,48,49],design:14,desir:[2,9,15,46,49],despawen:7,destin:[2,9,18],detail:[1,2,15,16,18,20,21,23,26,29,30,35,49],detect:[1,2,4,19,23,48],detection_radiu:2,detectionrang:[42,48,49],detector:[4,5],determin:[1,2,6,7,9,30,42,46,47,49],determinist:23,dev:15,devel:15,develop:[2,8,9,10,15,18,19,20,21,23,49],developer_inform:[9,12],deviat:[1,7,16,30,37,46],devic:7,dfmilib_build_shared_lib:15,dfmilib_build_static_lib:15,dfmilib_install_prefix:15,diagram:34,did:23,diff:9,differ:[1,2,3,5,12,15,18,20,30,32,34,37,38,42,46,47,48,49],differenti:18,diffutil:15,digit:[9,34],dimension:4,dinstall_extra_runtime_dep:11,dinstall_system_runtime_dep:11,dir:49,direcori:11,direct:[3,7,30],directli:[1,12,19,30,32,36,42,49],directori:[1,9,10,11,15,16,19,30,35,48,49],dirk:46,disabl:[2,15,48],discov:11,discoveri:11,discret:48,discuss:23,disk:14,displai:[38,42],dissolv:20,dist:2,distanc:[2,6,7,30,31,37,42,46,47,48],distanceind:7,distancereftofrontedgeego:48,distancereftofrontedgefront:48,distinguish:[1,19],distrib:15,distribut:[9,15,29,30,34,47],divid:[2,5,15,20,45,49],dlane:30,dll:[11,19,48],doc:[1,9,12,15,16,18,19,49],document:[1,10,11,16,19,20,21,23,30,32,42],doe:[6,7,11,15,18,23,31,32,42,47,48],doesn:[6,10,47,48],domain:44,don:[6,11,20,43],done:[7,8,9,16,18,44,46,49],donotent:7,donotpass:7,dontovertakeonouterlan:29,dos2unix:15,dot:7,doubl:[2,29,30,46,47,48,49],doubleparamet:29,doublevector:[29,47],doubt:15,dougla:7,down:2,download:[7,11,15,20],downstream:3,doxygen:15,dprotobuf_build_shared_lib:15,dprotobuf_build_test:15,draft:47,drag:[2,46],drawn:29,drivabl:6,drive:[2,16,21,23,29,30,31,43,46,47,48],driver:[2,23,28,32,34,36,42,45],driverlibrari:29,drivermod:34,drivermodel:34,driverprofil:[29,46],driverprofilenam:[1,42],driverstatesign:2,drivertask:34,drivetrain:2,dsrc:9,due:[5,7,9,12,15,19,30,42,46],duplic:43,durat:[1,5,30],dure:[1,2,5,9,14,16,19,30,33,42,47,48],duse_ccach:11,dvipng:15,dwith_api_doc:9,dwith_debug_postfix:11,dwith_doc:11,dwith_gui:11,dwith_simcor:11,dwith_test:11,dynam:[2,15,21,29,30,33,34,36,42],dynamics_collis:[0,34],dynamics_regulardriv:[0,34],dynamics_trajectoryfollow:[30,34],dynamicscollis:[2,34],dynamicsdimens:30,dynamicspriorit:2,dynamicsregulardriv:[32,34],dynamicsshap:30,dynamicssign:48,dynamicssignal_acceler:48,dynamicssignal_centripetalacceler:48,dynamicssignal_positioni:48,dynamicssignal_positionx:48,dynamicssignal_steeringwheelangl:48,dynamicssignal_traveldist:48,dynamicssignal_veloc:48,dynamicssignal_yaw:48,dynamicssignal_yawacceler:48,dynamicssignal_yawr:48,dynamicstrajectoryfollow:[2,34,45],each:[1,2,3,4,5,7,15,16,19,23,30,32,34,37,40,41,42,43,44,47,48,49],earlier:1,easi:[9,20,30],easier:35,easili:[15,20],east:31,echo:11,eclips:[9,10,12,16,22,23,42],edg:[2,7],edit:[11,36,49],editor:[11,15,25],effect:[6,11,30,48],ego:[3,7,29,30,42,43,46,47,48,49],egoaccid:[1,42],egoag:29,egodistancetravel:[1,42],either:[2,7,11,15,29,30,32,37,42,47,48,49],element:[1,7,30,32,43],elevationprofil:31,els:[18,30,47],emerg:[2,21,29,48,49],empir:46,empti:[7,30],enabl:[10,11,12,15,19,23],enablevisualobstruct:[2,48],encount:6,end:[5,6,7,10,15,19,30,40,41,47,49],endif:[9,19],endoffallspeedlimitsandovertakingrestrict:7,endoflan:7,endofmaximumspeedlimit:7,endofminimumspeedlimit:7,endofspeedlimit:7,endtim:30,endtoend:[12,15,19],endtoendtest:1,enforc:11,enforcedoublebuff:48,enforcetrajectori:48,engin:[2,46],enginemo:[32,42],enhanc:23,enlarg:46,enough:2,ensur:[7,21,37,49],enter:15,entir:[32,47],entireti:47,entiti:[1,23,32,42,43],entityact:30,entitycondit:[1,30],entitynam:30,entityref:30,entityselect:30,entri:[1,12,15,23,29,32,35,42,48],entrynam:30,env:11,environ:[1,2,8,10,11,12,13,16,19,20,29,49],environment:[11,16,21,23],environmentalzonebegin:7,environmentalzoneend:7,environmentcatalog:30,environmentvari:11,epl:[9,22],equal:[2,7,9,46],equalto:30,equat:[15,46],equilibrium:46,equip:[21,49],equival:[29,30],error:[1,2,6,7,11,15,16,18,19,23,35,37,48],escap:[1,19],especi:[12,20,34],establish:9,etc:[15,18,35,41,49],euclidean:7,evalu:[12,21,23,25,30,47,48],event:[2,4,5,23,30,34,49],eventdetector:[0,5,42],eventnetwork:[4,30],everi:[1,2,10,12,18,23,29,32,34,37,42,43,48,49],everyth:[1,48],evolv:12,exact:[19,49],exactli:[2,18,30],exampl:[2,7,9,14,18,19,20,23,30,34,36,42,43,44,48,49],examplelist:29,exampleprofil:29,except:[34,48],exchang:[20,21],exclud:1,exe:[10,11,15,35,49],exec:15,execut:[0,2,4,7,10,11,15,16,23,34,35,44,48,49],executor:1,exemplari:49,exemplarili:14,exhal:[9,15],exhaust:2,exhibit:7,exist:[2,9,15,18,23,29,42,43,47,48,49],existencefront:48,existencefrontfront:48,exit:[7,48],expand:34,expect:[11,48],experi:[23,29,42,43,44,49],experienc:34,experiment:[20,23],experimentid:32,expertis:23,expir:47,explain:[2,15,16],explicit:[19,34],explicitli:[1,19,34,47],explor:11,expon:46,exponentialdistribut:29,express:42,extend:[7,11,19,47],extens:[9,11,15,48],extern:[6,11,12,48],externalconsol:11,extra:[10,15],extract:[15,48],extrem:7,fachthemen:7,facilit:9,factor:[2,37],fail:[1,7,11,19],failur:[16,19],failureprob:48,fall:19,fals:[2,9,11,29,30,32,42,48,49],far:[15,20,32,42],fashion:45,faster:[2,20],featur:[0,15,19,20,30],feb:31,fetch:1,fhwa:7,field:[2,18,30,48],figur:2,file:[1,5,6,7,9,10,11,12,15,16,18,19,23,26,29,30,31,32,33,34,35,36,37,38,40,41,47,48,49],filenam:[9,15,23,42,48],filenameprefix:[32,43],filepath:30,fill:47,find:[1,10,11,15,16,18,34,35,49],findpackag:18,fine:15,finish:[13,37],first:[1,5,6,7,13,15,19,20,21,23,30,32,34,35,40,41,43,47,48],firstparamet:29,fit:[1,2,11,21],five:2,fix:[2,7,9,15,20,30,47,48],flag:[1,2,5,7,10,15,16,18,30,42,47],flash:30,flasher:2,flexibl:21,flow:[2,23,34],fmi1:15,fmi1_import_capi:15,fmi2:15,fmi2_import_capi:15,fmi:[15,21,48],fmilibrari:[11,15,16,18,19],fmu1:[34,48],fmu1_staticfmu:1,fmu2:34,fmu2_staticfmu:1,fmu3:34,fmu:[1,15,20,21,30,45],fmuhandl:48,fmupath:[1,48],fmuvari:48,fmuwrapp:48,focus:23,folder:[9,11,15,16,18,19,23,35,38,40,41,49],follow:[1,2,3,5,7,9,10,11,13,15,16,18,19,23,25,27,29,32,34,36,37,40,42,43,44,45,46,47,48,49],followingmod:30,followtrajectori:30,followtrajectoryact:30,font:15,forc:[1,2,30,46,48,49],forget:11,form:[23,29,30,42],format:[9,11,20,21,23,30,40,41,48,49],formatonsav:11,formatonsavemod:11,formrescuelan:29,fortran:11,fortun:19,forward:[2,4,30,34,48],found:[15,16,18,19,48,49],foundat:15,four:[2,7],fpic:15,frac:[2,46,48],frame:[40,41],framework:[2,4,12,15,19,21,48],free:[14,29,46],freedom:44,freeli:31,freespac:30,frequenc:14,fric:2,friction:[2,32],from:[1,2,3,7,9,10,11,12,15,16,18,19,20,23,29,30,32,34,35,37,40,43,44,46,47,48,49],front:[2,7,42,46,48],frontag:46,frozen:34,fulfil:[30,47],full:[2,30,48],fullfil:47,fulli:[2,13,23,49],further:[7,12,13,15,19,23,29,30,46,49],furthermor:30,furthest:7,fusion:34,futur:48,gammadistribut:29,gap:[44,46,47],gas:36,gather:2,gcc:[11,15,19,21],gdb:[11,15],gear:[2,30,32,42,46],gener:[1,2,3,7,9,10,11,12,15,20,21,23,27,29,30,32,34,37,42,43,44,48,49],genhtml:19,geometr:20,geometri:[0,31],geometric2d:[29,42,48],geometric2dfront:42,german:[7,21,23],germani:[7,29],get:[2,3,12,15,19,29,34,35,48],getlanemark:7,getobstruct:[0,48],ghz:14,gida:[21,23],git:16,github:[15,21,48],gitlab:[10,12,16,42],give:[2,5,11,15,20,23],given:[1,2,5,6,7,15,23,30,32,37,43,44,47,48,49],givewai:7,glob:[9,11],glob_recurs:9,global:[29,30],globalact:30,glossari:12,gmbh:9,gmock:20,gnu:21,goal:[15,23],goe:[16,48],going:[23,42],good:10,googl:[15,19],googlemock:20,googletest:[11,15,19],got:11,gov:7,govern:46,gpu:14,graphic:[12,14],graphviz:15,graviti:21,greater:[2,6,48],greaterthan:30,green:[2,7,9,30],ground:[20,23],groundtruth:48,group:[0,1,2,3,4,5,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31,32,33,34,35,36,37,38,39,40,41,42,43,44,45,46,47,48,49,50],grouptyp:29,gtest:[15,20],guarante:7,guard:[43,49],guardrail:[31,43],guardrail_01:43,guardrail_02:43,gui:[9,12,19,20,35,36,37,44,49],guid:[2,8,13,15,16,19,23,36,45,49],guidanc:[12,13,46],guidelin:45,half:2,hand:23,handl:[0,5,6,29,30,34],handler:48,happen:[1,5,21,23,30,48],haptic:48,hard:14,harder:46,hardwar:[13,14],has:[1,2,3,4,6,7,9,10,15,18,20,29,30,32,34,36,37,38,42,44,47,48,49],have:[1,2,4,5,6,7,9,14,15,16,18,19,20,23,29,30,36,43,47,48,49],hdg:31,head:[9,30,47],header:[15,20,31,40,41,42],headlight:2,headwai:30,heart:23,heavili:20,heavyvehicl:47,height:[2,3,29,31,42],helb:46,held:47,hello:30,help:[19,23,36],henc:[2,35,43],henneck:46,here:[7,9,10,15,18,23,26,29,30,32,34,47,48,49],high:[2,32,44,46,48],higher:[2,9,48],highest:[2,5,32,34,35],highli:11,highlight:9,highwai:[7,23,29],highwaybegin:7,highwayend:7,highwayexit:7,highwayexitpol:7,highwayscenario:32,hint:[11,19],histogram:40,histor:23,hold:[1,2,7,13,16,18,20,46],home:[15,16],homogen:47,hood:19,hook:[15,18],horizont:[42,48],horn:2,host:48,how:[1,9,13,15,16,18,20,23,32,42,43,45,46,47,49],howev:35,htm:[7,19],html:[1,7,9,19,20],http:[1,7,9,10,11,12,15,16,19,20,21,22,23,42,46,48],huge:[14,46],human:32,icon:11,ide_support:12,identif:42,identifi:[9,22,29,42,48],idm:46,ids:[1,34,42,43],ifdef:19,ignor:[6,15,29,30,31,40,47],ignorefailur:11,igor:6,illustr:23,imag:[2,7,23,40],immedi:30,impact:47,implement:[2,7,19,23,46],impos:14,imposs:1,improv:[10,19,23],inclin:4,includ:[2,5,9,10,11,15,19,20,23,36,40,42,43,47,49],inclus:36,incom:32,incorpor:49,increas:[3,19,20],increment:[34,42,47],indend:1,independ:[5,15,21,30],index:[19,20,34,43,48],indic:[2,3,7,10,34,48],indicatorst:[32,42],indirectli:32,individu:[1,2,7,11,12,21,23,32,41,42,43,45],indivu:29,inelast:2,inexist:47,inf:29,infin:46,influenc:30,info:[37,48],inform:[1,2,7,9,11,13,15,18,19,23,30,32,34,37,42,43,46,48,49],inherit:11,init:[5,34,48],init_:48,initi:[5,7,9,23,29,30,37,42,47,48,49],inject:9,input:[1,2,5,26,29,34,40,41,44,48,49],input_:48,input_osmpsensordatain:48,inputid:[29,48],inscrib:35,insert:11,insid:[0,11,30,32,47,48],insight:23,instal:[1,9,10,13,14,20,49],install_extra_runtime_dep:16,instanc:[4,19,42],instanti:[5,23,34,48],instead:[11,16,23,30],instruct:[1,10,13,15,16,20,48,49],int_:37,integ:[1,30,32,48],integr:[9,10,11,20],integratedtermin:1,intel:14,intellig:46,intellisensemod:11,intend:[21,47],intent:1,interact:[12,20,36,46],interdepend:23,interest:[2,23,26,45],interfac:[2,4,7,10,12,15,21,48],intermedi:47,intern:[1,7,15,19,20,23,30,43],interpol:7,interpret:[1,7,30],interrupt:37,intersect:[2,4,7,30,47],interv:[7,34,47,48],intervent:[23,30],introduc:[9,20,34,46],introduct:15,intvector:[29,47],invalid:[7,9,47,48],invers:3,investig:11,invoc:[1,23,32,42,44,49],invok:[10,19,44],involv:42,ipsum:[29,34],isaffect:1,isintersect:2,isn:[15,34,47],isoscel:2,issu:[2,11,12,15,19,20,42],istrigg:1,itchi:[10,12],item:[29,41],its:[1,2,3,4,5,7,10,11,16,19,20,30,46,48],itself:[4,11,15,18,20,29,30,37],jam:[29,46],jm_portabl:15,jmodelica:48,job:35,joint:7,json:[1,11,48],junction:[30,31,32,47],just:[1,2,5,9,37,46],keep:[2,9,11,12,16,23,42,46],keeptoouterlan:29,kei:[1,2,15,29,32,34,37,42,43,46,47,48],keyword:30,kind:[30,48],kit:19,kite:2,know:[11,18,19],knowledg:34,known:20,lai:[2,7],lambda:29,lane:[0,1,2,20,29,30,31,32,42,43,46,47,48,49],laneboundari:7,lanechang:[2,31],lanechangeact:30,lanechangeactiondynam:30,lanechangemanipul:2,lanechangetarget:30,lanecountleft:48,lanecountright:48,laneego:48,laneel:7,lanefront:48,lanefrontfront:48,lanegeometryel:7,laneid:[1,30,47],laneposit:30,laneroadmark:43,lanesect:31,lang:21,larg:[2,46],larger:[2,48],last:[5,6,16,20,34,47,48],lastest:20,latenc:48,later:[2,3,7,15,23,29,30,34,37,42,45,48],lateralact:30,lateralprofil:31,latest:[15,19,20],latex:15,latter:[2,19,48],launch:[1,11,21],launchtargetpath:11,layer:[7,21,48],layout:42,lcov:19,ldd:11,lead:[1,2,6,7,9,13,35,42,46],learn:[18,49],least:[6,11,14,18,29,48],leav:15,left:[3,7,11,29,30,31,47,48],lefthand:29,leftlaneend:7,leftmost:48,legal:[9,22],length:[2,3,6,7,16,30,31,42,47,48],lengthfront:48,less:[7,19,23,48],lessthan:30,let:[12,19,20,23,35,48],letter:16,level:[5,9,10,23,31,32,34,35,37,44],lib:[5,11,15,49],libboost:15,libench:15,libqt5xmlpatterns5:15,librari:[2,5,10,11,16,18,19,21,29,32,34,35,42,43,47,48,49],librarynam:29,libxslt:15,licens:[9,12],light:[2,7,30],lightstatu:[32,42],lightvehicl:47,lightweight:14,like:[1,6,9,11,15,18,23,30,32,34,37,38,46,48,49],lim:2,limit:[2,20,23,48],limiteraccelerationvehiclecompon:[0,32,34],line:[0,2,7,11,12,15,18,19,31,32],linear:[7,30,46],linearli:7,link:[10,11,16,23,30,31,42,47,48],linux64:[11,19],linux:[11,13,14,15,16,18,19,20],list:[1,2,6,10,11,14,15,16,19,23,29,30,32,34,40,42,47,48,49],list_directori:9,listen:30,listitem:[6,29,47],literalinclud:9,load:[10,15,21,32,35],local:[0,1,11,16,18,30],locat:[1,3,7,9,11,12,16,30,35,47,48,49],log:[5,11,23,34,35,37,42,43,48,49],logfil:[5,11],loggingcyclicstocsv:[32,42,49],logginggroup:32,logginggroup_:42,logginggroup_roadposit:[32,42],logginggroup_roadpositionextend:[32,42],logginggroup_sensor:[32,42],logginggroup_trac:[32,42],logginggroup_vehicl:[32,42],logginggroup_visu:[32,42],logic:[30,47],logicfil:30,login:11,loglevel:5,lognormaldistribut:[29,47],longest:7,longitudin:[2,3,23,29,34,42,45,48],longitudinalact:30,longitudinalpivotoffset:42,longitudinalsign:48,longitudinalsignal_accpedalpo:48,longitudinalsignal_brakepedalpo:48,longitudinalsignal_gear:48,look:[10,11,15,18,23,49],loop:23,lorem:[29,34],lot:23,low:[44,46,48],lower:[2,6,44,48],lowerbound:30,lowest:[2,41,47],luxuryclasscarag:[29,47],lvl:34,lxml:15,machin:16,macro:9,made:[9,16,20,22],madler:15,mai:[3,7,15,29,30,47,48,49],main:[7,16,23],mainlaneloc:7,mainli:[30,43],mainlocatepoint:48,maintain:[20,47],major:[19,20],make:[2,9,11,14,15,16,18,20,21,36,45,49],makefil:[10,11,15,16,19],makeflag:10,manag:[15,18,20,34,35],mandatori:[19,30,32,47,48,49],maneuv:[1,42,49],maneuvercatalog:30,maneuvergroup:30,manifest:16,manipul:[2,5,30,36,42],manner:[1,43],manual:[7,13,15,23,49],map:[43,48],mark:[0,19,20,49],markdown:20,martin:46,mass:2,mat:46,match:[6,10,29,30,48],materi:[9,22],math:37,matlab:48,matrix:[21,23],matter:36,max:[1,2,29,34,37,46,47,48],maxacceler:46,maxdeceler:46,maxdepth:15,maxenginespe:2,maximum:[1,2,5,7,19,29,30,32,46,47],maximumexecutioncount:30,maximumspeedlimit:7,mayb:2,mean:[1,2,7,11,15,23,29,30,32,34,35,44,47,48],meaningless:30,medium:48,meet:31,member:30,memori:19,mention:[2,11,23],merg:[2,3,29],messag:[9,11,20,35,48],met:[10,47],meta:48,metainfo:20,meter:[7,32,47,48],method:[2,34,48],microscop:46,middl:[7,30,46],middleclasscarag:[30,42,47],midebuggerpath:11,might:[2,11,15,16,19,21,23,26,30,46,49],mimod:11,min:[1,29,34,47,48],mindist:46,mingw32:11,mingw64:[11,16,19],mingw:[0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31,32,33,34,35,36,37,38,39,40,41,42,43,44,45,46,47,48,49,50],mini:29,minim:14,minimum:[2,5,7,29,46,47,49],minimumseparationbuff:6,minimumspeedlimit:7,minizip:[11,16,19],minor:46,miscobjectcatalog:30,miss:[1,6,10,11,15,18,19,30,49],mkdir:[15,16],mock:[15,20,21,48],mode:[23,36],model:[2,21,23,29,30,42,45,46,48],modeldescript:48,modelon:[15,48],modif:[11,16,23,49],modifi:[11,49],modul:[1,2,5,19,21,32,34,48],moment:[7,35],momentum:2,monitor:11,monolith:12,mont:44,more:[1,2,6,7,9,11,15,16,18,20,21,23,30,32,34,47,48,49],most:[7,11,23,29,35,45,47],motion:2,motioncommand:[20,48],mount:[3,48],mountingposheight:42,mountingposlater:42,mountingposlongitudin:42,move:[4,9,23,43,47,48],movement:[5,30,48],movingobject:43,msvc:[19,20],msy:[10,15,16,19,21],msys2:[1,15,18,19,21],msys2_path_typ:11,msys64:[11,15,16],msystem:11,much:[2,23,46],multi:18,multipl:[2,4,14,30,32,34,37,38,40,42,47],must:[1,2,7,9,11,16,29,30,32,37,48],mutcd:7,mutual:1,mutual_resources_path:1,myevent:30,mymaneuv:30,mymanipul:30,mysequ:30,mystori:30,myusernam:18,name:[1,2,5,7,9,11,15,23,29,30,31,32,34,35,37,42,43,46,47,48,49],nan:48,nativ:[1,10,11,18,21],natur:[7,30],navig:[15,16,49],nearest:7,necessari:[1,2,11,15,16,18,19,20,21,47,48],necessarili:[6,9],need:[1,2,3,7,10,11,12,15,18,19,20,23,29,31,32,34,35,36,40,41,42,47,48,49],neg:[30,42],neglig:2,neither:47,nest:29,net:[6,30,46,48],netdist:46,network:[23,31],never:48,newer:20,next:[1,2,5,9,11,16,18,19,23,35,47,49],ninja:15,non:[5,7,11,15,19,20,40,43,47,49],none:[29,30],nonrecur:5,normal:[9,11,23,30,42,47],normaldistribut:[29,34,47,48],north:31,notabl:2,note:[5,7,9,10,16,19,29,30,34,44,49],noth:5,notifi:2,notion:7,now:[7,11,18,30],number:[1,2,7,9,20,23,29,30,32,34,37,42,44,48,49],numberofexecut:1,numberofinvoc:32,numer:2,numpi:1,object:[2,3,4,7,20,21,23,30,31,43,48,49],oblig:35,observ:[5,23,27,42,43,46],observation_entityrepositori:[27,32],observation_log:[12,23,27,32],observationlog_cycl:42,observationlog_paramer:42,obstacl:[23,43],obstruct:[0,42,48],occas:48,occupi:7,occur:[2,4,15,42,47,48],occurr:[1,30],off:[9,11,15,16,19,30,48],offici:20,offramp:[47,48],offset:[2,7,30,34],often:8,older:20,omit:[21,47],onc:[5,13,16,32,42,43,47,48,49],one:[1,2,5,6,7,15,19,21,23,29,30,34,37,40,42,47,48,49],ones:[6,16],onli:[1,2,5,7,9,11,14,15,19,20,29,32,34,35,36,37,42,43,47,48,49],onramp:[47,48],onto:[4,48],op_osc_schemavers:30,op_rel_gui:9,op_rel_root:9,op_rel_sim:9,open:[0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,21,22,23,24,25,26,27,28,29,30,31,32,33,34,35,36,37,38,39,40,41,42,43,44,45,46,47,48,49,50],opendr:[7,21,23,30,31,43,47],opendrive_id:42,openingangleh:[42,48],openinganglev:42,openpass:[0,1,2,3,4,5,6,7,8,10,11,13,14,15,17,19,20,21,22,23,24,25,26,27,28,29,30,31,32,33,34,35,36,37,38,39,40,41,42,43,44,45,46,47,48,49,50],openpass_adjust_output:16,openpass_at_a_gl:23,openpass_os_dir:9,openpasswg:18,openscenario:[2,7,23,30,34,42,43,47,48],openscenarioact:[0,34],openscenariofil:32,opensimulationinterfac:[15,21,48],openspeedlimit:29,openspeedlimitbus:29,openspeedlimittruck:29,oper:[1,7,14,18,23,30],opposit:47,opsimul:[1,5,10,11,19,23,35,48,49],opsimulation_test:19,opsimulationmanag:[10,35],optic:48,optim:[11,19],option:[1,7,9,10,11,13,15,16,17,18,20,23,30,32,33,35,43,47,48],order:[1,5,7,9,11,15,47,49],org:[1,7,9,10,12,15,16,19,20,21,22,23,42,46,48],orient:[3,30,31,34],orientationpitch:42,orientationyaw:42,origin:[3,7,9,12,37],os_env:11,oscact:30,osi3:[11,19],osi:[2,3,7,11,16,18,19,21,48],osi_:19,osisensormodelpackag:48,osmp:[20,48],osmpsdtotu:48,oss:1,other:[2,3,6,11,14,18,19,21,29,30,32,34,42,43,45,47,48],other_index:37,otherwis:[7,16,30,42,48],our:[2,49],out:[2,7,11,12,23,42,47],outdat:[9,19],outermost:29,outgo:32,output:[1,2,5,6,12,16,19,30,32,34,48,49],output_:48,output_osmptrafficupdateout:48,outputfilenam:[32,42],outsid:[7,9,47,48],over:[2,12,40,41,48],overal:[2,23,49],overrid:[1,2,9,19,30,48],overriden:19,overridenam:11,overtak:29,overtakingban:7,overtakingbanbegin:7,overtakingbanend:7,overtakingbantrucksbegin:7,overtakingbantrucksend:7,overview:[0,5,12,20,28,48,49],overwrit:[1,30,49],overwritten:9,owl:7,own:[2,3,4,10,11,16,19,20,23,46,48],packag:[1,16,18,19,48],package_nam:18,packagenam:18,pacman:15,page:9,pai:11,pair:[1,32,42],panda:1,pane:11,panel:40,parallel:[3,7,10,16],parallelexecutionlimit:11,parallelexecutionofexecutablelimit:11,paralleljob:11,paramet:[0,1,2,12,21,23,29,30,32,36,42,43,44,46,47,48,49],parameter:[1,30,45,48],parameter_:48,parameter_transformlist:48,parameter_vehicl:34,parameterassign:30,parameteriz:[2,23,44],parameterref:30,parameters_vehicl:0,parametersag:34,parametersagentmodul:34,parametersvehicl:[2,34],parametersvehiclesign:2,parametertyp:30,parametr:[2,12,23,32],parent:[3,30],park:23,pars:[1,5,48],part:[6,9,15,19,20,21,30,42,48],parti:[15,16,20],partial:6,particip:[4,12,23,44,45],particular:[23,47,48],partner:2,pass:[1,29,48],passiv:2,past:23,patch:15,path:[1,5,6,9,10,15,16,18,19,23,30,32,42,48],pattern:[11,18],pcm:[12,21,23,24,25,36,44],pdf:[7,23,46],pdf_index:7,pedal:[2,36,46,48],pedestrian:[7,21,23,30],pedestrian_adult:30,pedestrian_child:30,pedestriancatalog:23,pedestriancross:7,pedestrianmodelcatalog:23,pedestrianmodelscatalog:[23,30,49],per:[1,7,11,30,34,42],perceiv:48,percentag:[2,48],percept:21,perform:[1,2,14,15,19,23,29,30,49],perpendicular:7,persist:[32,43],perspect:[2,19],peucker:7,phase1:30,phase2:30,phase3:30,phase4:30,phase:[0,21,30,48],physic:[2,23,30,46],pick:[4,23],pictur:[2,7,35],piecewis:7,pip3:15,pip:[1,15,18],pitch:[29,30,31,42],place:[6,9,16,19,23,30,34,37,47,48,49],placehold:9,placement:23,plan:35,plane:4,planview:31,platform:[12,13,15,18,19,21,48],pleas:[1,11,13,15,16,18,19,23,32,34,42,46],plot:41,plugin:[1,12,19,23,35,37,38,40,41],point:[1,2,3,7,9,11,12,15,18,23,30,36,37,42,47,48],polar:37,polygon:[2,7],polylin:30,polynomi:7,pool:47,popul:[45,47],posit:[1,2,3,7,9,21,23,29,32,36,37,41,42,46,47,48,49],positionrout:[1,30,32,42],positionsego:48,positionsfront:48,positiontego:48,positiontfront:48,positionxego:48,positionxfront:48,positionxfrontfront:48,positionyego:48,positionyfront:48,positionyfrontfront:48,posix:21,possibl:[1,2,9,10,11,16,18,19,20,23,29,34,37,38,40,42,44,46,47],post:42,postfix:19,potenti:[2,4,10,11,26,27,30,47],powershel:11,practic:19,pre:[15,21,49],preagent:5,preannouncehighwayexit:7,preannouncehighwayexitdirect:7,precas:21,precaut:20,preced:[9,48],precis:32,precompil:1,precondit:6,precrash:23,predecessor:[7,21],predefin:[30,49],predict:23,prefer:11,preferredgener:11,prefix:[1,9,19,30,43],prematur:7,prepar:[2,5,9,10,16],preparedoc:9,preparedoccustom:9,preprocessor:19,prerequisit:[10,11,12,13,16,19,20],prerun:[5,32],preruncommonspawn:47,prerunspawn:[0,45],present:[6,21,23,30],press:37,pretti:[11,19],prevent:[2,19,21],preview:40,previou:[2,3,18,37,38,47,49],previous:49,primarili:[7,20,23,49],primer:[26,27],primit:48,princip:7,print:[7,11],prior:[9,18,20],priorit:[2,23,34],prioriti:[0,1,2,30,32,48],prioritizeraccelerationdriv:34,prioritizeraccelerationvehiclecompon:[2,34],prioritizerdynam:[2,34],prioritizerlaterdriv:34,prioritizerlongitudin:[2,34],prioritizernam:2,prioritizerst:[2,34],prioritizersteeringvehiclecompon:[2,34],prioritizerturningind:[2,34],privat:[9,15,30],privateact:30,probabilist:[23,44],probabl:[2,23,29,32,44,47,48],process:[1,2,5,7,9,11,12,13,14,16,18,23,37,48],produc:[23,34,37],profil:[11,23,29,30,32,42,46,47,48,49],profilegroup:[23,47,48],profilenam:29,profilescatalog:[2,23,26,30,34,45,48,49],profilesgroup:34,program:[9,11,15,16,19,21,22],progress:[23,25,49],prohibit:29,project:[1,2,4,7,11,15,18,25,30],projected_height:2,prompt:[11,49],proper:[10,11,15,19,23,34],properli:[16,31],properti:9,proport:2,propos:20,proprietari:9,proto:15,protobuf:[16,19],protobuf_build_shared_lib:15,protoc:15,protocol:[15,19],protocolbuff:15,provid:[1,2,8,9,15,19,20,23,34,35,36,44,48,49],publish:[1,2,5,12,42],publisherinterfac:42,purpos:[11,21],put:23,pwd:19,pyopenpass:[1,19],pytest:1,python3:15,python3_execut:[1,10],python:[1,10,15,18],qt5:15,qtbase5:15,qtchooser:15,qtcreator:[13,19],quad:7,quadrangular:7,quadrilater:7,queri:[2,7],quickli:46,quot:[1,19],rad:48,radian:[3,48],radiant:30,radio:37,radiointerfac:2,radiu:[2,31,37],radius:2,rail:[31,43,49],raini:32,rais:[2,20],ram:14,ramer:7,ran:19,random:[6,12,23,29,30,32,37,42,47],randomli:[32,37],randomparamet:[29,34],randomse:[1,32,42],rang:[0,1,2,32,34,40,42,43,47,48],rate:[2,7,30,32,46],ratio:2,reach:[2,5,32,42],reachabl:[2,30],reachpositioncondit:30,react:2,read:[2,11,19,34,37,40,42,48],readabl:9,readm:15,real:[2,9,21,23,48],realist:45,realiz:7,rear:[3,7,42,48],reason:[1,30,42,43],receiv:[7,48],receivercar2x:[2,45],recent:[11,15,20],recogn:19,recommend:[1,10,11,13,14,15,16,19,20,23,35,47,48],recompil:20,reconfigur:11,record:23,recur:5,red:[2,7,30],reduc:[2,7,47],ref:[30,42],refer:[1,3,7,9,15,16,19,23,29,30,32,34,35,42,46,47,48],referenc:[9,16,23,29,30,31],referenceent:30,reflect:30,regard:[2,20,29,34],regex:9,regist:30,regul:[7,29],regular:[1,19,42,46],regularili:20,regularli:20,rel:[3,5,9,29,30,37,42,47,48],relai:[2,30],relat:[2,7,19,23,42,48],relativedistancefront:48,relativedistancefrontfront:48,relativeobjectposit:30,relativespeedcondit:30,relativetargetlan:30,relativetargetspe:30,releas:[10,11,15,16,19,20],relev:[10,34,40,41,49],reli:20,relinquish:48,reload:11,remain:[2,37],remaind:7,remov:[2,9,15,19,35,49],removeag:30,removeagentsmanipul:30,render:15,repeat:[15,31,43,49],replac:[1,9,48],repo:[9,15,30],report:[1,11,19,20],report_path:1,repositori:[1,9,11,15,16,18,32,43,49],repository_run_000:43,repository_run_00:43,repository_run_xxx:49,repres:[37,45,49],represent:[2,7,20,21],reproduc:37,repuls:46,request:[1,2,11],requir:[1,2,6,7,9,10,11,12,13,15,16,18,19,23,29,30,31,34,36,41,46,47,48,49],requiredpercentageofvisiblearea:48,requri:47,rerol:32,resembl:46,resid:9,resimul:37,resist:2,resolut:[11,19],resolv:[2,9,11,15,16],resourc:1,resources_path:1,resp:10,respect:[3,6,7,15,20,23,30],respons:[2,34,45,47],responsibili:2,restart:[11,15],restrict:[1,9,16,29,30,47],restructuredtext:9,result:[2,3,5,6,7,9,10,19,23,25,30,35,43,44,48,49],result_pcm:37,resum:15,retain:7,retriev:[1,2,7,11,18,37],review:46,revmajor:31,revminor:31,rewrit:21,rho_:2,right:[3,5,7,11,15,16,29,30,31,41,47,48,49],rightlaneend:7,rightlaneonli:[6,47],rightmost:[6,48],rightofwaybegin:7,rightofwayend:7,rightofwaynextintersect:7,rise:30,road:[0,20,21,23,30,31,32,42,43,46,47,48],road_id:30,roadcoordin:7,roadcurvature_:48,roaddirect:30,roadid:[30,47],roadmark:[7,31],roadnetwork:31,roadposit:[32,42],roadsidemarkerpost:31,roadsign:7,roadstream:47,roll:[2,4,15,29,30,31,32],root:[7,9,11],rotat:[2,3,42],roughli:[2,45],rout:[7,30,32,47,48],routecatalog:30,routingact:30,row:40,rpm:2,rst:[9,12],rstfile:9,rtd:15,rule:[9,29,30,34],run:[1,5,9,10,11,12,13,14,15,16,19,23,30,31,32,37,42,43,44,47,49],runid:42,runner:[1,11],runresult:42,runstatist:1,runtim:[5,7,11,16,19,30,32,33,47],runtimespawn:[0,45],s_max:7,s_min:7,safeti:[12,21,23],sai:11,said:32,same:[1,2,7,18,23,29,30,32,33,34,36,42,47,48],sampl:[0,2,23,33,42,44,47],sample_nam:42,satisfactori:46,satisfi:30,savannah:20,save:35,scale:[2,29,37],scan:7,scenario:[19,21,23,24,26,29,31,36,42,47,48],scenarioag:30,scenarionam:48,scenarioobject:30,scenariospawn:45,scenaro:43,scenegraphfil:30,sceneri:[6,7,23,26,30,42,43,47,48,49],sceneryconfigur:[9,30,31,49],schedul:[0,2,34],schedulertask:5,schema:[30,33,34],schemavers:32,scoordin:47,scope:[1,15,34,45],scratch:20,screen:35,scrollabl:40,seam:9,search:[11,19,43],second:[11,15,19,20,30,32,35,41,42,47,48,49],secondari:43,secondarydrivertask:34,secondarylan:[32,42],secondparamet:29,section:[1,2,7,8,9,11,15,16,17,20,23,29,30,32,34,42,49],sector:2,secur:1,sed:15,see:[1,2,7,9,10,11,12,15,16,17,18,20,21,23,29,30,32,34,35,38,41,42,44,48,49],seed:[23,32,37,42],seem:10,seen:[23,48],segment:35,seldom:1,select:[2,6,11,23,29,30,32,36,37,38,40,41,47,48],selector:[11,30],selecttriggeringent:30,semicolon:[1,19,40,41],send:[2,34,47,48],sendaccelerationen:2,sender:48,sendercar2x:34,sendpositionxen:2,sendpositionyen:2,sendvelocityen:2,sendyawen:2,sens:[23,44],sensit:48,sensor0_detectedag:1,sensor:[0,2,20,23,32,34,36,42,48,49],sensor_driv:[0,34],sensor_osi:[0,3,34],sensoraggreg:34,sensoraggregation_osi:34,sensordata:[0,2,34,48],sensordatasign:[2,48],sensordriv:[2,34],sensorfus:34,sensorfusion_errorless:3,sensorfusionerrorless:34,sensorfusionerrorless_osi:34,sensorfusionlane_:48,sensorfusionnumberofdetectingsensors_:48,sensorfusionobjectid_:48,sensorfusionosi:0,sensorfusionrelativenetleft_:48,sensorfusionrelativenetright_:48,sensorfusionrelativenets_:48,sensorfusionrelativenetx_:48,sensorfusionrelativenety_:48,sensorfusionrelatives_:48,sensorfusionrelativet_:48,sensorfusionvelocity_:48,sensorfusionvelocityx_:48,sensorfusionvelocityy_:48,sensorfusionyaw_:48,sensorgeometric2d:[0,45],sensorid:29,sensorlink:29,sensorobjectdetector:34,sensorrecordst:34,sensorrecordstatemodul:34,sensorview:[2,3,48],sensorviewconfig:48,sensorviewconfigrequest:48,sensorviewconfigur:2,sent:[2,34,48],separ:[1,7,9,18,19,20,23,30,32,37,40,41,43,46,47,48,49],sequenc:[0,1,5,30,42,47],serial:20,serv:23,set:[1,2,3,6,8,9,12,13,15,16,19,20,21,23,29,30,32,34,37,42,43,44,46,47,48,49],set_properti:9,setcomponentst:30,setup:[6,11,13,14,23,30,32],setupcommand:11,setx:11,sever:[2,7,12,18,19,20,30,32,45,47],shadow:2,shall:[1,6,9,15,18,19,26,29,30,37,40,44,48],shape:[29,30],share:[4,15,16,18,19],shell:[0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31,32,33,34,35,36,37,38,39,40,41,42,43,44,45,46,47,48,49,50],shift:[1,11,37,41],shorter:2,shot:35,should:[1,2,10,11,12,16,18,20,23,30,34,42,45,47,48,49],show:[5,7,11,13,15,18,23,40,42],shown:[1,2,19,20,38,40,41,48],side:[3,7,47],sight:2,sigma:[29,47],sign:[0,23,29],signal:[0,5,30,31,34,42,48],signalpriorit:[0,34],signalstrength:[2,48],sim:[1,9,11,30,48,49],similar:[1,10,21],simopenpass:[10,11,12,15,16,18,42],simpl:[2,11,16,18,29,46],simpli:[9,18,19,23,35],simplifi:[15,30,46],simul:[1,2,6,7,9,10,12,13,14,15,16,19,21,23,24,25,27,29,30,31,32,34,36,38,42,44,46,47,48],simulation_ex:1,simulationconfig:[23,26,29,49],simulationoutput:[1,23,32,49],simulationtimecondit:30,simulink:48,sinc:[2,3,5,20,34],singal:2,singl:[1,2,9,12,14,15,19,29,30,32,42,43],sinusoid:30,sit:23,situat:[12,15,19,21,23,44],size:[2,20,48],skip:[1,2,19,32,43],slash:9,slength:47,slow:[2,46],slower:20,small:[2,46],smaller:[2,7,44],snippet:[9,46],snowi:32,soffset:[7,31],softwar:[12,13,15,20,23],solid:[7,31,43],solut:[6,11],some:[1,9,10,11,15,19,20,23,30,31,42,46,47,49],sometim:1,sort:[5,9,48],sourc:[0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,16,17,18,19,21,22,23,24,25,26,27,28,29,30,31,32,33,34,35,36,37,38,39,40,41,42,43,44,45,46,47,48,49,50],south:31,space:[14,18,40,41],span:7,spawn:[0,5,30,43,47,49],spawnarea:47,spawncoordin:47,spawner:[0,5,23,28,29,45,49],spawnerprerun_highway_entryexit:6,spawnerprerun_highway_fullstream:6,spawnerprerun_highway_incorrectstreambegin:6,spawnerprerun_highway_incorrectstreammid:6,spawnerprerun_highway_roadoverlap:6,spawnerprerun_highway_singleroad:6,spawnerprerun_singleroad_drivingdirect:6,spawnerprerun_singleroad_rightlaneonli:6,spawnerprerun_singleroad_specifiedlan:6,spawnerprerun_singleroad_specifiedrang:6,spawnerpreruncommon:32,spawnerpreruncommonparameterextractor_extractspawnareas_alloptionalparamet:6,spawnerpreruncommonparameterextractor_extractspawnareaswithsoutofrange_returnsvalid:6,spawnerpreruncommonparameterextractor_getwaytonextroad_nopossiblewai:6,spawnerruntime_highway_multipleroad:6,spawnerruntime_highway_singleroad:6,spawnerruntime_highway_singleroad_drivingdirect:6,spawnerruntime_singleroad_rightlaneonli:6,spawnerruntime_singleroad_specifiedlan:6,spawnerruntimecommon:32,spawnerruntimecommon_osi:47,spawnerruntimecommonparameterextractor_extractminimumseparationbuffer_fixedvalu:6,spawnerruntimecommonparameterextractor_extractminimumseparationbuffer_novalue_setsdefault:6,spawnerscenario:32,spawnpoint:[30,47],spawnpointpreruncommon:49,spawnpointruntimecommon:49,spawnpointscenario:49,spawnzon:47,spdx:[9,22],special:[9,15,29,30,34,42,49],specif:[1,2,4,7,11,12,14,15,16,18,20,23,29,30,32,37,42,48,49],specifi:[1,2,9,15,16,18,19,21,23,29,30,32,35,36,47,48,49],speed:[1,2,29,44,46,48],speedactiondynam:30,speedactiontarget:30,speedlimit:7,speedlimit_:48,speedlimitzonebegin:7,speedlimitzoneend:7,speedtargetvaluetyp:30,spell:15,sphinx:[9,15,19],sphinx_execut:9,sphinxcontrib:15,spiral:31,split:[1,5,43],spreadsheet:48,sqrt:46,src:[11,15],ss_:48,sstart:47,stabl:18,stack:7,stage:11,stai:[2,11],stakehold:23,stand:12,standalon:1,standard:[7,11,19,20,21,23,29,30,31,48],standingag:30,start:[6,9,11,12,15,16,20,30,32,35,42,43,47,48,49],startcondit:1,starttrigg:30,startup:11,state:[0,4,5,7,16,29,34,42,44,46,49],stati:2,staticosmpsensordatatotrafficupdatestepp:48,stationari:[4,43],stationaryobject:43,statist:[2,36,39,42],stddeviat:30,steer:[2,34,36,46,48],steeringangl:[32,42],steeringsign:48,steeringsignal_steeringwheelangl:48,steeringwheelego:48,step:[1,2,3,5,7,9,10,11,13,15,16,18,19,20,23,30,34,35,42,47,48,49],stick:20,still:[10,11,12,18,20,23,35,48],stochast:[0,23,29,30,34,47,49],stop:[2,7,37,42,48],stopatentri:11,stopreason:[1,42],stoptim:[1,42],storag:[15,20],store:[1,7,30,42],stori:[1,23,42],str:1,straight:7,strang:[16,23],stream:[7,15],strength:[2,48],strictli:16,string:[1,9,19,29,30,32,34,42,43,46,47,48],stringparamet:[29,34],stringsign:30,stringvector:[29,32,42,47],strip:1,structer:19,structur:[2,9,13,15,16,20,31,38],studi:[21,23],studio:[8,13,19],stvo:7,sub:30,subdirectori:16,subel:29,subfold:[40,41,48],submodul:2,subsequ:[40,46],subset:[23,30,34],subst:16,substitut:29,subtract:[3,30,46],subtyp:[7,43],succeed:1,success:[1,7,35,42],success_r:1,successfulli:[15,16,23,49],successor:[7,31,32],sudo:15,suffer:16,suffic:2,suggest:15,suit:12,suitabl:[2,15,21],suiteabl:10,sunni:32,superset:[2,23],supplement:21,supplementari:7,support:[1,5,7,11,12,15,17,20,21,23,29,30,31,36,42,43,48],sure:[9,11,15,16,36,45],surfac:2,surround:[2,49],suu:15,svg:2,symbol:[2,48],syncglobaldata:5,synchron:[5,48],syncron:5,syncworld:5,syntax:[15,34],system:[0,7,11,12,13,15,16,19,21,23,25,29,34,37,48,49],systemconfig:[5,23,26,29,34,36,48],systemconfigblueprint:[2,23,26,29,33,42,49],systemconfigfmu:1,syuu:15,tab:[15,41],tabl:[5,14,34,41,46,48],tackl:23,tag:[1,7,15,29,30,31,32,42],take:[2,6,19,30,47,48],taken:[1,2,4,30,37],tangent:2,tangenti:2,target:[7,9,13,26,30],target_object:23,task:[0,2,7,18,48],tcoordin:[30,32,42],tech:9,technolog:23,teleportact:30,temp:11,templat:9,temporari:[9,10,15,48],term:[9,22,23,46,47],termin:[11,15,32],test:[2,6,10,11,12,13,14,15,16,18,20,23,49],test_:1,test_end_to_end:1,test_fil:1,testfil:31,testmat:11,texliv:15,text:[2,7,11,15,37,48],tgap:47,tgapwish:46,than:[2,6,7,18,46,48,49],the_kei:32,the_observation_librari:32,the_valu:32,theact:1,thei:[5,6,11,20,23,30,32,33,34,37,42,45,47,49],them:[2,4,15,18,21,34,42,48],themaneuv:1,theme:15,therebi:[2,7,9,20,23,44],therefor:[2,5,10,11,16,23,30,33,37,49],thesequ:1,thestori:1,thi:[1,2,3,4,5,7,8,9,10,11,12,13,15,16,18,19,20,22,23,29,30,31,32,34,35,36,37,38,40,41,42,43,44,45,46,47,48,49],thing:[11,45],third:[15,16,20,41],thirdparti:[11,13,15,16,19],those:[20,23],three:[1,2,3,15,30,35,41,48],threesignalstrafficlight:42,threshold:[2,6,48],through:[9,11,13,19,23,45,49],throughout:47,thrown:18,thu:[1,9,14,31,49],thw:30,time:[2,4,5,12,15,18,19,21,23,29,30,32,34,41,42,46,47,48,49],timeheadwaycondit:30,timeofdai:32,timeplot:39,timerefer:30,timestamp:[5,48],timestep:[1,2,4,5,32,42,47,48],timetocollis:1,timetocollisioncondit:30,timetocollisionconditiontarget:30,tmp:11,toc:9,togeth:[23,43],toler:30,too:[2,7,15,19,42],tool:[1,6,10,11,12,15,16,20,21,44],top:[23,31],topic:[15,20],topmost:44,torqu:2,total:[2,7,42],totaldistancetravel:[1,32,42],touch:[7,30],toward:46,town:7,townbegin:7,townend:7,trace:[12,32,42,48],track:[41,42],track_id:41,tradition:21,traffic:[0,12,20,21,23,29,30,44,46,47,49],traffic_light_st:42,trafficag:15,trafficcalmeddistrictbegin:7,trafficcalmeddistrictend:7,trafficcommand:[30,48],trafficgroup:[29,45],trafficlight:[0,42],trafficlightcontrol:42,trafficrul:32,trafficsign:[7,30],trafficsignalcontrol:30,trafficsignalid:30,trafficsignalst:30,trafficsimul:25,trafficupd:48,trafficvolum:47,trajectori:[2,34,36,37,38,41,48,49],trajectorya:30,trajectorycatalog:30,trajectoryfil:48,trajectoryfollow:2,trajectoryfollowingmod:30,trajectorymanipul:2,transform:[1,7,48],transformlist:48,transit:[7,9,30],translat:[3,7],transmiss:2,travel:[7,42,48],treat:15,tree:[7,9,15,38],treeview:40,treiber:46,tri:20,triangl:2,trig:30,trigger:[1,5,11,23,30,32,34,42,47,48,49],triggeringent:[1,30,42],triggeringentitiesrul:30,troubl:10,truck:30,truth:[20,23],ttc:[6,21,30,47,48,49],ttc_event:1,tunabl:48,turn:[2,9,30,32],turningr:32,tutori:[12,13,23,35,50],tutorialspoint:19,two:[1,2,3,4,6,7,9,15,29,34,36,40,41,42,44,47,48,49],txt:[1,9,10,18],type:[0,1,2,4,7,10,11,19,29,30,31,32,34,35,42,43,46,47,48],typic:[19,23,47],ubuntu:[14,15],uhd:14,ultim:7,unabl:1,und:[7,49],undefin:[47,48],under:[1,9,10,11,15,16,19,22,44,47,49],underli:[7,14],underscor:9,understand:[15,23],understood:[7,35],unfamiliar:15,unfortunatli:10,uniform:[6,7],uniformdistribut:29,uniqu:[21,30,37],unit:[2,6,7,11,16,19,20,21,29,34,46,47,48],unix:[11,15,21],unix_command:19,unless:[19,43],unlik:30,unlimit:30,unrel:30,unsign:32,unsort:2,unspecifi:5,untest:6,until:[2,23,32],unus:[3,32,48],unziponceperinst:48,upcom:18,updat:[2,4,5,11,15,34],updateoutput:34,upgrad:15,upload:7,upon:48,upper:2,upperbound:30,upward:7,usag:[1,9,11,12,15,19,30],use:[1,2,3,9,10,11,12,14,15,16,18,19,20,23,29,30,32,35,42,47,48],use_ccach:16,use_extend:19,use_extended_osi:19,usecas:37,used:[2,6,7,9,10,11,14,15,18,19,20,21,23,29,30,34,35,36,37,38,40,41,42,46,47,48,49],useful:[18,19,49],user:[1,2,18,19,23,30,34,35,36,37,44,48,49],user_guid:12,userdefin:2,uses:[1,2,3,4,5,9,11,15,19,20,29,32,34],using:[1,3,6,9,10,11,15,18,19,20,21,23,29,30,35,37,40,42,48],usr:[11,15,16],usual:4,util:[14,15,21],valid:[2,7,23,47,48],validlength:31,valu:[1,2,3,5,6,7,11,19,23,29,30,32,34,37,42,43,46,47,48],vanish:46,var_00001:37,var_nam:48,vari:[15,29],variabl:[1,7,10,11,13,15,16,17,20],variant:30,variat:[23,44,49],varibl:19,varieti:7,variou:[2,9,20,21,23,30,49],varnam:48,vector:[2,7,47,48],vectori:3,veh:2,vehicl:[0,3,21,23,29,30,34,36,37,42,45,46,47,48,49],vehicleattribut:42,vehiclecatalog:[23,29],vehiclecommunicationdata:[20,48],vehiclecompon:[2,28,34,45],vehiclecomponentprofil:48,vehiclecomptocompctrlsign:2,vehicledynamicscontrol:34,vehiclemodel:29,vehiclemodelcatalog:23,vehiclemodelparamet:2,vehiclemodelscatalog:[23,30,49],vehiclemodeltyp:[1,42],vehicleprofil:48,veloc:[1,2,3,30,37,41,42,46,47,48,49],velocityego:[1,32,42,48],velocityfront:48,velocityfrontfront:48,velocitywish:46,verbos:[1,9],veri:[2,14,44],verifi:6,verkehrstechnik:7,verkehrszeichen:7,version:[9,11,12,16,18,19,31,43,46],vertex:30,vertic:[30,42],via:[2,7,11,15,16,19,20,30,34,48],view:[20,28],vim:15,virtual:[5,7,21],visibilityact:30,visibilitydist:[1,32,42],visibl:[2,30,42,48],visit:18,visual:[0,8,13,19,23,25,32,38,42,43,48],visualstudio:11,volum:[44,49],vscode:[11,19],vufo:21,w64:[11,15,21],wai:[6,9,11,12,13,15,18,29,30,42,46,47,48],want:[1,2,23,49],warn:[15,20,23,37,48],waypoint:30,weather:32,websit:[15,48],weight:[7,31,32,47],well:[11,14,20,21,23,29,30,34,42,48,49],were:[6,18,42,47],west:31,what:[11,12,18,23,30,37,42],wheel:[2,36,46,48],when:[1,2,5,6,7,9,10,11,15,16,19,23,30,34,35,37,42,44,48,49],whenev:[1,5],where:[1,2,3,10,11,16,18,23,30,35,37,47,48,49],wherea:[7,35,47],wherebi:7,whether:[1,2,4,7,42,47,48],which:[1,2,3,4,5,6,7,9,10,11,12,15,16,18,19,20,21,22,23,29,30,31,32,34,35,36,37,40,42,43,44,45,46,47,48,49],white:40,whitespac:15,who:[12,23,42],whole:[2,6,15,23,46,47,48],whose:[3,21],why:[19,42],width:[3,7,31,42,48],widthfront:48,wikimedia:7,wikipedia:7,wildcard:9,win64:[11,19],window:[1,10,11,13,14,15,16,18,19,20,21],wish:[18,46],with_:11,with_api_doc:9,with_debug_postfix:16,with_doc:[9,16],with_endtoend_test:10,with_extended_osi:15,with_gui:9,withag:1,within:[1,2,5,7,10,11,15,16,21,23,30,31,32,43,47,48,49],without:[2,7,14,19,20,23,32],won:[1,11,37],word:[23,30,43],work:[0,1,2,3,4,5,6,7,8,9,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31,32,33,34,35,36,37,38,39,40,41,42,43,44,45,46,47,48,49,50],workspac:11,workspacefold:11,workspaceroot:11,world:[0,2,4,5,20,23,30,32,42,45,47,48,49],world_osi:[0,15,32],worldinterfac:48,worldlibrari:32,worldposit:30,would:[1,2,9,11,18,23,35,44],wrap:20,wrapper:[30,45],write:[2,5,9,12,15,32,42,43,50],writejson_:48,writejson_sensordata:48,writejson_trafficupd:48,writepersistentent:[32,43],writetrace_:48,writevalu:48,written:[3,9,20,30,37,42,43,48,49],www:[7,9,19,20,21,22],x64:[11,14],x86_64:[11,15],x_max:7,x_min:7,xml:[1,2,23,29,30,32,35,36,42,48,49],xodr:[9,30,31,49],xosc:[23,30,32,49],xpath:1,xposit:[32,42],xyz:1,y_max:7,y_min:7,yaw:[2,7,29,42,48],yawangl:[32,42],yawego:48,yawfront:48,yawrat:[32,42],yellow:[2,7,30],yes:[5,11,32,47],yet:[1,13,15,20,23,26,49],yield:41,you:[1,11,13,15,16,18,19,20,23,35,36,37,43,49],your:[8,9,10,11,13,15,16,19,20,23,35],yposit:[32,42],zero:[30,43],zip:48,zipper:29,zippermerg:29,zlib1g:15,zlib:16,zoffset:31,zone:30,zziplib:15},titles:["Simulator","EndToEnd Test Framework","Agent Components","Coordinate Systems","EventDetector","Simulation","Spawner Features","World_OSI","IDE Support","Documentation Concept","Working with Qt Creator","Working with Visual Studio Code","OpenPASS Documentation","Getting Started","System Requirements","Installing Prerequisites","Installing OpenPASS","Further Guidance","Building with Conan","CMake Variables and Options","External Dependencies","Glossary","License","Overview","Tutorials","GUI Plugins","Configs in Depth","Outputs in Depth","Simulator","ProfilesCatalog","Scenario","Scenery","SimulationConfig","Static SystemConfig","SystemConfigBlueprint","Project","System Editor","PCM Simulation","PCM Evaluation","Result Visualization","Statistics","TimePlot","Observation_Log","Observation_EntityRepository","Overview","Component View","Driver","Spawner","VehicleComponents","Scenario-based simulation","PCM Simulation"],titleterms:{"case":2,"export":18,"function":2,"import":42,"static":33,IDE:8,IDs:6,Ids:34,Used:2,Useful:20,Using:1,acquir:30,across:6,action:30,action_longitudinaldriv:2,action_secondarydriv:2,actor:30,addit:18,advanc:12,aeb:48,agent:[2,3,6,30,42],agentcompon:34,agentprofil:[29,30],agentupdat:2,algorithm_later:2,algorithm_longitudin:2,algorithmagentfollowingdrivermodel:46,algorithmcar2xsend:2,also:19,altern:10,append:15,argument:5,assumpt:11,audienc:23,base:49,basic:[1,7,9],between:3,binari:[15,20],boost:20,boundari:6,buffer:[6,20],build:[9,11,15,18,19],catalog:30,causal:48,ccach:20,chang:30,channel:34,cmake:[10,11,19,20],cmake_build_typ:19,cmake_c_compil:19,cmake_cxx_compil:19,cmake_install_prefix:19,cmake_object_path_max:19,cmake_prefix_path:19,cmake_with_debug_postix:19,code:11,collect:20,collis:6,collisiondetector:4,command:[5,19],compil:20,compon:[2,29,30,45],componentcontrol:2,conan:18,concept:9,condit:30,config:26,configur:[1,11,37],consecut:6,control:46,convers:3,coordin:3,creat:18,creator:10,csv:43,custom:17,cyclic:42,cyclics_run_:42,datatyp:1,debug:11,debugg:20,defaultcustomcommandact:30,definit:42,depend:[20,48],depth:[26,27,45],descript:5,dev:1,develop:12,direct:6,distribut:6,document:[9,12,15],doxygen:20,drive:6,driver:[29,46],dynamics_collis:2,dynamics_regulardriv:2,dynamicstrajectoryfollow:48,editor:36,endtoend:1,entiti:30,environ:[15,32],evalu:[38,40,41],event:[1,42],eventdetector:4,exampl:[1,29,31,32],execut:[1,5,19],exist:6,experi:[32,37],explicit:1,extern:20,featur:6,file:[42,43],filter:1,fmi:20,fmil:[15,20],fmu:48,fmu_wrapp:30,folder:37,follow:30,followrouteact:30,framework:[1,20,23],full:[31,32],further:17,gcc:20,gdb:20,gener:[18,19,35],geometri:7,get:[13,23],getobstruct:7,git:15,glossari:21,gnu:20,googletest:20,group:6,gui:[23,25],guid:12,guidanc:17,handl:2,hint:20,includ:6,inform:[12,20],init:30,input:[23,37],insid:2,instal:[11,12,15,16,18,19],install_extra_runtime_dep:19,install_system_runtime_dep:19,intellisens:11,intend:23,interact:23,interfac:20,issu:10,junction:6,kit:[10,11],lane:[6,7],lanechang:30,later:46,librari:[15,20],licens:22,limiteraccelerationvehiclecompon:2,line:5,linux:10,load:[37,38,40,41],local:7,locat:15,logginggroup:42,longitudin:46,make:19,maneuv:30,mark:7,mechan:9,messag:30,method:10,minizip:15,modelon:20,msys2:[10,11],multipl:6,non:6,note:[1,20],observ:32,observation_entityrepositori:43,observation_log:42,obstruct:2,onli:[6,18,30],open:20,openpass:[9,12,16,18],openpass_adjust_output:19,openscenario:1,openscenarioact:2,option:19,osi:[15,20],osmp:30,other:12,output:[23,27,35,37,42,43],outsid:6,overlap:6,overview:[2,23,30,44],packag:[15,20],paramer:42,paramet:[6,34],parameterdeclar:30,parameters_vehicl:2,parametr:43,path:[11,35],payload:1,pcm:[37,38,50],pedestriancatalog:30,phase:5,plugin:25,posit:30,prerequisit:[1,15,18],prerunspawn:[6,47],primer:23,prioriti:[5,34],profil:6,profilegroup:29,profilescatalog:[29,32],project:[10,35],protobuf:[15,20],protocol:20,queri:1,rang:6,readvalu:48,receivercar2x:48,recip:18,relativelaneposit:30,relativespe:30,remov:30,repository_persist:43,repository_run_:43,requir:14,restrict:31,result:[1,37,38,39,40,41],right:6,road:[3,6,7],roadnetwork:30,roadposit:30,runstatist:42,runtimespawn:[6,47],sampl:7,save:37,scenario:[30,32,49],scenariospawn:47,sceneri:31,schedul:5,see:19,send:6,sensor:[3,29],sensor_driv:2,sensor_osi:2,sensordata:3,sensorfusionosi:2,sensorgeometric2d:[2,48],separ:6,sequenc:7,set:[10,11,35],setup:10,sign:7,signal:2,signalpriorit:2,simul:[0,5,20,28,35,37,49,50],simulationconfig:32,simulationoutput:42,simulationtim:30,singl:6,slength:6,sourc:[15,20],spawn:[1,6],spawner:[6,32,47],spawnerprofil:29,specifi:6,speedact:30,ssh:15,sstart:6,start:[13,23,37],state:[2,30],statist:40,stochast:6,stoptrigg:30,stori:30,storyboard:30,stream:6,structur:37,studio:11,submodul:9,support:8,syntax:1,system:[3,14,36],systemconfig:33,systemconfigblueprint:34,target:[11,19],task:5,test:[1,19],tgap:6,thirdparti:18,through:15,time:[1,6],timeheadwai:30,timeplot:41,timetocollis:30,todo:[10,12,42,50],todolist:12,topic:12,traffic:[6,7],trafficgroup:47,trafficlight:7,trafficrul:29,trajectori:30,transit:1,troubleshoot:11,tutori:24,type:5,use_ccach:19,useddefinedact:30,user:[11,12],userdefinedact:30,variabl:[19,48],variat:37,vehicl:2,vehiclecatalog:30,vehiclecompon:[29,48],vehiclemodel:30,vehicleprofil:29,veloc:6,version:[10,15,20],view:45,visual:[2,11,39],wildcard:42,win_onli:11,with_api_doc:19,with_coverag:19,with_doc:19,with_endtoend_test:19,with_extended_osi:19,with_gui:19,with_protobuf_arena:19,with_simcor:19,with_test:19,within:6,work:[10,11],workflow:23,world:[3,7],world_osi:7,wrapper:48,write:48,zlib:15}}) \ No newline at end of file +Search.setIndex({docnames:["advanced_topics/20_simulator_advanced","advanced_topics/30_testing","advanced_topics/simulator/agent_components","advanced_topics/simulator/coordinate_systems","advanced_topics/simulator/event_detector","advanced_topics/simulator/scenario_actions","advanced_topics/simulator/simulation","advanced_topics/simulator/spawner_features","advanced_topics/simulator/world_osi","developer_information/10_ide_support","developer_information/20_documentation","developer_information/30_coding_conventions","developer_information/ide_support/20_qt_creator","developer_information/ide_support/30_vscode","index","installation_guide/10_getting_started","installation_guide/15_system_requirements","installation_guide/20_install_prerequisites","installation_guide/30_install_openpass","installation_guide/50_further_guidance","installation_guide/60_conan","installation_guide/further_guidance/10_cmake","other_information/10_external_dependencies","other_information/20_glossary","other_information/30_gui_plugins","other_information/40_license","other_information/gui_user_guide/10_projects","other_information/gui_user_guide/20_system_editor","other_information/gui_user_guide/30_pcm_sim","other_information/gui_user_guide/40_pcm_eval","other_information/gui_user_guide/50_result_visualization","other_information/gui_user_guide/result_visualization/10_statistics","other_information/gui_user_guide/result_visualization/20_timePlot","user_guide/10_overview","user_guide/20_tutorials","user_guide/30_configs_in_depth","user_guide/40_outputs_in_depth","user_guide/50_scenario_simulation","user_guide/configs/profilescatalog","user_guide/configs/scenario","user_guide/configs/scenery","user_guide/configs/simulationconfig","user_guide/configs/staticsystemconfig","user_guide/configs/systemconfigblueprint","user_guide/outputs/observation_log","user_guide/outputs/observation_repository","user_guide/sim_user_guide/10_overview","user_guide/sim_user_guide/20_components","user_guide/sim_user_guide/components/driver","user_guide/sim_user_guide/components/dynamics_scenario","user_guide/sim_user_guide/components/spawner","user_guide/sim_user_guide/components/vehicle","user_guide/tutorials/10_scenario_simulation","user_guide/tutorials/20_pcm_simulation"],envversion:{"sphinx.domains.c":2,"sphinx.domains.changeset":1,"sphinx.domains.citation":1,"sphinx.domains.cpp":3,"sphinx.domains.index":1,"sphinx.domains.javascript":2,"sphinx.domains.math":2,"sphinx.domains.python":2,"sphinx.domains.rst":2,"sphinx.domains.std":2,"sphinx.ext.todo":2,sphinx:56},filenames:["advanced_topics/20_simulator_advanced.rst","advanced_topics/30_testing.rst","advanced_topics/simulator/agent_components.rst","advanced_topics/simulator/coordinate_systems.rst","advanced_topics/simulator/event_detector.rst","advanced_topics/simulator/scenario_actions.rst","advanced_topics/simulator/simulation.rst","advanced_topics/simulator/spawner_features.rst","advanced_topics/simulator/world_osi.rst","developer_information/10_ide_support.rst","developer_information/20_documentation.rst","developer_information/30_coding_conventions.rst","developer_information/ide_support/20_qt_creator.rst","developer_information/ide_support/30_vscode.rst","index.rst","installation_guide/10_getting_started.rst","installation_guide/15_system_requirements.rst","installation_guide/20_install_prerequisites.rst","installation_guide/30_install_openpass.rst","installation_guide/50_further_guidance.rst","installation_guide/60_conan.rst","installation_guide/further_guidance/10_cmake.rst","other_information/10_external_dependencies.rst","other_information/20_glossary.rst","other_information/30_gui_plugins.rst","other_information/40_license.rst","other_information/gui_user_guide/10_projects.rst","other_information/gui_user_guide/20_system_editor.rst","other_information/gui_user_guide/30_pcm_sim.rst","other_information/gui_user_guide/40_pcm_eval.rst","other_information/gui_user_guide/50_result_visualization.rst","other_information/gui_user_guide/result_visualization/10_statistics.rst","other_information/gui_user_guide/result_visualization/20_timePlot.rst","user_guide/10_overview.rst","user_guide/20_tutorials.rst","user_guide/30_configs_in_depth.rst","user_guide/40_outputs_in_depth.rst","user_guide/50_scenario_simulation.rst","user_guide/configs/profilescatalog.rst","user_guide/configs/scenario.rst","user_guide/configs/scenery.rst","user_guide/configs/simulationconfig.rst","user_guide/configs/staticsystemconfig.rst","user_guide/configs/systemconfigblueprint.rst","user_guide/outputs/observation_log.rst","user_guide/outputs/observation_repository.rst","user_guide/sim_user_guide/10_overview.rst","user_guide/sim_user_guide/20_components.rst","user_guide/sim_user_guide/components/driver.rst","user_guide/sim_user_guide/components/dynamics_scenario.rst","user_guide/sim_user_guide/components/spawner.rst","user_guide/sim_user_guide/components/vehicle.rst","user_guide/tutorials/10_scenario_simulation.rst","user_guide/tutorials/20_pcm_simulation.rst"],objects:{},objnames:{},objtypes:{},terms:{"000":[8,40],"0000000000000000e":40,"000177":4,"0002177":48,"001":[8,51],"0028500000000000066":40,"003":40,"011":8,"015":2,"100":[1,2,39,40,43,44],"1000":50,"10000":1,"100000":45,"100001":45,"100002":45,"100003":45,"100004":45,"100005":45,"100006":45,"100007":45,"100008":45,"100009":45,"100010":45,"1000208":28,"1004":8,"100m":8,"101":2,"102":2,"103":44,"10310u":16,"105":50,"1067":51,"10_quickstart":10,"10_scenario_simul":14,"110":39,"120":[11,43],"12204699500415":40,"123":41,"125":41,"1350":2,"1415":[11,39],"143":40,"1472558076":39,"148":[14,44],"149":[12,14,43],"150":[2,43],"15_prepare_thirdparti":20,"15m":8,"180":[2,39],"1805":48,"1813":43,"1824":48,"1825":4,"183":40,"199":43,"1_model_document":39,"1km":8,"1x3":1,"200":[43,44],"2000":48,"200000":45,"200001":45,"200002":45,"200003":45,"200004":45,"200005":45,"200006":45,"2007":40,"2009":8,"2009r1r2":8,"200m":8,"2013":51,"2015840166":39,"2016":4,"20200903":17,"2021":10,"2022":[17,51],"20220501":17,"204":44,"205":8,"206":8,"20_pcm_simul":14,"20_qt_creator":14,"20g":22,"20km":8,"2222222":38,"230":39,"250":[41,43],"255":21,"265":50,"267":8,"26esv":4,"270":8,"274":8,"275":8,"276":8,"277":8,"278":8,"279":8,"280":8,"281":8,"282":8,"285":40,"2928":38,"293":8,"294":8,"299":43,"300":[41,44,51],"300m":8,"301":8,"306":8,"307":8,"3083973":39,"30km":8,"310":[8,43],"311":8,"325":8,"330":[8,43],"333":8,"3333":38,"3350391612494":40,"350":[1,43],"351":43,"360":2,"398":43,"399":43,"3x1":1,"400":[41,43],"4000":40,"40612500000000096":40,"4280":40,"4285":40,"4422":40,"4468":40,"4476":40,"448":8,"449":8,"450":8,"475":50,"500":43,"5000":2,"500m":8,"5039":40,"50b":8,"50c":8,"50d":8,"5139":40,"515f156900f866e1004a53b352931547cf5a85f6":20,"531":8,"532725206":41,"570796326":39,"571":40,"620":16,"629710830536482":40,"6651848689908":40,"685":50,"694":40,"7188686309816":40,"7188686309819":40,"7453292519943295":40,"7777777":38,"800":1,"820":50,"8224":38,"88624436808436":40,"92972377559829977":40,"9323279193268":40,"9900":43,"999":[44,51],"abstract":[11,23],"boolean":[2,51],"break":52,"case":[0,1,4,8,11,26,27,28,33,38,39,44,50,51,52],"class":[2,5,11,17],"const":11,"default":[1,6,11,13,15,17,18,21,28,38,39,41,45,48,49,50,51,52],"enum":[11,51],"export":17,"final":[2,6,8,17,33,50,51],"float":[11,51],"function":[0,6,8,11,13,17,22,23,33,49,51,52],"import":[10,21,33,38,43,51],"int":[2,11,38,51],"k\u00fcc\u00fckai":51,"kgm\u00b2":51,"long":[1,2,21,33,39],"new":[2,6,11,12,14,26,28,31,33,43,49,50,52],"public":[10,11,25],"return":[8,11,39,51],"short":[11,17,18,51],"static":[2,17,27,33,35,38,40,43,51,52],"switch":[2,49],"throw":51,"true":[1,2,4,7,8,13,17,20,38,39,40,44,50,51,52],"try":[1,39,48],"void":11,"while":[2,12,38,39,48,49],AND:13,Adding:[11,31],But:[13,38],FOR:13,For:[1,2,3,8,11,12,13,17,18,20,22,26,28,31,32,33,38,39,41,43,44,46,48,51],Has:51,IDE:[14,19],IDEs:[13,21],IDs:[44,51],Ids:[4,8,39],Its:33,LTS:17,Not:[13,15],One:[2,50],Such:[26,33,39],That:33,The:[1,2,3,4,6,7,8,10,11,12,13,14,15,17,18,20,21,22,24,26,27,28,29,30,32,33,38,39,40,41,42,43,44,45,47,48,50,51,52],Then:[50,51],There:[4,8,20,21,22,26,38,39,47,48,51],These:[2,8,10,17,20,26,33,38,39,44,50,51],Use:[1,11,17,21,22],Used:[0,5,21,41,43],Will:[43,51],With:[43,51],Yes:38,_detectedag:[41,44],_persist:[41,45],_run_:[41,45],_static:[10,11],_test:13,_visibleag:[41,44],abbrevi:11,abi:51,abl:[12,13,17,18,20,26,28,51],abort:40,about:[2,11,14,15,17,20,33,41,44,45,51,52],abov:[1,2,10,11,12,17,18,26,45,51],absolut:[3,6,10,39,44,48,51],absolutetargetlan:[5,39],absolutetargetspe:39,absoultetargetspe:39,acceler:[2,3,39,43,44,48,51],accelerationego:[41,44,51],accelerationpedalposit:[41,44],accelerationpedalpositionego:51,accelerationsign:[2,43,51],accelerationsignal_acceler:51,accept:13,access:[1,4,17,51],accessmodifieroffset:11,accid:[23,33,44],accompani:[10,25],accomplish:1,accord:[2,3,4,8,11,13,18,33,38,39,40,48,51],accordingli:[4,10],account:[4,7,28,51],accumul:7,accuraci:8,achiev:[1,2,8,17,38,39],acoust:51,acquireglobalposit:43,acquireposit:39,acquirepositionact:[0,39],across:[8,11],act1:39,act:[1,8,10,21,33,39,44,47,49,50,51],action:[0,2,11,26,27,33,43,49],action_longitudinaldriv:[0,43],action_secondarydriv:0,action_secondarydrivertask:43,actionbrakesystem:47,actionlongitudinaldriv:43,actionlongitudinaldrivermodul:43,actionpowertrain:47,actionprimari:43,actionsecondarydrivertask:43,actionsecondarydrivertasksmodul:43,actionsteeringsystem:47,activ:[1,2,14,21,22,23,33,39,44,48,49,50,51,52],activecomponentchang:44,actor:5,actual:[1,2,8,21,33,39,48],ada:[2,3,23,33,38,43],adapt:[13,48],adasdriv:11,adasstatesign:2,add:[1,3,10,12,13,17,20,21,31,38,39,40,41],add_act:5,add_custom_target:10,add_path_point:5,add_trajectory_point:5,addcustomcommand:5,added:[13,17,31,39,51],adding:[11,13,41],addit:[1,4,8,10,11,12,13,17,28,38,39,40,44,47,51],addition:[28,33,38],additional_make_clean_fil:10,addtrafficcommandactionfromopenscenariotrajectori:5,adher:[8,11,39,49],adjust:[12,13,17,18,21,26,39,43,52],advanc:[23,27,33],advancedexecut:13,aeb1:51,aeb:[23,38,43,47,52],aeb_cutin:52,aebprofil:38,affect:[1,2,39,44],affectedent:[1,44],aforement:[39,46],aforment:6,after:[1,2,4,6,8,12,13,17,21,26,28,39,50,51,52],afterward:[6,8,50,51],again:[18,33,47,51],against:18,agent:[0,1,4,6,8,23,27,28,33,38,41,42,43,48,49,50,51,52],agentblueprint:11,agentblueprintinterfac:11,agentfollowingdriv:38,agentid:[1,11],agentinfront:[39,41,44],agentinterfac:[2,5,51],agentnetwork:[11,44],agentprofil:[43,50],agenttyp:1,agenttypegroupnam:[1,44],agenttypenam:[1,44],agentupdat:[0,43],aggreg:[1,2,8],ahigh:23,aim:[8,24,26,27,28,29,30],air:[2,48,51],airdragcoeffici:51,aka:8,algebra:8,algorithm:[2,8,11,27,43],algorithm_fmuwrapp:[21,22],algorithm_later:[0,43],algorithm_lateralafdm:48,algorithm_lateralvehicleafdm:43,algorithm_longitudin:0,algorithm_longitudinalafdm:[43,48],algorithm_longitudinalvehiclecompon:43,algorithm_routecontrol_implement:5,algorithm_steeringvehiclecompon:43,algorithmagentfollowingdrivermodel:[43,47],algorithmautonomousemergencybrak:43,algorithmcar2xsend:[0,43],algorithmfmuwrapp:43,algorithmlateraldriv:43,algorithmlateralmodul:48,algorithmlongitudin:2,algorithmlongitudinaldriv:43,algorithmlongitudinalmodul:48,algorithmlongitudinalvehiclecompon:43,alias:11,align:[8,11,51],alignafteroper:11,alignoperand:11,all:[1,2,3,4,6,7,8,10,11,12,13,14,15,17,18,20,21,31,32,33,35,36,38,39,40,41,43,44,45,47,49,50,51,52],allman:11,alloc:[17,21],allow:[1,2,8,10,11,13,20,23,38,39,43,51],allowshortfunctionsonasinglelin:11,almost:8,alon:14,along:[1,2,3,8,16,39,49,51],alongrout:39,alreadi:[13,17,22],also:[1,2,3,7,8,10,11,12,13,14,17,18,19,20,22,27,33,38,39,43,44,45,48,49,50,51,52],alter:39,altern:[13,42],although:[26,39,51],alwai:[2,8,39,48,49,51],among:[11,13,51],analysi:[1,7,21],anew:51,angl:[2,4,5,27,28,39,44,48,51],angular:44,ani:[2,6,8,10,11,13,20,21,26,33,38,39,50,51,52],announcehighwayexit:8,announceleftlaneend:8,announcerightlaneend:8,anoth:[4,10,13,38,39,51,52],another_kei:41,anotherprofil:38,ansgar:48,anymor:[22,28],anywher:43,api:[5,13,17,21,22,49],append:10,appendix:8,appli:[1,6,11,17,18,39,43,49,50,51],applic:[4,14,16,23,44,51],approach:[21,48,51],appropi:17,appropri:[11,50],approxim:[1,2,48],apt:[11,17,20],arbitrari:[1,7,39,51],arc:[8,40],architectur:[16,43,51],area:[2,11,29,50],areal:2,arena:[17,21],arg:[1,13,18,21],argument:[0,1,11,20,41],aris:50,arm:[2,51],around:[2,21,33,39,52],arrow:8,artifact:[1,20],arxiv:48,asam:[33,39,40,49],asam_openscenario_v1:39,ascii:10,ask:13,ass:33,assess:[14,23],assign:[2,8,39,43,44,51],assignrout:5,assignrouteact:[0,39],assist:[2,23,27,33,38],associ:[1,20,33],assum:[2,10,17,18,21,41],attempt:50,attribut:[8,38,39,40,41,43,44,45,51],audienc:35,augment:50,author:[11,51],autogener:11,autom:23,automat:[1,7,13,21],automaticdeactiv:51,autonom:[23,51,52],avail:[1,2,4,10,13,15,17,18,20,21,22,25,33,39,41,46,47,48,51,52],averag:[14,51],avg:51,avoid:[10,11,51],awar:48,awd:51,axi:[3,8,32,44,51],axl:[2,3,8,44,51],axleratio:51,back:[2,3,18,21,49,50,51],backend:[17,22],background:[31,33,47],barrier:45,barrier_01:45,base:[1,2,4,6,8,11,13,14,17,18,21,22,23,24,26,27,28,29,30,33,34,39,41,43,45,46,49,50,51],basedonstyl:11,bash:[13,17,18,23],basi:[17,52],basic:[0,2,7,13,15,20,41,44,51],basictrajectoryfollow:51,bast:[4,8],bast_2017:8,bbox:2,beam:2,becaus:[8,10,12,39,49],becom:[1,10],been:[1,17,18,22,33,51,52],befor:[1,6,10,13,17,18,22,23,26,50,51],begin:[3,4,11,26,51],beginn:33,behav:[33,39],behavior:[1,39,44,48,50,51],behaviour:51,behind:[2,4],being:[1,7,10,17,33,44,48,50],belong:[39,44],below:[1,2,4,8,10,11,16,32,41,43,44,45,48,51],best:[2,21],better:[11,13,14,17,33,44],between:[0,1,2,4,6,7,8,13,14,22,27,33,39,41,43,44,48,49,50,51],beyond:[18,22],bicycl:39,bigger:[2,51],bin:[1,13,17,18,21,52],binari:[1,20,51],binpackargu:11,binpackparamet:11,bit:[0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31,32,33,34,35,36,37,38,39,40,41,42,43,44,45,46,47,48,49,50,51,52,53],blank:39,block:[2,11],blue:[2,8],blueprint:33,bmw:38,bodi:11,bold:[8,21],book:51,bookworm:[11,16,17,20],bool:[11,38,41,44,50,51],boost:[13,17],bootstrap:6,border:40,both:[2,4,7,8,10,33,39,40,45,47,50,51],bottom:13,bound:[2,4,8,39,41,44,50,51],boundari:[2,8,22,39,51],box:[4,8,13,39,44,51],brake:[2,23,27,48,51],brakedecelerationdecliner:51,brakedecelerationincliner:51,brakelight:[41,44],brakepedalposit:[41,44],brakepedalpositionego:51,brakeresponsetimem:51,branch:[17,18],breakbeforebinaryoper:11,breakbeforebrac:11,breath:17,breviti:13,brief:11,bright:2,broadcast:2,broken:[8,40,45],brought:22,brows:29,buffer:[17,21,51],bug:11,buggi:12,build:[9,11,12,14,15,16,18,22,23,27,51],buildkit:13,built:[1,13,17,18,20,21,22,51],bulb:44,bullet:11,bundl:33,bus:39,button:28,byentiti:1,byentitycondit:39,byvaluecondit:39,c99:13,c_cpp_properti:13,c_w:2,cach:[13,20,22],calcul:[2,3,4,8,11,14,22,23,28,31,39,44,48,50,51],calculatearea:11,calculatedparamet:51,calculateroutefromwaypoint:5,calculatesinusiodallanechang:5,call:[6,8,13,17,21,23,26,33,39,44,48,51,52],camera:[38,51],can:[1,2,4,6,8,10,11,13,14,17,18,20,21,22,23,24,26,27,28,29,30,31,32,33,38,39,40,41,43,44,47,48,49,50,51,52],cannot:[1,2,8,13],cap:7,capabl:[46,52],captur:8,car1:28,car1_index:28,car2:28,car2_index:28,car2xsend:2,car:[3,4,33,50],car_bmw_3:39,car_bmw_7:[38,44],car_bmw_7_1:39,car_bmw_7_2:39,car_bmw_i3:39,car_mini_coop:39,care:[2,51],carlo:46,carri:[1,8,33],cartesian:8,cast:2,catalog:[33,51],catalogloc:39,catalognam:39,catalogrefer:39,categor:11,categori:44,caus:[13,21,44],cc_enable_arena:17,ccach:[17,21],cdot:[2,48,51],center:[3,8,23,40,44,51],centimet:8,central:33,centric:22,centripet:51,centripetalaccelerationego:51,certain:[1,10,13,38,39,44],chain:7,chanc:41,chang:[4,6,10,11,12,13,14,17,18,22,26,28,33,41,44,45,49,52],changeabl:6,channel:[2,20,23,51],chapter:[22,33,39],charact:[11,44],character:48,chart:33,chassi:51,check:[1,2,4,7,12,13,15,17,33,39,51],checker:17,checkout:[1,18,22,52],chere_invok:13,china:[8,38],china_gb_5768:8,choic:[1,17],choos:[13,26,28,29,31,32],chore:11,chosen:[28,40,41,52],circl:[2,11],circular:2,clang:[11,13,17,22],clean:10,clear:[11,13,31],clearli:10,click:[26,29,31,32,52],clock:16,clone:[10,18],close:[2,10,33,39,45],closer:44,closest:50,clothoid:8,cmake:[1,10,15,17,18,19,20],cmake_:21,cmake_binary_dir:10,cmake_build_typ:18,cmake_command:10,cmake_current_list_dir:10,cmake_echo_color:10,cmake_export_compile_command:13,cmake_find_packag:20,cmake_install_prefix:[10,17,18],cmake_lang_compil:21,cmake_make_program:13,cmake_prefix_path:[13,18],cmake_verbose_makefil:13,cmakelist:[10,12],cmakepath:13,coars:[43,46],code:[1,9,10,14,15,17,18,20,21,22,27,28,44,51],coeffici:[2,51],coexist:10,cog:23,collabor:11,collect:[1,2,23,33],collid:[1,4],collis:[1,2,4,10,13,23,33,39,51],collisiondetectionlateralboundari:51,collisiondetectionlongitudinalboundari:51,collisiondetector:0,collisionev:4,collisionmanipul:4,collisionveloc:4,collisionwithag:[1,4],color:[8,40],column:[1,31,32,44,45],columnlimit:11,com:[13,17,21,51],combin:[2,28,32],come:[8,12,14,26,41,44,45],comma:[28,31,32,51],command:[0,5,10,11,13,17,18,20,39,41],comment:[10,11,17],commentpragma:11,commerci:10,commit:20,common:[1,4,6,7,8,10,11,17,31,33,39,44,45,50,52],commonli:[2,16],commontrafficlight:5,commun:[2,14,17,43,44,51],compar:[1,2,8,29,46],comparison:[1,10],compat:[21,23,39,51],compctrlsignal_movementdomain:51,compctrlsignal_warningact:51,compctrlsignal_warningdirect:51,compctrlsignal_warningintens:51,compctrlsignal_warninglevel:51,compctrlsignal_warningtyp:51,compctrltovehiclecompsign:2,compens:48,compil:[1,12,13,14,15,17,18,20,21,51],compile_command:13,compilecommand:13,complain:17,complement:52,complet:[1,2,17,23,27,33,35,52],complex:11,complianc:17,compon:[0,5,6,11,17,21,23,27,33,37,43,44,48,51,52],componentcontrol:[0,39,43],componentcontrollerimplement:5,componentnam:38,componentport:11,componentrepositori:6,componentschannelcommunicationdiagram:2,componentst:[2,51],componentstatechang:39,componentstatechangemanipul:39,componentstatesign:2,compos:[2,33,47],composit:[33,38],comput:1,conan:[14,15],conanfil:20,concaten:[41,45],concept:[2,4,14],concis:11,concret:33,cond:48,condit:[1,6,23,33,43,44,46,50,52],conditionedg:39,conditiongroup:[1,39],cone:51,conf:10,config:[1,2,6,10,13,14,26,33,41,51,52],config_folder_1:1,config_folder_2:1,config_folder_3:1,config_folder_4:1,config_set:1,config_set_1:1,config_set_2:1,config_set_3:1,configuir:1,configur:[2,4,6,7,10,11,12,14,17,20,21,24,26,27,29,30,33,38,39,42,43,44,51,52],configurationprovid:13,configure_fil:10,configurearg:13,configureset:13,confin:2,conflict:1,conform:[33,49],conftest:1,congest:48,conjunct:[21,39],connect:[2,6,7,8,23,33,51],connectingramp:50,connector:41,consecut:45,consequ:[2,8],conserv:2,consid:[4,17,20,39,51],consider:[50,51],consist:[2,3,8,11,23,31,38,39,41,43,44,51],consol:[1,52],consolid:[41,45],constant:[2,8,10,11,39,44,48,49,51],constantli:12,constel:52,constraint:2,construct:2,consum:[22,43],contact:[4,13],contain:[1,2,4,7,8,10,11,14,15,23,26,31,32,33,38,39,41,43,44,45,50,51,52],content:[2,10,11,31,33,39,43],context:[10,11],contextu:11,continu:[8,33,39,50,51],contrib:[10,17,18,39,51,52],contribut:17,control:[1,2,8,33,39,43,44,47,49,51],controllercatalog:39,controllerswitch:43,controlstrategi:[5,49],controlstrategytyp:5,conveni:39,convent:[33,45],convers:0,convert:[2,3,8,17,51],convertscenarioabsolutetargetlan:5,convertscenariolanechangetarget:5,convertscenariorelativetargetlan:5,convertscenariotrafficdefinit:5,convex:2,cooper:38,coordin:[0,2,4,7,8,28,38,39,44,51],coordinatesystem:39,copi:[1,10,13,17,18,21,52],copy_document:10,copyright:10,core:[1,6,11,13,14,16,17,18,21,33,39,41,47,52],corner:[2,8],correct:[2,7,11,17],correctli:[13,28],correspond:[1,2,6,8,10,13,20,31,36,39,43,44,51,52],corridor:38,could:[2,21,33,38,51],count:[1,28],counter:11,counterclockwis:3,countri:38,cover:[2,7,27,46],coverag:21,coverage_exclud:21,cpp:[11,13,17,44],cppdbg:13,cppstandard:13,cpu:16,crash:[4,21,23,33],creat:[4,8,11,12,13,17,18,22,26,33,44,50,51,52],creation:20,creator:[9,13,14,15,21],credenti:17,critic:50,crop:50,cross:[7,8,15,21,45],crosswalk:8,cruis:[2,48],cstandard:13,csv:[31,32,33,41,44,51,52],csvoutput:51,ctest:13,ctrl:[13,28,32],cubic:8,current:[1,2,3,8,10,11,13,17,18,21,22,27,28,33,38,39,41,43,44,48,49,50,51,52],currentcontrolset:1,curvatur:[8,40,44,51],curvend:40,curvstart:40,custom:[10,13,20,21,39],custom_doc:[10,11],custom_rel_sim:10,customact:5,customcommandact:[0,39,43],customparamet:[39,43],cut:52,cwd:13,cxx:13,cycl:[2,4,43],cyclic:[1,33,43,52],cyclics_run_000:[33,44],cyclics_run_:33,cyclics_run_xxx:52,cyclicsfil:44,cygpath:13,cygwin:[13,23],d0c0e58d17358044cc9018c74308b45f6097ecfb:20,dai:[11,41],damper:51,dampercoeffici:51,danger:23,data:[1,2,3,11,17,22,23,28,39,43,44,51],databas:[17,28,33],databuff:[5,6,44],dataflow:2,datafram:1,datastructur:22,datatyp:[5,51],date:[14,17,40,44],dcmake_build_typ:[13,17],dcmake_cxx_flag:17,dcmake_export_compile_command:13,dcmake_install_prefix:[13,17],dcmake_prefix_path:[13,17],ddst:10,deactiv:[2,39,51,52],debian:[11,16,17,20],debug:[1,6,12,17,21,22,28],debugg:12,deceler:[2,48,51],decentr:20,decid:39,declar:39,declin:51,decor:11,decreas:[33,48,51],dedic:22,defaultpreruncommon:[41,50],defaultprofil:13,defaultruntimecommon:[41,50],defaultstrategi:47,defin:[1,2,3,6,8,11,20,21,28,33,38,39,41,43,44,45,46,49,50,51,52],definilti:22,definit:[1,8,11,33,38,39,40,41,51],degre:[4,49],degress:51,delai:[2,39,43,51],delet:[6,10,13,51],deleteentityact:39,deliber:[2,17],deliv:[4,43],delta:[8,28,39,48],delta_left:8,demo:[26,27,52],densiti:2,dep:[10,13,18,21,52],depend:[1,2,6,8,11,13,14,17,18,20,21,23,26,28,33,38,39,41,43],depic:8,depict:2,deploi:20,deploy:20,deprec:[22,24,26,27,28,29,30],depth:[14,23,33,37,41,52],deptict:33,der:51,deriv:2,describ:[2,3,4,8,10,11,13,15,17,18,21,22,23,33,35,36,39,40,41,42,43,44,45,47,48,50,52],descript:[0,1,2,4,11,13,26,33,38,39,41,43,44,45,48,50,51,52],design:[16,51],desir:[2,10,17,48,51,52],despawen:8,destin:[2,10],detail:[1,2,4,11,17,18,20,22,23,26,33,35,38,39,49,52],detect:[1,2,4,21,33,51],detectindent:13,detection_radiu:2,detectiondelaytim:51,detectionrang:[44,51,52],detector:[4,6],determin:[1,2,4,7,8,10,39,44,48,50,51,52],determinist:33,dev:17,devel:17,develop:[2,4,9,10,12,17,21,22,23,33,52],developer_inform:[10,14],deviat:[1,8,18,28,39,48],devic:8,dfmilib_build_shared_lib:17,dfmilib_build_static_lib:17,dfmilib_install_prefix:17,diagram:43,did:33,diff:10,differ:[1,2,3,6,10,14,17,22,28,29,39,41,43,44,48,50,51,52],diffutil:17,digit:[10,43],dim:13,dimension:[4,51],dinstall_extra_runtime_dep:13,dinstall_system_runtime_dep:13,dir:52,direcori:13,direct:[3,4,8,39,44,49,51],directli:[1,11,14,21,27,39,41,44,52],directori:[1,10,11,12,13,17,18,21,26,39,51,52],dirk:48,disabl:[1,2,17,51],discov:13,discoveri:13,discret:51,discuss:[11,33],disk:16,displai:[29,44],dissip:51,dissolv:22,dist:2,distanc:[2,7,8,28,39,40,44,48,49,50,51],distancecondit:39,distanceind:8,distancereftofrontedgeego:51,distancereftofrontedgefront:51,distinguish:[1,11,21],distrib:17,distribut:[10,17,38,39,43,50,51],divid:[2,6,17,22,47,51,52],dlane:39,dll:[13,21,51],doc:[1,10,11,14,17,18,20,21,52],docid:4,dockerfil:10,dockerimagenam:10,document:[1,11,12,13,18,21,22,23,33,39,41,44],doe:[7,8,11,13,17,33,39,40,41,44,50,51],doesn:[7,12,50,51],domain:[46,49],don:[7,13,22,45],done:[8,9,10,18,46,48,52],donotent:8,donotpass:8,dontovertakeonouterlan:38,dot:[4,8],doubl:[2,11,38,39,44,48,50,51,52],doubleparamet:38,doublevector:[38,50],doubt:17,dougla:8,down:2,download:[8,13,17,22],downstream:3,doxygen:17,dprotobuf_build_shared_lib:17,dprotobuf_build_test:17,draft:50,drag:[2,48],drawn:38,drivabl:7,drive:[2,18,23,33,38,39,40,44,45,48,49,50,51],driver:[2,11,27,33,37,41,43,44,47,51],driverlibrari:38,drivermod:43,drivermodel:43,driverprofil:[38,48],driverprofilenam:[1,44],driverstatesign:2,drivertask:43,drivetrain:[2,51],drop:51,dslane:39,dsrc:10,due:[4,6,8,10,14,17,21,39,44,48,49],duplic:45,durat:[1,6,39],dure:[1,2,6,10,16,18,20,21,39,42,44,49,50,51],duse_ccach:13,dvipng:17,dwith_api_doc:10,dwith_debug_postfix:13,dwith_doc:13,dwith_simcor:13,dwith_test:13,dynam:[2,11,17,23,27,38,39,42,43,44,51],dynamics_collis:[0,43],dynamics_regulardriv:[0,43],dynamics_scenario:[0,37,43,47],dynamics_trajectoryfollow:[39,43],dynamicschassi:47,dynamicscollis:[2,43],dynamicsdimens:[39,49],dynamicsmotionmodel:47,dynamicspriorit:2,dynamicsregulardriv:[41,43],dynamicsscenarioimplement:5,dynamicsshap:[39,49],dynamicssign:51,dynamicssignal_acceler:51,dynamicssignal_centripetalacceler:51,dynamicssignal_positioni:51,dynamicssignal_positionx:51,dynamicssignal_steeringwheelangl:51,dynamicssignal_traveldist:51,dynamicssignal_veloc:51,dynamicssignal_yaw:51,dynamicssignal_yawacceler:51,dynamicssignal_yawr:51,dynamicstiremodel:47,dynamicstrajectoryfollow:[2,43,47],each:[1,2,3,4,6,8,11,17,18,21,28,31,32,33,39,41,43,44,45,46,49,50,51,52],earlier:1,easi:[10,22,39],easier:[11,26],easili:[11,17,22],east:40,echo:13,eclips:[10,12,14,18,24,25,26,27,28,29,30,33,44,49],edg:[2,8],edit:[11,13,24,26,27,28,29,30,52],editor:[13,17,24],effect:[7,13,39,51],ego:[3,8,38,39,44,45,48,50,51,52],egoaccid:[1,44],egoag:38,egoagentinterfac:5,egodistancetravel:[1,44],either:[2,8,13,17,28,38,39,41,44,50,51,52],elaps:51,elast:51,element:[1,8,39,41,45],elevationprofil:40,els:[39,50],emerg:[2,23,38,51,52],empir:48,empti:[8,39],enabl:[12,13,14,17,21,33],enablevisualobstruct:[2,51],encod:41,encount:7,end:[6,7,8,11,12,17,21,31,32,39,49,50,51,52],endif:10,endoffallspeedlimitsandovertakingrestrict:8,endoflan:8,endofmaximumspeedlimit:8,endofminimumspeedlimit:8,endofspeedlimit:8,endtim:39,endtoend:[14,17,21],endtoendtest:1,enforc:13,enforcedoublebuff:51,enforcetrajectori:51,engin:[2,48,49,51],enginemo:[41,44],enhanc:[11,33],enlarg:48,enough:[2,17],ensur:[8,11,23,28,52],enter:17,entir:[11,41,50,51],entireti:50,entiti:[1,5,11,33,41,44,45,51],entityact:39,entitycondit:[1,39],entitynam:39,entityref:39,entityselect:39,entityvisibilityconfig:5,entri:[1,14,17,26,33,38,41,44,51],entrynam:39,env:13,environ:[1,2,9,10,12,13,14,15,18,20,21,22,38,52],environment:[13,18,23,33],environmentalzonebegin:8,environmentalzoneend:8,environmentcatalog:39,environmentvari:13,eol:[11,13],epl:[10,25],equal:[2,8,10,48],equalto:39,equat:[17,48,51],equilibrium:48,equip:[23,52],equival:[38,39],error:[1,2,7,8,13,17,18,21,26,28,33,51],esar:4,escap:[1,21],especi:[11,14,22,43],establish:10,estim:4,esv:4,etc:[1,17,20,26,32,52],euclidean:8,evalu:[4,14,23,24,33,39,50,51],even:[13,49],evenli:51,event:[2,4,6,33,39,43,52],eventdetector:[0,6,44],eventnetwork:[4,39],everi:[1,2,11,12,14,28,33,38,41,43,44,45,49,51,52],everyon:11,everyth:[1,51],evolv:14,exact:[20,21,52],exactli:[2,39],exampl:[2,8,10,11,13,16,20,21,27,33,39,43,44,45,46,51,52],examplelist:38,exampleprofil:38,exce:11,except:[11,43,49,51],excerpt:11,excess:11,exchang:[22,23],exclud:1,exe:[12,13,17,26,52],exec:17,execut:[0,2,4,8,10,11,12,13,17,18,26,33,39,43,46,49,51,52],executecustomcommand:5,executor:1,exemplari:52,exemplarili:16,exhal:[10,17],exhaust:2,exhibit:8,exibit:11,exist:[1,2,10,11,17,33,38,44,45,50,51,52],existencefront:51,existencefrontfront:51,exit:[8,51],expand:43,expect:[13,51],experi:[24,26,27,29,30,33,38,44,45,46,52],experienc:43,experiment:33,experimentid:41,expertis:33,expir:50,explain:[2,17,18],explan:11,explicit:[21,43],explicitli:[1,11,21,43,50],explor:13,expon:48,exponentialdistribut:38,express:[44,51],extend:[8,13,50],extens:[10,11,13,17,51],extern:[7,13,14,49,51],externalconsol:13,extra:[12,17],extract:[17,51],extrem:8,f0px2fref:51,f0pxfref:51,f0py2fref:51,f0pyfref:51,f117_21:4,fachthemen:8,facilit:[10,11],factor:[2,28,51],fahrzeugtechnik:51,fail:[1,8,13,21],failur:[18,21],failureprob:51,fake:11,fakeworld:11,fall:21,fals:[2,4,10,11,13,20,38,39,41,44,51,52],far:[17,22,41,44],fashion:47,faster:[2,22],fastest:39,feat:11,featur:[0,11,17,21,22,39],feb:40,ferit:51,fetch:[1,20],fhwa:8,field:[2,20,39,51],figur:[2,51],file:[1,4,6,7,8,10,11,12,13,14,17,18,20,21,26,27,28,29,31,32,33,35,38,39,40,41,42,43,51,52],filenam:[10,17,33,44,51],filenameprefix:[41,45],filepath:39,filesystem:1,fill:50,find:[1,12,13,17,18,26,43,52],fine:17,finish:[15,28,49],fire:39,first:[1,6,7,8,15,17,21,22,23,26,31,32,33,39,41,43,45,50,51],firstparamet:38,fit:[1,2,13,23],five:2,fix:[2,8,10,11,17,22,39,50,51],flag:[1,2,6,8,12,17,18,20,39,44,50],flash:39,flasher:2,flexibl:23,flow:[2,33,43],fmi:[17,23,51],fmilibrari:[13,17,18,20,21],fmu1:[43,51],fmu1_staticfmu:1,fmu2:43,fmu2_staticfmu:1,fmu3:43,fmu:[1,5,17,22,23,39,47],fmuhandl:51,fmuhelp:5,fmupath:[1,51],fmuvari:51,fmuwrapp:51,focus:33,folder:[10,13,17,18,20,21,26,29,31,32,33,51,52],follow:[1,2,3,6,8,10,11,12,13,15,17,18,20,21,27,28,31,33,36,38,41,43,44,45,46,47,48,49,50,51,52],followingmod:39,followpathact:5,followtrajectori:[39,47],followtrajectoryact:[0,39,49],followtrajectorycontrolstrategi:5,followvelocitysplin:47,followvelocitysplinecontrolstrategi:5,font:17,foopart:11,footer:11,forc:[1,2,39,48,51,52],forget:13,form:[11,38,39,44,51],format:[10,11,13,22,23,31,32,33,39,51,52],formatonsav:13,formatonsavemod:13,formrescuelan:38,fortran:13,fortun:21,forward:[2,4,39,43,51],found:[1,17,18,20,21,24,26,27,28,29,30,51,52],foundat:17,four:[2,8,51],fpic:17,frac:[2,48,51],frame:[31,32],framework:[2,4,14,17,21,23,51],free:[16,38,48],freedom:46,freeli:[40,51],freespac:39,fref:51,frefnorm:51,frequenc:16,fric:2,friction:[2,41,51],frictioncoeffici:51,from:[1,2,3,8,10,11,12,13,14,17,18,20,21,22,26,28,31,33,38,39,41,43,44,45,46,48,50,51,52],front:[2,8,44,48,51],frontag:48,frontaxlepercentag:51,frontdoor:4,frontratioawd:51,frontsurfac:51,frozen:43,fulfil:[39,50],full:[2,4,39,51],fullfil:50,fulli:[2,15,33,52],further:[8,11,14,15,17,21,33,38,39,48,51,52],furthermor:[4,39],furthest:8,fusion:43,futur:51,fwd:51,gammadistribut:38,gap:[46,48,50],gas:27,gather:2,gcc:[13,17,20,21,23],gdb:[13,17],gear:[2,39,41,44,48,51],gearrat:51,gearratio:51,gener:[1,2,3,4,8,10,12,13,14,17,22,23,28,33,36,38,39,41,43,44,45,46,51,52],genhtml:21,geometr:[4,22],geometri:[0,40],geometric2d:[38,44,51],geometric2dfront:44,geometryhelp:5,georg:51,german:[8,23,33],germani:[8,38],get:[2,3,14,17,21,26,38,43,51],getabsolutetargetlan:5,getcustomcommand:5,getdist:11,getlanechangetarget:5,getlaneidsatposit:5,getlanemark:8,getobstruct:[0,51],getposit:5,getpositioni:5,getpositionx:5,getrelativelaneid:5,getrelativetargetlan:5,getsignaltyp:5,getsignalvalu:11,gettimeofdai:11,gettrafficlight:5,gettrafficsignidmap:5,getupwardsshiftedlaneposit:5,getvelocityfromsplin:5,getyaw:5,ghz:16,gida:[23,33],git:[11,18],gitattribut:11,github:[17,23,51],gitlab:[12,14,18,44,49],give:[2,6,13,17,22,33,51],given:[1,2,6,7,8,17,20,28,33,39,41,45,46,50,51,52],givewai:8,glob:[10,13],glob_recurs:10,global:[11,38,39],globalact:39,glossari:14,gmbh:10,gmock:[11,22],gnu:23,goal:[17,33],goe:[18,51],going:[33,44],good:12,googl:[11,17,21],googlemock:22,googletest:[13,17,21],got:13,gov:[4,8],govern:48,gpu:16,graphic:[14,16],graphviz:17,graviti:[23,51],greater:[2,7,51],greaterorequ:39,greaterthan:39,green:[2,8,10,39],ground:[22,33],groundtruth:51,group:[0,1,2,3,4,5,6,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31,32,33,34,35,36,37,38,39,40,41,42,43,44,45,46,47,48,49,50,51,52,53],grouptyp:38,grundlagen:51,gtest:[11,17,20,22],guarante:8,guard:[45,52],guardrail:[40,45],guardrail_01:45,guardrail_02:45,gui:[14,22,26,27,28,29,30,33,46,52],guid:[2,9,15,17,18,21,27,33,47,52],guidanc:[14,15,48],guidelin:[14,47],half:[2,51],hand:33,handl:[0,6,7,11,38,39,43,51],happen:[1,6,23,33,39,51],haptic:51,hard:16,harder:48,hardwar:[15,16],has:[1,2,3,4,7,8,10,12,17,22,27,28,29,38,39,41,43,44,46,51,52],hascontrolstrategygoalbeenreach:5,hasnewlongitudinalstrategi:5,have:[1,2,4,6,7,8,10,11,16,17,18,21,22,27,33,38,39,45,49,50,51,52],hbz:4,hcpa:4,hcpao:4,hdg:40,head:[10,39],header:[11,17,22,31,32,40,44],headlight:2,headwai:39,heart:33,heavyvehicl:50,height:[2,3,38,40,44],helb:48,held:50,hello:39,help:[11,21,27,33],henc:[2,26,45],henneck:48,here:[8,10,12,17,24,26,27,28,29,30,33,35,38,39,41,43,50,51,52],high:[2,41,46,48,51],higher:[2,10],highest:[2,6,26,41,43],highli:13,highlight:10,highwai:[8,33,38],highwaybegin:8,highwayend:8,highwayexit:8,highwayexitpol:8,highwayscenario:41,hint:[13,21],histogram:31,histor:33,hkey_local_machin:1,hold:[1,2,8,15,18,22,48],home:[17,18],homogen:50,hood:21,hook:[17,20],horizont:[44,51],horn:2,host:[4,51],how:[1,10,15,17,18,22,33,39,41,44,45,47,48,50,52],howev:26,htm:[8,21],html:[1,8,10,21,22,39],http:[1,4,8,10,12,13,14,17,18,21,22,23,24,25,26,27,28,29,30,33,39,44,48,49,51],huge:[16,48],human:41,hungarian:11,iabsolutetargetlan:5,icon:13,icount:11,ide_support:14,ident:51,identif:44,identifi:[10,25,38,44,51],idm:48,ids:[1,20,43,44,45],ientiti:5,ignor:[7,17,31,38,39,40,49,50],ignorefailur:13,igor:7,ilanechangetarget:5,illustr:33,imag:[2,8,31,33],immedi:39,impact:[4,50],implement:[2,5,8,11,21,33,48,49],impos:16,imposs:1,improv:[11,12,21,33],inclin:[4,51],includ:[2,6,10,11,12,13,17,20,22,27,31,33,39,44,45,50,51,52],includecategori:11,inclus:27,incom:41,incorpor:52,increas:[1,3,21,22,51],increment:[43,44,50],indend:1,independ:[6,17,23,39],index:[4,14,21,22,43,45,51],indic:[2,3,8,12,43,51],indicatorst:[41,44],indirectli:41,individu:[1,2,8,13,14,23,32,33,41,44,45,47,51],indivu:38,inelast:2,inertia:51,inexist:50,inf:38,infin:48,influenc:[20,39],info:[28,51],inform:[1,2,8,10,11,13,15,17,20,28,33,39,41,43,44,45,48,51,52],inherit:13,init:[6,43,51],init_:51,initi:[4,6,8,10,28,33,38,39,44,51,52],inject:10,inlin:11,input:[1,2,6,11,31,32,35,38,43,46,51,52],input_:51,input_osmpsensordatain:51,inputid:[38,51],inputport:11,inscrib:26,insert:13,insertfinalnewlin:13,insertspac:13,insid:[0,13,21,39,41,50,51],insight:33,instal:[1,10,11,12,15,16,22,52],install_extra_runtime_dep:18,instanc:[4,21,44,51],instanti:[6,33,43,44,51],instead:[11,13,18,20,33,39],instruct:[1,12,15,17,18,22,51,52],int_:28,integ:[1,39,41,44,51],integervector:44,integr:[10,12,13,22],integratedtermin:1,intel:16,intellig:48,intellisensemod:13,intend:[23,44,50],intent:1,interact:[14,22,27,33,48],interdepend:33,interest:[2,33,35,47],interfac:[2,4,5,8,11,12,14,17,20,23,51],intermedi:50,intern:[1,8,17,21,22,33,39,45],interpol:[8,49,51],interpret:[1,4,8,39,49],interrupt:28,intersect:[2,4,8,39,50],interv:[8,43,50,51],intervent:[33,39],introduc:[10,22,43,48],introduct:17,intvector:[38,50],invalid:[8,10,50,51],invers:3,investig:13,invoc:[1,33,41,44,46,52],invok:[12,21,46],involv:[20,44],ipsum:[38,43],irelativetargetlan:5,isaffect:1,isintersect:2,isn:[17,43,50],iso:11,isoscel:2,issu:[2,13,14,17,21,22,44],istrigg:1,itchi:[12,14],item:[32,38],itrafficdefinit:5,its:[1,2,3,4,6,8,12,13,18,20,21,22,39,48,51],itself:[4,13,17,20,22,28,38,39],jam:[38,48],jmodelica:51,job:[24,26,27,28,29,30],joint:8,json:[1,13,51],jump:49,junction:[39,40,41],just:[1,2,6,10,11,28,48],justif:11,kboth:5,keep:[2,10,13,14,18,33,44,48,49],keeplaneoffset:47,keeptoouterlan:38,keepveloc:47,kei:[1,2,17,28,38,41,43,44,45,48,50,51],keyword:39,kfollowtrajectori:5,kfollowvelocitysplin:5,kind:[39,51],kit:21,kite:2,klater:5,klongitudin:5,know:[13,21],knowledg:43,known:22,kolk:4,kperformlanechang:5,lai:[2,8],lambda:38,lane:[0,1,2,22,38,39,40,41,44,45,48,49,50,51,52],laneboundari:8,lanechang:[2,40],lanechangeact:[0,39,49],lanechangeactiondynam:39,lanechangeactionimpl:5,lanechangemanipul:2,lanechangetarget:39,lanechangetargetimpl:5,lanecountleft:51,lanecountright:51,laneego:51,laneel:8,lanefront:51,lanefrontfront:51,lanegeometryel:8,laneid:[1,5,39,50],lanelocationqueryservic:5,laneposit:39,laneroadmark:45,lanesect:40,lang:23,languag:11,larg:[2,48],larger:[2,51],last:[6,7,18,22,43,50,51],lastest:22,latenc:51,later:[2,3,8,17,28,33,38,39,43,44,47,51],lateralact:39,lateralprofil:40,latest:[17,21,22,24,26,27,28,29,30],latex:17,latter:[2,21,51],launch:[1,13,23],launchtargetpath:13,layer:[5,8,23,51],layout:44,lcov:21,ldd:13,lead:[1,2,7,8,10,15,26,44,48],learn:[20,52],least:[7,13,16,38,51],leav:17,left:[3,8,13,38,39,40,50,51],lefthand:38,leftlaneend:8,leftmost:51,legal:[10,25],length:[1,2,3,5,7,8,18,39,40,44,50,51],lengthfront:51,less:[8,21,33,51],lessorequ:39,lessthan:39,let:[14,21,22,26,33,51],letter:18,level:[6,10,12,26,28,33,40,41,43,46],lib:[6,13,17,52],libboost:17,libench:17,libqt5xmlpatterns5:17,librari:[2,6,12,13,18,20,21,23,26,38,41,43,44,45,50,51,52],librarynam:38,libxslt:17,licens:[10,11,14],lies:49,light:[2,8,39],lightstatu:[41,44],lightvehicl:50,lightweight:16,like:[1,7,10,13,17,28,29,33,39,41,43,48,51,52],lim:2,limit:[1,2,22,33,51],limiteraccelerationvehiclecompon:[0,41,43],line:[0,2,8,11,13,14,17,21,40,41],linear:[8,39,48,51],linearli:[8,49,51],link:[12,13,18,33,39,40,44,50,51],linux64:[13,21],linux:[11,13,15,16,17,18,20,21,22],list:[1,2,4,7,12,13,16,17,18,20,21,31,33,38,39,41,43,44,50,51,52],list_directori:10,listen:39,listitem:[7,38,50],literalinclud:[10,11],load:[12,17,23,26,41,51],local:[0,1,4,13,18,20,39],locallinkid:11,locat:[1,3,8,10,13,14,18,20,26,39,44,50,52],log:[6,13,26,28,33,43,44,45,51,52],logfil:[6,13],loggingcyclicstocsv:[41,44,52],logginggroup:41,logginggroup_:44,logginggroup_roadposit:[41,44],logginggroup_roadpositionextend:[41,44],logginggroup_sensor:[41,44],logginggroup_trac:[41,44],logginggroup_vehicl:[41,44],logginggroup_visu:[41,44],logic:[39,50],logicfil:39,login:13,loglevel:6,lognormaldistribut:[38,50],longernam:11,longest:8,longitudin:[2,3,33,38,39,43,44,47,51],longitudinalact:39,longitudinalpivotoffset:44,longitudinalsign:51,longitudinalsignal_accpedalpo:51,longitudinalsignal_brakepedalpo:51,longitudinalsignal_gear:51,longpathsen:1,look:[12,13,17,33,52],loop:33,lorem:[38,43],lot:33,low:[46,48,51],lower:[2,7,46,51],lowerbound:39,lowercamelcas:11,lowercas:11,lowest:[2,32],luxuryclasscarag:[38,50],lvl:43,lxml:17,machin:18,macro:10,made:[10,11,18,22,25,51],madler:17,magic:11,mai:[3,8,17,38,39,49,50,51,52],main:[8,11,18,33],mainlaneloc:8,mainli:[24,26,27,28,29,30,39,45],maintain:[22,50],mainten:11,major:[21,22,39],make:[2,10,11,13,16,17,18,20,22,23,27,47,52],makefil:[12,13,17,18,21],makeflag:12,manag:[17,20,22,26,43],mandatori:[21,39,41,52],maneuv:[1,44,52],maneuvercatalog:39,maneuvergroup:39,manifest:18,manipul:[2,6,27,39,44],manner:[1,45],mantl:49,mantle_api:5,mantleapi:[20,49],mantleapi_vers:20,manual:[8,15,17,33,52],map:[0,11,45,51],mark:[0,21,22,52],markdown:[11,22],martin:48,mass:[2,4,51],mat:48,match:[7,12,38,39,51],materi:[10,25],math:28,mathemat:11,matlab:51,matrix:[23,33],matter:27,max:[1,2,28,38,39,43,48,50,51],max_steer:51,maxacceler:48,maxdeceler:[48,51],maxdepth:17,maxdropouttim:51,maxenginespe:2,maximum:[1,2,6,8,11,21,38,39,41,48,50,51],maximumenginepow:51,maximumenginespe:51,maximumenginetorqu:51,maximumexecutioncount:39,maximumspeedlimit:8,maxsteer:51,mayb:2,mean:[1,2,8,13,17,26,33,38,39,41,43,46,49,50,51],meaningless:39,medium:51,meet:40,member:11,memori:21,mention:[2,13,33],merg:[2,3,38],messag:[1,10,13,22,26,51],met:[12,50],meta:51,metadata:20,metainfo:22,meter:[8,11,41,51],meter_t:5,meters_per_second_t:5,method:[2,5,11,43,51],microscop:48,middl:[8,39,44,48],middleclasscarag:[39,44,50],midebuggerpath:13,might:[1,2,13,17,18,21,23,33,35,39,48,52],mimod:13,min:[1,38,43,50,51],mindist:48,mingw32:13,mingw64:[13,18,21],mingw:[0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31,32,33,34,35,36,37,38,39,40,41,42,43,44,45,46,47,48,49,50,51,52,53],mini:38,minim:16,minimum:[2,6,8,11,38,48,50,52],minimumseparationbuff:[7,50],minimumspeedlimit:8,minizip:[13,18,21],minor:[24,26,27,28,29,30,48],miscobjectcatalog:39,mislead:1,miss:[1,7,12,13,17,20,21,39,52],mkdir:[17,18],mock:[11,17,22,23,51],mode:[27,33],model:[2,4,23,33,38,39,44,47,48,51],modeldescript:51,modeldocument:39,modelon:[17,51],modern:11,modif:[11,13,18,33,52],modifi:[10,11,13,52],modul:[1,2,6,21,23,41,43,49,51],modular:51,momement:49,moment:[8,26],momentum:[2,4],monitor:13,monolith:14,mont:46,more:[1,2,4,7,8,10,11,13,17,18,20,22,23,33,39,41,43,50,51,52],most:[8,13,26,33,38,47,50],motion:[2,51],motor:51,mount:[3,51],mountingposheight:44,mountingposlater:44,mountingposlongitudin:44,move:[4,10,33,45,50,51],movement:[6,39,49,51],movementdomain:[5,49],movingobject:45,msvc:[21,22],msy:[12,17,18,21,23],msys2:[1,17,20,21,23],msys2_path_typ:13,msys64:[13,17,18],msystem:13,much:[2,33,48],multi:[11,20],multipl:[2,4,16,28,29,31,39,41,43,44],must:[1,2,8,10,11,13,18,28,38,39,41,51],mutable_custom_act:5,mutable_follow_path_act:5,mutable_follow_trajectory_act:5,mutable_speed_act:5,mutcd:8,mutiremaxx2fref:51,mutiremaxxfref:51,mutiremaxy2fref:51,mutiremaxyfref:51,mutireslidex2fref:51,mutireslidexfref:51,mutireslidey2fref:51,mutireslideyfref:51,mutual:1,mutual_resources_path:1,myevent:39,mymaneuv:39,mymanipul:39,mysequ:39,myst:17,mystori:39,name:[1,2,5,6,8,10,13,17,26,28,33,38,39,40,41,43,44,45,48,50,51,52],namespac:[11,20],namingconvent:11,nan:51,nativ:[1,11,12,13,20,23],natur:[8,11,39,49],navig:[17,18,52],nearest:8,necessari:[1,2,10,11,13,17,18,20,21,22,23,51],necessarili:[7,10,39,51],need:[1,2,3,8,11,12,13,14,17,21,22,26,27,31,32,33,38,39,40,41,43,44,50,51,52],neg:[39,44],neglig:2,neither:50,nest:38,net:[7,39,48,49,51],net_asam_openscenario:5,netdist:48,network:[33,40],never:[49,51],newer:22,next:[1,2,6,10,13,18,21,26,33,44,49,50,52],nhtsa:4,no_kil:20,non:[6,8,11,13,17,21,22,31,45,50,52],none:[38,39],nonrecur:6,normal:[4,10,11,13,33,39,44,51],normaldistribut:[38,43,50,51],north:40,notabl:2,notat:11,note:[6,8,10,11,12,18,21,38,39,43,46,52],noth:6,notifi:2,notion:8,now:[8,13,39],nrw:4,nth:51,number:[1,2,8,10,11,20,22,28,33,38,39,41,43,44,46,51,52],numberofexecut:1,numberofgear:51,numberofinvoc:41,numer:2,numpi:1,object:[2,3,4,8,22,23,33,39,40,44,45,51,52],objectcontrol:39,oblig:26,observ:[6,33,36,44,45,48],observation_entityrepositori:[36,41],observation_log:[14,33,36,41],observationlog_cycl:44,observationlog_parameter:44,obstacl:[33,45],obstruct:[0,44,51],obtain:51,occas:51,occupi:8,occur:[2,4,17,44,50,51],occurr:[1,39],ocpa:4,ocpao:4,off:[10,13,17,18,21,39,51],offici:[22,49],offramp:[50,51],offset:[2,8,39,43,49],often:[1,9],old:[10,17],older:22,omega_:51,omit:[23,50],on_button_click:11,onc:[6,15,18,41,44,45,50,51,52],one:[1,2,6,7,8,10,17,21,23,28,31,33,38,39,43,44,49,50,51,52],ones:[7,18],onesignalstrafficlight:5,onli:[1,2,4,6,8,10,11,13,16,17,21,22,26,27,28,38,41,43,44,45,49,50,51,52],onramp:[50,51],onto:[4,51],op_osc_schemavers:39,op_rel_root:10,op_rel_sim:10,open:[0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,23,24,25,26,27,28,29,30,31,32,33,34,35,36,37,38,39,40,41,42,43,44,45,46,47,48,49,50,51,52,53],opendr:[8,23,33,39,40,44,45,50],opendrive_id:44,opendriveid:11,opengl:20,openingangleh:[44,51],openinganglev:44,openpass:[0,1,2,3,4,5,6,7,8,9,11,12,13,15,16,17,19,20,21,22,23,24,25,26,27,28,29,30,31,32,33,34,35,36,37,38,39,40,41,42,43,44,45,46,47,48,49,50,51,52,53],openpass_0:[24,26,27,28,29,30],openpass_adjust_output:18,openpass_at_a_gl:33,openpass_os_dir:10,openpass_simulator_build:[24,26,27,28,29,30],openscenario:[0,2,8,13,33,39,43,44,45,49,51],openscenario_api:20,openscenario_engin:20,openscenarioact:[0,43],openscenarioengin:[5,13],openscenariofil:41,opensimulationinterfac:[17,23,51],openspeedlimit:38,openspeedlimitbus:38,openspeedlimittruck:38,openssl:20,oper:[1,8,11,13,16,33,39],oppon:4,opponentcollisionveloc:4,opponentpointofcontactlocali:4,opponentpointofcontactlocalx:4,opponentveloc:4,opponentvelocitychang:4,opponentvelocitydirect:4,opponentyawveloc:4,opposit:50,opsimualt:5,opsimul:[1,6,12,13,14,18,20,21,26,33,44,51,52],opsimulation_test:21,opsimulationmanag:[12,26],optic:51,optim:[13,21],option:[1,8,11,12,13,15,17,18,19,20,22,26,33,39,41,42,45,50,51],opu:4,opus45:4,order:[1,6,8,10,13,17,50,52],org:[1,8,10,12,14,17,18,21,22,23,24,25,26,27,28,29,30,33,44,48,49,51],orient:[3,39,40,43,49],orientation3:5,orientationpitch:44,orientationyaw:44,origin:[3,8,10,14,28],os_env:13,oscact:39,osherov:11,osi3:[5,13],osi:[2,3,8,13,18,21,23,51],osisensormodelpackag:51,osmp:51,osmpsdtotu:51,oss:1,other:[2,3,7,11,13,16,20,21,23,38,39,41,43,44,45,47,49,50,51],other_index:28,otherwis:[8,18,39,44,51],our:[2,52],out:[2,8,11,13,14,33,44,50],outdat:[10,20,21],outermost:38,outgo:41,outlin:11,output:[1,2,6,7,11,14,18,21,39,41,43,49,51,52],output_:51,output_osmptrafficupdateout:51,outputfilenam:[41,44],outputpath:51,outputport:11,outsid:[8,10,50,51],over:[2,14,31,32,49,51],overal:[2,33,52],overlap:4,overrid:[1,2,10,11,20,21,39,51],overriden:21,overridenam:13,overtak:38,overtakingban:8,overtakingbanbegin:8,overtakingbanend:8,overtakingbantrucksbegin:8,overtakingbantrucksend:8,overview:[0,6,10,11,14,22,37,51,52],overwrit:[1,39,52],overwritten:10,owl:8,own:[2,3,4,12,13,18,21,22,33,48,51],oya:4,packag:[1,10,18,20,21,51],pacman:[11,17],page:[10,11,51],pai:13,pair:[1,41,44],panda:[1,17],pane:13,panel:31,paragraph:[14,52],parallel:[3,8,12,18],parallelexecutionlimit:13,parallelexecutionofexecutablelimit:13,paralleljob:13,param:11,paramet:[0,1,2,4,11,14,23,27,33,38,39,41,44,45,46,48,50,51,52],parameter:[1,39,47,51],parameter_:51,parameter_assignspecial_:51,parameter_transformlist:51,parameter_vehicl:43,parameterassign:39,parameteriz:[2,33,46],parameterref:39,parameters_vehicl:0,parametersag:43,parametersagentmodul:43,parametersvehicl:[2,43],parametersvehiclesign:2,parametertyp:39,parametr:[2,14,33,41],parent:[3,39],parenthesi:11,park:33,pars:[1,6,22,51],parser:17,part:[7,10,11,17,21,22,23,24,26,27,28,29,30,39,44,51],parti:[17,18,20,22],partial:7,particip:[4,14,33,46,47],particular:[33,50,51],partmap:11,partner:2,pass:[1,20,38,51],passiv:2,past:33,patch:17,path:[1,6,7,10,11,12,17,18,20,21,33,39,41,44,51],path_to_recip:20,path_to_sourc:20,pattern:13,pcm:[14,23,24,26,27,30,33,34,46],pdf:[4,8,33,48],pdf_index:8,pedal:[2,27,48,51],pedestrian:[8,23,33,39],pedestrian_adult:39,pedestrian_child:39,pedestriancatalog:33,pedestriancross:8,pedestrianmodelcatalog:33,pedestrianmodelscatalog:[33,39,52],per:[1,8,13,39,43,44,51],perceiv:51,percentag:[2,51],percept:23,perf:11,perform:[1,2,11,16,17,21,33,38,39,51,52],performchangelan:47,performlanechangecontrolstrategi:5,perhap:39,perpendicular:8,persist:[41,45],person:11,perspect:[2,21],peucker:8,phase1:39,phase2:39,phase3:39,phase4:39,phase:[0,23,39,51],physic:[2,33,39,48],pick:[4,33],pictur:[2,8,26],piecewis:[8,49],pip3:17,pip:[1,17,20],pitch:[38,39,40,44],pkg:20,place:[7,10,11,18,21,28,33,39,43,51,52],placehold:10,placement:33,plan:26,plane:4,planview:40,platform:[14,15,17,20,21,23,51],pleas:[1,11,13,15,17,18,20,21,33,41,43,44,48],plot:32,plugin:[1,14,26,28,29,31,32,33],pneumat:51,pneumatictrail:51,point:[1,2,3,4,8,10,11,13,14,17,27,28,33,39,44,49,50,51],pointofcontactlocali:4,pointofcontactlocalx:4,polar:28,polygon:[2,8],polylin:[5,39],polymorph:11,polynomi:[8,49],pool:50,popul:[47,50],port:11,portion:11,posit:[1,2,3,8,10,23,27,28,32,33,38,41,44,48,49,50,51,52],position_:51,positionrout:[1,39,41,44],positionsego:51,positionsfront:51,positiontego:51,positiontfront:51,positionxego:51,positionxfront:51,positionxfrontfront:51,positionyego:51,positionyfront:51,positionyfrontfront:51,posix:23,possibl:[1,2,10,12,13,18,21,22,28,29,31,33,38,43,44,46,48,50,51],post:44,postfix:21,potenti:[2,4,12,13,35,36,39,50],power:51,powershel:13,powertrain:51,practic:21,pre:[17,23,52],preagent:6,preannouncehighwayexit:8,preannouncehighwayexitdirect:8,precas:23,precaut:22,preced:[10,51],precis:41,precompil:1,precondit:7,precrash:33,predecessor:[8,23],predefin:[39,52],predetermin:51,predict:33,prefer:[11,13],preferredgener:13,prefil:51,prefix:[1,10,21,39,45],prematur:8,prepar:[2,6,10,12,18],preparedoc:10,preparedoccustom:10,prerequisit:[12,13,14,15,18,21,22],prerun:[6,41],preruncommonspawn:50,prerunspawn:[0,47],present:[7,11,23,33,39],press:28,pretti:[13,21],prevent:[2,21,23],preview:31,previou:[2,3,22,28,29,49,50,52],previous:[50,52],primarili:[8,22,33,52],primer:[35,36],primit:51,princip:8,print:[8,13],prior:[4,10,22],priorit:[2,33,43],prioriti:[0,1,2,11,39,41,51],prioritizeraccelerationdriv:43,prioritizeraccelerationvehiclecompon:[2,43],prioritizerdynam:[2,43],prioritizerlaterdriv:43,prioritizerlongitudin:[2,43],prioritizernam:2,prioritizerst:[2,43],prioritizersteeringvehiclecompon:[2,43],prioritizerturningind:[2,43],privat:[10,11,17,39],privateact:39,probabilist:[33,46],probabl:[2,33,38,41,46,50,51],proceed:4,process:[1,2,6,8,10,13,14,15,16,18,20,28,33,51],produc:[28,33,43],product:51,profil:[13,33,38,39,41,44,48,50,51,52],profilegroup:[33,50,51],profilenam:38,profilescatalog:[2,33,35,39,43,47,51,52],profilesgroup:43,program:[10,13,17,18,21,23,25],progress:[4,33,52],prohibit:38,project:[1,2,4,8,10,11,13,17,20,24,39],projected_height:2,prompt:[13,52],proper:[12,13,17,21,33,43],properli:[18,40],properti:[10,39,51],proport:2,proprietari:10,proto:17,protobuf:[13,18,20,21],protobuf_build_shared_lib:17,protoc:17,protocol:[17,21],protocolbuff:17,provid:[1,2,9,10,11,17,21,22,26,27,33,43,46,51,52],publish:[1,2,6,14,20,44],publisherinterfac:44,pure:11,purpos:[13,17,23],put:33,putacycl:5,pwd:21,pyopenpass:[1,21],pytest:[1,17],python3:17,python3_execut:[1,12],python:[1,12,17,20],qt5:17,qtbase5:17,qtchooser:17,qtcreator:[15,21],qtxmlpattern:20,quad:8,quadrangular:8,quadrilater:8,queri:[2,8],quickli:48,quot:[1,21],rad:[44,51],radian:[3,51],radian_t:5,radiant:39,radio:28,radiointerfac:2,radiu:[2,11,28,40],radius:2,radius_m:11,rail:[40,45,52],raini:41,rais:[2,22],ram:16,ramer:8,ran:21,random:[7,14,28,33,38,39,41,44,50,51],randomli:[28,41],randomparamet:[38,43],randomse:[1,41,44,51],rang:[0,1,2,31,41,43,44,45,50,51],rate:[2,8,39,41,44,48,51],rate_:51,rather:11,ratio:[2,4,51],reach:[2,6,41,44,51],reachabl:[2,39],react:[2,14,52],read:[2,13,21,28,31,43,44,51],readabl:[10,11],readm:17,readwaypointdata:5,real:[2,10,23,33,51],realist:47,realiz:8,rear:[3,8,44,51],reason:[1,39,44,45],receiv:[8,51],receivercar2x:[2,47],recent:[13,17,22],recogn:21,recommend:[1,11,12,13,15,16,17,18,21,22,26,33,39,51],recompil:22,reconfigur:13,record:33,recur:6,red:[2,8,39],reduc:[2,8,50,51],ref:[39,44],refactor:11,refer:[1,3,8,10,11,17,18,21,26,33,38,39,41,43,44,48,50,51],referenc:[10,18,33,38,39,40],referenceent:39,reflect:39,regard:[2,22,38,43],regardless:44,regex:[10,11],regist:39,registri:1,regul:[8,38],regular:[1,21,44,48],regularili:22,regularli:22,rel:[3,5,6,10,28,38,39,44,51],relai:[2,39],relat:[2,8,11,20,21,33,44,51],relativedistancefront:51,relativedistancefrontfront:51,relativedistancetyp:39,relativeobjectposit:39,relativespeedcondit:39,relativetargetlan:[5,39],relativetargetspe:39,releas:[12,13,17,18,21,22,24,26,27,28,29,30,51],relev:[5,12,31,32,43,51,52],reli:22,relinquish:51,reload:13,remain:[2,28],remaind:8,remot:20,remov:[2,10,11,17,21,26,52],removeag:39,removeagentsmanipul:39,render:17,renderfinalnewlin:13,renderwhitespac:13,repeat:[17,40,45,52],replac:[1,10,11,51],repo:[10,17,39],report:[1,13,21,49],report_path:1,repositori:[1,10,11,13,17,18,20,41,45,52],repository_run_000:45,repository_run_00:45,repository_run_xxx:52,repres:[11,28,47,52],represent:[2,8,22,23],reproduc:28,repuls:48,request:[1,2,13,49,51],requir:[1,2,7,8,10,12,13,14,15,17,18,20,21,27,32,33,38,39,40,43,48,50,51,52],requiredpercentageofvisiblearea:51,requri:50,rerol:41,resembl:48,resid:10,resimul:28,resist:[2,51],resolut:[13,21],resolv:[2,10,13,17,18,20],resourc:1,resources_path:1,resp:12,respect:[3,7,8,17,22,33,39,44],respons:[2,43,47,50,51],responsibili:2,restart:[13,17],restrict:[1,10,18,38,39,50],restructuredtext:10,result:[2,3,6,7,8,10,12,20,21,24,26,33,39,45,46,49,51,52],result_pcm:28,resum:17,retain:8,retriev:[1,2,8,11,13,20,28],revert:11,review:48,revmajor:40,revminor:40,rewrit:23,rho_:2,right:[3,6,8,13,17,18,32,38,39,40,50,51,52],rightlaneend:8,rightlaneonli:[7,50],rightmost:[7,51],rightofwaybegin:8,rightofwayend:8,rightofwaynextintersect:8,rill:51,rise:39,road:[0,22,23,33,39,40,41,44,45,48,50,51],road_id:39,roadcoordin:8,roadcurvature_:51,roaddirect:39,roadgraph:5,roadgraphvertex:5,roadid:[39,50],roadmark:[8,40],roadnetwork:40,roadposit:[41,44],roadsidemarkerpost:40,roadsign:8,roadstream:50,roi:11,roll:[2,4,17,38,39,40,41],root:[8,10,11,13],rotat:[2,3,44,51],roughli:[2,47],rout:[8,39,41,44,50,51],routecatalog:39,routedefinit:5,routesampl:5,routesamplerinterfac:5,routestrategi:39,routewaypoint:5,routingact:39,row:31,rpm:2,rst:[10,14],rstfile:10,rtd:17,rule:[10,11,38,39,43],run:[1,6,10,11,12,13,14,15,16,17,18,20,21,28,33,39,40,41,44,45,46,50,51,52],runid:44,runner:[1,13],runresult:44,runstatist:1,runtim:[6,8,13,18,21,39,41,42,50],runtimespawn:[0,47],rwd:51,s_max:8,s_min:8,safeti:[14,23,33],sai:13,said:41,same:[1,2,8,10,27,33,38,39,41,42,43,44,49,50,51],sampl:[0,2,5,33,42,44,46,50],sample_nam:44,satisfactori:48,satisfi:39,savannah:22,save:26,scale:[2,28,38,51],scan:8,scenario:[21,23,27,33,34,35,38,40,44,49,50,51],scenario_api:[13,49],scenarioag:39,scenarionam:51,scenarioobject:39,scenariospawn:50,scenaro:45,scenegraphfil:39,sceneri:[7,8,33,35,39,44,45,50,51,52],sceneryconfigur:[10,39,40,52],schedul:[0,2,43],schedulertask:6,schema:[39,42,43],schemavers:41,scoordin:50,scope:[1,11,17,43,47],scratch:22,screen:26,script:20,scrollabl:31,seam:10,search:[13,21,45],second:[13,17,21,22,26,32,39,41,44,50,51,52],secondari:[44,45],secondarydrivertask:43,secondarylan:[41,44],secondparamet:38,section:[1,2,8,9,10,11,13,14,17,18,19,22,33,38,39,41,43,44,52],sector:2,secur:1,sed:17,see:[1,2,8,10,11,12,13,14,17,18,19,20,22,23,26,29,32,33,38,39,41,43,44,46,51,52],seed:[28,33,41,44,51],seem:12,seen:[33,51],segment:26,seldom:1,select:[2,7,13,27,28,29,31,32,33,38,39,41,50,51],selector:[13,39],selecttriggeringent:39,self:51,semicolon:[1,21,31,32],send:[2,43,50,51],sendaccelerationen:2,sender:51,sendercar2x:43,sendpositionxen:2,sendpositionyen:2,sendvelocityen:2,sendyawen:2,sens:[33,46],sensit:51,sensor0_detectedag:1,sensor:[0,2,11,22,27,33,41,43,44,51,52],sensor_driv:[0,43],sensor_osi:[0,3,43],sensoraggreg:43,sensoraggregation_osi:43,sensordata:[0,2,43,51],sensordatasign:[2,51],sensordriv:[2,43],sensorfus:43,sensorfusion_errorless:3,sensorfusionerrorless:43,sensorfusionerrorless_osi:43,sensorfusionlane_:51,sensorfusionnumberofdetectingsensors_:51,sensorfusionobjectid_:51,sensorfusionosi:0,sensorfusionrelativenetleft_:51,sensorfusionrelativenetright_:51,sensorfusionrelativenets_:51,sensorfusionrelativenetx_:51,sensorfusionrelativenety_:51,sensorfusionrelatives_:51,sensorfusionrelativet_:51,sensorfusionrelativex_:51,sensorfusionrelativey_:51,sensorfusionvelocity_:51,sensorfusionvelocityx_:51,sensorfusionvelocityy_:51,sensorfusionyaw_:51,sensorgeometric2d:[0,47],sensorid:38,sensorlink:38,sensorobjectdetector:43,sensorrecordst:43,sensorrecordstatemodul:43,sensorview:[2,3,51],sensorviewconfig:51,sensorviewconfigrequest:51,sensorviewconfigur:2,sent:[2,43,51],separ:[1,8,10,11,21,22,28,31,32,33,39,41,45,48,50,51,52],sequenc:[0,1,6,39,44,50],serial:22,serv:33,set:[1,2,3,7,9,10,11,14,15,17,18,20,21,22,23,28,33,38,39,41,43,44,45,46,48,49,50,51,52],set_absolute_target_spe:5,set_command:5,set_mod:5,set_properti:10,setassignedlaneid:5,setcomponentst:39,setlinearvelocitysplinecontrolstrategi:5,setorient:5,setposit:5,setpositioni:5,setpositionx:5,setroadgraph:5,setsignalvalu:11,setspe:5,setstat:5,setstrategi:5,settrafficsignalst:5,setup:[7,13,15,16,33,39,41],setupcommand:13,setuptool:17,setvis:5,setx:13,setyaw:5,sever:[2,8,11,14,20,21,22,39,41,47,50],shadow:2,shall:[1,7,10,17,21,28,31,35,38,39,46,51],shape:[38,39],share:[4,11,13,17,18,20,21],shell:[0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31,32,33,34,35,36,37,38,39,40,41,42,43,44,45,46,47,48,49,50,51,52,53],shift:[1,13,28,32],shorter:2,shortnam:11,shot:26,should:[1,2,10,11,12,13,14,18,22,33,39,43,44,47,50,51,52],show:[6,8,13,15,17,20,31,33,44],shown:[1,2,11,21,22,29,31,32,51],shutil:1,side:[3,8,50,51],sight:2,sigma:[38,50],sign:[0,33,38],signal:[0,6,11,39,40,43,44,51],signalpriorit:[0,43],signalstrength:[2,51],sim:[1,10,13,39,51,52],similar:[1,12,23],simpl:[2,13,18,38,48],simpli:[10,21,26,33],simplifi:[17,39,48],simul:[1,2,7,8,10,12,14,15,16,17,18,20,21,23,24,27,29,30,33,34,36,38,39,40,41,43,44,46,48,49,50,51],simulation_ex:1,simulationconfig:[33,35,38,52],simulationoutput:[1,33,41,52],simulationtimecondit:39,simulink:51,sinc:[2,3,6,22,43],singal:2,singl:[1,2,10,11,14,16,17,21,38,39,41,44,45],singular:11,sinusoid:[39,49],situat:[14,17,21,23,33,46],six:51,size:[2,11,22,51],skip:[1,2,21,41,45],slash:10,slength:50,slide:51,slip:51,sliptiremaxx2fref:51,sliptiremaxxfref:51,sliptiremaxy2fref:51,sliptiremaxyfref:51,sliptireslidex2fref:51,sliptireslidexfref:51,sliptireslidey2fref:51,sliptireslideyfref:51,slope:51,slot:11,slow:[2,48],slower:22,small:[2,48],smaller:[2,8,46],snippet:[10,48],snowi:41,soffset:[8,40],softwar:[14,15,17,22,33],solid:[8,40,45],solut:[7,13],some:[1,10,12,13,17,21,22,33,39,40,44,48,50,52],sometim:1,sort:[6,10,51],sourc:[0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,18,19,20,21,23,24,25,26,27,28,29,30,31,32,33,34,35,36,37,38,39,40,41,42,43,44,45,46,47,48,49,50,51,52,53],source_fil:11,south:40,space:[11,16,31,32],spacesinlinecommentprefix:11,span:8,spawn:[0,6,39,45,50,52],spawnarea:50,spawncoordin:50,spawner:[0,6,33,37,38,47,52],spawnerprerun_highway_entryexit:7,spawnerprerun_highway_fullstream:7,spawnerprerun_highway_incorrectstreambegin:7,spawnerprerun_highway_incorrectstreammid:7,spawnerprerun_highway_roadoverlap:7,spawnerprerun_highway_singleroad:7,spawnerprerun_singleroad_drivingdirect:7,spawnerprerun_singleroad_rightlaneonli:7,spawnerprerun_singleroad_specifiedlan:7,spawnerprerun_singleroad_specifiedrang:7,spawnerpreruncommon:41,spawnerpreruncommonparameterextractor_extractspawnareas_alloptionalparamet:7,spawnerpreruncommonparameterextractor_extractspawnareaswithsoutofrange_returnsvalid:7,spawnerpreruncommonparameterextractor_getwaytonextroad_nopossiblewai:7,spawnerruntime_highway_multipleroad:7,spawnerruntime_highway_singleroad:7,spawnerruntime_highway_singleroad_drivingdirect:7,spawnerruntime_singleroad_rightlaneonli:7,spawnerruntime_singleroad_specifiedlan:7,spawnerruntimecommon:41,spawnerruntimecommon_osi:50,spawnerruntimecommonparameterextractor_extractminimumseparationbuffer_fixedvalu:7,spawnerruntimecommonparameterextractor_extractminimumseparationbuffer_novalue_setsdefault:7,spawnparamet:5,spawnpoint:[39,50],spawnpointpreruncommon:52,spawnpointruntimecommon:52,spawnpointscenario:52,spawnzon:50,spdx:[10,25],special:[10,11,17,38,39,43,44,51,52],specif:[1,2,4,8,13,14,16,17,18,20,22,28,33,38,39,41,44,51,52],specifi:[1,2,10,11,17,18,20,21,23,26,27,33,38,39,41,50,51,52],speed:[1,2,38,46,48,51],speedact:[0,49],speedactiondynam:39,speedactiontarget:39,speedlimit:8,speedlimit_:51,speedlimitzonebegin:8,speedlimitzoneend:8,speedtargetvaluetyp:39,spell:17,sphinx:[10,17,21],sphinx_execut:10,sphinx_rtd_them:17,sphinxcontrib:17,spin:44,spiral:40,spline:49,split:[1,6,45],spreadsheet:51,spring:51,springcoeffici:51,sqrt:48,src:[13,17],ss_:51,sstart:50,stack:8,stage:13,stai:[2,13],stakehold:33,stand:14,standalon:1,standard:[8,13,21,22,23,33,38,39,40,49,51],standingag:39,start:[7,10,13,14,17,18,22,26,39,41,44,45,49,50,51,52],startcondit:1,starttrigg:39,startup:13,state:[0,4,5,6,8,18,38,43,44,46,48,49,52],stati:2,static_download:39,staticosmpsensordatatotrafficupdatestepp:51,staticto:51,stationari:[4,45],stationaryobject:45,statist:[2,27,30,44],std:[5,11],stddeviat:39,stdio:11,steer:[2,27,43,44,48,51],steeringangl:[41,44],steeringratio:51,steeringsign:51,steeringsignal_steeringwheelangl:51,steeringwheelego:51,step:[1,2,3,6,8,10,11,12,13,15,17,18,21,22,26,33,39,43,44,49,50,51,52],stick:22,still:[12,13,14,22,26,33,51],stochast:[0,33,38,39,43,50,52],stop:[2,8,28,44,49,51],stopatentri:13,stopreason:[1,44],stoptim:[1,44],storag:[17,22],store:[1,4,8,39,44],stori:[1,33,44],str:1,straight:8,strang:[18,33],strategi:47,stream:[8,17],strength:[2,51],strictli:[18,49],string:[1,5,10,21,38,39,41,43,44,45,48,50,51],stringparamet:[38,43],stringsign:39,stringvector:[38,41,44,50],strip:1,structer:21,structur:[2,10,11,15,17,18,22,29,40],stub:11,studi:[23,33],studio:[9,15,21],stvo:8,style:11,sub:39,subdirectori:18,subel:38,subfold:[31,32,51],submodul:2,subsequ:[31,48],subset:[33,39,43],subst:18,substitut:38,subtract:[3,39,48],subtyp:[8,45],succeed:1,success:[1,8,11,26,44],success_r:1,successfulli:[17,18,33,52],successor:[8,40,41],sudo:17,suffer:18,suffic:2,suffici:11,suggest:[13,17],suit:14,suitabl:[2,17,23],suiteabl:12,summar:11,summari:11,sunni:41,superset:[2,33],supplement:23,supplementari:[8,11],support:[1,6,8,10,13,14,17,19,22,23,27,33,38,39,40,44,45,49,51],sure:[10,13,17,18,27,47],surfac:2,surround:[2,52],suu:17,svg:2,symbol:[2,51],syncglobaldata:6,synchron:[6,51],syncron:[6,49],syncworld:6,syntax:[11,17,20,43],system:[0,1,4,8,11,13,14,15,17,18,20,21,23,24,28,33,38,43,44,51,52],systemconfig:[6,27,33,35,38,43,51],systemconfigblueprint:[2,33,35,38,42,44,52],systemconfigfmu:1,systemprofil:44,syuu:17,tab:[11,17,32],tabl:[4,6,16,32,43,48,51],tackl:33,tag:[1,8,17,24,26,27,28,29,30,38,39,40,41,44],take:[2,7,21,39,51],taken:[1,2,4,28,39,51],tangent:2,tangenti:2,target:[8,10,15,20,35,39,49],target_object:33,targetspe:5,task:[0,2,8,11,20,22,51],tcoordin:[39,41,44],team:11,tech:10,technolog:33,teleportact:[0,39],tell:11,temp:13,templat:10,temporari:[10,12,17,51],term:[4,10,25,33,48,50],termin:[11,13,17,41],test:[2,4,7,11,12,13,14,15,16,17,18,20,22,33,52],test_:1,test_end_to_end:1,test_fil:1,testfil:40,testmat:13,texliv:17,text:[2,8,13,17,28,51],tgap:50,tgapwish:48,than:[2,7,8,11,48,49,51,52],the_kei:41,the_observation_librari:41,the_valu:41,theact:1,thei:[6,7,11,13,20,22,28,33,39,41,42,43,44,47,50,52],them:[2,4,11,17,20,23,43,44,51],themaneuv:1,theme:17,therebi:[2,8,10,22,33,46],therefor:[2,6,12,13,18,28,33,39,42,52],thesequ:1,thestori:1,thi:[1,2,3,4,6,8,9,10,11,12,13,14,15,17,18,20,21,22,24,25,26,27,28,29,30,31,32,33,38,39,40,41,43,44,45,46,47,48,49,50,51,52],thing:[13,47],third:[11,17,18,20,22,32],thirdparti:[13,15,17,18,21],those:[22,33],three:[1,2,3,17,26,32,39,51],threesignalstrafficlight:[5,44],threshold:[2,7,51],through:[10,13,15,21,33,47,49,52],throughout:50,thu:[1,10,16,40,52],thw:39,time:[2,4,5,6,11,14,17,21,23,32,33,38,39,41,43,44,48,49,50,51,52],timeheadwaycondit:39,timeofdai:41,timeplot:30,timerefer:39,timestamp:[6,51],timestep:[1,2,4,6,41,44,49,50,51],timetocollis:1,timetocollisioncondit:39,timetocollisionconditiontarget:39,tire:51,tmeasi:51,tmp:13,toc:10,toe:51,togeth:[33,45],toler:39,too:[2,8,17,21,44],tool:[1,7,12,13,14,17,18,22,23,46],toolset:20,top:[33,40],topic:[17,22],topmost:46,torqu:[2,51],total:[2,8,44,51],totaldistancetravel:[1,41,44],touch:[8,39,49],toward:48,town:8,townbegin:8,townend:8,trace:[14,41,44,51],track:[32,44],track_id:32,tradition:23,traffic:[0,14,22,23,33,38,39,46,48,50,52],traffic_light_st:44,trafficact:5,trafficaction_customact:5,trafficaction_followpathact:5,trafficaction_followtrajectoryact:5,trafficag:17,trafficcalmeddistrictbegin:8,trafficcalmeddistrictend:8,trafficcommand:[5,39,51],trafficgroup:[38,47],trafficlight:[0,44],trafficlight_classif:5,trafficlight_classification_mod:5,trafficlightcontrol:44,trafficrul:41,trafficsign:[8,39],trafficsignalact:0,trafficsignalcontrol:39,trafficsignalid:39,trafficsignalst:39,trafficsignalstateact:0,trafficsinkact:0,trafficupd:51,trafficvolum:50,trail:[11,51],trajectori:[2,5,27,28,29,32,43,49,51,52],trajectorya:39,trajectorycatalog:39,trajectoryfil:51,trajectoryfollow:2,trajectoryfollowercommonbas:5,trajectoryfollowerimplement:5,trajectoryfollowingmod:[39,49],trajectorymanipul:2,trajectoryref:39,transfer:51,transform:[1,8,51],transformlist:51,transit:[8,10,39],translat:[3,8,51],translateglobalpositionloc:5,transmiss:[2,11,51],travel:[8,44,51],treat:17,tree:[8,10,17,29],treeview:31,treiber:48,tri:22,triangl:2,trig:39,trigger:[1,5,6,13,33,39,41,43,44,50,51,52],triggeringent:[1,39,44],triggeringentitiesrul:39,trim:11,trimautowhitespac:13,trimfinalnewlin:13,trimtrailingwhitespac:13,troubl:12,truck:39,truth:[22,33],ttc:[7,23,39,50,51,52],ttc_event:1,tunabl:51,turn:[2,10,39,41,51],turningr:41,tutori:[14,15,26,33,53],tutorialspoint:21,two:[1,2,3,4,7,8,10,17,27,31,32,38,43,44,46,50,51,52],twosignalstrafficlight:5,txt:[1,10,11,12,20],type:[0,1,2,4,5,8,11,12,13,21,26,38,39,40,41,43,44,45,48,50,51],typedrivetrain:51,typic:[21,33,50],ubuntu:[11,16,17],uhd:16,uint64_t:5,ultim:8,unabl:1,unavoid:11,und:[8,52],undefin:[50,51],under:[1,10,11,12,13,17,18,20,21,25,46,50,51,52],underli:[8,11,16],underscor:10,understand:[17,33],understood:[8,26],undetect:51,unfamiliar:17,unfortunatli:12,uniform:[7,8],uniformdistribut:38,uniqu:[23,28,39,51],uniqueid:5,unit:[2,5,7,8,13,18,20,21,22,23,38,43,44,48,50,51],unix:[13,17,23],unix_command:21,unless:[11,21,45],unlik:39,unlimit:39,unrel:39,unsign:41,unsort:2,unspecifi:6,untest:7,until:[2,33,41,51],unus:[3,41],updat:[2,4,6,13,14,17,39,43,52],updatecontrolstrategi:5,updateoutput:43,upgrad:17,upload:8,upon:51,upper:2,upperbound:39,uppercamelcas:11,upward:8,usag:[1,10,13,14,17,21,39],use:[1,2,3,10,11,12,13,14,16,17,18,21,22,26,33,38,39,41,44,50,51],use_ccach:18,use_cxx_env:20,usecas:28,used:[2,7,8,10,11,12,13,16,17,20,21,22,23,26,27,28,29,31,32,33,38,39,43,44,48,50,51,52],useful:[21,52],user:[1,2,11,20,21,26,27,28,33,39,43,46,51,52],user_guid:14,userdefin:2,uses:[1,2,3,4,6,10,11,13,17,21,22,38,41,43,51],using:[1,3,7,10,11,12,13,17,21,22,23,26,28,31,33,38,39,44,51],usr:[13,17,18],usual:4,utf:41,util:[10,16,17,23],v1_0:13,v1_1:5,valid:[2,8,33,44,50,51],validlength:40,valu:[1,2,3,6,7,8,13,20,21,28,33,38,39,41,43,44,45,48,50,51],vanish:48,var_00001:28,var_nam:51,vari:[17,38],variabl:[1,8,11,12,13,15,17,18,19,22],variant:39,variat:[33,46,52],varibl:21,varieti:8,variou:[2,10,22,23,33,39,52],varnam:51,vec3:5,vector2d:11,vector:[2,5,8,11,44,50,51],vectorbool:51,vectordoubl:51,vectori:3,veh:2,vehicl:[0,3,4,23,27,28,33,38,39,43,44,47,48,51,52],vehicleattribut:44,vehiclecatalog:[33,38,51],vehiclecompon:[2,37,43,47],vehiclecomponentprofil:51,vehiclecomptocompctrlsign:2,vehicledynam:47,vehicledynamicscontrol:43,vehiclemodel:38,vehiclemodelcatalog:33,vehiclemodelparamet:2,vehiclemodelscatalog:[33,39,52],vehiclemodeltyp:[1,44],vehicleprofil:51,veloc:[1,2,3,4,5,28,32,39,44,48,49,50,51,52],velocitychang:4,velocityego:[1,41,44,51],velocityfront:51,velocityfrontfront:51,velocitywish:48,verb:11,verbos:[1,10],veri:[2,16,46],verifi:7,verkehrstechnik:8,verkehrszeichen:8,version:[10,11,13,14,18,20,21,24,26,27,28,29,30,40,41,45,48],vertex:39,vertic:[39,44,51],verylongnam:11,via:[2,8,13,17,18,21,22,39,43,51],view:[22,24,26,27,28,29,30,37],virtual:[6,8,11,23],visibilityact:[0,39],visibilitydist:[1,41,44],visibl:[2,39,44,49,51],visit:20,visual:[0,9,15,21,24,29,33,41,44,45,51],visual_studio:20,visualstudio:13,volum:[46,52],vscode:[11,13,21],vufo:23,w64:[11,13,17,23],wagstrom:4,wai:[7,10,13,14,15,17,38,39,44,48,50,51],want:[1,2,10,33,52],warn:[17,22,28,33,51],waypoint:39,weather:41,websit:[17,51],weight:[8,40,41,50],well:[13,16,22,23,33,38,39,43,44,51,52],were:[7,44,50],west:40,what:[11,13,14,28,33,39,44],wheel:[2,27,44,48,51],wheelbas:51,when:[1,2,6,7,8,10,11,12,13,17,18,20,21,26,28,33,39,43,44,46,49,51,52],whenev:[1,6],where:[1,2,3,11,12,13,18,26,28,33,39,49,50,51,52],wherea:[8,26],wherebi:8,whether:[1,2,4,8,20,44,50,51],which:[1,2,3,4,6,7,8,10,11,12,13,14,17,18,20,21,22,23,25,26,27,28,31,33,38,39,40,41,43,44,45,46,47,48,49,50,51,52],whick:11,white:31,whitespac:[11,13,17],who:[14,33,44],whole:[2,7,17,33,48,50,51],whose:[3,23],why:[11,21,44],width:[3,8,40,44,51],widthfront:51,wikimedia:8,wikipedia:8,wildcard:10,win64:[13,21],window:[1,11,12,13,15,16,17,18,20,21,22,23],wish:48,with_:13,with_api_doc:10,with_debug_postfix:18,with_doc:[10,18],with_endtoend_test:12,with_pq:20,with_protobuf_arena:17,withag:1,within:[1,2,6,8,11,12,13,17,18,23,33,39,40,41,45,50,51,52],without:[2,8,11,16,21,22,33,41,51],withtout:11,won:[1,13,28],word:[33,39,45],work:[0,1,2,3,4,5,6,7,8,9,10,11,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31,32,33,34,35,36,37,38,39,40,41,42,43,44,45,46,47,48,49,50,51,52,53],workspac:13,workspacefold:13,world:[0,2,4,6,11,22,33,39,41,44,47,50,51,52],world_osi:[0,17,41],worlddata:5,worldinterfac:[11,51],worldlibrari:41,worldposit:39,would:[1,2,10,13,26,33,46],wrap:11,wrapper:[39,47],write:[2,6,10,11,14,17,41,44,45,53],writejson_:51,writejson_sensordata:51,writejson_trafficupd:51,writepersistentent:[41,45],writetrace_:51,writevalu:51,written:[3,10,11,22,28,39,44,45,51,52],www:[4,8,10,21,22,23,25,39,49,51],x64:[13,16],x86_64:[11,13,17],x_max:8,x_min:8,xml:[1,2,22,26,27,33,38,39,41,44,51,52],xmlparser:11,xmlpattern:17,xodr:[10,39,40,52],xosc:[33,39,41,52],xpath:1,xposit:[41,44],xpositioncog:51,xyz:1,y_max:8,y_min:8,yase:20,yase_vers:20,yaw:[2,4,8,38,44,51],yawangl:[41,44],yawego:51,yawfront:51,yawrat:[41,44],yellow:[2,8,39],yes:[6,13,41,50],yet:[1,11,15,17,22,33,35,52],yield:32,you:[1,13,15,17,18,20,21,22,26,27,28,33,45,51,52],your:[9,10,11,12,13,15,17,18,21,22,26,33],yposit:[41,44],ypositioncog:51,zero:[39,45,51],zip:51,zipper:38,zippermerg:38,zlib1g:17,zlib:[13,18,20],zoffset:40,zone:39,zziplib:17},titles:["Simulator","EndToEnd Test Framework","Agent Components","Coordinate Systems","EventDetector","Mapping of OpenSCENARIO Actions","Simulation","Spawner Features","World_OSI","IDE Support","Documentation Concept","Coding Guidelines","Working with Qt Creator","Working with Visual Studio Code","openPASS Documentation","Getting Started","System Requirements","Installing Prerequisites","Installing openPASS","Further Guidance","Building with Conan","CMake Variables and Options","External Dependencies","Glossary","GUI Plugins","License","Project","System Editor","PCM Simulation","PCM Evaluation","Result Visualization","Statistics","TimePlot","Overview","Tutorials","Configs in Depth","Outputs in Depth","Simulator","ProfilesCatalog","Scenario","Scenery","SimulationConfig","Static SystemConfig","SystemConfigBlueprint","Observation_Log","Observation_EntityRepository","Overview","Component View","Driver","Dynamics_Scenario","Spawner","VehicleComponents","Scenario-based simulation","PCM Simulation"],titleterms:{"case":2,"function":2,"import":44,"static":42,IDE:9,IDs:7,Ids:43,Used:2,Useful:22,Using:1,acquir:39,acquirepositionact:5,across:7,action:[5,39],action_longitudinaldriv:2,action_secondarydriv:2,actionbrakesystem:51,actionpowertrain:51,actionsteeringsystem:51,actor:39,addit:20,advanc:14,aeb:51,agent:[2,3,7,39,44],agentcompon:43,agentprofil:[38,39],agentupdat:2,algorithm_later:2,algorithm_longitudin:2,algorithmagentfollowingdrivermodel:48,algorithmcar2xsend:2,also:21,altern:12,append:17,argument:6,assignrouteact:5,assumpt:13,audienc:33,base:52,basic:[1,8,10],between:3,binari:[17,22],boost:22,both:49,boundari:7,buffer:[7,22],build:[10,13,17,20,21],catalog:39,causal:51,ccach:22,chang:39,channel:43,clangformat:11,cmake:[12,13,21,22],cmake_build_typ:21,cmake_c_compil:21,cmake_cxx_compil:21,cmake_install_prefix:21,cmake_object_path_max:21,cmake_prefix_path:21,cmake_with_debug_postix:21,code:[11,13],collect:22,collis:7,collisiondetector:4,command:[6,21],commit:11,compil:22,compon:[2,38,39,47],componentcontrol:2,conan:20,concept:10,condit:39,config:35,configur:[1,13,28],consecut:7,control:48,convent:11,convers:3,coordin:3,creat:20,creator:12,csv:45,custom:19,customcommandact:5,cyclic:44,cyclics_run_:44,datatyp:1,debug:13,debugg:22,defaultcustomcommandact:39,defaultstrategi:49,definit:44,depend:[22,51],depth:[35,36,47],descript:6,dev:1,develop:14,direct:7,distribut:7,docker:10,document:[10,14,17],doxygen:22,drive:7,driver:[38,48],dynamics_collis:2,dynamics_regulardriv:2,dynamics_scenario:[2,49],dynamicschassi:51,dynamicsmotionmodel:51,dynamicstiremodel:51,dynamicstrajectoryfollow:51,editor:27,endtoend:1,entiti:39,environ:[17,41],evalu:[29,31,32],event:[1,44],eventdetector:4,exampl:[1,38,40,41],execut:[1,6,21],exist:7,experi:[28,41],explicit:1,extern:22,featur:7,file:[44,45],filter:1,fmi:22,fmil:[17,22],fmu:51,fmu_wrapp:39,folder:28,follow:39,followrouteact:39,followtrajectori:49,followtrajectoryact:5,followvelocitysplin:49,framework:[1,22],full:[40,41],further:19,gcc:22,gdb:22,gener:[11,20,21,26],geometri:8,get:[15,33],getobstruct:8,git:17,glossari:23,gnu:22,googletest:22,group:7,gui:24,guid:14,guidanc:19,guidelin:11,handl:2,hint:22,imag:10,includ:7,inform:[14,22],init:39,input:[28,33],insid:2,instal:[13,14,17,18,20,21],install_exampl:21,install_extra_runtime_dep:21,install_system_runtime_dep:21,intellisens:13,intend:33,interfac:22,issu:12,junction:7,keeplaneoffset:49,keepveloc:49,kit:[12,13],lane:[7,8],lanechang:39,lanechangeact:5,later:[48,49],librari:[17,22],licens:25,limiteraccelerationvehiclecompon:2,line:6,linux:12,load:[28,29,31,32],local:8,locat:17,logginggroup:44,longitudin:[48,49],make:21,maneuv:39,map:5,mark:8,mechan:10,messag:[11,39],method:12,minizip:17,modelon:22,msys2:[12,13],multipl:7,name:11,non:7,note:[1,22],observ:41,observation_entityrepositori:45,observation_log:44,obstruct:2,onli:[7,20,39],open:22,openpass:[10,14,18],openpass_adjust_output:21,openscenario:[1,5],openscenarioact:2,option:21,osi:[17,22],osmp:39,other:14,output:[26,28,33,36,44,45],outsid:7,overlap:7,overview:[2,33,39,46],packag:[17,22],paramet:[7,43],parameter:44,parameterdeclar:39,parameters_vehicl:2,parametr:45,path:[13,26],payload:1,pcm:[28,29,53],pedestriancatalog:39,performchangelan:49,phase:6,plugin:24,posit:39,prerequisit:[1,17,20],prerunspawn:[7,50],primer:33,prioriti:[6,43],profil:7,profilegroup:38,profilescatalog:[38,41],project:[12,26],protobuf:[17,22],protocol:22,queri:1,rang:7,readvalu:51,receivercar2x:51,recip:20,relativelaneposit:39,relativespe:39,remov:39,repository_persist:45,repository_run_:45,requir:16,restrict:40,result:[1,28,29,30,31,32],right:7,road:[3,7,8],roadnetwork:39,roadposit:39,runstatist:44,runtimespawn:[7,50],sampl:8,save:28,scenario:[39,41,52],sceneri:40,schedul:6,see:21,send:7,sensor:[3,38],sensor_driv:2,sensor_osi:2,sensordata:3,sensorfusionosi:2,sensorgeometric2d:[2,51],separ:7,sequenc:8,set:[12,13,26],setup:12,sign:8,signal:2,signalpriorit:2,simul:[0,6,22,26,28,37,52,53],simulationconfig:41,simulationoutput:44,simulationtim:39,singl:7,slength:7,sourc:[17,22],spawn:[1,7],spawner:[7,41,50],spawnerprofil:38,specifi:7,speedact:[5,39],ssh:17,sstart:7,start:[15,28,33],state:[2,39],statist:31,stochast:7,stoptrigg:39,stori:39,storyboard:39,strategi:49,stream:7,structur:28,studio:13,submodul:10,support:9,syntax:1,system:[3,16,27],systemconfig:42,systemconfigblueprint:43,target:[13,21],task:6,teleportact:5,test:[1,21],tgap:7,thirdparti:20,through:17,time:[1,7],timeheadwai:39,timeplot:32,timetocollis:39,todo:[12,14,44,52,53],todolist:14,topic:14,traffic:[7,8],trafficgroup:50,trafficlight:8,trafficrul:38,trafficsignalact:5,trafficsignalstateact:5,trafficsinkact:5,trajectori:39,transit:1,troubleshoot:13,tutori:34,type:6,use_ccach:21,useddefinedact:39,user:[13,14],userdefinedact:39,variabl:[21,51],variat:28,vehicl:2,vehiclecatalog:39,vehiclecompon:[38,51],vehicledynam:51,vehiclemodel:39,vehicleprofil:38,veloc:7,version:[12,17,22],view:47,visibilityact:5,visual:[2,13,30],wildcard:44,win_onli:13,with_api_doc:21,with_coverag:21,with_doc:21,with_endtoend_test:21,with_protobuf_arena:21,with_simcor:21,with_test:21,within:7,work:[12,13],workflow:33,world:[3,8],world_osi:8,wrapper:51,write:51,zlib:17}}) \ No newline at end of file
diff --git a/content/html/user_guide/10_overview.html b/content/html/user_guide/10_overview.html index 64efdf7..c8cf08c 100644 --- a/content/html/user_guide/10_overview.html +++ b/content/html/user_guide/10_overview.html
@@ -7,7 +7,7 @@ <meta name="viewport" content="width=device-width, initial-scale=1.0" /> - <title>Overview — OpenPASS Documentation</title> + <title>Overview — openPASS Documentation</title> @@ -70,7 +70,7 @@ <div class="version"> - "openPASS v0.11" + "develop_4d7f6d4f2e22c286789082dd8cbe3eb7f5b5af62" </div> @@ -100,7 +100,7 @@ <li class="toctree-l1"><a class="reference internal" href="../installation_guide/10_getting_started.html">Getting Started</a></li> <li class="toctree-l1"><a class="reference internal" href="../installation_guide/15_system_requirements.html">System Requirements</a></li> <li class="toctree-l1"><a class="reference internal" href="../installation_guide/20_install_prerequisites.html">Installing Prerequisites</a></li> -<li class="toctree-l1"><a class="reference internal" href="../installation_guide/30_install_openpass.html">Installing OpenPASS</a></li> +<li class="toctree-l1"><a class="reference internal" href="../installation_guide/30_install_openpass.html">Installing openPASS</a></li> <li class="toctree-l1"><a class="reference internal" href="../installation_guide/50_further_guidance.html">Further Guidance</a></li> <li class="toctree-l1"><a class="reference internal" href="../installation_guide/60_conan.html">Building with Conan</a></li> </ul> @@ -109,7 +109,6 @@ <li class="toctree-l1 current"><a class="current reference internal" href="#">Overview</a><ul> <li class="toctree-l2"><a class="reference internal" href="#getting-started">Getting Started</a></li> <li class="toctree-l2"><a class="reference internal" href="#intended-audience">Intended Audience</a></li> -<li class="toctree-l2"><a class="reference internal" href="#interaction-gui-and-framework">Interaction GUI and Framework</a></li> <li class="toctree-l2"><a class="reference internal" href="#workflow">Workflow</a></li> <li class="toctree-l2"><a class="reference internal" href="#primer">Primer</a><ul> <li class="toctree-l3"><a class="reference internal" href="#inputs">Inputs</a></li> @@ -119,10 +118,9 @@ </ul> </li> <li class="toctree-l1"><a class="reference internal" href="20_tutorials.html">Tutorials</a></li> -<li class="toctree-l1"><a class="reference internal" href="30_gui_plugins.html">GUI Plugins</a></li> -<li class="toctree-l1"><a class="reference internal" href="40_configs_in_depth.html">Configs in Depth</a></li> -<li class="toctree-l1"><a class="reference internal" href="50_outputs_in_depth.html">Outputs in Depth</a></li> -<li class="toctree-l1"><a class="reference internal" href="60_scenario_simulation.html">Simulator</a></li> +<li class="toctree-l1"><a class="reference internal" href="30_configs_in_depth.html">Configs in Depth</a></li> +<li class="toctree-l1"><a class="reference internal" href="40_outputs_in_depth.html">Outputs in Depth</a></li> +<li class="toctree-l1"><a class="reference internal" href="50_scenario_simulation.html">Simulator</a></li> </ul> <p class="caption"><span class="caption-text">Advanced topics</span></p> <ul> @@ -133,12 +131,14 @@ <ul> <li class="toctree-l1"><a class="reference internal" href="../developer_information/10_ide_support.html">IDE Support</a></li> <li class="toctree-l1"><a class="reference internal" href="../developer_information/20_documentation.html">Documentation Concept</a></li> +<li class="toctree-l1"><a class="reference internal" href="../developer_information/30_coding_conventions.html">Coding Guidelines</a></li> </ul> <p class="caption"><span class="caption-text">Other Information</span></p> <ul> <li class="toctree-l1"><a class="reference internal" href="../other_information/10_external_dependencies.html">External Dependencies</a></li> <li class="toctree-l1"><a class="reference internal" href="../other_information/20_glossary.html">Glossary</a></li> -<li class="toctree-l1"><a class="reference internal" href="../other_information/30_license.html">License</a></li> +<li class="toctree-l1"><a class="reference internal" href="../other_information/30_gui_plugins.html">GUI Plugins</a></li> +<li class="toctree-l1"><a class="reference internal" href="../other_information/40_license.html">License</a></li> </ul> @@ -208,8 +208,8 @@ <div class="section" id="overview"> <span id="user-guide-overview"></span><h1>Overview<a class="headerlink" href="#overview" title="Permalink to this headline">¶</a></h1> -<p>OpenPASS is an open-source software, which is continuously being improved by stakeholders of the openPASS working group: <strong>openPASS</strong> (Open Source) (<a class="reference external" href="https://openpass.eclipse.org/">https://openpass.eclipse.org/</a>) -OpenPASS can simulate traffic situations with the goal of predicting and evaluating the safety of driver assistance systems, more specifically ADAS (Advanced Driving Assistance Systems) or AD functions. Its main use-cases are PCM-(PreCrash Matrix), and scenario-based simulations. +<p>openPASS is an open-source software, which is continuously being improved by stakeholders of the openPASS working group: <strong>openPASS</strong> (Open Source) (<a class="reference external" href="https://openpass.eclipse.org/">https://openpass.eclipse.org/</a>) +openPASS can simulate traffic situations with the goal of predicting and evaluating the safety of driver assistance systems, more specifically ADAS (Advanced Driving Assistance Systems) or AD functions. Its main use-cases are PCM-(PreCrash Matrix), and scenario-based simulations. Let’s have a look at what that means:</p> <a class="reference internal image-reference" href="../_images/crash-scenario.png"><img alt="../_images/crash-scenario.png" class="align-center" src="../_images/crash-scenario.png" style="width: 600px;" /></a> <ol class="arabic simple"> @@ -255,12 +255,6 @@ The <code class="docutils literal notranslate"><span class="pre">core</span></code>, executed manually by the experimenter, processes these configs and generates an (configurable) output-set typically placed in a folder named <code class="docutils literal notranslate"><span class="pre">results</span></code>. Thereby, the <strong>Simulation Output</strong> is again a set of files.</p> </div> -<div class="section" id="interaction-gui-and-framework"> -<h2>Interaction GUI and Framework<a class="headerlink" href="#interaction-gui-and-framework" title="Permalink to this headline">¶</a></h2> -<img alt="../_images/gui_framework_overview.png" src="../_images/gui_framework_overview.png" /> -<p>The GUI sits on top of the simulation framework. It produces configuration files for the framework based on the user input. -With these files, the GUI can trigger the simulation to start. The results of the simulation (in form of files) can be evaluated by the GUI.</p> -</div> <div class="section" id="workflow"> <h2>Workflow<a class="headerlink" href="#workflow" title="Permalink to this headline">¶</a></h2> <p>A typical workflow can be:</p> @@ -394,7 +388,7 @@ <div role="contentinfo"> <p> - © Copyright 2023 OpenPASS Working Group. + © Copyright 2023 openPASS Working Group. </p> </div>
diff --git a/content/html/user_guide/20_tutorials.html b/content/html/user_guide/20_tutorials.html index 11bba17..fd74e7c 100644 --- a/content/html/user_guide/20_tutorials.html +++ b/content/html/user_guide/20_tutorials.html
@@ -7,7 +7,7 @@ <meta name="viewport" content="width=device-width, initial-scale=1.0" /> - <title>Tutorials — OpenPASS Documentation</title> + <title>Tutorials — openPASS Documentation</title> @@ -70,7 +70,7 @@ <div class="version"> - "openPASS v0.11" + "develop_4d7f6d4f2e22c286789082dd8cbe3eb7f5b5af62" </div> @@ -100,7 +100,7 @@ <li class="toctree-l1"><a class="reference internal" href="../installation_guide/10_getting_started.html">Getting Started</a></li> <li class="toctree-l1"><a class="reference internal" href="../installation_guide/15_system_requirements.html">System Requirements</a></li> <li class="toctree-l1"><a class="reference internal" href="../installation_guide/20_install_prerequisites.html">Installing Prerequisites</a></li> -<li class="toctree-l1"><a class="reference internal" href="../installation_guide/30_install_openpass.html">Installing OpenPASS</a></li> +<li class="toctree-l1"><a class="reference internal" href="../installation_guide/30_install_openpass.html">Installing openPASS</a></li> <li class="toctree-l1"><a class="reference internal" href="../installation_guide/50_further_guidance.html">Further Guidance</a></li> <li class="toctree-l1"><a class="reference internal" href="../installation_guide/60_conan.html">Building with Conan</a></li> </ul> @@ -112,10 +112,9 @@ <li class="toctree-l2"><a class="reference internal" href="tutorials/20_pcm_simulation.html">PCM Simulation</a></li> </ul> </li> -<li class="toctree-l1"><a class="reference internal" href="30_gui_plugins.html">GUI Plugins</a></li> -<li class="toctree-l1"><a class="reference internal" href="40_configs_in_depth.html">Configs in Depth</a></li> -<li class="toctree-l1"><a class="reference internal" href="50_outputs_in_depth.html">Outputs in Depth</a></li> -<li class="toctree-l1"><a class="reference internal" href="60_scenario_simulation.html">Simulator</a></li> +<li class="toctree-l1"><a class="reference internal" href="30_configs_in_depth.html">Configs in Depth</a></li> +<li class="toctree-l1"><a class="reference internal" href="40_outputs_in_depth.html">Outputs in Depth</a></li> +<li class="toctree-l1"><a class="reference internal" href="50_scenario_simulation.html">Simulator</a></li> </ul> <p class="caption"><span class="caption-text">Advanced topics</span></p> <ul> @@ -126,12 +125,14 @@ <ul> <li class="toctree-l1"><a class="reference internal" href="../developer_information/10_ide_support.html">IDE Support</a></li> <li class="toctree-l1"><a class="reference internal" href="../developer_information/20_documentation.html">Documentation Concept</a></li> +<li class="toctree-l1"><a class="reference internal" href="../developer_information/30_coding_conventions.html">Coding Guidelines</a></li> </ul> <p class="caption"><span class="caption-text">Other Information</span></p> <ul> <li class="toctree-l1"><a class="reference internal" href="../other_information/10_external_dependencies.html">External Dependencies</a></li> <li class="toctree-l1"><a class="reference internal" href="../other_information/20_glossary.html">Glossary</a></li> -<li class="toctree-l1"><a class="reference internal" href="../other_information/30_license.html">License</a></li> +<li class="toctree-l1"><a class="reference internal" href="../other_information/30_gui_plugins.html">GUI Plugins</a></li> +<li class="toctree-l1"><a class="reference internal" href="../other_information/40_license.html">License</a></li> </ul> @@ -223,7 +224,7 @@ <div role="contentinfo"> <p> - © Copyright 2023 OpenPASS Working Group. + © Copyright 2023 openPASS Working Group. </p> </div>
diff --git a/content/html/user_guide/40_configs_in_depth.html b/content/html/user_guide/30_configs_in_depth.html similarity index 89% rename from content/html/user_guide/40_configs_in_depth.html rename to content/html/user_guide/30_configs_in_depth.html index c07d32b..afa38a7 100644 --- a/content/html/user_guide/40_configs_in_depth.html +++ b/content/html/user_guide/30_configs_in_depth.html
@@ -7,7 +7,7 @@ <meta name="viewport" content="width=device-width, initial-scale=1.0" /> - <title>Configs in Depth — OpenPASS Documentation</title> + <title>Configs in Depth — openPASS Documentation</title> @@ -43,7 +43,7 @@ <link rel="index" title="Index" href="../genindex.html" /> <link rel="search" title="Search" href="../search.html" /> <link rel="next" title="ProfilesCatalog" href="configs/profilescatalog.html" /> - <link rel="prev" title="TimePlot" href="gui_user_guide/result_visualization/20_timePlot.html" /> + <link rel="prev" title="PCM Simulation" href="tutorials/20_pcm_simulation.html" /> </head> <body class="wy-body-for-nav"> @@ -70,7 +70,7 @@ <div class="version"> - "openPASS v0.11" + "develop_4d7f6d4f2e22c286789082dd8cbe3eb7f5b5af62" </div> @@ -100,7 +100,7 @@ <li class="toctree-l1"><a class="reference internal" href="../installation_guide/10_getting_started.html">Getting Started</a></li> <li class="toctree-l1"><a class="reference internal" href="../installation_guide/15_system_requirements.html">System Requirements</a></li> <li class="toctree-l1"><a class="reference internal" href="../installation_guide/20_install_prerequisites.html">Installing Prerequisites</a></li> -<li class="toctree-l1"><a class="reference internal" href="../installation_guide/30_install_openpass.html">Installing OpenPASS</a></li> +<li class="toctree-l1"><a class="reference internal" href="../installation_guide/30_install_openpass.html">Installing openPASS</a></li> <li class="toctree-l1"><a class="reference internal" href="../installation_guide/50_further_guidance.html">Further Guidance</a></li> <li class="toctree-l1"><a class="reference internal" href="../installation_guide/60_conan.html">Building with Conan</a></li> </ul> @@ -108,7 +108,6 @@ <ul class="current"> <li class="toctree-l1"><a class="reference internal" href="10_overview.html">Overview</a></li> <li class="toctree-l1"><a class="reference internal" href="20_tutorials.html">Tutorials</a></li> -<li class="toctree-l1"><a class="reference internal" href="30_gui_plugins.html">GUI Plugins</a></li> <li class="toctree-l1 current"><a class="current reference internal" href="#">Configs in Depth</a><ul> <li class="toctree-l2"><a class="reference internal" href="configs/profilescatalog.html">ProfilesCatalog</a></li> <li class="toctree-l2"><a class="reference internal" href="configs/scenario.html">Scenario</a></li> @@ -118,8 +117,8 @@ <li class="toctree-l2"><a class="reference internal" href="configs/systemconfigblueprint.html">SystemConfigBlueprint</a></li> </ul> </li> -<li class="toctree-l1"><a class="reference internal" href="50_outputs_in_depth.html">Outputs in Depth</a></li> -<li class="toctree-l1"><a class="reference internal" href="60_scenario_simulation.html">Simulator</a></li> +<li class="toctree-l1"><a class="reference internal" href="40_outputs_in_depth.html">Outputs in Depth</a></li> +<li class="toctree-l1"><a class="reference internal" href="50_scenario_simulation.html">Simulator</a></li> </ul> <p class="caption"><span class="caption-text">Advanced topics</span></p> <ul> @@ -130,12 +129,14 @@ <ul> <li class="toctree-l1"><a class="reference internal" href="../developer_information/10_ide_support.html">IDE Support</a></li> <li class="toctree-l1"><a class="reference internal" href="../developer_information/20_documentation.html">Documentation Concept</a></li> +<li class="toctree-l1"><a class="reference internal" href="../developer_information/30_coding_conventions.html">Coding Guidelines</a></li> </ul> <p class="caption"><span class="caption-text">Other Information</span></p> <ul> <li class="toctree-l1"><a class="reference internal" href="../other_information/10_external_dependencies.html">External Dependencies</a></li> <li class="toctree-l1"><a class="reference internal" href="../other_information/20_glossary.html">Glossary</a></li> -<li class="toctree-l1"><a class="reference internal" href="../other_information/30_license.html">License</a></li> +<li class="toctree-l1"><a class="reference internal" href="../other_information/30_gui_plugins.html">GUI Plugins</a></li> +<li class="toctree-l1"><a class="reference internal" href="../other_information/40_license.html">License</a></li> </ul> @@ -190,7 +191,7 @@ <li class="wy-breadcrumbs-aside"> - <a href="../_sources/user_guide/40_configs_in_depth.rst.txt" rel="nofollow"> View page source</a> + <a href="../_sources/user_guide/30_configs_in_depth.rst.txt" rel="nofollow"> View page source</a> </li> @@ -226,14 +227,14 @@ <footer> <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> <a href="configs/profilescatalog.html" class="btn btn-neutral float-right" title="ProfilesCatalog" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a> - <a href="gui_user_guide/result_visualization/20_timePlot.html" class="btn btn-neutral float-left" title="TimePlot" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a> + <a href="tutorials/20_pcm_simulation.html" class="btn btn-neutral float-left" title="PCM Simulation" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a> </div> <hr/> <div role="contentinfo"> <p> - © Copyright 2023 OpenPASS Working Group. + © Copyright 2023 openPASS Working Group. </p> </div>
diff --git a/content/html/user_guide/50_outputs_in_depth.html b/content/html/user_guide/40_outputs_in_depth.html similarity index 90% rename from content/html/user_guide/50_outputs_in_depth.html rename to content/html/user_guide/40_outputs_in_depth.html index 33ce46b..e681386 100644 --- a/content/html/user_guide/50_outputs_in_depth.html +++ b/content/html/user_guide/40_outputs_in_depth.html
@@ -7,7 +7,7 @@ <meta name="viewport" content="width=device-width, initial-scale=1.0" /> - <title>Outputs in Depth — OpenPASS Documentation</title> + <title>Outputs in Depth — openPASS Documentation</title> @@ -42,7 +42,7 @@ <link rel="index" title="Index" href="../genindex.html" /> <link rel="search" title="Search" href="../search.html" /> - <link rel="next" title="Simulator" href="60_scenario_simulation.html" /> + <link rel="next" title="Simulator" href="50_scenario_simulation.html" /> <link rel="prev" title="SystemConfigBlueprint" href="configs/systemconfigblueprint.html" /> </head> @@ -70,7 +70,7 @@ <div class="version"> - "openPASS v0.11" + "develop_4d7f6d4f2e22c286789082dd8cbe3eb7f5b5af62" </div> @@ -100,7 +100,7 @@ <li class="toctree-l1"><a class="reference internal" href="../installation_guide/10_getting_started.html">Getting Started</a></li> <li class="toctree-l1"><a class="reference internal" href="../installation_guide/15_system_requirements.html">System Requirements</a></li> <li class="toctree-l1"><a class="reference internal" href="../installation_guide/20_install_prerequisites.html">Installing Prerequisites</a></li> -<li class="toctree-l1"><a class="reference internal" href="../installation_guide/30_install_openpass.html">Installing OpenPASS</a></li> +<li class="toctree-l1"><a class="reference internal" href="../installation_guide/30_install_openpass.html">Installing openPASS</a></li> <li class="toctree-l1"><a class="reference internal" href="../installation_guide/50_further_guidance.html">Further Guidance</a></li> <li class="toctree-l1"><a class="reference internal" href="../installation_guide/60_conan.html">Building with Conan</a></li> </ul> @@ -108,14 +108,13 @@ <ul class="current"> <li class="toctree-l1"><a class="reference internal" href="10_overview.html">Overview</a></li> <li class="toctree-l1"><a class="reference internal" href="20_tutorials.html">Tutorials</a></li> -<li class="toctree-l1"><a class="reference internal" href="30_gui_plugins.html">GUI Plugins</a></li> -<li class="toctree-l1"><a class="reference internal" href="40_configs_in_depth.html">Configs in Depth</a></li> +<li class="toctree-l1"><a class="reference internal" href="30_configs_in_depth.html">Configs in Depth</a></li> <li class="toctree-l1 current"><a class="current reference internal" href="#">Outputs in Depth</a><ul> <li class="toctree-l2"><a class="reference internal" href="outputs/observation_log.html">Observation_Log</a></li> <li class="toctree-l2"><a class="reference internal" href="outputs/observation_repository.html">Observation_EntityRepository</a></li> </ul> </li> -<li class="toctree-l1"><a class="reference internal" href="60_scenario_simulation.html">Simulator</a></li> +<li class="toctree-l1"><a class="reference internal" href="50_scenario_simulation.html">Simulator</a></li> </ul> <p class="caption"><span class="caption-text">Advanced topics</span></p> <ul> @@ -126,12 +125,14 @@ <ul> <li class="toctree-l1"><a class="reference internal" href="../developer_information/10_ide_support.html">IDE Support</a></li> <li class="toctree-l1"><a class="reference internal" href="../developer_information/20_documentation.html">Documentation Concept</a></li> +<li class="toctree-l1"><a class="reference internal" href="../developer_information/30_coding_conventions.html">Coding Guidelines</a></li> </ul> <p class="caption"><span class="caption-text">Other Information</span></p> <ul> <li class="toctree-l1"><a class="reference internal" href="../other_information/10_external_dependencies.html">External Dependencies</a></li> <li class="toctree-l1"><a class="reference internal" href="../other_information/20_glossary.html">Glossary</a></li> -<li class="toctree-l1"><a class="reference internal" href="../other_information/30_license.html">License</a></li> +<li class="toctree-l1"><a class="reference internal" href="../other_information/30_gui_plugins.html">GUI Plugins</a></li> +<li class="toctree-l1"><a class="reference internal" href="../other_information/40_license.html">License</a></li> </ul> @@ -186,7 +187,7 @@ <li class="wy-breadcrumbs-aside"> - <a href="../_sources/user_guide/50_outputs_in_depth.rst.txt" rel="nofollow"> View page source</a> + <a href="../_sources/user_guide/40_outputs_in_depth.rst.txt" rel="nofollow"> View page source</a> </li> @@ -217,7 +218,7 @@ </div> <footer> <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> - <a href="60_scenario_simulation.html" class="btn btn-neutral float-right" title="Simulator" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a> + <a href="50_scenario_simulation.html" class="btn btn-neutral float-right" title="Simulator" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a> <a href="configs/systemconfigblueprint.html" class="btn btn-neutral float-left" title="SystemConfigBlueprint" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a> </div> @@ -225,7 +226,7 @@ <div role="contentinfo"> <p> - © Copyright 2023 OpenPASS Working Group. + © Copyright 2023 openPASS Working Group. </p> </div>
diff --git a/content/html/user_guide/60_scenario_simulation.html b/content/html/user_guide/50_scenario_simulation.html similarity index 88% rename from content/html/user_guide/60_scenario_simulation.html rename to content/html/user_guide/50_scenario_simulation.html index 65a36b1..cc00aba 100644 --- a/content/html/user_guide/60_scenario_simulation.html +++ b/content/html/user_guide/50_scenario_simulation.html
@@ -7,7 +7,7 @@ <meta name="viewport" content="width=device-width, initial-scale=1.0" /> - <title>Simulator — OpenPASS Documentation</title> + <title>Simulator — openPASS Documentation</title> @@ -43,7 +43,7 @@ <link rel="index" title="Index" href="../genindex.html" /> <link rel="search" title="Search" href="../search.html" /> <link rel="next" title="Overview" href="sim_user_guide/10_overview.html" /> - <link rel="prev" title="Outputs in Depth" href="50_outputs_in_depth.html" /> + <link rel="prev" title="Outputs in Depth" href="40_outputs_in_depth.html" /> </head> <body class="wy-body-for-nav"> @@ -70,7 +70,7 @@ <div class="version"> - "openPASS v0.11" + "develop_4d7f6d4f2e22c286789082dd8cbe3eb7f5b5af62" </div> @@ -100,7 +100,7 @@ <li class="toctree-l1"><a class="reference internal" href="../installation_guide/10_getting_started.html">Getting Started</a></li> <li class="toctree-l1"><a class="reference internal" href="../installation_guide/15_system_requirements.html">System Requirements</a></li> <li class="toctree-l1"><a class="reference internal" href="../installation_guide/20_install_prerequisites.html">Installing Prerequisites</a></li> -<li class="toctree-l1"><a class="reference internal" href="../installation_guide/30_install_openpass.html">Installing OpenPASS</a></li> +<li class="toctree-l1"><a class="reference internal" href="../installation_guide/30_install_openpass.html">Installing openPASS</a></li> <li class="toctree-l1"><a class="reference internal" href="../installation_guide/50_further_guidance.html">Further Guidance</a></li> <li class="toctree-l1"><a class="reference internal" href="../installation_guide/60_conan.html">Building with Conan</a></li> </ul> @@ -108,9 +108,8 @@ <ul class="current"> <li class="toctree-l1"><a class="reference internal" href="10_overview.html">Overview</a></li> <li class="toctree-l1"><a class="reference internal" href="20_tutorials.html">Tutorials</a></li> -<li class="toctree-l1"><a class="reference internal" href="30_gui_plugins.html">GUI Plugins</a></li> -<li class="toctree-l1"><a class="reference internal" href="40_configs_in_depth.html">Configs in Depth</a></li> -<li class="toctree-l1"><a class="reference internal" href="50_outputs_in_depth.html">Outputs in Depth</a></li> +<li class="toctree-l1"><a class="reference internal" href="30_configs_in_depth.html">Configs in Depth</a></li> +<li class="toctree-l1"><a class="reference internal" href="40_outputs_in_depth.html">Outputs in Depth</a></li> <li class="toctree-l1 current"><a class="current reference internal" href="#">Simulator</a><ul> <li class="toctree-l2"><a class="reference internal" href="sim_user_guide/10_overview.html">Overview</a></li> <li class="toctree-l2"><a class="reference internal" href="sim_user_guide/20_components.html">Component View</a></li> @@ -126,12 +125,14 @@ <ul> <li class="toctree-l1"><a class="reference internal" href="../developer_information/10_ide_support.html">IDE Support</a></li> <li class="toctree-l1"><a class="reference internal" href="../developer_information/20_documentation.html">Documentation Concept</a></li> +<li class="toctree-l1"><a class="reference internal" href="../developer_information/30_coding_conventions.html">Coding Guidelines</a></li> </ul> <p class="caption"><span class="caption-text">Other Information</span></p> <ul> <li class="toctree-l1"><a class="reference internal" href="../other_information/10_external_dependencies.html">External Dependencies</a></li> <li class="toctree-l1"><a class="reference internal" href="../other_information/20_glossary.html">Glossary</a></li> -<li class="toctree-l1"><a class="reference internal" href="../other_information/30_license.html">License</a></li> +<li class="toctree-l1"><a class="reference internal" href="../other_information/30_gui_plugins.html">GUI Plugins</a></li> +<li class="toctree-l1"><a class="reference internal" href="../other_information/40_license.html">License</a></li> </ul> @@ -186,7 +187,7 @@ <li class="wy-breadcrumbs-aside"> - <a href="../_sources/user_guide/60_scenario_simulation.rst.txt" rel="nofollow"> View page source</a> + <a href="../_sources/user_guide/50_scenario_simulation.rst.txt" rel="nofollow"> View page source</a> </li> @@ -207,6 +208,7 @@ <li class="toctree-l1"><a class="reference internal" href="sim_user_guide/20_components.html">Component View</a><ul> <li class="toctree-l2"><a class="reference internal" href="sim_user_guide/20_components.html#components-in-depth">Components in Depth</a><ul> <li class="toctree-l3"><a class="reference internal" href="sim_user_guide/components/driver.html">Driver</a></li> +<li class="toctree-l3"><a class="reference internal" href="sim_user_guide/components/dynamics_scenario.html">Dynamics_Scenario</a></li> <li class="toctree-l3"><a class="reference internal" href="sim_user_guide/components/spawner.html">Spawner</a></li> <li class="toctree-l3"><a class="reference internal" href="sim_user_guide/components/vehicle.html">VehicleComponents</a></li> </ul> @@ -224,14 +226,14 @@ <footer> <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> <a href="sim_user_guide/10_overview.html" class="btn btn-neutral float-right" title="Overview" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a> - <a href="50_outputs_in_depth.html" class="btn btn-neutral float-left" title="Outputs in Depth" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a> + <a href="40_outputs_in_depth.html" class="btn btn-neutral float-left" title="Outputs in Depth" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a> </div> <hr/> <div role="contentinfo"> <p> - © Copyright 2023 OpenPASS Working Group. + © Copyright 2023 openPASS Working Group. </p> </div>
diff --git a/content/html/user_guide/configs/profilescatalog.html b/content/html/user_guide/configs/profilescatalog.html index 938c06a..bed681c 100644 --- a/content/html/user_guide/configs/profilescatalog.html +++ b/content/html/user_guide/configs/profilescatalog.html
@@ -7,7 +7,7 @@ <meta name="viewport" content="width=device-width, initial-scale=1.0" /> - <title>ProfilesCatalog — OpenPASS Documentation</title> + <title>ProfilesCatalog — openPASS Documentation</title> @@ -43,7 +43,7 @@ <link rel="index" title="Index" href="../../genindex.html" /> <link rel="search" title="Search" href="../../search.html" /> <link rel="next" title="Scenario" href="scenario.html" /> - <link rel="prev" title="Configs in Depth" href="../40_configs_in_depth.html" /> + <link rel="prev" title="Configs in Depth" href="../30_configs_in_depth.html" /> </head> <body class="wy-body-for-nav"> @@ -70,7 +70,7 @@ <div class="version"> - "openPASS v0.11" + "develop_4d7f6d4f2e22c286789082dd8cbe3eb7f5b5af62" </div> @@ -100,7 +100,7 @@ <li class="toctree-l1"><a class="reference internal" href="../../installation_guide/10_getting_started.html">Getting Started</a></li> <li class="toctree-l1"><a class="reference internal" href="../../installation_guide/15_system_requirements.html">System Requirements</a></li> <li class="toctree-l1"><a class="reference internal" href="../../installation_guide/20_install_prerequisites.html">Installing Prerequisites</a></li> -<li class="toctree-l1"><a class="reference internal" href="../../installation_guide/30_install_openpass.html">Installing OpenPASS</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../installation_guide/30_install_openpass.html">Installing openPASS</a></li> <li class="toctree-l1"><a class="reference internal" href="../../installation_guide/50_further_guidance.html">Further Guidance</a></li> <li class="toctree-l1"><a class="reference internal" href="../../installation_guide/60_conan.html">Building with Conan</a></li> </ul> @@ -108,8 +108,7 @@ <ul class="current"> <li class="toctree-l1"><a class="reference internal" href="../10_overview.html">Overview</a></li> <li class="toctree-l1"><a class="reference internal" href="../20_tutorials.html">Tutorials</a></li> -<li class="toctree-l1"><a class="reference internal" href="../30_gui_plugins.html">GUI Plugins</a></li> -<li class="toctree-l1 current"><a class="reference internal" href="../40_configs_in_depth.html">Configs in Depth</a><ul class="current"> +<li class="toctree-l1 current"><a class="reference internal" href="../30_configs_in_depth.html">Configs in Depth</a><ul class="current"> <li class="toctree-l2 current"><a class="current reference internal" href="#">ProfilesCatalog</a><ul> <li class="toctree-l3"><a class="reference internal" href="#agentprofiles">AgentProfiles</a><ul> <li class="toctree-l4"><a class="reference internal" href="#example">Example</a></li> @@ -134,8 +133,8 @@ <li class="toctree-l2"><a class="reference internal" href="systemconfigblueprint.html">SystemConfigBlueprint</a></li> </ul> </li> -<li class="toctree-l1"><a class="reference internal" href="../50_outputs_in_depth.html">Outputs in Depth</a></li> -<li class="toctree-l1"><a class="reference internal" href="../60_scenario_simulation.html">Simulator</a></li> +<li class="toctree-l1"><a class="reference internal" href="../40_outputs_in_depth.html">Outputs in Depth</a></li> +<li class="toctree-l1"><a class="reference internal" href="../50_scenario_simulation.html">Simulator</a></li> </ul> <p class="caption"><span class="caption-text">Advanced topics</span></p> <ul> @@ -146,12 +145,14 @@ <ul> <li class="toctree-l1"><a class="reference internal" href="../../developer_information/10_ide_support.html">IDE Support</a></li> <li class="toctree-l1"><a class="reference internal" href="../../developer_information/20_documentation.html">Documentation Concept</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../developer_information/30_coding_conventions.html">Coding Guidelines</a></li> </ul> <p class="caption"><span class="caption-text">Other Information</span></p> <ul> <li class="toctree-l1"><a class="reference internal" href="../../other_information/10_external_dependencies.html">External Dependencies</a></li> <li class="toctree-l1"><a class="reference internal" href="../../other_information/20_glossary.html">Glossary</a></li> -<li class="toctree-l1"><a class="reference internal" href="../../other_information/30_license.html">License</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../other_information/30_gui_plugins.html">GUI Plugins</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../other_information/40_license.html">License</a></li> </ul> @@ -200,7 +201,7 @@ <li><a href="../../index.html" class="icon icon-home"></a> »</li> - <li><a href="../40_configs_in_depth.html">Configs in Depth</a> »</li> + <li><a href="../30_configs_in_depth.html">Configs in Depth</a> »</li> <li>ProfilesCatalog</li> @@ -659,14 +660,14 @@ <footer> <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> <a href="scenario.html" class="btn btn-neutral float-right" title="Scenario" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a> - <a href="../40_configs_in_depth.html" class="btn btn-neutral float-left" title="Configs in Depth" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a> + <a href="../30_configs_in_depth.html" class="btn btn-neutral float-left" title="Configs in Depth" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a> </div> <hr/> <div role="contentinfo"> <p> - © Copyright 2023 OpenPASS Working Group. + © Copyright 2023 openPASS Working Group. </p> </div>
diff --git a/content/html/user_guide/configs/scenario.html b/content/html/user_guide/configs/scenario.html index 50d24eb..f35f1fe 100644 --- a/content/html/user_guide/configs/scenario.html +++ b/content/html/user_guide/configs/scenario.html
@@ -7,7 +7,7 @@ <meta name="viewport" content="width=device-width, initial-scale=1.0" /> - <title>Scenario — OpenPASS Documentation</title> + <title>Scenario — openPASS Documentation</title> @@ -70,7 +70,7 @@ <div class="version"> - "openPASS v0.11" + "develop_4d7f6d4f2e22c286789082dd8cbe3eb7f5b5af62" </div> @@ -100,7 +100,7 @@ <li class="toctree-l1"><a class="reference internal" href="../../installation_guide/10_getting_started.html">Getting Started</a></li> <li class="toctree-l1"><a class="reference internal" href="../../installation_guide/15_system_requirements.html">System Requirements</a></li> <li class="toctree-l1"><a class="reference internal" href="../../installation_guide/20_install_prerequisites.html">Installing Prerequisites</a></li> -<li class="toctree-l1"><a class="reference internal" href="../../installation_guide/30_install_openpass.html">Installing OpenPASS</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../installation_guide/30_install_openpass.html">Installing openPASS</a></li> <li class="toctree-l1"><a class="reference internal" href="../../installation_guide/50_further_guidance.html">Further Guidance</a></li> <li class="toctree-l1"><a class="reference internal" href="../../installation_guide/60_conan.html">Building with Conan</a></li> </ul> @@ -108,8 +108,7 @@ <ul class="current"> <li class="toctree-l1"><a class="reference internal" href="../10_overview.html">Overview</a></li> <li class="toctree-l1"><a class="reference internal" href="../20_tutorials.html">Tutorials</a></li> -<li class="toctree-l1"><a class="reference internal" href="../30_gui_plugins.html">GUI Plugins</a></li> -<li class="toctree-l1 current"><a class="reference internal" href="../40_configs_in_depth.html">Configs in Depth</a><ul class="current"> +<li class="toctree-l1 current"><a class="reference internal" href="../30_configs_in_depth.html">Configs in Depth</a><ul class="current"> <li class="toctree-l2"><a class="reference internal" href="profilescatalog.html">ProfilesCatalog</a></li> <li class="toctree-l2 current"><a class="current reference internal" href="#">Scenario</a><ul> <li class="toctree-l3"><a class="reference internal" href="#overview">Overview</a></li> @@ -135,8 +134,8 @@ <li class="toctree-l2"><a class="reference internal" href="systemconfigblueprint.html">SystemConfigBlueprint</a></li> </ul> </li> -<li class="toctree-l1"><a class="reference internal" href="../50_outputs_in_depth.html">Outputs in Depth</a></li> -<li class="toctree-l1"><a class="reference internal" href="../60_scenario_simulation.html">Simulator</a></li> +<li class="toctree-l1"><a class="reference internal" href="../40_outputs_in_depth.html">Outputs in Depth</a></li> +<li class="toctree-l1"><a class="reference internal" href="../50_scenario_simulation.html">Simulator</a></li> </ul> <p class="caption"><span class="caption-text">Advanced topics</span></p> <ul> @@ -147,12 +146,14 @@ <ul> <li class="toctree-l1"><a class="reference internal" href="../../developer_information/10_ide_support.html">IDE Support</a></li> <li class="toctree-l1"><a class="reference internal" href="../../developer_information/20_documentation.html">Documentation Concept</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../developer_information/30_coding_conventions.html">Coding Guidelines</a></li> </ul> <p class="caption"><span class="caption-text">Other Information</span></p> <ul> <li class="toctree-l1"><a class="reference internal" href="../../other_information/10_external_dependencies.html">External Dependencies</a></li> <li class="toctree-l1"><a class="reference internal" href="../../other_information/20_glossary.html">Glossary</a></li> -<li class="toctree-l1"><a class="reference internal" href="../../other_information/30_license.html">License</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../other_information/30_gui_plugins.html">GUI Plugins</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../other_information/40_license.html">License</a></li> </ul> @@ -201,7 +202,7 @@ <li><a href="../../index.html" class="icon icon-home"></a> »</li> - <li><a href="../40_configs_in_depth.html">Configs in Depth</a> »</li> + <li><a href="../30_configs_in_depth.html">Configs in Depth</a> »</li> <li>Scenario</li> @@ -240,7 +241,7 @@ </pre></div> </div> <p><strong>Example usage</strong></p> -<div class="highlight-xml notranslate"><div class="highlight"><pre><span></span><span class="nt"><SimulationTimeCondition</span> <span class="na">value=</span><span class="s">"30.0"</span> <span class="na">rule=</span><span class="s">"greaterThan"</span><span class="nt">/></span> +<div class="highlight-xml notranslate"><div class="highlight"><pre><span></span> <span class="nt"><SimulationTimeCondition</span> <span class="na">value=</span><span class="s">"0.0"</span> <span class="na">rule=</span><span class="s">"greaterOrEqual"</span><span class="nt">/></span> </pre></div> </div> <p><strong>Supported parameterTypes</strong></p> @@ -270,10 +271,10 @@ <p><strong>Example</strong></p> <div class="highlight-xml notranslate"><div class="highlight"><pre><span></span><span class="nt"><CatalogLocations></span> <span class="nt"><VehicleCatalog></span> - <span class="nt"><Directory</span> <span class="na">path=</span><span class="s">"VehicleModelsCatalog.xosc"</span><span class="nt">/></span> + <span class="nt"><Directory</span> <span class="na">path=</span><span class="s">"Vehicles"</span><span class="nt">/></span> <span class="nt"></VehicleCatalog></span> <span class="nt"><PedestrianCatalog></span> - <span class="nt"><Directory</span> <span class="na">path=</span><span class="s">"PedestrianModelsCatalog.xosc"</span><span class="nt">/></span> + <span class="nt"><Directory</span> <span class="na">path=</span><span class="s">"Vehicles"</span><span class="nt">/></span> <span class="nt"></PedestrianCatalog></span> <span class="nt"><ControllerCatalog></span> <span class="nt"><Directory</span> <span class="na">path=</span><span class="s">""</span><span class="nt">/></span> @@ -298,8 +299,8 @@ </div> <div class="section" id="vehiclecatalog"> <span id="scenario-vehiclemodels"></span><h3>VehicleCatalog<a class="headerlink" href="#vehiclecatalog" title="Permalink to this headline">¶</a></h3> -<p>This file is mandatory. -It contains the available vehicle models for the simulation. +<p>This path is mandatory. +It contains the available vehicle model catalogs for the simulation. For each vehicle the physical parameters are stored here.</p> <p><strong>Supported models:</strong></p> <ul class="simple"> @@ -312,12 +313,16 @@ <li><p>truck</p></li> <li><p>bicycle</p></li> </ul> -<p><strong>Full Example:</strong> <a class="reference download internal" download="" href="../../_downloads/bc0ffd4f4913ee64271fcfbe312d1f55/VehicleModelsCatalog.xosc"><code class="xref download docutils literal notranslate"><span class="pre">/../../../repo/sim/contrib/examples/Common/VehicleModelsCatalog.xosc</span></code></a></p> +<p><strong>Example Catalog:</strong> <a class="reference download internal" download="" href="../../_downloads/8789748ec2bbe8f70ec8c0763329bc98/VehicleModelsCatalog.xosc"><code class="xref download docutils literal notranslate"><span class="pre">/../../../repo/sim/contrib/examples/Common/Vehicles/VehicleModelsCatalog.xosc</span></code></a></p> </div> <div class="section" id="pedestriancatalog"> <span id="scenario-pedestrianmodels"></span><h3>PedestrianCatalog<a class="headerlink" href="#pedestriancatalog" title="Permalink to this headline">¶</a></h3> -<p>This file is mandatory. -It contains the available pedestrian models for the simulation. +<div class="admonition warning"> +<p class="admonition-title">Warning</p> +<p>This part of the documentation needs a major update! Pedestrians are handled as vehicles and are included in the vehicle catalogs.</p> +</div> +<p>This path is mandatory. +It contains the available pedestrian model catalogs for the simulation. For each pedestrian the physical parameters are stored here.</p> <div class="admonition note"> <p class="admonition-title">Note</p> @@ -329,7 +334,7 @@ <li><p>pedestrian_child</p></li> <li><p>pedestrian_adult</p></li> </ul> -<p><strong>Full Example:</strong> <a class="reference download internal" download="" href="../../_downloads/459c8430e19638f5201d47052051994a/PedestrianModelsCatalog.xosc"><code class="xref download docutils literal notranslate"><span class="pre">/../../../repo/sim/contrib/examples/Common/PedestrianModelsCatalog.xosc</span></code></a></p> +<p><strong>Full Example:</strong> <a class="reference download internal" download="" href="../../_downloads/e127566572084ecb8640fe52563f5060/PedestrianModelsCatalog.xosc"><code class="xref download docutils literal notranslate"><span class="pre">/../../../repo/sim/contrib/examples/Common/Vehicles/PedestrianModelsCatalog.xosc</span></code></a></p> </div> </div> <div class="section" id="roadnetwork"> @@ -349,16 +354,16 @@ <div class="highlight-xml notranslate"><div class="highlight"><pre><span></span><span class="nt"><TrafficSignals></span> <span class="nt"><TrafficSignalController</span> <span class="na">name=</span><span class="s">""</span><span class="nt">></span> <span class="nt"><Phase</span> <span class="na">duration=</span><span class="s">"3"</span> <span class="na">name=</span><span class="s">"Phase1"</span><span class="nt">></span> - <span class="nt"><TrafficSignalState</span> <span class="na">state=</span><span class="s">"green"</span> <span class="na">trafficSignalId=</span><span class="s">"1"</span> <span class="nt">/></span> + <span class="nt"><TrafficSignalState</span> <span class="na">state=</span><span class="s">"green"</span> <span class="na">trafficSignalId=</span><span class="s">"1"</span><span class="nt">/></span> <span class="nt"></Phase></span> <span class="nt"><Phase</span> <span class="na">duration=</span><span class="s">"3"</span> <span class="na">name=</span><span class="s">"Phase2"</span><span class="nt">></span> - <span class="nt"><TrafficSignalState</span> <span class="na">state=</span><span class="s">"yellow"</span> <span class="na">trafficSignalId=</span><span class="s">"1"</span> <span class="nt">/></span> + <span class="nt"><TrafficSignalState</span> <span class="na">state=</span><span class="s">"yellow"</span> <span class="na">trafficSignalId=</span><span class="s">"1"</span><span class="nt">/></span> <span class="nt"></Phase></span> <span class="nt"><Phase</span> <span class="na">duration=</span><span class="s">"3"</span> <span class="na">name=</span><span class="s">"Phase3"</span><span class="nt">></span> - <span class="nt"><TrafficSignalState</span> <span class="na">state=</span><span class="s">"red"</span> <span class="na">trafficSignalId=</span><span class="s">"1"</span> <span class="nt">/></span> + <span class="nt"><TrafficSignalState</span> <span class="na">state=</span><span class="s">"red"</span> <span class="na">trafficSignalId=</span><span class="s">"1"</span><span class="nt">/></span> <span class="nt"></Phase></span> <span class="nt"><Phase</span> <span class="na">duration=</span><span class="s">"3"</span> <span class="na">name=</span><span class="s">"Phase4"</span><span class="nt">></span> - <span class="nt"><TrafficSignalState</span> <span class="na">state=</span><span class="s">"red yellow"</span> <span class="na">trafficSignalId=</span><span class="s">"1"</span> <span class="nt">/></span> + <span class="nt"><TrafficSignalState</span> <span class="na">state=</span><span class="s">"red yellow"</span> <span class="na">trafficSignalId=</span><span class="s">"1"</span><span class="nt">/></span> <span class="nt"></Phase></span> <span class="nt"></TrafficSignalController></span> <span class="nt"></TrafficSignals></span> @@ -399,16 +404,20 @@ <p>Entities can also be grouped into selections.</p> <div class="admonition note"> <p class="admonition-title">Note</p> -<p>EntitySelections currently have no effect in <strong>OpenPASS</strong></p> +<p>EntitySelections currently have no effect in <strong>openPASS</strong></p> </div> <p><strong>Example</strong></p> <div class="highlight-xml notranslate"><div class="highlight"><pre><span></span><span class="nt"><Entities></span> <span class="nt"><ScenarioObject</span> <span class="na">name=</span><span class="s">"Ego"</span><span class="nt">></span> - <span class="nt"><CatalogReference</span> <span class="na">catalogName=</span><span class="s">"ProfilesCatalog.xml"</span> <span class="na">entryName=</span><span class="s">"MiddleClassCarAgent"</span><span class="nt">/></span> + <span class="nt"><CatalogReference</span> <span class="na">catalogName=</span><span class="s">"VehicleCatalog"</span> <span class="na">entryName=</span><span class="s">"car_mini_cooper"</span><span class="nt">/></span> + <span class="nt"><ObjectController></span> + <span class="nt"><Controller</span> <span class="na">name=</span><span class="s">"Ego"</span><span class="nt">></span> + <span class="nt"><Properties></span> + <span class="nt"><Property</span> <span class="na">name=</span><span class="s">"AgentProfile"</span> <span class="na">value=</span><span class="s">"MiddleClassCarAgent"</span><span class="nt">/></span> + <span class="nt"></Properties></span> + <span class="nt"></Controller></span> + <span class="nt"></ObjectController></span> <span class="nt"></ScenarioObject></span> - <span class="nt"><EntitySelection</span> <span class="na">name=</span><span class="s">"ScenarioAgents"</span><span class="nt">></span> - <span class="nt"><Members/></span> - <span class="nt"></EntitySelection></span> <span class="nt"></Entities></span> </pre></div> </div> @@ -427,7 +436,7 @@ </div> <div class="admonition-agentprofile-vs-vehiclemodel admonition"> <p class="admonition-title">AgentProfile vs. VehicleModel</p> -<p><strong>OpenPASS</strong> references AgentProfiles instead of a VehicleModels. +<p><strong>openPASS</strong> references AgentProfiles instead of a VehicleModels. Such an AgentProfile may have a stochastic distribution of different VehicleModels, each with potentially different parameters. After the random selection of the vehicle model, some parameters may not be available and are therefore not assigned (ignored).</p> </div> @@ -649,7 +658,7 @@ </tbody> </table> <p><strong>Defining a Position</strong></p> -<p><strong>OpenPASS</strong> only supports <code class="docutils literal notranslate"><span class="pre">LanePosition</span></code> and <code class="docutils literal notranslate"><span class="pre">WorldPosition</span></code> from the OpenSCENARIO standard.</p> +<p><strong>openPASS</strong> only supports <code class="docutils literal notranslate"><span class="pre">LanePosition</span></code> and <code class="docutils literal notranslate"><span class="pre">WorldPosition</span></code> from the OpenSCENARIO standard.</p> <p><strong>Controlling Visibility</strong></p> <p>VisibilityAction is an optional attribute, which allows easy parameterization of certain entities, e.g. via <a class="reference internal" href="#scenario-parameterdeclaration"><span class="std std-ref">ParameterDeclarations</span></a>.</p> <div class="admonition note"> @@ -801,7 +810,7 @@ </div> <div class="section" id="conditions"> <span id="scenario-conditions"></span><h5>Conditions<a class="headerlink" href="#conditions" title="Permalink to this headline">¶</a></h5> -<p><strong>OpenPASS</strong> support different kind of conditions, belonging either to <code class="docutils literal notranslate"><span class="pre">ByValueCondition</span></code> or <code class="docutils literal notranslate"><span class="pre">ByEntityCondition</span></code>. +<p><strong>openPASS</strong> support different kind of conditions, belonging either to <code class="docutils literal notranslate"><span class="pre">ByValueCondition</span></code> or <code class="docutils literal notranslate"><span class="pre">ByEntityCondition</span></code>. While a <strong>by value condition</strong> trigger based on a specified value and is unrelated to any specific agent, a <strong>by entity condition</strong> is bound to an triggering agent, defined by a mandatory section <code class="docutils literal notranslate"><span class="pre">TriggeringEntities</span></code>. Entities can be either ego or scenario agents, or all agents if the section is left blank.</p> <div class="admonition note"> @@ -845,9 +854,14 @@ </table> <div class="section" id="simulationtime"> <span id="scenario-simulationtime"></span><h6>SimulationTime<a class="headerlink" href="#simulationtime" title="Permalink to this headline">¶</a></h6> -<p>Defines, when the simulation ends. -Triggers at a specified time value, given in seconds. +<p>The SimulationTimeCondition only defines an arbitrary trigger, which can be used in ANY condition (see here: <a class="reference external" href="https://www.asam.net/static_downloads/ASAM_OpenSCENARIO_V1.1.1_Model_Documentation/modelDocumentation/content/SimulationTimeCondition.html">https://www.asam.net/static_downloads/ASAM_OpenSCENARIO_V1.1.1_Model_Documentation/modelDocumentation/content/SimulationTimeCondition.html</a>) +If used in conjunction with a StopTrigger of a Storyboard defines how long the simulation will be executed at max. The rule is required and only <code class="docutils literal notranslate"><span class="pre">greaterThan</span></code> is currently supported.</p> +<div class="admonition warning"> +<p class="admonition-title">Warning</p> +<p>It is mandatory for openPASS to define a StopTrigger that will fire in any case. +This does not necessarily have to be a SimulationTimeCondition, but it is recommended to use it, perhaps in conjunction with another trigger.</p> +</div> <p><strong>Example</strong></p> <div class="highlight-xml notranslate"><div class="highlight"><pre><span></span><span class="nt"><Condition</span> <span class="na">name=</span><span class="s">"EndTime"</span> <span class="na">delay=</span><span class="s">"0"</span> <span class="na">conditionEdge=</span><span class="s">"rising"</span><span class="nt">></span> <span class="nt"><ByValueCondition></span> @@ -864,17 +878,17 @@ The tolerance is then added and subtracted from the resulting s-coordinate to form a triggering zone. The condition is satisfied, if a TriggeringEntity touches this zone.</p> <p><strong>Example</strong></p> -<div class="highlight-xml notranslate"><div class="highlight"><pre><span></span><span class="nt"><Condition</span> <span class="na">name=</span><span class="s">"RelativeLanePosition"</span><span class="nt">></span> +<div class="highlight-xml notranslate"><div class="highlight"><pre><span></span><span class="nt"><Condition</span> <span class="na">name=</span><span class="s">"RelativeLanePosition"</span> <span class="na">delay=</span><span class="s">"0"</span> <span class="na">conditionEdge=</span><span class="s">"rising"</span><span class="nt">></span> <span class="nt"><ByEntityCondition></span> <span class="nt"><TriggeringEntities</span> <span class="na">triggeringEntitiesRule=</span><span class="s">"any"</span><span class="nt">></span> <span class="nt"><EntityRef</span> <span class="na">entityRef=</span><span class="s">"Ego"</span><span class="nt">/></span> <span class="nt"></TriggeringEntities></span> <span class="nt"><EntityCondition></span> - <span class="nt"><ReachPositionCondition</span> <span class="na">tolerance=</span><span class="s">"15.0"</span><span class="nt">></span> + <span class="nt"><DistanceCondition</span> <span class="na">relativeDistanceType=</span><span class="s">"longitudinal"</span> <span class="na">coordinateSystem=</span><span class="s">"entity"</span> <span class="na">freespace=</span><span class="s">"false"</span> <span class="na">rule=</span><span class="s">"lessOrEqual"</span> <span class="na">value=</span><span class="s">"15.0"</span><span class="nt">></span> <span class="nt"><Position></span> - <span class="nt"><RelativeLanePosition</span> <span class="na">entityRef=</span><span class="s">"StandingAgent"</span> <span class="na">dLane=</span><span class="s">"-1"</span> <span class="na">ds=</span><span class="s">"20.0"</span><span class="nt">/></span> + <span class="nt"><RelativeLanePosition</span> <span class="na">entityRef=</span><span class="s">"StandingAgent"</span> <span class="na">dLane=</span><span class="s">"-1"</span> <span class="na">dsLane=</span><span class="s">"20.0"</span><span class="nt">/></span> <span class="nt"></Position></span> - <span class="nt"></ReachPositionCondition></span> + <span class="nt"></DistanceCondition></span> <span class="nt"></EntityCondition></span> <span class="nt"></ByEntityCondition></span> <span class="nt"></Condition></span> @@ -887,17 +901,17 @@ Note that the tolerance is added and subtracted from the s-coordinate to form a triggering zone. The condition is satisfied, if a TriggeringEntity touches this zone.</p> <p><strong>Example</strong></p> -<div class="highlight-xml notranslate"><div class="highlight"><pre><span></span><span class="nt"><Condition</span> <span class="na">name=</span><span class="s">"RoadPosition"</span><span class="nt">></span> +<div class="highlight-xml notranslate"><div class="highlight"><pre><span></span><span class="nt"><Condition</span> <span class="na">name=</span><span class="s">"RoadPosition"</span> <span class="na">delay=</span><span class="s">"0"</span> <span class="na">conditionEdge=</span><span class="s">"rising"</span><span class="nt">></span> <span class="nt"><ByEntityCondition></span> <span class="nt"><TriggeringEntities</span> <span class="na">triggeringEntitiesRule=</span><span class="s">"any"</span><span class="nt">></span> <span class="nt"><EntityRef</span> <span class="na">entityRef=</span><span class="s">"Ego"</span><span class="nt">/></span> <span class="nt"></TriggeringEntities></span> <span class="nt"><EntityCondition></span> - <span class="nt"><ReachPositionCondition</span> <span class="na">tolerance=</span><span class="s">"3.0"</span><span class="nt">></span> + <span class="nt"><DistanceCondition</span> <span class="na">relativeDistanceType=</span><span class="s">"longitudinal"</span> <span class="na">coordinateSystem=</span><span class="s">"entity"</span> <span class="na">freespace=</span><span class="s">"false"</span> <span class="na">rule=</span><span class="s">"lessOrEqual"</span> <span class="na">value=</span><span class="s">"3.0"</span><span class="nt">></span> <span class="nt"><Position></span> - <span class="nt"><RoadPosition</span> <span class="na">roadId=</span><span class="s">"0"</span> <span class="na">s=</span><span class="s">"110.0"</span> <span class="na">t=</span><span class="s">"0.0"</span><span class="nt">/></span> + <span class="nt"><RoadPosition</span> <span class="na">roadId=</span><span class="s">"0"</span> <span class="na">s=</span><span class="s">"110.0"</span> <span class="na">t=</span><span class="s">"-8.0"</span><span class="nt">/></span> <span class="nt"></Position></span> - <span class="nt"></ReachPositionCondition></span> + <span class="nt"></DistanceCondition></span> <span class="nt"></EntityCondition></span> <span class="nt"></ByEntityCondition></span> <span class="nt"></Condition></span> @@ -908,7 +922,7 @@ <span id="scenario-relativespeed"></span><h6>RelativeSpeed<a class="headerlink" href="#relativespeed" title="Permalink to this headline">¶</a></h6> <p>This condition evaluates if the relative velocity (<img class="math" src="../../_images/math/fcf1e10911eacf44f57a43c7f8b190228aba5320.png" alt="v_{rel}"/>) between a TriggeringEntity and a reference entity, is <em>lessThan</em>, <em>equalTo</em>, or <em>greaterThan</em>, a specified value, where <img class="math" src="../../_images/math/d17927d945626222b572588e9b810bd91a62f7bb.png" alt="v_{rel} = v_{trig} - v_{ref}"/>.</p> <p><strong>Example</strong></p> -<div class="highlight-xml notranslate"><div class="highlight"><pre><span></span><span class="nt"><Condition</span> <span class="na">name=</span><span class="s">"RelativeSpeed"</span><span class="nt">></span> +<div class="highlight-xml notranslate"><div class="highlight"><pre><span></span><span class="nt"><Condition</span> <span class="na">name=</span><span class="s">"RelativeSpeed"</span> <span class="na">delay=</span><span class="s">"0"</span> <span class="na">conditionEdge=</span><span class="s">"rising"</span><span class="nt">></span> <span class="nt"><ByEntityCondition></span> <span class="nt"><TriggeringEntities</span> <span class="na">triggeringEntitiesRule=</span><span class="s">"any"</span><span class="nt">></span> <span class="nt"><EntityRef</span> <span class="na">entityRef=</span><span class="s">"Ego"</span><span class="nt">/></span> @@ -926,13 +940,13 @@ <p>This condition evaluates if the <em>Time To Collision</em> (TTC) between a TriggeringEntity and a reference entity is <em>lessThan</em>, <em>equalTo</em>, or <em>greaterThan</em> a specified value. The TTC is determined by projecting the movement of the entities using steps of 0.1 seconds and returning the first time step, at which their bounding boxes intersect.</p> <p><strong>Example</strong></p> -<div class="highlight-xml notranslate"><div class="highlight"><pre><span></span><span class="nt"><Condition</span> <span class="na">name=</span><span class="s">"TimeToCollision"</span><span class="nt">></span> +<div class="highlight-xml notranslate"><div class="highlight"><pre><span></span><span class="nt"><Condition</span> <span class="na">name=</span><span class="s">"TimeToCollision"</span> <span class="na">delay=</span><span class="s">"0"</span> <span class="na">conditionEdge=</span><span class="s">"rising"</span><span class="nt">></span> <span class="nt"><ByEntityCondition></span> <span class="nt"><TriggeringEntities</span> <span class="na">triggeringEntitiesRule=</span><span class="s">"any"</span><span class="nt">></span> <span class="nt"><EntityRef</span> <span class="na">entityRef=</span><span class="s">"Ego"</span><span class="nt">/></span> <span class="nt"></TriggeringEntities></span> <span class="nt"><EntityCondition></span> - <span class="nt"><TimeToCollisionCondition</span> <span class="na">value=</span><span class="s">"3.0"</span> <span class="na">rule=</span><span class="s">"lessThan"</span><span class="nt">></span> + <span class="nt"><TimeToCollisionCondition</span> <span class="na">value=</span><span class="s">"3.0"</span> <span class="na">rule=</span><span class="s">"lessThan"</span> <span class="na">freespace=</span><span class="s">"false"</span><span class="nt">></span> <span class="nt"><TimeToCollisionConditionTarget></span> <span class="nt"><EntityRef</span> <span class="na">entityRef=</span><span class="s">"StandingAgent"</span><span class="nt">/></span> <span class="nt"></TimeToCollisionConditionTarget></span> @@ -949,17 +963,13 @@ If <code class="docutils literal notranslate"><span class="pre">freespace="true"</span></code> the net distance of the bounding boxes is considered, otherwise the distance of the reference points. The <code class="docutils literal notranslate"><span class="pre">alongRoute</span></code> attribute must be <code class="docutils literal notranslate"><span class="pre">true</span></code>.</p> <p><strong>Example</strong></p> -<div class="highlight-xml notranslate"><div class="highlight"><pre><span></span><span class="nt"><Condition</span> <span class="na">name=</span><span class="s">"TimeHeadway"</span><span class="nt">></span> +<div class="highlight-xml notranslate"><div class="highlight"><pre><span></span><span class="nt"><Condition</span> <span class="na">name=</span><span class="s">"TimeHeadway"</span> <span class="na">delay=</span><span class="s">"0"</span> <span class="na">conditionEdge=</span><span class="s">"rising"</span><span class="nt">></span> <span class="nt"><ByEntityCondition></span> <span class="nt"><TriggeringEntities</span> <span class="na">triggeringEntitiesRule=</span><span class="s">"any"</span><span class="nt">></span> <span class="nt"><EntityRef</span> <span class="na">entityRef=</span><span class="s">"Ego"</span><span class="nt">/></span> <span class="nt"></TriggeringEntities></span> <span class="nt"><EntityCondition></span> - <span class="nt"><TimeHeadwayCondition</span> <span class="na">value=</span><span class="s">"3.0"</span> - <span class="na">rule=</span><span class="s">"lessThan"</span> - <span class="na">entityRef=</span><span class="s">"StandingAgent"</span> - <span class="na">freespace=</span><span class="s">"true"</span> - <span class="na">alongRoute=</span><span class="s">"true"</span><span class="nt">/></span> + <span class="nt"><TimeHeadwayCondition</span> <span class="na">value=</span><span class="s">"3.0"</span> <span class="na">rule=</span><span class="s">"lessThan"</span> <span class="na">entityRef=</span><span class="s">"StandingAgent"</span> <span class="na">freespace=</span><span class="s">"true"</span> <span class="na">alongRoute=</span><span class="s">"true"</span> <span class="na">relativeDistanceType=</span><span class="s">"longitudinal"</span><span class="nt">/></span> <span class="nt"></EntityCondition></span> <span class="nt"></ByEntityCondition></span> <span class="nt"></Condition></span> @@ -990,27 +1000,27 @@ which are located by road_id and further with s and t coordinates. The Agent will try to follow the specified points.</p> <p><strong>Example</strong> <em>Right turn, by specifying three waypoints</em></p> -<div class="highlight-xml notranslate"><div class="highlight"><pre><span></span> <span class="nt"><RoutingAction></span> - <span class="nt"><AssignRouteAction></span> - <span class="nt"><Route></span> - <span class="nt"><Waypoint></span> - <span class="nt"><Position></span> - <span class="nt"><RoadPosition</span> <span class="na">roadId=</span><span class="s">"1472558076"</span> <span class="na">t=</span><span class="s">"-1.0"</span> <span class="na">s=</span><span class="s">"230"</span><span class="nt">/></span> - <span class="nt"></Position></span> - <span class="nt"></Waypoint></span> - <span class="nt"><Waypoint></span> - <span class="nt"><Position></span> - <span class="nt"><RoadPosition</span> <span class="na">roadId=</span><span class="s">"3083973"</span> <span class="na">t=</span><span class="s">"0"</span> <span class="na">s=</span><span class="s">"8.5"</span><span class="nt">/></span> - <span class="nt"></Position></span> - <span class="nt"></Waypoint></span> - <span class="nt"><Waypoint></span> - <span class="nt"><Position></span> - <span class="nt"><RoadPosition</span> <span class="na">roadId=</span><span class="s">"2015840166"</span> <span class="na">t=</span><span class="s">"-0.2"</span> <span class="na">s=</span><span class="s">"100"</span><span class="nt">/></span> - <span class="nt"></Position></span> - <span class="nt"></Waypoint></span> - <span class="nt"></Route></span> - <span class="nt"></AssignRouteAction></span> - <span class="nt"></RoutingAction></span> +<div class="highlight-xml notranslate"><div class="highlight"><pre><span></span> <span class="nt"><RoutingAction></span> + <span class="nt"><AssignRouteAction></span> + <span class="nt"><Route</span> <span class="na">closed=</span><span class="s">"false"</span> <span class="na">name=</span><span class="s">""</span><span class="nt">></span> + <span class="nt"><Waypoint</span> <span class="na">routeStrategy=</span><span class="s">"fastest"</span><span class="nt">></span> + <span class="nt"><Position></span> + <span class="nt"><RoadPosition</span> <span class="na">roadId=</span><span class="s">"1472558076"</span> <span class="na">t=</span><span class="s">"-1.0"</span> <span class="na">s=</span><span class="s">"230"</span><span class="nt">/></span> + <span class="nt"></Position></span> + <span class="nt"></Waypoint></span> + <span class="nt"><Waypoint</span> <span class="na">routeStrategy=</span><span class="s">"fastest"</span><span class="nt">></span> + <span class="nt"><Position></span> + <span class="nt"><RoadPosition</span> <span class="na">roadId=</span><span class="s">"3083973"</span> <span class="na">t=</span><span class="s">"-1.0"</span> <span class="na">s=</span><span class="s">"8.5"</span><span class="nt">/></span> + <span class="nt"></Position></span> + <span class="nt"></Waypoint></span> + <span class="nt"><Waypoint</span> <span class="na">routeStrategy=</span><span class="s">"fastest"</span><span class="nt">></span> + <span class="nt"><Position></span> + <span class="nt"><RoadPosition</span> <span class="na">roadId=</span><span class="s">"2015840166"</span> <span class="na">t=</span><span class="s">"-0.2"</span> <span class="na">s=</span><span class="s">"100"</span><span class="nt">/></span> + <span class="nt"></Position></span> + <span class="nt"></Waypoint></span> + <span class="nt"></Route></span> + <span class="nt"></AssignRouteAction></span> + <span class="nt"></RoutingAction></span> </pre></div> </div> </div> @@ -1062,22 +1072,24 @@ <span class="nt"><PrivateAction></span> <span class="nt"><RoutingAction></span> <span class="nt"><FollowTrajectoryAction></span> - <span class="nt"><Trajectory</span> <span class="na">name=</span><span class="s">"LaneChange"</span> <span class="na">closed=</span><span class="s">"false"</span><span class="nt">></span> - <span class="nt"><Shape></span> - <span class="nt"><Polyline></span> - <span class="nt"><Vertex</span> <span class="na">time=</span><span class="s">"0"</span><span class="nt">></span> - <span class="nt"><Position></span> - <span class="nt"><WorldPosition</span> <span class="na">x=</span><span class="s">"100"</span> <span class="na">y=</span><span class="s">"3"</span> <span class="na">z=</span><span class="s">"0"</span> <span class="na">h=</span><span class="s">"1.570796326"</span> <span class="na">p=</span><span class="s">"0"</span> <span class="na">r=</span><span class="s">"0"</span><span class="nt">/></span> - <span class="nt"></Position></span> - <span class="nt"></Vertex></span> - <span class="nt"><Vertex</span> <span class="na">time=</span><span class="s">"5"</span><span class="nt">></span> - <span class="nt"><Position></span> - <span class="nt"><WorldPosition</span> <span class="na">x=</span><span class="s">"100"</span> <span class="na">y=</span><span class="s">"8"</span> <span class="na">z=</span><span class="s">"0"</span> <span class="na">h=</span><span class="s">"1.570796326"</span> <span class="na">p=</span><span class="s">"0"</span> <span class="na">r=</span><span class="s">"0"</span><span class="nt">/></span> - <span class="nt"></Position></span> - <span class="nt"></Vertex></span> - <span class="nt"></Polyline></span> - <span class="nt"></Shape></span> - <span class="nt"></Trajectory></span> + <span class="nt"><TrajectoryRef></span> + <span class="nt"><Trajectory</span> <span class="na">name=</span><span class="s">"LaneChange"</span> <span class="na">closed=</span><span class="s">"false"</span><span class="nt">></span> + <span class="nt"><Shape></span> + <span class="nt"><Polyline></span> + <span class="nt"><Vertex</span> <span class="na">time=</span><span class="s">"0"</span><span class="nt">></span> + <span class="nt"><Position></span> + <span class="nt"><WorldPosition</span> <span class="na">x=</span><span class="s">"100"</span> <span class="na">y=</span><span class="s">"3"</span> <span class="na">z=</span><span class="s">"0"</span> <span class="na">h=</span><span class="s">"1.570796326"</span> <span class="na">p=</span><span class="s">"0"</span> <span class="na">r=</span><span class="s">"0"</span><span class="nt">/></span> + <span class="nt"></Position></span> + <span class="nt"></Vertex></span> + <span class="nt"><Vertex</span> <span class="na">time=</span><span class="s">"5"</span><span class="nt">></span> + <span class="nt"><Position></span> + <span class="nt"><WorldPosition</span> <span class="na">x=</span><span class="s">"100"</span> <span class="na">y=</span><span class="s">"8"</span> <span class="na">z=</span><span class="s">"0"</span> <span class="na">h=</span><span class="s">"1.570796326"</span> <span class="na">p=</span><span class="s">"0"</span> <span class="na">r=</span><span class="s">"0"</span><span class="nt">/></span> + <span class="nt"></Position></span> + <span class="nt"></Vertex></span> + <span class="nt"></Polyline></span> + <span class="nt"></Shape></span> + <span class="nt"></Trajectory></span> + <span class="nt"></TrajectoryRef></span> <span class="nt"><TimeReference></span> <span class="nt"><None/></span> <span class="nt"></TimeReference></span> @@ -1111,7 +1123,7 @@ </div> <div class="admonition warning"> <p class="admonition-title">Warning</p> -<p>An FMU might contain routing logic not visible to the OpenPASS simulation core. +<p>An FMU might contain routing logic not visible to the openPASS simulation core. For that reason, an equivalent <cite>RoutingAction</cite> should be set when using <cite>AcquirePosition</cite>. Otherwise the simulation output might contain missing data for fields depending on the localization along the route (<cite>PositionRoute</cite>, <cite>TCoordinate</cite>, <cite>AgentInFront</cite>, …).</p> </div> @@ -1275,7 +1287,7 @@ <div role="contentinfo"> <p> - © Copyright 2023 OpenPASS Working Group. + © Copyright 2023 openPASS Working Group. </p> </div>
diff --git a/content/html/user_guide/configs/scenery.html b/content/html/user_guide/configs/scenery.html index 6652a09..6a3988c 100644 --- a/content/html/user_guide/configs/scenery.html +++ b/content/html/user_guide/configs/scenery.html
@@ -7,7 +7,7 @@ <meta name="viewport" content="width=device-width, initial-scale=1.0" /> - <title>Scenery — OpenPASS Documentation</title> + <title>Scenery — openPASS Documentation</title> @@ -70,7 +70,7 @@ <div class="version"> - "openPASS v0.11" + "develop_4d7f6d4f2e22c286789082dd8cbe3eb7f5b5af62" </div> @@ -100,7 +100,7 @@ <li class="toctree-l1"><a class="reference internal" href="../../installation_guide/10_getting_started.html">Getting Started</a></li> <li class="toctree-l1"><a class="reference internal" href="../../installation_guide/15_system_requirements.html">System Requirements</a></li> <li class="toctree-l1"><a class="reference internal" href="../../installation_guide/20_install_prerequisites.html">Installing Prerequisites</a></li> -<li class="toctree-l1"><a class="reference internal" href="../../installation_guide/30_install_openpass.html">Installing OpenPASS</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../installation_guide/30_install_openpass.html">Installing openPASS</a></li> <li class="toctree-l1"><a class="reference internal" href="../../installation_guide/50_further_guidance.html">Further Guidance</a></li> <li class="toctree-l1"><a class="reference internal" href="../../installation_guide/60_conan.html">Building with Conan</a></li> </ul> @@ -108,8 +108,7 @@ <ul class="current"> <li class="toctree-l1"><a class="reference internal" href="../10_overview.html">Overview</a></li> <li class="toctree-l1"><a class="reference internal" href="../20_tutorials.html">Tutorials</a></li> -<li class="toctree-l1"><a class="reference internal" href="../30_gui_plugins.html">GUI Plugins</a></li> -<li class="toctree-l1 current"><a class="reference internal" href="../40_configs_in_depth.html">Configs in Depth</a><ul class="current"> +<li class="toctree-l1 current"><a class="reference internal" href="../30_configs_in_depth.html">Configs in Depth</a><ul class="current"> <li class="toctree-l2"><a class="reference internal" href="profilescatalog.html">ProfilesCatalog</a></li> <li class="toctree-l2"><a class="reference internal" href="scenario.html">Scenario</a></li> <li class="toctree-l2 current"><a class="current reference internal" href="#">Scenery</a><ul> @@ -122,8 +121,8 @@ <li class="toctree-l2"><a class="reference internal" href="systemconfigblueprint.html">SystemConfigBlueprint</a></li> </ul> </li> -<li class="toctree-l1"><a class="reference internal" href="../50_outputs_in_depth.html">Outputs in Depth</a></li> -<li class="toctree-l1"><a class="reference internal" href="../60_scenario_simulation.html">Simulator</a></li> +<li class="toctree-l1"><a class="reference internal" href="../40_outputs_in_depth.html">Outputs in Depth</a></li> +<li class="toctree-l1"><a class="reference internal" href="../50_scenario_simulation.html">Simulator</a></li> </ul> <p class="caption"><span class="caption-text">Advanced topics</span></p> <ul> @@ -134,12 +133,14 @@ <ul> <li class="toctree-l1"><a class="reference internal" href="../../developer_information/10_ide_support.html">IDE Support</a></li> <li class="toctree-l1"><a class="reference internal" href="../../developer_information/20_documentation.html">Documentation Concept</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../developer_information/30_coding_conventions.html">Coding Guidelines</a></li> </ul> <p class="caption"><span class="caption-text">Other Information</span></p> <ul> <li class="toctree-l1"><a class="reference internal" href="../../other_information/10_external_dependencies.html">External Dependencies</a></li> <li class="toctree-l1"><a class="reference internal" href="../../other_information/20_glossary.html">Glossary</a></li> -<li class="toctree-l1"><a class="reference internal" href="../../other_information/30_license.html">License</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../other_information/30_gui_plugins.html">GUI Plugins</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../other_information/40_license.html">License</a></li> </ul> @@ -188,7 +189,7 @@ <li><a href="../../index.html" class="icon icon-home"></a> »</li> - <li><a href="../40_configs_in_depth.html">Configs in Depth</a> »</li> + <li><a href="../30_configs_in_depth.html">Configs in Depth</a> »</li> <li>Scenery</li> @@ -386,7 +387,7 @@ <div role="contentinfo"> <p> - © Copyright 2023 OpenPASS Working Group. + © Copyright 2023 openPASS Working Group. </p> </div>
diff --git a/content/html/user_guide/configs/simulationconfig.html b/content/html/user_guide/configs/simulationconfig.html index 3171f87..db79057 100644 --- a/content/html/user_guide/configs/simulationconfig.html +++ b/content/html/user_guide/configs/simulationconfig.html
@@ -7,7 +7,7 @@ <meta name="viewport" content="width=device-width, initial-scale=1.0" /> - <title>SimulationConfig — OpenPASS Documentation</title> + <title>SimulationConfig — openPASS Documentation</title> @@ -70,7 +70,7 @@ <div class="version"> - "openPASS v0.11" + "develop_4d7f6d4f2e22c286789082dd8cbe3eb7f5b5af62" </div> @@ -100,7 +100,7 @@ <li class="toctree-l1"><a class="reference internal" href="../../installation_guide/10_getting_started.html">Getting Started</a></li> <li class="toctree-l1"><a class="reference internal" href="../../installation_guide/15_system_requirements.html">System Requirements</a></li> <li class="toctree-l1"><a class="reference internal" href="../../installation_guide/20_install_prerequisites.html">Installing Prerequisites</a></li> -<li class="toctree-l1"><a class="reference internal" href="../../installation_guide/30_install_openpass.html">Installing OpenPASS</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../installation_guide/30_install_openpass.html">Installing openPASS</a></li> <li class="toctree-l1"><a class="reference internal" href="../../installation_guide/50_further_guidance.html">Further Guidance</a></li> <li class="toctree-l1"><a class="reference internal" href="../../installation_guide/60_conan.html">Building with Conan</a></li> </ul> @@ -108,8 +108,7 @@ <ul class="current"> <li class="toctree-l1"><a class="reference internal" href="../10_overview.html">Overview</a></li> <li class="toctree-l1"><a class="reference internal" href="../20_tutorials.html">Tutorials</a></li> -<li class="toctree-l1"><a class="reference internal" href="../30_gui_plugins.html">GUI Plugins</a></li> -<li class="toctree-l1 current"><a class="reference internal" href="../40_configs_in_depth.html">Configs in Depth</a><ul class="current"> +<li class="toctree-l1 current"><a class="reference internal" href="../30_configs_in_depth.html">Configs in Depth</a><ul class="current"> <li class="toctree-l2"><a class="reference internal" href="profilescatalog.html">ProfilesCatalog</a></li> <li class="toctree-l2"><a class="reference internal" href="scenario.html">Scenario</a></li> <li class="toctree-l2"><a class="reference internal" href="scenery.html">Scenery</a></li> @@ -131,8 +130,8 @@ <li class="toctree-l2"><a class="reference internal" href="systemconfigblueprint.html">SystemConfigBlueprint</a></li> </ul> </li> -<li class="toctree-l1"><a class="reference internal" href="../50_outputs_in_depth.html">Outputs in Depth</a></li> -<li class="toctree-l1"><a class="reference internal" href="../60_scenario_simulation.html">Simulator</a></li> +<li class="toctree-l1"><a class="reference internal" href="../40_outputs_in_depth.html">Outputs in Depth</a></li> +<li class="toctree-l1"><a class="reference internal" href="../50_scenario_simulation.html">Simulator</a></li> </ul> <p class="caption"><span class="caption-text">Advanced topics</span></p> <ul> @@ -143,12 +142,14 @@ <ul> <li class="toctree-l1"><a class="reference internal" href="../../developer_information/10_ide_support.html">IDE Support</a></li> <li class="toctree-l1"><a class="reference internal" href="../../developer_information/20_documentation.html">Documentation Concept</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../developer_information/30_coding_conventions.html">Coding Guidelines</a></li> </ul> <p class="caption"><span class="caption-text">Other Information</span></p> <ul> <li class="toctree-l1"><a class="reference internal" href="../../other_information/10_external_dependencies.html">External Dependencies</a></li> <li class="toctree-l1"><a class="reference internal" href="../../other_information/20_glossary.html">Glossary</a></li> -<li class="toctree-l1"><a class="reference internal" href="../../other_information/30_license.html">License</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../other_information/30_gui_plugins.html">GUI Plugins</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../other_information/40_license.html">License</a></li> </ul> @@ -197,7 +198,7 @@ <li><a href="../../index.html" class="icon icon-home"></a> »</li> - <li><a href="../40_configs_in_depth.html">Configs in Depth</a> »</li> + <li><a href="../30_configs_in_depth.html">Configs in Depth</a> »</li> <li>SimulationConfig</li> @@ -467,11 +468,6 @@ If different spawners are to be triggered at the same time the spawner with the highest priority is triggered first.</p> <div class="highlight-xml notranslate"><div class="highlight"><pre><span></span> <span class="nt"><Spawners></span> <span class="nt"><Spawner></span> - <span class="nt"><Library></span>SpawnerScenario<span class="nt"></Library></span> - <span class="nt"><Type></span>PreRun<span class="nt"></Type></span> - <span class="nt"><Priority></span>1<span class="nt"></Priority></span> - <span class="nt"></Spawner></span> - <span class="nt"><Spawner></span> <span class="nt"><Library></span>SpawnerPreRunCommon<span class="nt"></Library></span> <span class="nt"><Type></span>PreRun<span class="nt"></Type></span> <span class="nt"><Priority></span>0<span class="nt"></Priority></span> @@ -567,11 +563,8 @@ <span class="normal">74</span> <span class="normal">75</span> <span class="normal">76</span> -<span class="normal">77</span> -<span class="normal">78</span> -<span class="normal">79</span> -<span class="normal">80</span> -<span class="normal">81</span></pre></div></td><td class="code"><div class="highlight"><pre><span></span><span class="nt"><simulationConfig</span> <span class="na">SchemaVersion=</span><span class="s">"0.8.2"</span><span class="nt">></span> +<span class="normal">77</span></pre></div></td><td class="code"><div class="highlight"><pre><span></span><span class="cp"><?xml version='1.0' encoding='UTF-8'?></span> +<span class="nt"><simulationConfig</span> <span class="na">SchemaVersion=</span><span class="s">"0.8.2"</span><span class="nt">></span> <span class="nt"><ProfilesCatalog></span>ProfilesCatalog.xml<span class="nt"></ProfilesCatalog></span> <span class="nt"><Experiment></span> <span class="nt"><ExperimentID></span>123<span class="nt"></ExperimentID></span> @@ -634,11 +627,6 @@ <span class="nt"></Observations></span> <span class="nt"><Spawners></span> <span class="nt"><Spawner></span> - <span class="nt"><Library></span>SpawnerScenario<span class="nt"></Library></span> - <span class="nt"><Type></span>PreRun<span class="nt"></Type></span> - <span class="nt"><Priority></span>1<span class="nt"></Priority></span> - <span class="nt"></Spawner></span> - <span class="nt"><Spawner></span> <span class="nt"><Library></span>SpawnerPreRunCommon<span class="nt"></Library></span> <span class="nt"><Type></span>PreRun<span class="nt"></Type></span> <span class="nt"><Priority></span>0<span class="nt"></Priority></span> @@ -672,7 +660,7 @@ <div role="contentinfo"> <p> - © Copyright 2023 OpenPASS Working Group. + © Copyright 2023 openPASS Working Group. </p> </div>
diff --git a/content/html/user_guide/configs/staticsystemconfig.html b/content/html/user_guide/configs/staticsystemconfig.html index 70fe1b6..b7a33cd 100644 --- a/content/html/user_guide/configs/staticsystemconfig.html +++ b/content/html/user_guide/configs/staticsystemconfig.html
@@ -7,7 +7,7 @@ <meta name="viewport" content="width=device-width, initial-scale=1.0" /> - <title>Static SystemConfig — OpenPASS Documentation</title> + <title>Static SystemConfig — openPASS Documentation</title> @@ -70,7 +70,7 @@ <div class="version"> - "openPASS v0.11" + "develop_4d7f6d4f2e22c286789082dd8cbe3eb7f5b5af62" </div> @@ -100,7 +100,7 @@ <li class="toctree-l1"><a class="reference internal" href="../../installation_guide/10_getting_started.html">Getting Started</a></li> <li class="toctree-l1"><a class="reference internal" href="../../installation_guide/15_system_requirements.html">System Requirements</a></li> <li class="toctree-l1"><a class="reference internal" href="../../installation_guide/20_install_prerequisites.html">Installing Prerequisites</a></li> -<li class="toctree-l1"><a class="reference internal" href="../../installation_guide/30_install_openpass.html">Installing OpenPASS</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../installation_guide/30_install_openpass.html">Installing openPASS</a></li> <li class="toctree-l1"><a class="reference internal" href="../../installation_guide/50_further_guidance.html">Further Guidance</a></li> <li class="toctree-l1"><a class="reference internal" href="../../installation_guide/60_conan.html">Building with Conan</a></li> </ul> @@ -108,8 +108,7 @@ <ul class="current"> <li class="toctree-l1"><a class="reference internal" href="../10_overview.html">Overview</a></li> <li class="toctree-l1"><a class="reference internal" href="../20_tutorials.html">Tutorials</a></li> -<li class="toctree-l1"><a class="reference internal" href="../30_gui_plugins.html">GUI Plugins</a></li> -<li class="toctree-l1 current"><a class="reference internal" href="../40_configs_in_depth.html">Configs in Depth</a><ul class="current"> +<li class="toctree-l1 current"><a class="reference internal" href="../30_configs_in_depth.html">Configs in Depth</a><ul class="current"> <li class="toctree-l2"><a class="reference internal" href="profilescatalog.html">ProfilesCatalog</a></li> <li class="toctree-l2"><a class="reference internal" href="scenario.html">Scenario</a></li> <li class="toctree-l2"><a class="reference internal" href="scenery.html">Scenery</a></li> @@ -118,8 +117,8 @@ <li class="toctree-l2"><a class="reference internal" href="systemconfigblueprint.html">SystemConfigBlueprint</a></li> </ul> </li> -<li class="toctree-l1"><a class="reference internal" href="../50_outputs_in_depth.html">Outputs in Depth</a></li> -<li class="toctree-l1"><a class="reference internal" href="../60_scenario_simulation.html">Simulator</a></li> +<li class="toctree-l1"><a class="reference internal" href="../40_outputs_in_depth.html">Outputs in Depth</a></li> +<li class="toctree-l1"><a class="reference internal" href="../50_scenario_simulation.html">Simulator</a></li> </ul> <p class="caption"><span class="caption-text">Advanced topics</span></p> <ul> @@ -130,12 +129,14 @@ <ul> <li class="toctree-l1"><a class="reference internal" href="../../developer_information/10_ide_support.html">IDE Support</a></li> <li class="toctree-l1"><a class="reference internal" href="../../developer_information/20_documentation.html">Documentation Concept</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../developer_information/30_coding_conventions.html">Coding Guidelines</a></li> </ul> <p class="caption"><span class="caption-text">Other Information</span></p> <ul> <li class="toctree-l1"><a class="reference internal" href="../../other_information/10_external_dependencies.html">External Dependencies</a></li> <li class="toctree-l1"><a class="reference internal" href="../../other_information/20_glossary.html">Glossary</a></li> -<li class="toctree-l1"><a class="reference internal" href="../../other_information/30_license.html">License</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../other_information/30_gui_plugins.html">GUI Plugins</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../other_information/40_license.html">License</a></li> </ul> @@ -184,7 +185,7 @@ <li><a href="../../index.html" class="icon icon-home"></a> »</li> - <li><a href="../40_configs_in_depth.html">Configs in Depth</a> »</li> + <li><a href="../30_configs_in_depth.html">Configs in Depth</a> »</li> <li>Static SystemConfig</li> @@ -226,7 +227,7 @@ <div role="contentinfo"> <p> - © Copyright 2023 OpenPASS Working Group. + © Copyright 2023 openPASS Working Group. </p> </div>
diff --git a/content/html/user_guide/configs/systemconfigblueprint.html b/content/html/user_guide/configs/systemconfigblueprint.html index eb71eb7..ca2779e 100644 --- a/content/html/user_guide/configs/systemconfigblueprint.html +++ b/content/html/user_guide/configs/systemconfigblueprint.html
@@ -7,7 +7,7 @@ <meta name="viewport" content="width=device-width, initial-scale=1.0" /> - <title>SystemConfigBlueprint — OpenPASS Documentation</title> + <title>SystemConfigBlueprint — openPASS Documentation</title> @@ -42,7 +42,7 @@ <link rel="index" title="Index" href="../../genindex.html" /> <link rel="search" title="Search" href="../../search.html" /> - <link rel="next" title="Outputs in Depth" href="../50_outputs_in_depth.html" /> + <link rel="next" title="Outputs in Depth" href="../40_outputs_in_depth.html" /> <link rel="prev" title="Static SystemConfig" href="staticsystemconfig.html" /> </head> @@ -70,7 +70,7 @@ <div class="version"> - "openPASS v0.11" + "develop_4d7f6d4f2e22c286789082dd8cbe3eb7f5b5af62" </div> @@ -100,7 +100,7 @@ <li class="toctree-l1"><a class="reference internal" href="../../installation_guide/10_getting_started.html">Getting Started</a></li> <li class="toctree-l1"><a class="reference internal" href="../../installation_guide/15_system_requirements.html">System Requirements</a></li> <li class="toctree-l1"><a class="reference internal" href="../../installation_guide/20_install_prerequisites.html">Installing Prerequisites</a></li> -<li class="toctree-l1"><a class="reference internal" href="../../installation_guide/30_install_openpass.html">Installing OpenPASS</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../installation_guide/30_install_openpass.html">Installing openPASS</a></li> <li class="toctree-l1"><a class="reference internal" href="../../installation_guide/50_further_guidance.html">Further Guidance</a></li> <li class="toctree-l1"><a class="reference internal" href="../../installation_guide/60_conan.html">Building with Conan</a></li> </ul> @@ -108,8 +108,7 @@ <ul class="current"> <li class="toctree-l1"><a class="reference internal" href="../10_overview.html">Overview</a></li> <li class="toctree-l1"><a class="reference internal" href="../20_tutorials.html">Tutorials</a></li> -<li class="toctree-l1"><a class="reference internal" href="../30_gui_plugins.html">GUI Plugins</a></li> -<li class="toctree-l1 current"><a class="reference internal" href="../40_configs_in_depth.html">Configs in Depth</a><ul class="current"> +<li class="toctree-l1 current"><a class="reference internal" href="../30_configs_in_depth.html">Configs in Depth</a><ul class="current"> <li class="toctree-l2"><a class="reference internal" href="profilescatalog.html">ProfilesCatalog</a></li> <li class="toctree-l2"><a class="reference internal" href="scenario.html">Scenario</a></li> <li class="toctree-l2"><a class="reference internal" href="scenery.html">Scenery</a></li> @@ -124,8 +123,8 @@ </li> </ul> </li> -<li class="toctree-l1"><a class="reference internal" href="../50_outputs_in_depth.html">Outputs in Depth</a></li> -<li class="toctree-l1"><a class="reference internal" href="../60_scenario_simulation.html">Simulator</a></li> +<li class="toctree-l1"><a class="reference internal" href="../40_outputs_in_depth.html">Outputs in Depth</a></li> +<li class="toctree-l1"><a class="reference internal" href="../50_scenario_simulation.html">Simulator</a></li> </ul> <p class="caption"><span class="caption-text">Advanced topics</span></p> <ul> @@ -136,12 +135,14 @@ <ul> <li class="toctree-l1"><a class="reference internal" href="../../developer_information/10_ide_support.html">IDE Support</a></li> <li class="toctree-l1"><a class="reference internal" href="../../developer_information/20_documentation.html">Documentation Concept</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../developer_information/30_coding_conventions.html">Coding Guidelines</a></li> </ul> <p class="caption"><span class="caption-text">Other Information</span></p> <ul> <li class="toctree-l1"><a class="reference internal" href="../../other_information/10_external_dependencies.html">External Dependencies</a></li> <li class="toctree-l1"><a class="reference internal" href="../../other_information/20_glossary.html">Glossary</a></li> -<li class="toctree-l1"><a class="reference internal" href="../../other_information/30_license.html">License</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../other_information/30_gui_plugins.html">GUI Plugins</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../other_information/40_license.html">License</a></li> </ul> @@ -190,7 +191,7 @@ <li><a href="../../index.html" class="icon icon-home"></a> »</li> - <li><a href="../40_configs_in_depth.html">Configs in Depth</a> »</li> + <li><a href="../30_configs_in_depth.html">Configs in Depth</a> »</li> <li>SystemConfigBlueprint</li> @@ -615,6 +616,14 @@ <td><p>Dynamics</p></td> <td><p>5</p></td> </tr> +<tr class="row-odd"><td><p>Dynamics_Scenario</p></td> +<td><p>Dynamics</p></td> +<td><p>6</p></td> +</tr> +<tr class="row-even"><td><p>ControllerSwitch</p></td> +<td><p>Dynamics</p></td> +<td><p>7</p></td> +</tr> <tr class="row-odd"><td><p>Algorithm_LongitudinalVehicleComponent</p></td> <td><p>Algorithm</p></td> <td><p>11</p></td> @@ -846,7 +855,7 @@ </div> <footer> <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> - <a href="../50_outputs_in_depth.html" class="btn btn-neutral float-right" title="Outputs in Depth" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a> + <a href="../40_outputs_in_depth.html" class="btn btn-neutral float-right" title="Outputs in Depth" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a> <a href="staticsystemconfig.html" class="btn btn-neutral float-left" title="Static SystemConfig" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a> </div> @@ -854,7 +863,7 @@ <div role="contentinfo"> <p> - © Copyright 2023 OpenPASS Working Group. + © Copyright 2023 openPASS Working Group. </p> </div>
diff --git a/content/html/user_guide/outputs/observation_log.html b/content/html/user_guide/outputs/observation_log.html index 655b8e9..9351666 100644 --- a/content/html/user_guide/outputs/observation_log.html +++ b/content/html/user_guide/outputs/observation_log.html
@@ -7,7 +7,7 @@ <meta name="viewport" content="width=device-width, initial-scale=1.0" /> - <title>Observation_Log — OpenPASS Documentation</title> + <title>Observation_Log — openPASS Documentation</title> @@ -70,7 +70,7 @@ <div class="version"> - "openPASS v0.11" + "develop_4d7f6d4f2e22c286789082dd8cbe3eb7f5b5af62" </div> @@ -100,7 +100,7 @@ <li class="toctree-l1"><a class="reference internal" href="../../installation_guide/10_getting_started.html">Getting Started</a></li> <li class="toctree-l1"><a class="reference internal" href="../../installation_guide/15_system_requirements.html">System Requirements</a></li> <li class="toctree-l1"><a class="reference internal" href="../../installation_guide/20_install_prerequisites.html">Installing Prerequisites</a></li> -<li class="toctree-l1"><a class="reference internal" href="../../installation_guide/30_install_openpass.html">Installing OpenPASS</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../installation_guide/30_install_openpass.html">Installing openPASS</a></li> <li class="toctree-l1"><a class="reference internal" href="../../installation_guide/50_further_guidance.html">Further Guidance</a></li> <li class="toctree-l1"><a class="reference internal" href="../../installation_guide/60_conan.html">Building with Conan</a></li> </ul> @@ -108,8 +108,7 @@ <ul class="current"> <li class="toctree-l1"><a class="reference internal" href="../10_overview.html">Overview</a></li> <li class="toctree-l1"><a class="reference internal" href="../20_tutorials.html">Tutorials</a></li> -<li class="toctree-l1"><a class="reference internal" href="../30_gui_plugins.html">GUI Plugins</a></li> -<li class="toctree-l1 current"><a class="reference internal" href="../40_configs_in_depth.html">Configs in Depth</a><ul class="current"> +<li class="toctree-l1 current"><a class="reference internal" href="../30_configs_in_depth.html">Configs in Depth</a><ul class="current"> <li class="toctree-l2"><a class="reference internal" href="../configs/profilescatalog.html">ProfilesCatalog</a></li> <li class="toctree-l2"><a class="reference internal" href="../configs/scenario.html">Scenario</a></li> <li class="toctree-l2"><a class="reference internal" href="../configs/scenery.html">Scenery</a></li> @@ -131,8 +130,8 @@ <li class="toctree-l2"><a class="reference internal" href="../configs/systemconfigblueprint.html">SystemConfigBlueprint</a></li> </ul> </li> -<li class="toctree-l1"><a class="reference internal" href="../50_outputs_in_depth.html">Outputs in Depth</a></li> -<li class="toctree-l1"><a class="reference internal" href="../60_scenario_simulation.html">Simulator</a></li> +<li class="toctree-l1"><a class="reference internal" href="../40_outputs_in_depth.html">Outputs in Depth</a></li> +<li class="toctree-l1"><a class="reference internal" href="../50_scenario_simulation.html">Simulator</a></li> </ul> <p class="caption"><span class="caption-text">Advanced topics</span></p> <ul> @@ -143,12 +142,14 @@ <ul> <li class="toctree-l1"><a class="reference internal" href="../../developer_information/10_ide_support.html">IDE Support</a></li> <li class="toctree-l1"><a class="reference internal" href="../../developer_information/20_documentation.html">Documentation Concept</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../developer_information/30_coding_conventions.html">Coding Guidelines</a></li> </ul> <p class="caption"><span class="caption-text">Other Information</span></p> <ul> <li class="toctree-l1"><a class="reference internal" href="../../other_information/10_external_dependencies.html">External Dependencies</a></li> <li class="toctree-l1"><a class="reference internal" href="../../other_information/20_glossary.html">Glossary</a></li> -<li class="toctree-l1"><a class="reference internal" href="../../other_information/30_license.html">License</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../other_information/30_gui_plugins.html">GUI Plugins</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../other_information/40_license.html">License</a></li> </ul> @@ -197,7 +198,7 @@ <li><a href="../../index.html" class="icon icon-home"></a> »</li> - <li><a href="../40_configs_in_depth.html">Configs in Depth</a> »</li> + <li><a href="../30_configs_in_depth.html">Configs in Depth</a> »</li> <li><a href="../configs/simulationconfig.html">SimulationConfig</a> »</li> @@ -223,8 +224,8 @@ <div class="section" id="observation-log"> <span id="id1"></span><h1>Observation_Log<a class="headerlink" href="#observation-log" title="Permalink to this headline">¶</a></h1> <p>This section describes the parameters and outputs of the <code class="docutils literal notranslate"><span class="pre">Observation_Log</span></code> observer.</p> -<div class="section" id="paramerization"> -<span id="observationlog-paramerization"></span><h2>Paramerization<a class="headerlink" href="#paramerization" title="Permalink to this headline">¶</a></h2> +<div class="section" id="parameterization"> +<span id="observationlog-parameterization"></span><h2>Parameterization<a class="headerlink" href="#parameterization" title="Permalink to this headline">¶</a></h2> <p>Following parameters are supported:</p> <table class="tight-table docutils align-default"> <colgroup> @@ -262,28 +263,105 @@ Simulation components including agent components can write this values into the DataBuffer component using the PublisherInterface. The Observation_Log can then read this values and write them into the output.</p> <p>The world publishes the following cyclics (see source of <code class="docutils literal notranslate"><span class="pre">AgentNetwork.cpp</span></code>):</p> -<ul class="simple"> -<li><p>XPosition</p></li> -<li><p>YPosition</p></li> -<li><p>VelocityEgo</p></li> -<li><p>AccelerationEgo</p></li> -<li><p>YawAngle</p></li> -<li><p>YawRate</p></li> -<li><p>SteeringAngle</p></li> -<li><p>TotalDistanceTraveled</p></li> -<li><p>PositionRoute</p></li> -<li><p>TCoordinate</p></li> -<li><p>Lane</p></li> -<li><p>Road</p></li> -<li><p>SecondaryLanes</p></li> -<li><p>AgentInFront</p></li> -</ul> +<table class="tight-table docutils align-default"> +<colgroup> +<col style="width: 16%" /> +<col style="width: 10%" /> +<col style="width: 4%" /> +<col style="width: 70%" /> +</colgroup> +<thead> +<tr class="row-odd"><th class="head"><p>Cyclics</p></th> +<th class="head"><p>Type</p></th> +<th class="head"><p>Unit</p></th> +<th class="head"><p>Description</p></th> +</tr> +</thead> +<tbody> +<tr class="row-even"><td><p>XPosition</p></td> +<td><p>Double</p></td> +<td><p>m</p></td> +<td><p>Position x of the reference point (in world coordinates)</p></td> +</tr> +<tr class="row-odd"><td><p>YPosition</p></td> +<td><p>Double</p></td> +<td><p>m</p></td> +<td><p>Position y of the reference point (in world coordinates)</p></td> +</tr> +<tr class="row-even"><td><p>VelocityEgo</p></td> +<td><p>Double</p></td> +<td><p>m/s</p></td> +<td><p>Absolute velocity (length of the velocity vector) at the reference point +(including spin caused by YawRate)</p></td> +</tr> +<tr class="row-odd"><td><p>AccelerationEgo</p></td> +<td><p>Double</p></td> +<td><p>m/s²</p></td> +<td><p>Longitudinal acceleration (including angular acceleration) at the reference point. +Longitudinal refers to the angle of the vehicle regardless of the curvature of the road it is on.</p></td> +</tr> +<tr class="row-even"><td><p>YawAngle</p></td> +<td><p>Double</p></td> +<td><p>rad</p></td> +<td><p>Yaw angle w.r.t. x-axis</p></td> +</tr> +<tr class="row-odd"><td><p>YawRate</p></td> +<td><p>Double</p></td> +<td><p>rad/s</p></td> +<td><p>Yaw rate of the agent</p></td> +</tr> +<tr class="row-even"><td><p>SteeringAngle</p></td> +<td><p>Double</p></td> +<td><p>rad</p></td> +<td><p>Steering wheel angle</p></td> +</tr> +<tr class="row-odd"><td><p>TotalDistanceTraveled</p></td> +<td><p>Double</p></td> +<td><p>m</p></td> +<td><p>Total traveled distance of all agents</p></td> +</tr> +<tr class="row-even"><td><p>PositionRoute*</p></td> +<td><p>Double</p></td> +<td><p>m</p></td> +<td><p>Position of the agent’s front center in <strong>road’s</strong> s coordinate +(distance to the start of the road)</p></td> +</tr> +<tr class="row-odd"><td><p>TCoordinate*</p></td> +<td><p>Double</p></td> +<td><p>m</p></td> +<td><p>Position of the agent’s front center in <strong>lane’s</strong> t coordinate +(distance to the middle of the lane respecting intended driving direction)</p></td> +</tr> +<tr class="row-even"><td><p>Lane*</p></td> +<td><p>Integer</p></td> +<td></td> +<td><p>Id of the lane</p></td> +</tr> +<tr class="row-odd"><td><p>Road*</p></td> +<td><p>String</p></td> +<td></td> +<td><p>OpenDrive id of the road on which the agent is on (i.e. the front center).</p></td> +</tr> +<tr class="row-even"><td><p>SecondaryLanes*</p></td> +<td><p>IntegerVector</p></td> +<td></td> +<td><p>List of secondary lanes on a specific road</p></td> +</tr> +<tr class="row-odd"><td><p>AgentInFront*</p></td> +<td><p>Integer</p></td> +<td></td> +<td><p>Id of the next object on the agent’s route</p></td> +</tr> +</tbody> +</table> +<p>*Only valid when the agent has a valid route assigned in the current timestep.</p> +<p>The agent’s reference point is located at the center of the rear axle (see <a class="reference internal" href="../../advanced_topics/simulator/coordinate_systems.html#coordinatesystems"><span class="std std-ref">Coordinate Systems</span></a>).</p> <p>Please refer to the individual components, for information about their published cyclics.</p> <div class="admonition-todo admonition" id="id2"> <p class="admonition-title">Todo</p> <p>We also need a way to better communicate, who is publishing what. This should directly come out of the source code, to keep the documentation up to date. -See <a class="reference external" href="https://gitlab.eclipse.org/eclipse/simopenpass/simopenpass/-/issues/148">https://gitlab.eclipse.org/eclipse/simopenpass/simopenpass/-/issues/148</a></p> +See <a class="reference external" href="https://gitlab.eclipse.org/eclipse/openpass/opSimulation/-/issues/148">https://gitlab.eclipse.org/eclipse/openpass/opSimulation/-/issues/148</a></p> </div> <div class="admonition-wildcards-in-logginggroup-definitions admonition"> <p class="admonition-title"><strong>Wildcards in LoggingGroup definitions</strong></p> @@ -312,7 +390,7 @@ <h2>Output Files<a class="headerlink" href="#output-files" title="Permalink to this headline">¶</a></h2> <div class="section" id="simulationoutput"> <span id="observationlog-simout"></span><h3>SimulationOutput<a class="headerlink" href="#simulationoutput" title="Permalink to this headline">¶</a></h3> -<p>Every successful run (single experiment) generates a single file, normally called <code class="docutils literal notranslate"><span class="pre">simulationOutput.xml</span></code> (see :ref:’observationlog_paramerization’). +<p>Every successful run (single experiment) generates a single file, normally called <code class="docutils literal notranslate"><span class="pre">simulationOutput.xml</span></code> (see :ref:’observationlog_parameterization’). The output can contain multiple invocations of the same configuration with different random seeds. For each invocation a RunResult is stored, which contains information about the agents and their parameters. As well as run specific events and parameters.</p> @@ -437,6 +515,7 @@ </tr> </tbody> </table> +<p>The change in the active component of longitudinal and/or lateral control is also logged as event with name “ActiveComponentChange”.</p> </div> <div class="section" id="agents"> <span id="observationlog-agents"></span><h4>Agents<a class="headerlink" href="#agents" title="Permalink to this headline">¶</a></h4> @@ -504,6 +583,26 @@ </tr> </tbody> </table> +<p>The Components tag lists all instantiated components from the SystemProfile.</p> +<table class="tight-table docutils align-default"> +<colgroup> +<col style="width: 23%" /> +<col style="width: 77%" /> +</colgroup> +<thead> +<tr class="row-odd"><th class="head"><p>Attribute</p></th> +<th class="head"><p>Description</p></th> +</tr> +</thead> +<tbody> +<tr class="row-even"><td><p>Type</p></td> +<td><p>Type of the component</p></td> +</tr> +<tr class="row-odd"><td><p>Profile</p></td> +<td><p>Name of the component profile</p></td> +</tr> +</tbody> +</table> <p>The Sensors tag lists all sensors of the agent and their parameters.</p> <table class="tight-table docutils align-default"> <colgroup> @@ -665,7 +764,7 @@ <div role="contentinfo"> <p> - © Copyright 2023 OpenPASS Working Group. + © Copyright 2023 openPASS Working Group. </p> </div>
diff --git a/content/html/user_guide/outputs/observation_repository.html b/content/html/user_guide/outputs/observation_repository.html index f9133c2..f7aa9aa 100644 --- a/content/html/user_guide/outputs/observation_repository.html +++ b/content/html/user_guide/outputs/observation_repository.html
@@ -7,7 +7,7 @@ <meta name="viewport" content="width=device-width, initial-scale=1.0" /> - <title>Observation_EntityRepository — OpenPASS Documentation</title> + <title>Observation_EntityRepository — openPASS Documentation</title> @@ -70,7 +70,7 @@ <div class="version"> - "openPASS v0.11" + "develop_4d7f6d4f2e22c286789082dd8cbe3eb7f5b5af62" </div> @@ -100,7 +100,7 @@ <li class="toctree-l1"><a class="reference internal" href="../../installation_guide/10_getting_started.html">Getting Started</a></li> <li class="toctree-l1"><a class="reference internal" href="../../installation_guide/15_system_requirements.html">System Requirements</a></li> <li class="toctree-l1"><a class="reference internal" href="../../installation_guide/20_install_prerequisites.html">Installing Prerequisites</a></li> -<li class="toctree-l1"><a class="reference internal" href="../../installation_guide/30_install_openpass.html">Installing OpenPASS</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../installation_guide/30_install_openpass.html">Installing openPASS</a></li> <li class="toctree-l1"><a class="reference internal" href="../../installation_guide/50_further_guidance.html">Further Guidance</a></li> <li class="toctree-l1"><a class="reference internal" href="../../installation_guide/60_conan.html">Building with Conan</a></li> </ul> @@ -108,8 +108,7 @@ <ul class="current"> <li class="toctree-l1"><a class="reference internal" href="../10_overview.html">Overview</a></li> <li class="toctree-l1"><a class="reference internal" href="../20_tutorials.html">Tutorials</a></li> -<li class="toctree-l1"><a class="reference internal" href="../30_gui_plugins.html">GUI Plugins</a></li> -<li class="toctree-l1 current"><a class="reference internal" href="../40_configs_in_depth.html">Configs in Depth</a><ul class="current"> +<li class="toctree-l1 current"><a class="reference internal" href="../30_configs_in_depth.html">Configs in Depth</a><ul class="current"> <li class="toctree-l2"><a class="reference internal" href="../configs/profilescatalog.html">ProfilesCatalog</a></li> <li class="toctree-l2"><a class="reference internal" href="../configs/scenario.html">Scenario</a></li> <li class="toctree-l2"><a class="reference internal" href="../configs/scenery.html">Scenery</a></li> @@ -131,8 +130,8 @@ <li class="toctree-l2"><a class="reference internal" href="../configs/systemconfigblueprint.html">SystemConfigBlueprint</a></li> </ul> </li> -<li class="toctree-l1"><a class="reference internal" href="../50_outputs_in_depth.html">Outputs in Depth</a></li> -<li class="toctree-l1"><a class="reference internal" href="../60_scenario_simulation.html">Simulator</a></li> +<li class="toctree-l1"><a class="reference internal" href="../40_outputs_in_depth.html">Outputs in Depth</a></li> +<li class="toctree-l1"><a class="reference internal" href="../50_scenario_simulation.html">Simulator</a></li> </ul> <p class="caption"><span class="caption-text">Advanced topics</span></p> <ul> @@ -143,12 +142,14 @@ <ul> <li class="toctree-l1"><a class="reference internal" href="../../developer_information/10_ide_support.html">IDE Support</a></li> <li class="toctree-l1"><a class="reference internal" href="../../developer_information/20_documentation.html">Documentation Concept</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../developer_information/30_coding_conventions.html">Coding Guidelines</a></li> </ul> <p class="caption"><span class="caption-text">Other Information</span></p> <ul> <li class="toctree-l1"><a class="reference internal" href="../../other_information/10_external_dependencies.html">External Dependencies</a></li> <li class="toctree-l1"><a class="reference internal" href="../../other_information/20_glossary.html">Glossary</a></li> -<li class="toctree-l1"><a class="reference internal" href="../../other_information/30_license.html">License</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../other_information/30_gui_plugins.html">GUI Plugins</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../other_information/40_license.html">License</a></li> </ul> @@ -197,7 +198,7 @@ <li><a href="../../index.html" class="icon icon-home"></a> »</li> - <li><a href="../40_configs_in_depth.html">Configs in Depth</a> »</li> + <li><a href="../30_configs_in_depth.html">Configs in Depth</a> »</li> <li><a href="../configs/simulationconfig.html">SimulationConfig</a> »</li> @@ -640,7 +641,7 @@ <div role="contentinfo"> <p> - © Copyright 2023 OpenPASS Working Group. + © Copyright 2023 openPASS Working Group. </p> </div>
diff --git a/content/html/user_guide/sim_user_guide/10_overview.html b/content/html/user_guide/sim_user_guide/10_overview.html index 06bb63a..4fb2ab5 100644 --- a/content/html/user_guide/sim_user_guide/10_overview.html +++ b/content/html/user_guide/sim_user_guide/10_overview.html
@@ -7,7 +7,7 @@ <meta name="viewport" content="width=device-width, initial-scale=1.0" /> - <title>Overview — OpenPASS Documentation</title> + <title>Overview — openPASS Documentation</title> @@ -43,7 +43,7 @@ <link rel="index" title="Index" href="../../genindex.html" /> <link rel="search" title="Search" href="../../search.html" /> <link rel="next" title="Component View" href="20_components.html" /> - <link rel="prev" title="Simulator" href="../60_scenario_simulation.html" /> + <link rel="prev" title="Simulator" href="../50_scenario_simulation.html" /> </head> <body class="wy-body-for-nav"> @@ -70,7 +70,7 @@ <div class="version"> - "openPASS v0.11" + "develop_4d7f6d4f2e22c286789082dd8cbe3eb7f5b5af62" </div> @@ -100,7 +100,7 @@ <li class="toctree-l1"><a class="reference internal" href="../../installation_guide/10_getting_started.html">Getting Started</a></li> <li class="toctree-l1"><a class="reference internal" href="../../installation_guide/15_system_requirements.html">System Requirements</a></li> <li class="toctree-l1"><a class="reference internal" href="../../installation_guide/20_install_prerequisites.html">Installing Prerequisites</a></li> -<li class="toctree-l1"><a class="reference internal" href="../../installation_guide/30_install_openpass.html">Installing OpenPASS</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../installation_guide/30_install_openpass.html">Installing openPASS</a></li> <li class="toctree-l1"><a class="reference internal" href="../../installation_guide/50_further_guidance.html">Further Guidance</a></li> <li class="toctree-l1"><a class="reference internal" href="../../installation_guide/60_conan.html">Building with Conan</a></li> </ul> @@ -108,10 +108,9 @@ <ul class="current"> <li class="toctree-l1"><a class="reference internal" href="../10_overview.html">Overview</a></li> <li class="toctree-l1"><a class="reference internal" href="../20_tutorials.html">Tutorials</a></li> -<li class="toctree-l1"><a class="reference internal" href="../30_gui_plugins.html">GUI Plugins</a></li> -<li class="toctree-l1"><a class="reference internal" href="../40_configs_in_depth.html">Configs in Depth</a></li> -<li class="toctree-l1"><a class="reference internal" href="../50_outputs_in_depth.html">Outputs in Depth</a></li> -<li class="toctree-l1 current"><a class="reference internal" href="../60_scenario_simulation.html">Simulator</a><ul class="current"> +<li class="toctree-l1"><a class="reference internal" href="../30_configs_in_depth.html">Configs in Depth</a></li> +<li class="toctree-l1"><a class="reference internal" href="../40_outputs_in_depth.html">Outputs in Depth</a></li> +<li class="toctree-l1 current"><a class="reference internal" href="../50_scenario_simulation.html">Simulator</a><ul class="current"> <li class="toctree-l2 current"><a class="current reference internal" href="#">Overview</a></li> <li class="toctree-l2"><a class="reference internal" href="20_components.html">Component View</a></li> </ul> @@ -126,12 +125,14 @@ <ul> <li class="toctree-l1"><a class="reference internal" href="../../developer_information/10_ide_support.html">IDE Support</a></li> <li class="toctree-l1"><a class="reference internal" href="../../developer_information/20_documentation.html">Documentation Concept</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../developer_information/30_coding_conventions.html">Coding Guidelines</a></li> </ul> <p class="caption"><span class="caption-text">Other Information</span></p> <ul> <li class="toctree-l1"><a class="reference internal" href="../../other_information/10_external_dependencies.html">External Dependencies</a></li> <li class="toctree-l1"><a class="reference internal" href="../../other_information/20_glossary.html">Glossary</a></li> -<li class="toctree-l1"><a class="reference internal" href="../../other_information/30_license.html">License</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../other_information/30_gui_plugins.html">GUI Plugins</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../other_information/40_license.html">License</a></li> </ul> @@ -180,7 +181,7 @@ <li><a href="../../index.html" class="icon icon-home"></a> »</li> - <li><a href="../60_scenario_simulation.html">Simulator</a> »</li> + <li><a href="../50_scenario_simulation.html">Simulator</a> »</li> <li>Overview</li> @@ -203,7 +204,7 @@ <div class="section" id="overview"> <h1>Overview<a class="headerlink" href="#overview" title="Permalink to this headline">¶</a></h1> -<p><strong>OpenPASS</strong> is a tool for executing a traffic based Monte-Carlo simulation and provides capabilities for the following two levels of variation:</p> +<p><strong>openPASS</strong> is a tool for executing a traffic based Monte-Carlo simulation and provides capabilities for the following two levels of variation:</p> <ol class="arabic simple"> <li><p><strong>Experiment:</strong> Topmost, an experiment defines the domains of possible inputs, which shall be compared, such as <em>“traffic at high volume”</em> with <em>“traffic at low volume”</em>. In this sense, a parameter variation is done at a very coarse level, resulting in two sets of inputs. @@ -222,14 +223,14 @@ <footer> <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> <a href="20_components.html" class="btn btn-neutral float-right" title="Component View" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a> - <a href="../60_scenario_simulation.html" class="btn btn-neutral float-left" title="Simulator" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a> + <a href="../50_scenario_simulation.html" class="btn btn-neutral float-left" title="Simulator" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a> </div> <hr/> <div role="contentinfo"> <p> - © Copyright 2023 OpenPASS Working Group. + © Copyright 2023 openPASS Working Group. </p> </div>
diff --git a/content/html/user_guide/sim_user_guide/20_components.html b/content/html/user_guide/sim_user_guide/20_components.html index a10644f..4a4310d 100644 --- a/content/html/user_guide/sim_user_guide/20_components.html +++ b/content/html/user_guide/sim_user_guide/20_components.html
@@ -7,7 +7,7 @@ <meta name="viewport" content="width=device-width, initial-scale=1.0" /> - <title>Component View — OpenPASS Documentation</title> + <title>Component View — openPASS Documentation</title> @@ -70,7 +70,7 @@ <div class="version"> - "openPASS v0.11" + "develop_4d7f6d4f2e22c286789082dd8cbe3eb7f5b5af62" </div> @@ -100,7 +100,7 @@ <li class="toctree-l1"><a class="reference internal" href="../../installation_guide/10_getting_started.html">Getting Started</a></li> <li class="toctree-l1"><a class="reference internal" href="../../installation_guide/15_system_requirements.html">System Requirements</a></li> <li class="toctree-l1"><a class="reference internal" href="../../installation_guide/20_install_prerequisites.html">Installing Prerequisites</a></li> -<li class="toctree-l1"><a class="reference internal" href="../../installation_guide/30_install_openpass.html">Installing OpenPASS</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../installation_guide/30_install_openpass.html">Installing openPASS</a></li> <li class="toctree-l1"><a class="reference internal" href="../../installation_guide/50_further_guidance.html">Further Guidance</a></li> <li class="toctree-l1"><a class="reference internal" href="../../installation_guide/60_conan.html">Building with Conan</a></li> </ul> @@ -108,14 +108,14 @@ <ul class="current"> <li class="toctree-l1"><a class="reference internal" href="../10_overview.html">Overview</a></li> <li class="toctree-l1"><a class="reference internal" href="../20_tutorials.html">Tutorials</a></li> -<li class="toctree-l1"><a class="reference internal" href="../30_gui_plugins.html">GUI Plugins</a></li> -<li class="toctree-l1"><a class="reference internal" href="../40_configs_in_depth.html">Configs in Depth</a></li> -<li class="toctree-l1"><a class="reference internal" href="../50_outputs_in_depth.html">Outputs in Depth</a></li> -<li class="toctree-l1 current"><a class="reference internal" href="../60_scenario_simulation.html">Simulator</a><ul class="current"> +<li class="toctree-l1"><a class="reference internal" href="../30_configs_in_depth.html">Configs in Depth</a></li> +<li class="toctree-l1"><a class="reference internal" href="../40_outputs_in_depth.html">Outputs in Depth</a></li> +<li class="toctree-l1 current"><a class="reference internal" href="../50_scenario_simulation.html">Simulator</a><ul class="current"> <li class="toctree-l2"><a class="reference internal" href="10_overview.html">Overview</a></li> <li class="toctree-l2 current"><a class="current reference internal" href="#">Component View</a><ul> <li class="toctree-l3"><a class="reference internal" href="#components-in-depth">Components in Depth</a><ul> <li class="toctree-l4"><a class="reference internal" href="components/driver.html">Driver</a></li> +<li class="toctree-l4"><a class="reference internal" href="components/dynamics_scenario.html">Dynamics_Scenario</a></li> <li class="toctree-l4"><a class="reference internal" href="components/spawner.html">Spawner</a></li> <li class="toctree-l4"><a class="reference internal" href="components/vehicle.html">VehicleComponents</a></li> </ul> @@ -134,12 +134,14 @@ <ul> <li class="toctree-l1"><a class="reference internal" href="../../developer_information/10_ide_support.html">IDE Support</a></li> <li class="toctree-l1"><a class="reference internal" href="../../developer_information/20_documentation.html">Documentation Concept</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../developer_information/30_coding_conventions.html">Coding Guidelines</a></li> </ul> <p class="caption"><span class="caption-text">Other Information</span></p> <ul> <li class="toctree-l1"><a class="reference internal" href="../../other_information/10_external_dependencies.html">External Dependencies</a></li> <li class="toctree-l1"><a class="reference internal" href="../../other_information/20_glossary.html">Glossary</a></li> -<li class="toctree-l1"><a class="reference internal" href="../../other_information/30_license.html">License</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../other_information/30_gui_plugins.html">GUI Plugins</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../other_information/40_license.html">License</a></li> </ul> @@ -188,7 +190,7 @@ <li><a href="../../index.html" class="icon icon-home"></a> »</li> - <li><a href="../60_scenario_simulation.html">Simulator</a> »</li> + <li><a href="../50_scenario_simulation.html">Simulator</a> »</li> <li>Component View</li> @@ -211,7 +213,7 @@ <div class="section" id="component-view"> <h1>Component View<a class="headerlink" href="#component-view" title="Permalink to this headline">¶</a></h1> -<p><strong>OpenPASS</strong> is divided into components, which can be roughly divided into <strong>core components</strong> and <strong>model components</strong>. +<p><strong>openPASS</strong> is divided into components, which can be roughly divided into <strong>core components</strong> and <strong>model components</strong>. The most interesting core components are the individual <strong>spawners</strong>, which are responsible for populating the world in a realistic fashion. Model components are again roughly divided into <strong>drivers</strong> and <strong>vehicle components</strong> and represent how an individual participant is composed.</p> <div class="admonition note"> @@ -232,8 +234,21 @@ </li> </ul> </li> +<li class="toctree-l1"><a class="reference internal" href="components/dynamics_scenario.html">Dynamics_Scenario</a><ul> +<li class="toctree-l2"><a class="reference internal" href="components/dynamics_scenario.html#defaultstrategies">DefaultStrategies</a><ul> +<li class="toctree-l3"><a class="reference internal" href="components/dynamics_scenario.html#keepvelocity-longitudinal">KeepVelocity - longitudinal</a></li> +<li class="toctree-l3"><a class="reference internal" href="components/dynamics_scenario.html#keeplaneoffset-lateral">KeepLaneOffset - lateral</a></li> +</ul> +</li> +<li class="toctree-l2"><a class="reference internal" href="components/dynamics_scenario.html#strategies">Strategies</a><ul> +<li class="toctree-l3"><a class="reference internal" href="components/dynamics_scenario.html#followvelocityspline-longitudinal">FollowVelocitySpline - longitudinal</a></li> +<li class="toctree-l3"><a class="reference internal" href="components/dynamics_scenario.html#performchangelane-lateral">PerformChangeLane - lateral</a></li> +<li class="toctree-l3"><a class="reference internal" href="components/dynamics_scenario.html#followtrajectory-both">FollowTrajectory - both</a></li> +</ul> +</li> +</ul> +</li> <li class="toctree-l1"><a class="reference internal" href="components/spawner.html">Spawner</a><ul> -<li class="toctree-l2"><a class="reference internal" href="components/spawner.html#scenariospawner">ScenarioSpawner</a></li> <li class="toctree-l2"><a class="reference internal" href="components/spawner.html#prerunspawner">PreRunSpawner</a></li> <li class="toctree-l2"><a class="reference internal" href="components/spawner.html#runtimespawner">RuntimeSpawner</a></li> <li class="toctree-l2"><a class="reference internal" href="components/spawner.html#trafficgroups">TrafficGroups</a></li> @@ -245,6 +260,15 @@ <li class="toctree-l2"><a class="reference internal" href="components/vehicle.html#fmu-wrapper">FMU Wrapper</a></li> <li class="toctree-l2"><a class="reference internal" href="components/vehicle.html#sensorgeometric2d">SensorGeometric2D</a></li> <li class="toctree-l2"><a class="reference internal" href="components/vehicle.html#receivercar2x">ReceiverCar2X</a></li> +<li class="toctree-l2"><a class="reference internal" href="components/vehicle.html#vehicledynamics">VehicleDynamics</a><ul> +<li class="toctree-l3"><a class="reference internal" href="components/vehicle.html#actionsteeringsystem">ActionSteeringSystem</a></li> +<li class="toctree-l3"><a class="reference internal" href="components/vehicle.html#actionpowertrain">ActionPowertrain</a></li> +<li class="toctree-l3"><a class="reference internal" href="components/vehicle.html#actionbrakesystem">ActionBrakeSystem</a></li> +<li class="toctree-l3"><a class="reference internal" href="components/vehicle.html#dynamicschassis">DynamicsChassis</a></li> +<li class="toctree-l3"><a class="reference internal" href="components/vehicle.html#dynamicstiremodel">DynamicsTireModel</a></li> +<li class="toctree-l3"><a class="reference internal" href="components/vehicle.html#dynamicsmotionmodel">DynamicsMotionModel</a></li> +</ul> +</li> </ul> </li> </ul> @@ -266,7 +290,7 @@ <div role="contentinfo"> <p> - © Copyright 2023 OpenPASS Working Group. + © Copyright 2023 openPASS Working Group. </p> </div>
diff --git a/content/html/user_guide/sim_user_guide/components/driver.html b/content/html/user_guide/sim_user_guide/components/driver.html index 5624669..06451ba 100644 --- a/content/html/user_guide/sim_user_guide/components/driver.html +++ b/content/html/user_guide/sim_user_guide/components/driver.html
@@ -7,7 +7,7 @@ <meta name="viewport" content="width=device-width, initial-scale=1.0" /> - <title>Driver — OpenPASS Documentation</title> + <title>Driver — openPASS Documentation</title> @@ -42,7 +42,7 @@ <link rel="index" title="Index" href="../../../genindex.html" /> <link rel="search" title="Search" href="../../../search.html" /> - <link rel="next" title="Spawner" href="spawner.html" /> + <link rel="next" title="Dynamics_Scenario" href="dynamics_scenario.html" /> <link rel="prev" title="Component View" href="../20_components.html" /> </head> @@ -70,7 +70,7 @@ <div class="version"> - "openPASS v0.11" + "develop_4d7f6d4f2e22c286789082dd8cbe3eb7f5b5af62" </div> @@ -100,7 +100,7 @@ <li class="toctree-l1"><a class="reference internal" href="../../../installation_guide/10_getting_started.html">Getting Started</a></li> <li class="toctree-l1"><a class="reference internal" href="../../../installation_guide/15_system_requirements.html">System Requirements</a></li> <li class="toctree-l1"><a class="reference internal" href="../../../installation_guide/20_install_prerequisites.html">Installing Prerequisites</a></li> -<li class="toctree-l1"><a class="reference internal" href="../../../installation_guide/30_install_openpass.html">Installing OpenPASS</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../../installation_guide/30_install_openpass.html">Installing openPASS</a></li> <li class="toctree-l1"><a class="reference internal" href="../../../installation_guide/50_further_guidance.html">Further Guidance</a></li> <li class="toctree-l1"><a class="reference internal" href="../../../installation_guide/60_conan.html">Building with Conan</a></li> </ul> @@ -108,14 +108,14 @@ <ul class="current"> <li class="toctree-l1"><a class="reference internal" href="../../10_overview.html">Overview</a></li> <li class="toctree-l1"><a class="reference internal" href="../../20_tutorials.html">Tutorials</a></li> -<li class="toctree-l1"><a class="reference internal" href="../../30_gui_plugins.html">GUI Plugins</a></li> -<li class="toctree-l1"><a class="reference internal" href="../../40_configs_in_depth.html">Configs in Depth</a></li> -<li class="toctree-l1"><a class="reference internal" href="../../50_outputs_in_depth.html">Outputs in Depth</a></li> -<li class="toctree-l1 current"><a class="reference internal" href="../../60_scenario_simulation.html">Simulator</a><ul class="current"> +<li class="toctree-l1"><a class="reference internal" href="../../30_configs_in_depth.html">Configs in Depth</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../40_outputs_in_depth.html">Outputs in Depth</a></li> +<li class="toctree-l1 current"><a class="reference internal" href="../../50_scenario_simulation.html">Simulator</a><ul class="current"> <li class="toctree-l2"><a class="reference internal" href="../10_overview.html">Overview</a></li> <li class="toctree-l2 current"><a class="reference internal" href="../20_components.html">Component View</a><ul class="current"> <li class="toctree-l3 current"><a class="reference internal" href="../20_components.html#components-in-depth">Components in Depth</a><ul class="current"> <li class="toctree-l4 current"><a class="current reference internal" href="#">Driver</a></li> +<li class="toctree-l4"><a class="reference internal" href="dynamics_scenario.html">Dynamics_Scenario</a></li> <li class="toctree-l4"><a class="reference internal" href="spawner.html">Spawner</a></li> <li class="toctree-l4"><a class="reference internal" href="vehicle.html">VehicleComponents</a></li> </ul> @@ -134,12 +134,14 @@ <ul> <li class="toctree-l1"><a class="reference internal" href="../../../developer_information/10_ide_support.html">IDE Support</a></li> <li class="toctree-l1"><a class="reference internal" href="../../../developer_information/20_documentation.html">Documentation Concept</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../../developer_information/30_coding_conventions.html">Coding Guidelines</a></li> </ul> <p class="caption"><span class="caption-text">Other Information</span></p> <ul> <li class="toctree-l1"><a class="reference internal" href="../../../other_information/10_external_dependencies.html">External Dependencies</a></li> <li class="toctree-l1"><a class="reference internal" href="../../../other_information/20_glossary.html">Glossary</a></li> -<li class="toctree-l1"><a class="reference internal" href="../../../other_information/30_license.html">License</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../../other_information/30_gui_plugins.html">GUI Plugins</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../../other_information/40_license.html">License</a></li> </ul> @@ -188,7 +190,7 @@ <li><a href="../../../index.html" class="icon icon-home"></a> »</li> - <li><a href="../../60_scenario_simulation.html">Simulator</a> »</li> + <li><a href="../../50_scenario_simulation.html">Simulator</a> »</li> <li><a href="../20_components.html">Component View</a> »</li> @@ -351,7 +353,7 @@ </div> <footer> <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> - <a href="spawner.html" class="btn btn-neutral float-right" title="Spawner" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a> + <a href="dynamics_scenario.html" class="btn btn-neutral float-right" title="Dynamics_Scenario" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a> <a href="../20_components.html" class="btn btn-neutral float-left" title="Component View" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a> </div> @@ -359,7 +361,7 @@ <div role="contentinfo"> <p> - © Copyright 2023 OpenPASS Working Group. + © Copyright 2023 openPASS Working Group. </p> </div>
diff --git a/content/html/user_guide/sim_user_guide/components/dynamics_scenario.html b/content/html/user_guide/sim_user_guide/components/dynamics_scenario.html new file mode 100644 index 0000000..4bc9f1d --- /dev/null +++ b/content/html/user_guide/sim_user_guide/components/dynamics_scenario.html
@@ -0,0 +1,320 @@ + + +<!DOCTYPE html> +<html class="writer-html5" lang="en" > +<head> + <meta charset="utf-8" /> + + <meta name="viewport" content="width=device-width, initial-scale=1.0" /> + + <title>Dynamics_Scenario — openPASS Documentation</title> + + + + <link rel="stylesheet" href="../../../_static/css/theme.css" type="text/css" /> + <link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" /> + <link rel="stylesheet" href="../../../_static/tabs.css" type="text/css" /> + <link rel="stylesheet" href="../../../_static/css/custom.css" type="text/css" /> + + + + <link rel="shortcut icon" href="../../../_static/openPASS.ico"/> + + + + + + + + + <!--[if lt IE 9]> + <script src="../../../_static/js/html5shiv.min.js"></script> + <![endif]--> + + + <script type="text/javascript" id="documentation_options" data-url_root="../../../" src="../../../_static/documentation_options.js"></script> + <script src="../../../_static/jquery.js"></script> + <script src="../../../_static/underscore.js"></script> + <script src="../../../_static/doctools.js"></script> + + <script type="text/javascript" src="../../../_static/js/theme.js"></script> + + + <link rel="index" title="Index" href="../../../genindex.html" /> + <link rel="search" title="Search" href="../../../search.html" /> + <link rel="next" title="Spawner" href="spawner.html" /> + <link rel="prev" title="Driver" href="driver.html" /> +</head> + +<body class="wy-body-for-nav"> + + + <div class="wy-grid-for-nav"> + + <nav data-toggle="wy-nav-shift" class="wy-nav-side"> + <div class="wy-side-scroll"> + <div class="wy-side-nav-search" > + + + + <a href="../../../index.html" class="icon icon-home"> openPASS + + + + + <img src="../../../_static/openPASS.png" class="logo" alt="Logo"/> + + </a> + + + + + <div class="version"> + "develop_4d7f6d4f2e22c286789082dd8cbe3eb7f5b5af62" + </div> + + + + +<div role="search"> + <form id="rtd-search-form" class="wy-form" action="../../../search.html" method="get"> + <input type="text" name="q" placeholder="Search docs" /> + <input type="hidden" name="check_keywords" value="yes" /> + <input type="hidden" name="area" value="default" /> + </form> +</div> + + + </div> + + + <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation"> + + + + + + + <p class="caption"><span class="caption-text">Installation Guide</span></p> +<ul> +<li class="toctree-l1"><a class="reference internal" href="../../../installation_guide/10_getting_started.html">Getting Started</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../../installation_guide/15_system_requirements.html">System Requirements</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../../installation_guide/20_install_prerequisites.html">Installing Prerequisites</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../../installation_guide/30_install_openpass.html">Installing openPASS</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../../installation_guide/50_further_guidance.html">Further Guidance</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../../installation_guide/60_conan.html">Building with Conan</a></li> +</ul> +<p class="caption"><span class="caption-text">User Guides</span></p> +<ul class="current"> +<li class="toctree-l1"><a class="reference internal" href="../../10_overview.html">Overview</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../20_tutorials.html">Tutorials</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../30_configs_in_depth.html">Configs in Depth</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../40_outputs_in_depth.html">Outputs in Depth</a></li> +<li class="toctree-l1 current"><a class="reference internal" href="../../50_scenario_simulation.html">Simulator</a><ul class="current"> +<li class="toctree-l2"><a class="reference internal" href="../10_overview.html">Overview</a></li> +<li class="toctree-l2 current"><a class="reference internal" href="../20_components.html">Component View</a><ul class="current"> +<li class="toctree-l3 current"><a class="reference internal" href="../20_components.html#components-in-depth">Components in Depth</a><ul class="current"> +<li class="toctree-l4"><a class="reference internal" href="driver.html">Driver</a></li> +<li class="toctree-l4 current"><a class="current reference internal" href="#">Dynamics_Scenario</a></li> +<li class="toctree-l4"><a class="reference internal" href="spawner.html">Spawner</a></li> +<li class="toctree-l4"><a class="reference internal" href="vehicle.html">VehicleComponents</a></li> +</ul> +</li> +</ul> +</li> +</ul> +</li> +</ul> +<p class="caption"><span class="caption-text">Advanced topics</span></p> +<ul> +<li class="toctree-l1"><a class="reference internal" href="../../../advanced_topics/20_simulator_advanced.html">Simulator</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../../advanced_topics/30_testing.html">EndToEnd Test Framework</a></li> +</ul> +<p class="caption"><span class="caption-text">Developer Information</span></p> +<ul> +<li class="toctree-l1"><a class="reference internal" href="../../../developer_information/10_ide_support.html">IDE Support</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../../developer_information/20_documentation.html">Documentation Concept</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../../developer_information/30_coding_conventions.html">Coding Guidelines</a></li> +</ul> +<p class="caption"><span class="caption-text">Other Information</span></p> +<ul> +<li class="toctree-l1"><a class="reference internal" href="../../../other_information/10_external_dependencies.html">External Dependencies</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../../other_information/20_glossary.html">Glossary</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../../other_information/30_gui_plugins.html">GUI Plugins</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../../other_information/40_license.html">License</a></li> +</ul> + + + + </div> + + </div> + </nav> + + <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> + + + <nav class="wy-nav-top" aria-label="top navigation"> + + <i data-toggle="wy-nav-top" class="fa fa-bars"></i> + <a href="../../../index.html">openPASS</a> + + </nav> + + + <div class="wy-nav-content"> + + <div class="rst-content"> + + + + + + + + + + + + + + + + + + + +<div role="navigation" aria-label="breadcrumbs navigation"> + + <ul class="wy-breadcrumbs"> + + <li><a href="../../../index.html" class="icon icon-home"></a> »</li> + + <li><a href="../../50_scenario_simulation.html">Simulator</a> »</li> + + <li><a href="../20_components.html">Component View</a> »</li> + + <li>Dynamics_Scenario</li> + + + <li class="wy-breadcrumbs-aside"> + + + <a href="../../../_sources/user_guide/sim_user_guide/components/dynamics_scenario.rst.txt" rel="nofollow"> View page source</a> + + + </li> + + </ul> + + + <hr/> +</div> + <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> + <div itemprop="articleBody"> + + <div class="section" id="dynamics-scenario"> +<span id="id1"></span><h1>Dynamics_Scenario<a class="headerlink" href="#dynamics-scenario" title="Permalink to this headline">¶</a></h1> +<p>This module acts as a direct implementation of external scenario actions, requested through <cite>ControlStrategies</cite> defined in the <cite>Mantle API <https://gitlab.eclipse.org/eclipse/openpass/scenario_api></cite>. +As the MantleAPI is not an official standard, the module currently follows a “standard conform” interpretation based on <cite>openSCENARIO V1.1 <https://www.asam.net/standards/detail/openscenario/></cite>.</p> +<div class="admonition note"> +<p class="admonition-title">Note</p> +<p>Due to the nature of <strong>openPASS</strong> actions that are set by the scenario engine in one timestep, will be visible in the simulation output starting with the next timestep, +because all states are only syncronized at the end of a timestep</p> +</div> +<p>In every timestep one strategy for each MovementDomain (longitudinal and lateral) is active. +If the scenario engine sets a new strategy for a MovementDomain the previous strategy for this MovementDomain is stopped. +A strategy can also apply to both MovementDomains (meaning it is the only active strategy). +If a strategy is finished (except KeepVelocity and KeepLaneOffset which are never finished), this is reported back to the scenario engine.</p> +<div class="section" id="defaultstrategies"> +<h2>DefaultStrategies<a class="headerlink" href="#defaultstrategies" title="Permalink to this headline">¶</a></h2> +<div class="section" id="keepvelocity-longitudinal"> +<h3>KeepVelocity - longitudinal<a class="headerlink" href="#keepvelocity-longitudinal" title="Permalink to this headline">¶</a></h3> +<p>During this strategy the velocity is constant (same as at the time when this strategy is set). +This is the default longitudinal strategy, if no other longitudinal strategy is set.</p> +</div> +<div class="section" id="keeplaneoffset-lateral"> +<h3>KeepLaneOffset - lateral<a class="headerlink" href="#keeplaneoffset-lateral" title="Permalink to this headline">¶</a></h3> +<p>During this strategy the agent will drive along the lane with a constant offset (same as at the time when this strategy is set). +This is the default lateral strategy, if no other lateral strategy is set.</p> +</div> +</div> +<div class="section" id="strategies"> +<h2>Strategies<a class="headerlink" href="#strategies" title="Permalink to this headline">¶</a></h2> +<div class="section" id="followvelocityspline-longitudinal"> +<h3>FollowVelocitySpline - longitudinal<a class="headerlink" href="#followvelocityspline-longitudinal" title="Permalink to this headline">¶</a></h3> +<p>A velocity spline defines a function over time of the agent velocity. +This function is a piecewise polynomial of degree 3. +This strategy will be set for SpeedActions with DynamicsShape other than step.</p> +</div> +<div class="section" id="performchangelane-lateral"> +<h3>PerformChangeLane - lateral<a class="headerlink" href="#performchangelane-lateral" title="Permalink to this headline">¶</a></h3> +<p>This strategy will have the agent switching lanes while keeping a constant longitudinal velocity (in s direction). +It will be set for LaneChangeActions where the target lane is not the current lane. +At the momement only DynamicsShape sinusoidal and DynamicsDimension distance or time is supported.</p> +<div class="admonition note"> +<p class="admonition-title">Note</p> +<p>In the current implementation both movement domains are touched, even if a longitudinal movement controller is active. +This means that the velocity of the longitudinal is ignored while the lane change is executed. +This may result in a jump of the velocity at the end of the lane change.</p> +</div> +</div> +<div class="section" id="followtrajectory-both"> +<h3>FollowTrajectory - both<a class="headerlink" href="#followtrajectory-both" title="Permalink to this headline">¶</a></h3> +<p>A trajectory defines the position and orientation of the agent at defined times. +If a timestep lies between the trajectory points the position is linearly interpolated. +This strategy will be set for FollowTrajectoryActions. +TrajectoryFollowingMode is not supported and the agent will always strictly adhere to the trajectory.</p> +</div> +</div> +</div> + + + </div> + + </div> + <footer> + <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> + <a href="spawner.html" class="btn btn-neutral float-right" title="Spawner" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a> + <a href="driver.html" class="btn btn-neutral float-left" title="Driver" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a> + </div> + + <hr/> + + <div role="contentinfo"> + <p> + © Copyright 2023 openPASS Working Group. + + </p> + </div> + + + + Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a + + <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a> + + provided by <a href="https://readthedocs.org">Read the Docs</a>. + +</footer> + </div> + </div> + + </section> + + </div> + + + <script type="text/javascript"> + jQuery(function () { + SphinxRtdTheme.Navigation.enable(true); + }); + </script> + + + + + + +</body> +</html> \ No newline at end of file
diff --git a/content/html/user_guide/sim_user_guide/components/spawner.html b/content/html/user_guide/sim_user_guide/components/spawner.html index 34eaa41..4d77ad9 100644 --- a/content/html/user_guide/sim_user_guide/components/spawner.html +++ b/content/html/user_guide/sim_user_guide/components/spawner.html
@@ -7,7 +7,7 @@ <meta name="viewport" content="width=device-width, initial-scale=1.0" /> - <title>Spawner — OpenPASS Documentation</title> + <title>Spawner — openPASS Documentation</title> @@ -43,7 +43,7 @@ <link rel="index" title="Index" href="../../../genindex.html" /> <link rel="search" title="Search" href="../../../search.html" /> <link rel="next" title="VehicleComponents" href="vehicle.html" /> - <link rel="prev" title="Driver" href="driver.html" /> + <link rel="prev" title="Dynamics_Scenario" href="dynamics_scenario.html" /> </head> <body class="wy-body-for-nav"> @@ -70,7 +70,7 @@ <div class="version"> - "openPASS v0.11" + "develop_4d7f6d4f2e22c286789082dd8cbe3eb7f5b5af62" </div> @@ -100,7 +100,7 @@ <li class="toctree-l1"><a class="reference internal" href="../../../installation_guide/10_getting_started.html">Getting Started</a></li> <li class="toctree-l1"><a class="reference internal" href="../../../installation_guide/15_system_requirements.html">System Requirements</a></li> <li class="toctree-l1"><a class="reference internal" href="../../../installation_guide/20_install_prerequisites.html">Installing Prerequisites</a></li> -<li class="toctree-l1"><a class="reference internal" href="../../../installation_guide/30_install_openpass.html">Installing OpenPASS</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../../installation_guide/30_install_openpass.html">Installing openPASS</a></li> <li class="toctree-l1"><a class="reference internal" href="../../../installation_guide/50_further_guidance.html">Further Guidance</a></li> <li class="toctree-l1"><a class="reference internal" href="../../../installation_guide/60_conan.html">Building with Conan</a></li> </ul> @@ -108,14 +108,14 @@ <ul class="current"> <li class="toctree-l1"><a class="reference internal" href="../../10_overview.html">Overview</a></li> <li class="toctree-l1"><a class="reference internal" href="../../20_tutorials.html">Tutorials</a></li> -<li class="toctree-l1"><a class="reference internal" href="../../30_gui_plugins.html">GUI Plugins</a></li> -<li class="toctree-l1"><a class="reference internal" href="../../40_configs_in_depth.html">Configs in Depth</a></li> -<li class="toctree-l1"><a class="reference internal" href="../../50_outputs_in_depth.html">Outputs in Depth</a></li> -<li class="toctree-l1 current"><a class="reference internal" href="../../60_scenario_simulation.html">Simulator</a><ul class="current"> +<li class="toctree-l1"><a class="reference internal" href="../../30_configs_in_depth.html">Configs in Depth</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../40_outputs_in_depth.html">Outputs in Depth</a></li> +<li class="toctree-l1 current"><a class="reference internal" href="../../50_scenario_simulation.html">Simulator</a><ul class="current"> <li class="toctree-l2"><a class="reference internal" href="../10_overview.html">Overview</a></li> <li class="toctree-l2 current"><a class="reference internal" href="../20_components.html">Component View</a><ul class="current"> <li class="toctree-l3 current"><a class="reference internal" href="../20_components.html#components-in-depth">Components in Depth</a><ul class="current"> <li class="toctree-l4"><a class="reference internal" href="driver.html">Driver</a></li> +<li class="toctree-l4"><a class="reference internal" href="dynamics_scenario.html">Dynamics_Scenario</a></li> <li class="toctree-l4 current"><a class="current reference internal" href="#">Spawner</a></li> <li class="toctree-l4"><a class="reference internal" href="vehicle.html">VehicleComponents</a></li> </ul> @@ -134,12 +134,14 @@ <ul> <li class="toctree-l1"><a class="reference internal" href="../../../developer_information/10_ide_support.html">IDE Support</a></li> <li class="toctree-l1"><a class="reference internal" href="../../../developer_information/20_documentation.html">Documentation Concept</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../../developer_information/30_coding_conventions.html">Coding Guidelines</a></li> </ul> <p class="caption"><span class="caption-text">Other Information</span></p> <ul> <li class="toctree-l1"><a class="reference internal" href="../../../other_information/10_external_dependencies.html">External Dependencies</a></li> <li class="toctree-l1"><a class="reference internal" href="../../../other_information/20_glossary.html">Glossary</a></li> -<li class="toctree-l1"><a class="reference internal" href="../../../other_information/30_license.html">License</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../../other_information/30_gui_plugins.html">GUI Plugins</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../../other_information/40_license.html">License</a></li> </ul> @@ -188,7 +190,7 @@ <li><a href="../../../index.html" class="icon icon-home"></a> »</li> - <li><a href="../../60_scenario_simulation.html">Simulator</a> »</li> + <li><a href="../../50_scenario_simulation.html">Simulator</a> »</li> <li><a href="../20_components.html">Component View</a> »</li> @@ -214,22 +216,7 @@ <div class="section" id="spawner"> <span id="components-spawner"></span><h1>Spawner<a class="headerlink" href="#spawner" title="Permalink to this headline">¶</a></h1> <p>Spawners are responsible to populate the world. -In order to do so, several spawners can be used, whereas only the <strong>ScenarioSpawner</strong> is mandatory.</p> -<div class="section" id="scenariospawner"> -<span id="components-scenariospawner"></span><h2>ScenarioSpawner<a class="headerlink" href="#scenariospawner" title="Permalink to this headline">¶</a></h2> -<p>The ScenarioSpawner is responsible for spawning Ego and Scenario vehicles as defined in the Scenario configuration file. -It is only called once initially and is <strong>mandatory</strong> for each simulation. -This Spawner should trigger before any other Spawners.</p> -<p>The ScenarioSpawner has no parameters.</p> -<p>Behavior:</p> -<ul class="simple"> -<li><p>In order to spawn correctly, a position for each Ego and Scenario vehicle is necessary, normally coming from the scenario (recommended). -As the position is <em>optional</em> in openSCENARIO it is possible that it is <strong>not defined</strong>. -In such cases spawning takes place at <code class="docutils literal notranslate"><span class="pre">x</span> <span class="pre">=</span> <span class="pre">0</span></code> and <code class="docutils literal notranslate"><span class="pre">y</span> <span class="pre">=</span> <span class="pre">0</span></code>.</p></li> -<li><p>If there is no route defined in the Scenario, the Spawner will set a random route starting at the spawning position.</p></li> -<li><p>If there are multiple lanes at this position (this is only possible on junctions) it will take the lane with the lowest relative heading.</p></li> -</ul> -</div> +In order to do so, several spawners can be used.</p> <div class="section" id="prerunspawner"> <span id="components-prerunspawner"></span><h2>PreRunSpawner<a class="headerlink" href="#prerunspawner" title="Permalink to this headline">¶</a></h2> <p>The PreRunSpawner is responsible for populating the scenery/world with Common-Agents before the simulator starts. @@ -299,8 +286,33 @@ </div> <p>SStart, SEnd and SLength may be out of range for the road. In this case they are cropped such that the spawn range is maximum within the road’s bounds. -It is also possible to define the minimum gap in meters either as fixed parameter of type double or as stochastic distribution. -If it isn’t defined the default value of 5m is used.</p> +It is also possible to define the MinimumSeparationBuffer either as fixed parameter of type double or as stochastic distribution:</p> +<table class="tight-table docutils align-default"> +<colgroup> +<col style="width: 18%" /> +<col style="width: 31%" /> +<col style="width: 3%" /> +<col style="width: 6%" /> +<col style="width: 41%" /> +</colgroup> +<thead> +<tr class="row-odd"><th class="head"><p>Parameter</p></th> +<th class="head"><p>Type</p></th> +<th class="head"><p>Unit</p></th> +<th class="head"><p>optional</p></th> +<th class="head"><p>Description</p></th> +</tr> +</thead> +<tbody> +<tr class="row-even"><td><p>MinimumSeparationBuffer</p></td> +<td><p>Double (or any stochastic distribution)</p></td> +<td><p>m</p></td> +<td><p>yes</p></td> +<td><p>Required minimum distance on lane between two agents</p></td> +</tr> +</tbody> +</table> +<p>If the MinimumSeparationBuffer isn’t defined the default value of 5m is used.</p> <div class="highlight-xml notranslate"><div class="highlight"><pre><span></span><span class="nt"><Profile</span> <span class="na">Name=</span><span class="s">"DefaultPreRunCommon"</span><span class="nt">></span> <span class="nt"><List</span> <span class="na">Name=</span><span class="s">"SpawnZones"</span><span class="nt">></span> <span class="nt"><ListItem></span> @@ -320,6 +332,7 @@ <span class="nt"><Reference</span> <span class="na">Type=</span><span class="s">"TrafficGroup"</span> <span class="na">Name=</span><span class="s">"HeavyVehicles"</span><span class="nt">/></span> <span class="nt"></ListItem></span> <span class="nt"></List></span> + <span class="nt"><NormalDistribution</span> <span class="na">Key=</span><span class="s">"MinimumSeparationBuffer"</span> <span class="na">Mean=</span><span class="s">"3.47"</span> <span class="na">SD=</span><span class="s">"1.13"</span> <span class="na">Min=</span><span class="s">"2.0"</span> <span class="na">Max=</span><span class="s">"6.0"</span><span class="nt">/></span> <span class="nt"></Profile></span> </pre></div> </div> @@ -387,8 +400,8 @@ <span id="components-runtimespawner"></span><h2>RuntimeSpawner<a class="headerlink" href="#runtimespawner" title="Permalink to this headline">¶</a></h2> <p>The RuntimeSpawner (included in library “SpawnerRuntimeCommon_OSI”) is responsible for maintaining a populated scenery throughout the simulation runtime. It acts at each timestep throughout the simulation run and attempts to spawn Common Agents at the specified location(s). -The RuntimeSpawner needs a list of Spawners that define where it will spawn agents and a list of weighted <a class="reference internal" href="#components-trafficgroups"><span class="std std-ref">TrafficGroups</span></a> that defines the type and parameters of the spawned agents. -The Spawners have the following parameters:</p> +The RuntimeSpawner needs a list of SpawnZones that define where it will spawn agents and a list of weighted <a class="reference internal" href="#components-trafficgroups"><span class="std std-ref">TrafficGroups</span></a> that defines the type and parameters of the spawned agents. +The SpawnZones have the following parameters:</p> <table class="tight-table docutils align-default"> <colgroup> <col style="width: 11%" /> @@ -421,8 +434,33 @@ </tr> </tbody> </table> -<p>It is also possible to define the minimum gap in meters either as fixed parameter of type double or as stochastic distribution. -If it isn’t defined the default value of 5m is used.</p> +<p>It is also possible to define the MinimumSeparationBuffer either as fixed parameter of type double or as stochastic distribution:</p> +<table class="tight-table docutils align-default"> +<colgroup> +<col style="width: 18%" /> +<col style="width: 31%" /> +<col style="width: 3%" /> +<col style="width: 6%" /> +<col style="width: 41%" /> +</colgroup> +<thead> +<tr class="row-odd"><th class="head"><p>Parameter</p></th> +<th class="head"><p>Type</p></th> +<th class="head"><p>Unit</p></th> +<th class="head"><p>optional</p></th> +<th class="head"><p>Description</p></th> +</tr> +</thead> +<tbody> +<tr class="row-even"><td><p>MinimumSeparationBuffer</p></td> +<td><p>Double (or any stochastic distribution)</p></td> +<td><p>m</p></td> +<td><p>yes</p></td> +<td><p>Required minimum distance on lane between two agents</p></td> +</tr> +</tbody> +</table> +<p>If the MinimumSeparationBuffer isn’t defined the default value of 5m is used.</p> <div class="highlight-xml notranslate"><div class="highlight"><pre><span></span><span class="nt"><Profile</span> <span class="na">Name=</span><span class="s">"DefaultRuntimeCommon"</span><span class="nt">></span> <span class="nt"><List</span> <span class="na">Name=</span><span class="s">"SpawnPoints"</span><span class="nt">></span> <span class="nt"><ListItem></span> @@ -441,13 +479,14 @@ <span class="nt"><Reference</span> <span class="na">Type=</span><span class="s">"TrafficGroup"</span> <span class="na">Name=</span><span class="s">"HeavyVehicles"</span><span class="nt">/></span> <span class="nt"></ListItem></span> <span class="nt"></List></span> + <span class="nt"><NormalDistribution</span> <span class="na">Key=</span><span class="s">"MinimumSeparationBuffer"</span> <span class="na">Mean=</span><span class="s">"3.47"</span> <span class="na">SD=</span><span class="s">"1.13"</span> <span class="na">Min=</span><span class="s">"2.0"</span> <span class="na">Max=</span><span class="s">"6.0"</span><span class="nt">/></span> <span class="nt"></Profile></span> </pre></div> </div> <p>The RuntimeSpawner will spawn based on the following logic:</p> <ul class="simple"> <li><p>First the agentprofile needs to be determined. If the current spawn position evaluates to a right lane, the pool from which the agentprofile is drafted is extended by all traffic groups which contain the RightLaneOnly flag set to true.</p></li> -<li><p>Then the time gap between the new agent and the closest existing agent is sampled.</p></li> +<li><p>Then the gap between the spawn time of the new agent and the previously spawned agent is sampled.</p></li> <li><p>Afterwards the velocity of the new agent is being sampled under consideration of the homogeneity.</p></li> <li><p>A random route is sampled starting at the appropriate road</p></li> <li><p>Once the timely gap expires, the spawnpoint evaluate if the TTC (2s) conditions and a minimum required distance between agents (5m) are met. If the TTC is critical the spawn velocity is reduced to fullfill the TTC requriements. If the minimum distance is not fullfilled, the agent will be held back.</p></li> @@ -529,14 +568,14 @@ <footer> <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> <a href="vehicle.html" class="btn btn-neutral float-right" title="VehicleComponents" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a> - <a href="driver.html" class="btn btn-neutral float-left" title="Driver" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a> + <a href="dynamics_scenario.html" class="btn btn-neutral float-left" title="Dynamics_Scenario" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a> </div> <hr/> <div role="contentinfo"> <p> - © Copyright 2023 OpenPASS Working Group. + © Copyright 2023 openPASS Working Group. </p> </div>
diff --git a/content/html/user_guide/sim_user_guide/components/vehicle.html b/content/html/user_guide/sim_user_guide/components/vehicle.html index 7d76e21..fae2a62 100644 --- a/content/html/user_guide/sim_user_guide/components/vehicle.html +++ b/content/html/user_guide/sim_user_guide/components/vehicle.html
@@ -7,7 +7,7 @@ <meta name="viewport" content="width=device-width, initial-scale=1.0" /> - <title>VehicleComponents — OpenPASS Documentation</title> + <title>VehicleComponents — openPASS Documentation</title> @@ -70,7 +70,7 @@ <div class="version"> - "openPASS v0.11" + "develop_4d7f6d4f2e22c286789082dd8cbe3eb7f5b5af62" </div> @@ -100,7 +100,7 @@ <li class="toctree-l1"><a class="reference internal" href="../../../installation_guide/10_getting_started.html">Getting Started</a></li> <li class="toctree-l1"><a class="reference internal" href="../../../installation_guide/15_system_requirements.html">System Requirements</a></li> <li class="toctree-l1"><a class="reference internal" href="../../../installation_guide/20_install_prerequisites.html">Installing Prerequisites</a></li> -<li class="toctree-l1"><a class="reference internal" href="../../../installation_guide/30_install_openpass.html">Installing OpenPASS</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../../installation_guide/30_install_openpass.html">Installing openPASS</a></li> <li class="toctree-l1"><a class="reference internal" href="../../../installation_guide/50_further_guidance.html">Further Guidance</a></li> <li class="toctree-l1"><a class="reference internal" href="../../../installation_guide/60_conan.html">Building with Conan</a></li> </ul> @@ -108,14 +108,14 @@ <ul class="current"> <li class="toctree-l1"><a class="reference internal" href="../../10_overview.html">Overview</a></li> <li class="toctree-l1"><a class="reference internal" href="../../20_tutorials.html">Tutorials</a></li> -<li class="toctree-l1"><a class="reference internal" href="../../30_gui_plugins.html">GUI Plugins</a></li> -<li class="toctree-l1"><a class="reference internal" href="../../40_configs_in_depth.html">Configs in Depth</a></li> -<li class="toctree-l1"><a class="reference internal" href="../../50_outputs_in_depth.html">Outputs in Depth</a></li> -<li class="toctree-l1 current"><a class="reference internal" href="../../60_scenario_simulation.html">Simulator</a><ul class="current"> +<li class="toctree-l1"><a class="reference internal" href="../../30_configs_in_depth.html">Configs in Depth</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../40_outputs_in_depth.html">Outputs in Depth</a></li> +<li class="toctree-l1 current"><a class="reference internal" href="../../50_scenario_simulation.html">Simulator</a><ul class="current"> <li class="toctree-l2"><a class="reference internal" href="../10_overview.html">Overview</a></li> <li class="toctree-l2 current"><a class="reference internal" href="../20_components.html">Component View</a><ul class="current"> <li class="toctree-l3 current"><a class="reference internal" href="../20_components.html#components-in-depth">Components in Depth</a><ul class="current"> <li class="toctree-l4"><a class="reference internal" href="driver.html">Driver</a></li> +<li class="toctree-l4"><a class="reference internal" href="dynamics_scenario.html">Dynamics_Scenario</a></li> <li class="toctree-l4"><a class="reference internal" href="spawner.html">Spawner</a></li> <li class="toctree-l4 current"><a class="current reference internal" href="#">VehicleComponents</a></li> </ul> @@ -134,12 +134,14 @@ <ul> <li class="toctree-l1"><a class="reference internal" href="../../../developer_information/10_ide_support.html">IDE Support</a></li> <li class="toctree-l1"><a class="reference internal" href="../../../developer_information/20_documentation.html">Documentation Concept</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../../developer_information/30_coding_conventions.html">Coding Guidelines</a></li> </ul> <p class="caption"><span class="caption-text">Other Information</span></p> <ul> <li class="toctree-l1"><a class="reference internal" href="../../../other_information/10_external_dependencies.html">External Dependencies</a></li> <li class="toctree-l1"><a class="reference internal" href="../../../other_information/20_glossary.html">Glossary</a></li> -<li class="toctree-l1"><a class="reference internal" href="../../../other_information/30_license.html">License</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../../other_information/30_gui_plugins.html">GUI Plugins</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../../other_information/40_license.html">License</a></li> </ul> @@ -188,7 +190,7 @@ <li><a href="../../../index.html" class="icon icon-home"></a> »</li> - <li><a href="../../60_scenario_simulation.html">Simulator</a> »</li> + <li><a href="../../50_scenario_simulation.html">Simulator</a> »</li> <li><a href="../20_components.html">Component View</a> »</li> @@ -330,7 +332,7 @@ <p><strong>FMI variables</strong></p> <p>Communication with the FMU happens via FMI variables (inputs and outputs). The wrapper will read in available variables from <code class="docutils literal notranslate"><span class="pre">modelDescription.xml</span></code> in the FMU package. -These variables need to be mapped to variables and signals of OpenPASS in the VehicleComponentProfile.</p> +These variables need to be mapped to variables and signals of openPASS in the VehicleComponentProfile.</p> <p>FMI 1.0 supports these standard datatypes: - bool - integer @@ -341,7 +343,7 @@ <p>Configuration of a particular FMU takes place in <code class="docutils literal notranslate"><span class="pre">ProfilesCatalog.xml</span></code>. An example of a static system configuration can be found here “sim/contrib/examples/Configurations/StaticOSMPSensorDataToTrafficUpdateStepper”.</p> <p>The following parameters are always required for the FmuWrapper. Depending on the FmuHandler additional parameters may be needed.</p> -<table class="tight-table docutils align-default"> +<table class="tight-table docutils align-default" id="fmuwrapper-basic-configuration"> <colgroup> <col style="width: 12%" /> <col style="width: 4%" /> @@ -378,7 +380,6 @@ <span class="nt"><String</span> <span class="na">Key=</span><span class="s">"FmuPath"</span> <span class="na">Value=</span><span class="s">"OSMPSDToTUS.fmu"</span><span class="nt">/></span> <span class="nt"><Bool</span> <span class="na">Key=</span><span class="s">"Logging"</span> <span class="na">Value=</span><span class="s">"true"</span><span class="nt">/></span> <span class="nt"><Bool</span> <span class="na">Key=</span><span class="s">"CsvOutput"</span> <span class="na">Value=</span><span class="s">"false"</span><span class="nt">/></span> - <span class="nt"><Bool</span> <span class="na">Key=</span><span class="s">"UnzipOncePerInstance"</span> <span class="na">Value=</span><span class="s">"false"</span><span class="nt">/></span> <span class="nt"><String</span> <span class="na">Key=</span><span class="s">"Input_OSMPSensorDataIn"</span> <span class="na">Value=</span><span class="s">"SensorData"</span><span class="nt">/></span> <span class="nt"><String</span> <span class="na">Key=</span><span class="s">"Output_OSMPTrafficUpdateOut"</span> <span class="na">Value=</span><span class="s">"TrafficUpdate"</span><span class="nt">/></span> <span class="nt"><Bool</span> <span class="na">Key=</span><span class="s">"WriteJson_SensorData"</span> <span class="na">Value=</span><span class="s">"false"</span><span class="nt">/></span> @@ -396,18 +397,18 @@ This output can then be used for visualization in a spreadsheet application or it may be processed in any other way.</p> <p>Same goes for parameter <code class="docutils literal notranslate"><span class="pre">Logging</span></code> (having “log” as output file extension).</p> <p><strong>Primitive Datatypes</strong></p> -<p>The Fmu Handler allows to link Simulink models or any other FMU to <strong>openPASS</strong>. -It lets the user link any input variables of the FMU to values of the Agent in the simulation and any output values of the FMU to signals, that are forwarded to other components. -These mappings are defined with the following additional parameters, where the key describes the meaning in the simulation and the value is the variable in the modelDescription.xml:</p> +<p>The FMU Wrapper allows to link Simulink models or any other FMU to <strong>openPASS</strong>. +It lets the user link any input variables of the FMU to values of the Agent in the simulation and any output values of the FMU to signals, that are forwarded to other <strong>openPASS</strong> components. +These mappings are defined with the following optional parameters.</p> <div class="admonition note"> <p class="admonition-title">Note</p> -<p>Be careful with the size of integer data types when used in Matlab/Simulink. The FMU integer data type shall always be 32bit or higher for the ID.</p> +<p>Be careful with the size of integer data types when used in Matlab/Simulink. The FMU integer data type shall always be 32 bit or bigger, e.g. for IDs.</p> </div> <table class="tight-table docutils align-default"> <colgroup> -<col style="width: 17%" /> -<col style="width: 5%" /> -<col style="width: 78%" /> +<col style="width: 23%" /> +<col style="width: 4%" /> +<col style="width: 72%" /> </colgroup> <thead> <tr class="row-odd"><th class="head"><p>Key</p></th> @@ -418,25 +419,96 @@ <tbody> <tr class="row-even"><td><p>Parameter_<em>varName</em></p></td> <td><p>any</p></td> -<td><p>Mapping of a fixed value (bool, integer, double, string) to an FMU input. -<code class="docutils literal notranslate"><span class="pre">varName</span></code> references the FMU input defined in the modelDescription.xml.</p></td> +<td><p>Mapping of a fixed value (bool, integer, double, string) to an FMU input:</p> +<ul class="simple"> +<li><p><code class="docutils literal notranslate"><span class="pre">varName</span></code> references an FMI input variable.</p></li> +<li><p>The type of the parameter has to match the FMI variable type.</p></li> +</ul> +</td> </tr> -<tr class="row-odd"><td><p>Input_<em>varName</em></p></td> -<td><p>string</p></td> -<td><p>Mapping of a specific value of the simulation to an FMU input. -<code class="docutils literal notranslate"><span class="pre">varName</span></code> references the FMU input defined in the modelDescription.xml. -The value of this parameter has to be one of the types specified in the table below.</p></td> +<tr class="row-odd"><td><p>Parameter_AssignSpecial_<em>varName</em></p></td> +<td><p>any</p></td> +<td><p>Mapping of a specific value of the simulation to an FMU input, assigned only once at FMU initialization:</p> +<ul class="simple"> +<li><p><code class="docutils literal notranslate"><span class="pre">varName</span></code> references an FMI input variable.</p></li> +<li><p>The parameter is always of type string.</p></li> +<li><p>The value of this parameter has to be one of the types specified in the <a class="reference internal" href="#special-simulation-values">Special simulation values</a> table below, +which will also determine the required type of the FMI variable.</p></li> +</ul> +</td> </tr> -<tr class="row-even"><td><p>Output_<em>varName</em></p></td> +<tr class="row-even"><td><p>Input_<em>varName</em></p></td> <td><p>string</p></td> -<td><p>Mapping of a FMU output to a specific field in a specific signal. -<code class="docutils literal notranslate"><span class="pre">varName</span></code> references the FMU output defined in the modelDescription.xml. -The value of this parameter has to be one of the types specified in the signal table below.</p></td> +<td><p>Mapping of a specific value of the simulation to an FMU input:</p> +<ul class="simple"> +<li><p><code class="docutils literal notranslate"><span class="pre">varName</span></code> references an FMI input variable.</p></li> +<li><p>The value of this parameter has to be one of the types specified in the <a class="reference internal" href="#input-simulation-values">Input simulation values</a> table below.</p></li> +</ul> +</td> +</tr> +<tr class="row-odd"><td><p>Output_<em>varName</em></p></td> +<td><p>string</p></td> +<td><p>Mapping of a FMU output to a specific field in a specific signal:</p> +<ul class="simple"> +<li><p><code class="docutils literal notranslate"><span class="pre">varName</span></code> references an FMI output variable.</p></li> +<li><p>The value of this parameter has to be one of the types specified in the <a class="reference internal" href="#output-simulation-signals">Output simulation signals</a> table below.</p></li> +</ul> +</td> +</tr> +</tbody> +</table> +<p>The allowed special simulation values are as follows:</p> +<table class="tight-table docutils align-default" id="special-simulation-values"> +<colgroup> +<col style="width: 26%" /> +<col style="width: 11%" /> +<col style="width: 62%" /> +</colgroup> +<thead> +<tr class="row-odd"><th class="head"><p>Type</p></th> +<th class="head"><p>FMU Variable Type</p></th> +<th class="head"><p>Calculation</p></th> +</tr> +</thead> +<tbody> +<tr class="row-even"><td><p>RandomSeed</p></td> +<td><p>Integer</p></td> +<td><p>The random seed of the current simulation run.</p></td> +</tr> +<tr class="row-odd"><td><p>OutputPath</p></td> +<td><p>String</p></td> +<td><p>An output path unique to this FmuWrapper instance. +The path will always refer to a directory below the simulator’s current result folder. +This directory is not necessarily created by the FmuWrapper, depending on the setting of +<cite>CsvOutput</cite> and <cite>Logging</cite> parameters (see <a class="reference internal" href="#fmuwrapper-basic-configuration">FmuWrapper basic configuration</a>).</p></td> +</tr> +<tr class="row-even"><td><p>MaxSteering</p></td> +<td><p>Real</p></td> +<td><p>The <cite>max_steering</cite> property of an agent’s front axle as defined in OpenSCENARIO (catalog).</p></td> +</tr> +<tr class="row-odd"><td><p>SteeringRatio</p></td> +<td><p>Real</p></td> +<td><p>The steering ratio of the vehicle model. +Has to be defined in the properties of the Entity in the OpenSCENARIO catalog with the name +<code class="docutils literal notranslate"><span class="pre">SteeringRatio</span></code> and the value has to be a valid floating point expression.</p></td> +</tr> +<tr class="row-even"><td><p>NumberOfGears</p></td> +<td><p>Integer</p></td> +<td><p>The number of gears of the vehicle model. +Has to be defined in the properties of the Entity in the OpenSCENARIO catalog with the name +<code class="docutils literal notranslate"><span class="pre">NumberOfGears</span></code> and the value has to be a valid integer.</p></td> +</tr> +<tr class="row-odd"><td><p>GearRatio<em>N</em></p></td> +<td><p>Real</p></td> +<td><p>The ratio of the Nth gear. +Has to be defined in the properties of the Entity in the OpenSCENARIO catalog with the name +<code class="docutils literal notranslate"><span class="pre">GearRatioN</span></code> and the value has to be a valid floating point expression. +<em>N</em> is allowed to be in the range 1-9.</p></td> </tr> </tbody> </table> <p>The allowed inputs (simulation values) are as follows:</p> -<table class="tight-table docutils align-default"> +<table class="tight-table docutils align-default" id="input-simulation-values"> <colgroup> <col style="width: 26%" /> <col style="width: 11%" /> @@ -491,7 +563,7 @@ </tr> <tr class="row-even"><td><p>LaneEgo</p></td> <td><p>Integer</p></td> -<td><p>Lane id of the MainLocatePoint on the route (0, if off route)</p></td> +<td><p>Lane id of the front center on the route (0, if off route)</p></td> </tr> <tr class="row-odd"><td><p>PositionSEgo</p></td> <td><p>Real</p></td> @@ -575,26 +647,32 @@ </tr> <tr class="row-odd"><td><p>LaneCountLeft</p></td> <td><p>Integer</p></td> -<td><p>Number of lanes to the left of MainLocatePoint of type Driving, Exit, Entry, OnRamp or OffRamp</p></td> +<td><p>Number of lanes to the left of front center of type Driving, Exit, Entry, OnRamp or OffRamp</p></td> </tr> <tr class="row-even"><td><p>LaneCountRight</p></td> <td><p>Integer</p></td> -<td><p>Number of lanes to the right of MainLocatePoint of type Driving, Exit, Entry, OnRamp or OffRamp</p></td> +<td><p>Number of lanes to the right of front center of type Driving, Exit, Entry, OnRamp or OffRamp</p></td> </tr> <tr class="row-odd"><td><p>SpeedLimit_<em>X</em></p></td> <td><p>Real</p></td> -<td><p>Speed limit in effect in distance <em>X</em> meters from MainLocatePoint (999, if no speed limit)</p></td> +<td><p>Speed limit in effect in distance <em>X</em> meters from front center (999, if no speed limit)</p></td> </tr> <tr class="row-even"><td><p>RoadCurvature_<em>X</em></p></td> <td><p>Real</p></td> -<td><p>Road curvature in distance <em>X</em> meters from MainLocatePoint</p></td> +<td><p>Road curvature in distance <em>X</em> meters from front center</p></td> </tr> </tbody> </table> +<ul class="simple"> +<li><p><strong>reference point</strong>: Center of the rear axle</p></li> +<li><p><strong>front center</strong>: Center of the front of the bounding box of the object</p></li> +</ul> <p>If the FmuWrapper is linked to at least one sensor with InputId “Camera”, the following additional inputs are available. The objects seen by this sensor(s) are sorted by distance from the agent and accessed by indices starting from 0. For each object the values listed in the following table are available where <em>X</em> is the index of the object (between 0 and 9). -If there are less objects than <em>X</em>, a default value is set (-1 for the Id, 0 for the other values).</p> +If there are less objects than <em>X</em>, a default value is set (-1 for the Id, 0 for the other values). +Only the list of objects is taken from the sensor. +The values are then calculated by the FmuWrapper (not from the SensorData).</p> <table class="tight-table docutils align-default"> <colgroup> <col style="width: 27%" /> @@ -626,7 +704,15 @@ </tr> <tr class="row-even"><td><p>SensorFusionRelativeT_<em>X</em></p></td> <td><p>Real</p></td> -<td><p>Lateral obstruction for MainLocatePoint (NaN, if object not on route) (see <a class="reference internal" href="../../../advanced_topics/simulator/world_osi.html#world-getobstruction"><span class="std std-ref">GetObstruction</span></a>)</p></td> +<td><p>Lateral obstruction for front center (NaN, if object not on route) (see <a class="reference internal" href="../../../advanced_topics/simulator/world_osi.html#world-getobstruction"><span class="std std-ref">GetObstruction</span></a>)</p></td> +</tr> +<tr class="row-odd"><td><p>SensorFusionRelativeX_<em>X</em></p></td> +<td><p>Real</p></td> +<td><p>Relative distance between reference points in x in world coordinates</p></td> +</tr> +<tr class="row-even"><td><p>SensorFusionRelativeY_<em>X</em></p></td> +<td><p>Real</p></td> +<td><p>Relative distance between reference points in y in world coordinates</p></td> </tr> <tr class="row-odd"><td><p>SensorFusionRelativeNetLeft_<em>X</em></p></td> <td><p>Real</p></td> @@ -638,15 +724,15 @@ </tr> <tr class="row-odd"><td><p>SensorFusionRelativeNetX_<em>X</em></p></td> <td><p>Real</p></td> -<td><p>Net distance between bounding boxes in x</p></td> +<td><p>Net distance between bounding boxes in x in world coordinates</p></td> </tr> <tr class="row-even"><td><p>SensorFusionRelativeNetY_<em>X</em></p></td> <td><p>Real</p></td> -<td><p>Net distance between bounding boxes in y</p></td> +<td><p>Net distance between bounding boxes in y in world coordinates</p></td> </tr> <tr class="row-odd"><td><p>SensorFusionLane_<em>X</em></p></td> <td><p>Integer</p></td> -<td><p>Lane of MainLocatePoint</p></td> +<td><p>Lane of front center</p></td> </tr> <tr class="row-even"><td><p>SensorFusionVelocity_<em>X</em></p></td> <td><p>Real</p></td> @@ -654,15 +740,15 @@ </tr> <tr class="row-odd"><td><p>SensorFusionVelocityX_<em>X</em></p></td> <td><p>Real</p></td> -<td><p>Velocity in x at reference point</p></td> +<td><p>Velocity in x at reference point in world coordinates</p></td> </tr> <tr class="row-even"><td><p>SensorFusionVelocityY_<em>X</em></p></td> <td><p>Real</p></td> -<td><p>Velocity in y at reference point</p></td> +<td><p>Velocity in y at reference point in world coordinates</p></td> </tr> <tr class="row-odd"><td><p>SensorFusionYaw_<em>X</em></p></td> <td><p>Real</p></td> -<td><p>Yaw</p></td> +<td><p>Yaw in world coordinates</p></td> </tr> </tbody> </table> @@ -670,7 +756,7 @@ AccelerationSignal, LongitudinalSignal, SteeringSignal and DynamicsSignal</p> <p>The name of the signal field has to be specified after the signal name. This means the output type is one of the following:</p> -<table class="tight-table docutils align-default"> +<table class="tight-table docutils align-default" id="output-simulation-signals"> <colgroup> <col style="width: 39%" /> <col style="width: 19%" /> @@ -803,7 +889,7 @@ </tr> <tr class="row-even"><td><p>Output_<em>var_name</em></p></td> <td><p>string</p></td> -<td><p><em>var_name</em> references an FMU variable (as defined in FMU’s modelDescription.xml) from which a specific OSI message is received Allowed values: <cite>SensorViewConfigRequest</cite>, <cite>SensorData</cite>, <cite>TrafficUpdate</cite>, <code class="docutils literal notranslate"><span class="pre">MotionCommand</span></code></p></td> +<td><p><em>var_name</em> references an FMU variable (as defined in FMU’s modelDescription.xml) from which a specific OSI message is received Allowed values: <cite>SensorViewConfigRequest</cite>, <cite>SensorData</cite>, <cite>TrafficUpdate</cite></p></td> </tr> <tr class="row-odd"><td><p>Parameter_<em>var_name</em></p></td> <td><p>any</p></td> @@ -834,10 +920,8 @@ <li><p>SensorView: SensorView generated from the GroundTruth with this agent is host vehicle.</p></li> <li><p>SensorViewConfig, SensorViewConfigRequest: Configuration of a sensor according to OSMP.</p></li> <li><p>TrafficCommand: Trajectory from openSCENARIO, that will be converted into a TrafficCommand.</p></li> -<li><p>VehicleCommunicationData: Contains host vehicle location data</p></li> <li><p>SensorData: Output of a sensor. Can be input and/or output of an FMU. Received SensorData is forwarded to other components as SensorDataSignal.</p></li> <li><p>TrafficUpdate: Will be converted to a DynamicsSignal.</p></li> -<li><p>MotionCommand: Will be converted to a DynamicsSignal. Has priority over TrafficUpdate.</p></li> <li><p>GroundTruth: Will be used as groundtruth information for everything that exists in the simulation world.</p></li> </ul> <p><strong>FmuVariables</strong></p> @@ -978,7 +1062,17 @@ <tr class="row-odd"><td><p>Latency</p></td> <td><p>Double</p></td> <td><p>s</p></td> -<td><p>Sensor latency</p></td> +<td><p>Delay the sensor output</p></td> +</tr> +<tr class="row-even"><td><p>DetectionDelayTime</p></td> +<td><p>Double</p></td> +<td><p>s</p></td> +<td><p>Time an object needs to be in detection range before it is detected (optional)</p></td> +</tr> +<tr class="row-odd"><td><p>MaxDropOutTime</p></td> +<td><p>Double</p></td> +<td><p>s</p></td> +<td><p>Time after which delay for undetected object starts anew (optional)</p></td> </tr> <tr class="row-even"><td><p>OpeningAngleH</p></td> <td><p>Double</p></td> @@ -1000,6 +1094,8 @@ <span class="nt"><NormalDistribution</span> <span class="na">Key=</span><span class="s">"Latency"</span> <span class="na">Max=</span><span class="s">"0.0"</span> <span class="na">Mean=</span><span class="s">"0.0"</span> <span class="na">Min=</span><span class="s">"0.0"</span> <span class="na">SD=</span><span class="s">"0.0"</span><span class="nt">/></span> <span class="nt"><Double</span> <span class="na">Key=</span><span class="s">"OpeningAngleH"</span> <span class="na">Value=</span><span class="s">"0.35"</span><span class="nt">/></span> <span class="nt"><Double</span> <span class="na">Key=</span><span class="s">"RequiredPercentageOfVisibleArea"</span> <span class="na">Value=</span><span class="s">"0.001"</span><span class="nt">/></span> + <span class="nt"><Double</span> <span class="na">Key=</span><span class="s">"DetectionDelayTime"</span> <span class="na">Value=</span><span class="s">"0"</span><span class="nt">/></span> + <span class="nt"><Double</span> <span class="na">Key=</span><span class="s">"MaxDropOutTime"</span> <span class="na">Value=</span><span class="s">"0"</span><span class="nt">/></span> <span class="nt"></Profile></span> <span class="nt"></ProfileGroup></span> </pre></div> @@ -1031,7 +1127,7 @@ <tr class="row-even"><td><p>FailureProbability</p></td> <td><p>Double</p></td> <td></td> -<td><p>Probability object is not detected although it is visible (mandatory, but currently unused)</p></td> +<td><p>Probability object is not detected although it is visible</p></td> </tr> <tr class="row-odd"><td><p>Latency</p></td> <td><p>Double</p></td> @@ -1084,6 +1180,415 @@ See also <a class="reference internal" href="../../configs/profilescatalog.html#profilescatalog-vehicleprofiles"><span class="std std-ref">VehicleProfiles</span></a>.</p> </div> </div> +<div class="section" id="vehicledynamics"> +<h2>VehicleDynamics<a class="headerlink" href="#vehicledynamics" title="Permalink to this headline">¶</a></h2> +<p>Components of this group can be used to model the vehicle dynamics. The vehicle dynamics model has a modular design. If necessary, the individual components can be replaced by the user with their own models. The vehicle dynamics model consists of six components listed below:</p> +<table class="tight-table docutils align-default"> +<colgroup> +<col style="width: 16%" /> +<col style="width: 84%" /> +</colgroup> +<thead> +<tr class="row-odd"><th class="head"><p>Component</p></th> +<th class="head"><p>Short Description</p></th> +</tr> +</thead> +<tbody> +<tr class="row-even"><td><p><a class="reference internal" href="#components-steeringsystem"><span class="std std-ref">ActionSteeringSystem</span></a></p></td> +<td><p>The steering model transfers the driver’s input into the vehicle’s wheel angle</p></td> +</tr> +<tr class="row-odd"><td><p><a class="reference internal" href="#components-powertrain"><span class="std std-ref">ActionPowertrain</span></a></p></td> +<td><p>The powertrain model converts the accelerator pedal position into wheel drive torques, under consideration of the selected gear</p></td> +</tr> +<tr class="row-even"><td><p><a class="reference internal" href="#components-brakesystem"><span class="std std-ref">ActionBrakeSystem</span></a></p></td> +<td><p>The brake model converts the brake pedal position into wheel brake torques</p></td> +</tr> +<tr class="row-odd"><td><p><a class="reference internal" href="#components-tiremodel"><span class="std std-ref">DynamicsTireModel</span></a></p></td> +<td><p>The tire model converts the predetermined drive and braking torques of the tires into tire longitudinal and lateral forces, under consideration of the wheel angles</p></td> +</tr> +<tr class="row-even"><td><p><a class="reference internal" href="#components-motionmodel"><span class="std std-ref">DynamicsMotionModel</span></a></p></td> +<td><p>The motion model calculates the translational and rotational vehicle movement with the calculated tire forces</p></td> +</tr> +<tr class="row-odd"><td><p><a class="reference internal" href="#components-chassismodel"><span class="std std-ref">DynamicsChassis</span></a></p></td> +<td><p>The chassis model determines the dynamic wheel loads via the vehicle’s longitudinal and lateral acceleration</p></td> +</tr> +</tbody> +</table> +<p>The following figure gives an overview of the driving dynamics components and their signals:</p> +<img alt="|op| Vehicle dynamics overview" src="../../../_images/VehicleDynamicsOverview.svg" /><div class="section" id="actionsteeringsystem"> +<span id="components-steeringsystem"></span><h3>ActionSteeringSystem<a class="headerlink" href="#actionsteeringsystem" title="Permalink to this headline">¶</a></h3> +<p>The steering model obtains the “SteeringRatio” property from the <a class="reference internal" href="../../configs/scenario.html#scenario-vehiclemodels"><span class="std std-ref">VehicleCatalog</span></a> and uses it to calculate the steering angle of the front wheels. +Both wheels are turned at the same angle. Steering elasticities are currently not taken into account. The following parameter can be used to set a static toe:</p> +<table class="tight-table docutils align-default"> +<colgroup> +<col style="width: 6%" /> +<col style="width: 8%" /> +<col style="width: 3%" /> +<col style="width: 83%" /> +</colgroup> +<thead> +<tr class="row-odd"><th class="head"><p>Attribute</p></th> +<th class="head"><p>Type</p></th> +<th class="head"><p>Unit</p></th> +<th class="head"><p>Description</p></th> +</tr> +</thead> +<tbody> +<tr class="row-even"><td><p>StaticToe</p></td> +<td><p>VectorDouble</p></td> +<td><p>rad</p></td> +<td><p>Static toe of the wheels (A positive value corresponds to a toe-in; wheels are indexed from the front left in the vector)</p></td> +</tr> +</tbody> +</table> +</div> +<div class="section" id="actionpowertrain"> +<span id="components-powertrain"></span><h3>ActionPowertrain<a class="headerlink" href="#actionpowertrain" title="Permalink to this headline">¶</a></h3> +<p>The powertrain model contains an engine model and a gear model. The type of the powertrain can be set using the following parameters:</p> +<table class="tight-table docutils align-default"> +<colgroup> +<col style="width: 9%" /> +<col style="width: 4%" /> +<col style="width: 3%" /> +<col style="width: 84%" /> +</colgroup> +<thead> +<tr class="row-odd"><th class="head"><p>Attribute</p></th> +<th class="head"><p>Type</p></th> +<th class="head"><p>Unit</p></th> +<th class="head"><p>Description</p></th> +</tr> +</thead> +<tbody> +<tr class="row-even"><td><p>TypeDrivetrain</p></td> +<td><p>String</p></td> +<td><ul class="simple"> +<li></li> +</ul> +</td> +<td><p>Type of drivetrain; A selection can be made between front-wheel drive (FWD), rear-wheel drive (RWD) and all-wheel drive (AWD)</p></td> +</tr> +<tr class="row-odd"><td><p>FrontRatioAWD</p></td> +<td><p>Double</p></td> +<td><ul class="simple"> +<li></li> +</ul> +</td> +<td><p>Distribution of the drive torque to the front axle in the case of all-wheel drive (AWD); Range 0-1</p></td> +</tr> +</tbody> +</table> +<p>The wheel speed is converted into an engine speed [Hz] according to the axle ratio and the transmission ratio of the selected gear. +The axle ratio and gear ratios are obtained from the <a class="reference internal" href="../../configs/scenario.html#scenario-vehiclemodels"><span class="std std-ref">VehicleCatalog</span></a> (“AxleRatio” & “GearRatio”). The average value of the powered wheels is used for the determination of the engine speed.</p> +<div class="math"> +<p><img src="../../../_images/math/340d7e571b3feafaa7e510b6c7d1328b1f4c64ad.png" alt="\omega_{engine} = \omega_{wheels,avg} \cdot i_{axle} \cdot i_{gear,selected}"/></p> +</div><p>The maximum possible engine torque [Nm] is limited by the engine power [W] or the maximum engine torque [Nm]. +The engine power and the maximum engine torque are obtained from the <a class="reference internal" href="../../configs/scenario.html#scenario-vehiclemodels"><span class="std std-ref">VehicleCatalog</span></a> (“MaximumEnginePower” & “MaximumEngineTorque”).</p> +<div class="math"> +<p><img src="../../../_images/math/bb9c6cf90a7cce5208d424db5de2b83f0ef1fddb.png" alt="M_{engine,max,current} = \begin{cases} + \frac{P_{engine,max}}{\omega_{engine}} & \text{ if } \frac{P_{engine,max}}{\omega_{engine}} < M_{engine,max} \\ + M_{engine,max} & \text{ if } \frac{P_{engine,max}}{\omega_{engine}} >= M_{engine,max} + \end{cases}"/></p> +</div><p>When 98% of the maximum speed of the motor is reached (“MaximumEngineSpeed” in the <a class="reference internal" href="../../configs/scenario.html#scenario-vehiclemodels"><span class="std std-ref">VehicleCatalog</span></a>), the engine torque is linearly reduced to 0.</p> +<p>The maximum engine torque is scaled via the accelerator pedal position (input). This value is calculated back to the total wheel drive torque via the gear ratio.</p> +<div class="math"> +<p><img src="../../../_images/math/1f81befb8ab4e6d3af9e6e11361477a156ea9836.png" alt="M_{wheels,current} = M_{engine,max,current} \cdot position_{accelerator pedal} \cdot i_{axle} \cdot i_{gear,selected}"/></p> +</div><p>The wheel total drive torque is evenly distributed to the wheels of an axle according to the definition of the drive type. +With all-wheel drive, the entire wheel drive torque is distributed statically over the defined ratio.</p> +</div> +<div class="section" id="actionbrakesystem"> +<span id="components-brakesystem"></span><h3>ActionBrakeSystem<a class="headerlink" href="#actionbrakesystem" title="Permalink to this headline">¶</a></h3> +<p>The brake model is a linearized model. The brake pedal position is used as input. As output, the model returns the braking torques of the wheels as a vector. +The model considers a response time [ms] and linear factors [m/s³] for the increase and decrease of the braking force.The distribution of braking force between the front and rear axles can be defined statically.</p> +<table class="tight-table docutils align-default"> +<colgroup> +<col style="width: 19%" /> +<col style="width: 4%" /> +<col style="width: 3%" /> +<col style="width: 74%" /> +</colgroup> +<thead> +<tr class="row-odd"><th class="head"><p>Attribute</p></th> +<th class="head"><p>Type</p></th> +<th class="head"><p>Unit</p></th> +<th class="head"><p>Description</p></th> +</tr> +</thead> +<tbody> +<tr class="row-even"><td><p>FrontAxlePercentage</p></td> +<td><p>Double</p></td> +<td><ul class="simple"> +<li></li> +</ul> +</td> +<td><p>Distribution of the brake torque to the front axle in the case of all-wheel drive (AWD); Range 0-1</p></td> +</tr> +<tr class="row-odd"><td><p>BrakeDecelerationInclineRate</p></td> +<td><p>Double</p></td> +<td><p>m/s³</p></td> +<td><p>Linear Rate of braking force increase</p></td> +</tr> +<tr class="row-even"><td><p>BrakeDecelerationDeclineRate</p></td> +<td><p>Double</p></td> +<td><p>m/s³</p></td> +<td><p>Linear Rate of braking force decrease</p></td> +</tr> +<tr class="row-odd"><td><p>BrakeResponseTimeMs</p></td> +<td><p>Double</p></td> +<td><p>ms</p></td> +<td><p>Brake response time</p></td> +</tr> +</tbody> +</table> +<p>The maximum braking force of the system is determined from the maximum possible deceleration and the mass of the vehicle and is scaled by the brake pedal position (Input). +The maximum possible deceleration and the vehicle mass are obtained from the <a class="reference internal" href="../../configs/scenario.html#scenario-vehiclemodels"><span class="std std-ref">VehicleCatalog</span></a> (“maxDeceleration” & “mass”).</p> +<div class="math"> +<p><img src="../../../_images/math/bc08e6aac48aefa03313665a4a532f6a9c5ecd63.png" alt="F_{brake,max} = a_{deceleration,max} \cdot m_{vehicle} \cdot position_{brake pedal}"/></p> +</div><p>When the brake is applied, a deceleration is calculated after the response time has elapsed. Then the braking force is built up linearly until the maximum or requested braking force has been reached.</p> +<div class="math"> +<p><img src="../../../_images/math/f1aece6474c2a5f6a6db0e37b59055fb90810d92.png" alt="F_{brake,current} = rate_{incline} \cdot (t_{brake} - t_{response})"/></p> +</div><p>When the brake is released, the braking force is dissipated with the decline rate until it has dropped to zero. After that, the response time builds up again. +The braking force is divided among the axles according to the parameter “FrontAxlePercentage”. Another input allows you to request a prefill that reduces the response time without braking</p> +</div> +<div class="section" id="dynamicschassis"> +<span id="components-chassismodel"></span><h3>DynamicsChassis<a class="headerlink" href="#dynamicschassis" title="Permalink to this headline">¶</a></h3> +<p>The chassis model determines the vertical forces of the four wheels from the longitudinal and lateral acceleration of the vehicle. Constant spring and damper rates are taken into account, which can be defined by the following parameters per axis:</p> +<table class="tight-table docutils align-default"> +<colgroup> +<col style="width: 18%" /> +<col style="width: 8%" /> +<col style="width: 3%" /> +<col style="width: 71%" /> +</colgroup> +<thead> +<tr class="row-odd"><th class="head"><p>Attribute</p></th> +<th class="head"><p>Type</p></th> +<th class="head"><p>Unit</p></th> +<th class="head"><p>Description</p></th> +</tr> +</thead> +<tbody> +<tr class="row-even"><td><p>SpringCoefficient</p></td> +<td><p>VectorDouble</p></td> +<td><p>N/m</p></td> +<td><p>Constant spring coefficient for each axis</p></td> +</tr> +<tr class="row-odd"><td><p>DamperCoefficient</p></td> +<td><p>VectorDouble</p></td> +<td><p>Ns/m</p></td> +<td><p>Constant damper coefficient for each axis</p></td> +</tr> +</tbody> +</table> +</div> +<div class="section" id="dynamicstiremodel"> +<span id="components-tiremodel"></span><h3>DynamicsTireModel<a class="headerlink" href="#dynamicstiremodel" title="Permalink to this headline">¶</a></h3> +<p>The tire model is freely configurable and includes a degressive behaviour. The tire forces are modeled according to Rill using the TMEasy model. The following parameters can be set for the tire model per axis :</p> +<table class="tight-table docutils align-default"> +<colgroup> +<col style="width: 14%" /> +<col style="width: 8%" /> +<col style="width: 3%" /> +<col style="width: 75%" /> +</colgroup> +<thead> +<tr class="row-odd"><th class="head"><p>Attribute</p></th> +<th class="head"><p>Type</p></th> +<th class="head"><p>Unit</p></th> +<th class="head"><p>Description</p></th> +</tr> +</thead> +<tbody> +<tr class="row-even"><td><p>MuTireMaxXFRef</p></td> +<td><p>VectorDouble</p></td> +<td><ul class="simple"> +<li></li> +</ul> +</td> +<td><p>Normalized scaling factor for maximum longitudinal force at reference vertical force</p></td> +</tr> +<tr class="row-odd"><td><p>MuTireMaxX2FRef</p></td> +<td><p>VectorDouble</p></td> +<td><ul class="simple"> +<li></li> +</ul> +</td> +<td><p>Normalized scaling factor for maximum longitudinal force at double reference vertical force</p></td> +</tr> +<tr class="row-even"><td><p>MuTireSlideXFRef</p></td> +<td><p>VectorDouble</p></td> +<td><ul class="simple"> +<li></li> +</ul> +</td> +<td><p>Normalized scaling factor for sliding longitudinal force at reference vertical force</p></td> +</tr> +<tr class="row-odd"><td><p>MuTireSlideX2FRef</p></td> +<td><p>VectorDouble</p></td> +<td><ul class="simple"> +<li></li> +</ul> +</td> +<td><p>Normalized scaling factor for sliding longitudinal force at double reference vertical force</p></td> +</tr> +<tr class="row-even"><td><p>SlipTireMaxXFRef</p></td> +<td><p>VectorDouble</p></td> +<td><ul class="simple"> +<li></li> +</ul> +</td> +<td><p>Longitudinal slip at maximum longitudinal force at reference vertical force</p></td> +</tr> +<tr class="row-odd"><td><p>SlipTireMaxX2FRef</p></td> +<td><p>VectorDouble</p></td> +<td><ul class="simple"> +<li></li> +</ul> +</td> +<td><p>Longitudinal slip at maximum longitudinal force at double reference vertical force</p></td> +</tr> +<tr class="row-even"><td><p>SlipTireSlideXFRef</p></td> +<td><p>VectorDouble</p></td> +<td><ul class="simple"> +<li></li> +</ul> +</td> +<td><p>Longitudinal slip at sliding longitudinal force at reference vertical force</p></td> +</tr> +<tr class="row-odd"><td><p>SlipTireSlideX2FRef</p></td> +<td><p>VectorDouble</p></td> +<td><ul class="simple"> +<li></li> +</ul> +</td> +<td><p>Longitudinal slip at sliding longitudinal force at double reference vertical force</p></td> +</tr> +<tr class="row-even"><td><p>F0pXFRef</p></td> +<td><p>VectorDouble</p></td> +<td><p>N</p></td> +<td><p>Initial slope of longitudinal force at reference force</p></td> +</tr> +<tr class="row-odd"><td><p>F0pX2FRef</p></td> +<td><p>VectorDouble</p></td> +<td><p>N</p></td> +<td><p>Initial slope of longitudinal force at double reference force</p></td> +</tr> +<tr class="row-even"><td><p>MuTireMaxYFRef</p></td> +<td><p>VectorDouble</p></td> +<td><ul class="simple"> +<li></li> +</ul> +</td> +<td><p>Normalized scaling factor for maximum lateral force at reference vertical force</p></td> +</tr> +<tr class="row-odd"><td><p>MuTireMaxY2FRef</p></td> +<td><p>VectorDouble</p></td> +<td><ul class="simple"> +<li></li> +</ul> +</td> +<td><p>Normalized scaling factor for maximum lateral force at double reference vertical force</p></td> +</tr> +<tr class="row-even"><td><p>MuTireSlideYFRef</p></td> +<td><p>VectorDouble</p></td> +<td><ul class="simple"> +<li></li> +</ul> +</td> +<td><p>Normalized scaling factor for sliding lateral force at reference vertical force</p></td> +</tr> +<tr class="row-odd"><td><p>MuTireSlideY2FRef</p></td> +<td><p>VectorDouble</p></td> +<td><ul class="simple"> +<li></li> +</ul> +</td> +<td><p>Normalized scaling factor for sliding lateral force at double reference vertical force</p></td> +</tr> +<tr class="row-even"><td><p>SlipTireMaxYFRef</p></td> +<td><p>VectorDouble</p></td> +<td><ul class="simple"> +<li></li> +</ul> +</td> +<td><p>Lateral slip at maximum lateral force at reference vertical force</p></td> +</tr> +<tr class="row-odd"><td><p>SlipTireMaxY2FRef</p></td> +<td><p>VectorDouble</p></td> +<td><ul class="simple"> +<li></li> +</ul> +</td> +<td><p>Lateral slip at maximum lateral force at double reference vertical force</p></td> +</tr> +<tr class="row-even"><td><p>SlipTireSlideYFRef</p></td> +<td><p>VectorDouble</p></td> +<td><ul class="simple"> +<li></li> +</ul> +</td> +<td><p>Lateral slip at sliding lateral force at reference vertical force</p></td> +</tr> +<tr class="row-odd"><td><p>SlipTireSlideY2FRef</p></td> +<td><p>VectorDouble</p></td> +<td><ul class="simple"> +<li></li> +</ul> +</td> +<td><p>Lateral slip at sliding lateral force at double reference vertical force</p></td> +</tr> +<tr class="row-even"><td><p>F0pYFRef</p></td> +<td><p>VectorDouble</p></td> +<td><p>N</p></td> +<td><p>Initial slope of lateral force at reference force</p></td> +</tr> +<tr class="row-odd"><td><p>F0pY2FRef</p></td> +<td><p>VectorDouble</p></td> +<td><p>N</p></td> +<td><p>Initial slope of lateral force at double reference force</p></td> +</tr> +<tr class="row-even"><td><p>FRef</p></td> +<td><p>VectorDouble</p></td> +<td><p>N</p></td> +<td><p>Vertical reference force for the tire parameters</p></td> +</tr> +<tr class="row-odd"><td><p>FRefNormalized</p></td> +<td><p>VectorBool</p></td> +<td><ul class="simple"> +<li></li> +</ul> +</td> +<td><p>Should the reference force be scaled with the static vertical tire force?</p></td> +</tr> +<tr class="row-even"><td><p>Inertia</p></td> +<td><p>VectorDouble</p></td> +<td><p>kgm²</p></td> +<td><p>Inertia of tire</p></td> +</tr> +<tr class="row-odd"><td><p>PneumaticTrail</p></td> +<td><p>VectorDouble</p></td> +<td><p>m</p></td> +<td><p>Pneumatic trail of tire</p></td> +</tr> +</tbody> +</table> +<p>The normalized factors refer to the reference vertical force or to the double reference vertical force +The input variables used by the model are tire drive and braking torques as well as the wheel angles and vertical wheel forces. All data is provided as vectors. +The model determines tire forces in the longitudinal and lateral directions as well as the wheel self aligning torques. The wheel self aligning torque is formed from the product of the tire side force and the pneumatic trail. +A linear interpolation is performed between the values for the reference force and the double reference force. If no degressive tire behavior is desired, the parameters for the double reference force must be set identically to the values for the reference force.</p> +<p>All forces are scaled with the coefficient of friction from the <a class="reference internal" href="../../configs/scenario.html#scenario-vehiclemodels"><span class="std std-ref">VehicleCatalog</span></a> (“FrictionCoefficient”).</p> +<p>All further information about the model can be found in the following sources:</p> +<p><a class="reference external" href="https://www.tmeasy.de/">https://www.tmeasy.de/</a></p> +<p>Rill, Georg. (2013). TMeasy – A Handling Tire Model based on a three-dimensional slip approach.</p> +</div> +<div class="section" id="dynamicsmotionmodel"> +<span id="components-motionmodel"></span><h3>DynamicsMotionModel<a class="headerlink" href="#dynamicsmotionmodel" title="Permalink to this headline">¶</a></h3> +<p>The motion model converts the tire forces (input) into a translational and rotational movement of the vehicle. The air resistance of the vehicle is taken into account. For the dynamic calculation, the center of gravity position is taken from the <a class="reference internal" href="../../configs/scenario.html#scenario-vehiclemodels"><span class="std std-ref">VehicleCatalog</span></a> (“XPositionCOG”,”YPositionCOG”), +which indicates the distance of the center of gravity to the center of the rear axle. If this data is not given, the center of gravity is positioned on half wheelbase. For air resistance, the properties “AirDragCoefficient” & “FrontSurface” from the <a class="reference internal" href="../../configs/scenario.html#scenario-vehiclemodels"><span class="std std-ref">VehicleCatalog</span></a> are used.</p> +<p>For the equations of motion, see relevant vehicle dynamics books such as:</p> +<p>Kücükay, Ferit (2022), “Grundlagen der Fahrzeugtechnik”, page 1067 ff</p> +</div> +</div> </div> @@ -1100,7 +1605,7 @@ <div role="contentinfo"> <p> - © Copyright 2023 OpenPASS Working Group. + © Copyright 2023 openPASS Working Group. </p> </div>
diff --git a/content/html/user_guide/tutorials/10_scenario_simulation.html b/content/html/user_guide/tutorials/10_scenario_simulation.html index 41891bc..4106264 100644 --- a/content/html/user_guide/tutorials/10_scenario_simulation.html +++ b/content/html/user_guide/tutorials/10_scenario_simulation.html
@@ -7,7 +7,7 @@ <meta name="viewport" content="width=device-width, initial-scale=1.0" /> - <title>Scenario-based simulation — OpenPASS Documentation</title> + <title>Scenario-based simulation — openPASS Documentation</title> @@ -70,7 +70,7 @@ <div class="version"> - "openPASS v0.11" + "develop_4d7f6d4f2e22c286789082dd8cbe3eb7f5b5af62" </div> @@ -100,7 +100,7 @@ <li class="toctree-l1"><a class="reference internal" href="../../installation_guide/10_getting_started.html">Getting Started</a></li> <li class="toctree-l1"><a class="reference internal" href="../../installation_guide/15_system_requirements.html">System Requirements</a></li> <li class="toctree-l1"><a class="reference internal" href="../../installation_guide/20_install_prerequisites.html">Installing Prerequisites</a></li> -<li class="toctree-l1"><a class="reference internal" href="../../installation_guide/30_install_openpass.html">Installing OpenPASS</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../installation_guide/30_install_openpass.html">Installing openPASS</a></li> <li class="toctree-l1"><a class="reference internal" href="../../installation_guide/50_further_guidance.html">Further Guidance</a></li> <li class="toctree-l1"><a class="reference internal" href="../../installation_guide/60_conan.html">Building with Conan</a></li> </ul> @@ -112,10 +112,9 @@ <li class="toctree-l2"><a class="reference internal" href="20_pcm_simulation.html">PCM Simulation</a></li> </ul> </li> -<li class="toctree-l1"><a class="reference internal" href="../30_gui_plugins.html">GUI Plugins</a></li> -<li class="toctree-l1"><a class="reference internal" href="../40_configs_in_depth.html">Configs in Depth</a></li> -<li class="toctree-l1"><a class="reference internal" href="../50_outputs_in_depth.html">Outputs in Depth</a></li> -<li class="toctree-l1"><a class="reference internal" href="../60_scenario_simulation.html">Simulator</a></li> +<li class="toctree-l1"><a class="reference internal" href="../30_configs_in_depth.html">Configs in Depth</a></li> +<li class="toctree-l1"><a class="reference internal" href="../40_outputs_in_depth.html">Outputs in Depth</a></li> +<li class="toctree-l1"><a class="reference internal" href="../50_scenario_simulation.html">Simulator</a></li> </ul> <p class="caption"><span class="caption-text">Advanced topics</span></p> <ul> @@ -126,12 +125,14 @@ <ul> <li class="toctree-l1"><a class="reference internal" href="../../developer_information/10_ide_support.html">IDE Support</a></li> <li class="toctree-l1"><a class="reference internal" href="../../developer_information/20_documentation.html">Documentation Concept</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../developer_information/30_coding_conventions.html">Coding Guidelines</a></li> </ul> <p class="caption"><span class="caption-text">Other Information</span></p> <ul> <li class="toctree-l1"><a class="reference internal" href="../../other_information/10_external_dependencies.html">External Dependencies</a></li> <li class="toctree-l1"><a class="reference internal" href="../../other_information/20_glossary.html">Glossary</a></li> -<li class="toctree-l1"><a class="reference internal" href="../../other_information/30_license.html">License</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../other_information/30_gui_plugins.html">GUI Plugins</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../other_information/40_license.html">License</a></li> </ul> @@ -209,15 +210,18 @@ The ego vehicle is equipped with an AEB system (the system under test). The scenario agent performs a cut-in and triggers as a result the AEB system of the ego agent. To force this exact maneuver, the scenario agent is set up to follow a predefined trajectory.</p> +<div class="admonition-todo admonition" id="id2"> +<p class="admonition-title">Todo</p> +<p>Update this paragraph for the new react GUI.</p> +</div> <p>The GUI is not yet capable of configuring and executing a scenario based simulation as this is currently work in progress. Thus, an existing simulation configuration is used and the simulation is started manually.</p> <p><strong>Step-by-step instructions</strong></p> <ol class="arabic"> -<li><p>Navigate into the <strong>openPASS</strong> install directory (e.g. <code class="docutils literal notranslate"><span class="pre">C:\OpenPASS</span></code>)</p></li> +<li><p>Navigate into the <strong>openPASS</strong> install directory (e.g. <code class="docutils literal notranslate"><span class="pre">C:\openPASS\bin\core</span></code>)</p></li> <li><p>The install directory should look like the following</p> <blockquote> -<div><div class="highlight-default notranslate"><div class="highlight"><pre><span></span>OpenPASS-Install-Dir -├── bin +<div><div class="highlight-default notranslate"><div class="highlight"><pre><span></span>openPASS-Install-Dir └── configs <-- this directory will be created in the next step └── examples <-- if non existent, it can be copied from the openPASS checkout repository (see note) │ ├── Common @@ -231,14 +235,14 @@ </div> <div class="admonition note"> <p class="admonition-title">Note</p> -<p>The folder <code class="docutils literal notranslate"><span class="pre">examples</span></code> might not be existent right after the installation. In this case one can find it in the checkout repository of OpenPASS under <code class="docutils literal notranslate"><span class="pre">sim/contrib</span></code>. From there one can copy it into the installation folder.</p> +<p>The folder <code class="docutils literal notranslate"><span class="pre">examples</span></code> might not be existent right after the installation. In this case one can find it in the checkout repository of openPASS under <code class="docutils literal notranslate"><span class="pre">deps/os/sim/contrib</span></code>. From there one can copy it into the installation folder.</p> </div> </div></blockquote> </li> <li><p>Create a new folder named “configs” for the configuration files within the <strong>openPASS</strong> install directory</p></li> <li><p>Copy configuration files</p> <blockquote> -<div><p>Simulations for <strong>openPASS</strong> are fully configured through configuration files. This is where the user defines the traffic scenario to be simulated by OpenPASS. +<div><p>Simulations for <strong>openPASS</strong> are fully configured through configuration files. This is where the user defines the traffic scenario to be simulated by openPASS. Examples for <strong>openPASS</strong> configuration files are located in the directory <code class="docutils literal notranslate"><span class="pre">examples</span></code> and are divided into two groups: <em>default configurations</em> and <em>specific configurations</em>.</p> <ol class="loweralpha"> <li><p>The <em>default configuration</em> files located under <code class="docutils literal notranslate"><span class="pre">examples/Common</span></code> contain the basis for any simulation. They represent the minimum input required, therefore:</p> @@ -260,7 +264,7 @@ </ol> <div class="admonition note"> <p class="admonition-title">Note</p> -<p>A detailed description of the various configuration files can be found under see <a class="reference internal" href="../40_configs_in_depth.html#configs-in-depth"><span class="std std-ref">Configs in Depth</span></a>.</p> +<p>A detailed description of the various configuration files can be found under see <a class="reference internal" href="../30_configs_in_depth.html#configs-in-depth"><span class="std std-ref">Configs in Depth</span></a>.</p> </div> </div></blockquote> </li> @@ -342,7 +346,7 @@ <div role="contentinfo"> <p> - © Copyright 2023 OpenPASS Working Group. + © Copyright 2023 openPASS Working Group. </p> </div>
diff --git a/content/html/user_guide/tutorials/20_pcm_simulation.html b/content/html/user_guide/tutorials/20_pcm_simulation.html index f2a0d91..80488f4 100644 --- a/content/html/user_guide/tutorials/20_pcm_simulation.html +++ b/content/html/user_guide/tutorials/20_pcm_simulation.html
@@ -7,7 +7,7 @@ <meta name="viewport" content="width=device-width, initial-scale=1.0" /> - <title>PCM Simulation — OpenPASS Documentation</title> + <title>PCM Simulation — openPASS Documentation</title> @@ -42,7 +42,7 @@ <link rel="index" title="Index" href="../../genindex.html" /> <link rel="search" title="Search" href="../../search.html" /> - <link rel="next" title="GUI Plugins" href="../30_gui_plugins.html" /> + <link rel="next" title="Configs in Depth" href="../30_configs_in_depth.html" /> <link rel="prev" title="Scenario-based simulation" href="10_scenario_simulation.html" /> </head> @@ -70,7 +70,7 @@ <div class="version"> - "openPASS v0.11" + "develop_4d7f6d4f2e22c286789082dd8cbe3eb7f5b5af62" </div> @@ -100,7 +100,7 @@ <li class="toctree-l1"><a class="reference internal" href="../../installation_guide/10_getting_started.html">Getting Started</a></li> <li class="toctree-l1"><a class="reference internal" href="../../installation_guide/15_system_requirements.html">System Requirements</a></li> <li class="toctree-l1"><a class="reference internal" href="../../installation_guide/20_install_prerequisites.html">Installing Prerequisites</a></li> -<li class="toctree-l1"><a class="reference internal" href="../../installation_guide/30_install_openpass.html">Installing OpenPASS</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../installation_guide/30_install_openpass.html">Installing openPASS</a></li> <li class="toctree-l1"><a class="reference internal" href="../../installation_guide/50_further_guidance.html">Further Guidance</a></li> <li class="toctree-l1"><a class="reference internal" href="../../installation_guide/60_conan.html">Building with Conan</a></li> </ul> @@ -112,10 +112,9 @@ <li class="toctree-l2 current"><a class="current reference internal" href="#">PCM Simulation</a></li> </ul> </li> -<li class="toctree-l1"><a class="reference internal" href="../30_gui_plugins.html">GUI Plugins</a></li> -<li class="toctree-l1"><a class="reference internal" href="../40_configs_in_depth.html">Configs in Depth</a></li> -<li class="toctree-l1"><a class="reference internal" href="../50_outputs_in_depth.html">Outputs in Depth</a></li> -<li class="toctree-l1"><a class="reference internal" href="../60_scenario_simulation.html">Simulator</a></li> +<li class="toctree-l1"><a class="reference internal" href="../30_configs_in_depth.html">Configs in Depth</a></li> +<li class="toctree-l1"><a class="reference internal" href="../40_outputs_in_depth.html">Outputs in Depth</a></li> +<li class="toctree-l1"><a class="reference internal" href="../50_scenario_simulation.html">Simulator</a></li> </ul> <p class="caption"><span class="caption-text">Advanced topics</span></p> <ul> @@ -126,12 +125,14 @@ <ul> <li class="toctree-l1"><a class="reference internal" href="../../developer_information/10_ide_support.html">IDE Support</a></li> <li class="toctree-l1"><a class="reference internal" href="../../developer_information/20_documentation.html">Documentation Concept</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../developer_information/30_coding_conventions.html">Coding Guidelines</a></li> </ul> <p class="caption"><span class="caption-text">Other Information</span></p> <ul> <li class="toctree-l1"><a class="reference internal" href="../../other_information/10_external_dependencies.html">External Dependencies</a></li> <li class="toctree-l1"><a class="reference internal" href="../../other_information/20_glossary.html">Glossary</a></li> -<li class="toctree-l1"><a class="reference internal" href="../../other_information/30_license.html">License</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../other_information/30_gui_plugins.html">GUI Plugins</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../other_information/40_license.html">License</a></li> </ul> @@ -215,7 +216,7 @@ </div> <footer> <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> - <a href="../30_gui_plugins.html" class="btn btn-neutral float-right" title="GUI Plugins" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a> + <a href="../30_configs_in_depth.html" class="btn btn-neutral float-right" title="Configs in Depth" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a> <a href="10_scenario_simulation.html" class="btn btn-neutral float-left" title="Scenario-based simulation" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a> </div> @@ -223,7 +224,7 @@ <div role="contentinfo"> <p> - © Copyright 2023 OpenPASS Working Group. + © Copyright 2023 openPASS Working Group. </p> </div>
