Commit 80d4a360 authored by noasakurajin's avatar noasakurajin
Browse files

updating to version 0.9.0

 THis commit changes the library version to 0.9.0 and the format
 version to 0.6.0. The new format version break compatibility
 which is caused by the new physics.

 There is also an update for the train_properties json
 format in this commit. This just explains the format changes in
 format 0.6.0.
parent 6e0dc8bc
Pipeline #66892 passed with stages
in 4 minutes and 32 seconds
......@@ -38,7 +38,7 @@ PROJECT_NAME = libtrainsim
# could be handy for archiving the generated documentation or if some version
# control system is used.
PROJECT_NUMBER = 0.8.0
PROJECT_NUMBER = 0.9.0
# Using the PROJECT_BRIEF tag one can provide an optional one line description
# for a project that appears at the top of each page and should give viewer a
......
......@@ -148,13 +148,13 @@ namespace libtrainsim {
* @brief the current version of the libtrainsim
*
*/
const version lib_version(0,8,0);
const version lib_version(0,9,0);
/**
* @brief the current version of the json formats
*
*/
const version format_version(0,5,0);
const version format_version(0,6,0);
/**
* @brief This enum maps action names to values for use with the control
......
......@@ -3,5 +3,5 @@
"mass":119400.0,
"maxPower":2350.0,
"powerUnit":"kW",
"formatVersion":"0.5.0"
"formatVersion":"0.6.0"
}
......@@ -2,22 +2,26 @@ The format of train_properties {#train_properties_format}
========================
The train properties descibes the properties of different train models.
The following json fields exists for version 0.4.0 of libtrainsim:
The following json fields exists for format version 0.6.0 of libtrainsim:
**required:**
* name (string) (since 0.4.0)
* mass (float) (since 0.4.0)
* maxVelocity (float) (since 0.4.0)
* maxAcceleration (float) (since 0.4.0)
* maxPower (float) (since 0.6.0)
**optional:**
* formatVersion (string) (since 0.4.0)
* trackDrag (float) (since 0.4.0)
* airDrag (float) (since 0.4.0)
* velocityUnit (string) (since 0.4.0)
* powerUnit (string) (since 0.6.0)
**deprecated:**
* velocityUnit (string) (removed in 0.6.0)
* maxVelocity (float) (removed in 0.6.0)
* maxAcceleration (float) (removed in 0.6.0)
### Detailed descriptions
......@@ -29,13 +33,9 @@ The name of the train that can be used to be displayed in an UI.
The mass of the train in kg.
#### maxVelocity
The highest Velocity this train model can drive in m/s.
#### maxAcceleration
#### maxPower
The highest Acceleration this train model can drive in m/s^2.
The highest power this train model can output in W.
### formatVersion
......@@ -46,20 +46,21 @@ If the library only supports an older format it may warn the user or even declar
#### trackDrag
The rolling resistance coefficent between the train and the tracks.
The default is 0.002.
The default is 0.02.
***At the moment this is used for the standing drag coefficient this will change in one of the next format versions!***
#### airDrag
The Front Area of the train multiplied by the Cw value.
The default value is 0.
### velocityUnit
### powerUnit
If this field is used the unit of maxVelocity can be manually set to something other than m/s.
If this field is used the unit of maxPower can be manually set to something other than W.
**The possible values are:**
* ms (since 0.4.0) (m/s)
* kmh (since 0.4.0) (km/h)
* W (since 0.6.0)
* kW (since 0.6.0)
All other values will be ignored and it will be assumed that m/s is used.
All other values will be ignored and it will be assumed that W is used.
......@@ -2,7 +2,7 @@ project(
'libtrainsim',
'cpp',
default_options : ['cpp_std=c++17'],
version : '0.8.0'
version : '0.9.0'
)
#set the configuration
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment