ExternalVendorCode/trick
1
0
Fork 0
mirror of https://github.com/nasa/trick.git synced 2025-06-17 06:38:27 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Tutorial suggestions (#1274)

Browse Source 
* Update Data-Record.md (#1265)

Fix typo in input arg string.

* Update TutVariableServer.md (#1269)

tightened up grammar

* Update TutVariableServer.md (#1270)

more accurate usage hint

* Update ATutNumericSim.md (#1271)

instanciate -> instantiate line 376

* Update TutVariableServer.md (#1272)

fixed ⚠️ (⚠️) not displaying properly

* Update ATutNumericSim.md (#1273)

fixed 👉 (👉) not displaying properly

Co-authored-by: Brian <brianmhannan@gmail.com>
Co-authored-by: Matthew D Elmer <matthewdavidelmer@gmail.com>
This commit is contained in:
Scott Fennell
2022-06-01 14:11:48 -05:00
committed by GitHub
parent 32339908fa
commit b314c09eec
3 changed files with 16 additions and 17 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
docs/documentation/simulation_capabilities/Data-Record.md
View File

@ -36,7 +36,7 @@ Note: drg is just an example name. Any name may be used.
### Adding a Variable To Be Recorded
To add variables to the recording group call the <tt>drg.add_variable("<string_of_variable_name">)</tt> method of the recording group.
To add variables to the recording group call the <tt>drg.add_variable("<string_of_variable_name>")</tt> method of the recording group.
For example:
```python
@ -44,7 +44,7 @@ drg.add_variable("ball.obj.state.output.position[0]")
drg.add_variable("ball.obj.state.output.position[1]")
```
An optional alias may also be specified in the method as <tt>drg.add_variable("<string_of_variable_name"> [, "<alias>"])</tt>.
An optional alias may also be specified in the method as <tt>drg.add_variable("<string_of_variable_name>" [, "<alias>"])</tt>.
If an alias is present as a second argument, the alias name will be used in the data recording file instead of the actual variable name.
For example:
@ -121,18 +121,18 @@ recording groups as well as record a single point of data.
```c++
/* C code */
dr_enable_group("<group_name">) ;
dr_disable_group("<group_name">) ;
dr_record_now_group("<group_name">) ;
dr_enable_group("<group_name>") ;
dr_disable_group("<group_name>") ;
dr_record_now_group("<group_name>") ;
```
This is the Python input file version:
```python
# Python code
trick.dr_enable_group("<group_name">) ; # same as <group_name>.enable()
trick.dr_disable_group("<group_name">) ; # same as <group_name>.disable()
trick.dr_record_now_group("<group_name">) ;
trick.dr_enable_group("<group_name>") ; # same as <group_name>.enable()
trick.dr_disable_group("<group_name>") ; # same as <group_name>.disable()
trick.dr_record_now_group("<group_name>") ;
```
### Changing the thread Data Recording runs on.