Skip to content

Commit 380d3bd

Browse files
committed
updated README
1 parent 98c0784 commit 380d3bd

File tree

1 file changed

+32
-0
lines changed

1 file changed

+32
-0
lines changed

README.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -90,3 +90,35 @@ Documentation:
9090
- pointsDisplayed: number of points to be shown at a given time. Used to control time-scaling
9191
- label1: String with label of the plotted variable
9292
- variable1: global variable that will be updated throughout program
93+
94+
#### void AddTimeGraph( String title, int pointsDisplayed, String label1, Variable1Type variable1, String label2, Variable2Type variable2, ... )
95+
96+
*Add a multi-variable graph vs. time*
97+
- title: String with title of graph
98+
- pointsDisplayed: number of points to be shown at a given time. Used to control time-scaling
99+
- label1: String with label of the plotted variable
100+
- variable1: global variable that will be updated throughout program
101+
- label2: String with label of the plotted variable
102+
- variable2: global variable that will be updated throughout program
103+
- ...
104+
105+
#### void AddXYGraph( String title, int pointsDisplayed, String labelX, VariableTypeX variableX, String labelY, VariableTypeY variableY )
106+
107+
*Add an X vs Y graph*
108+
- title: String with title of graph
109+
- pointsDisplayed: number of points to be shown at a given time. Used to control time-scaling
110+
- labelX: String with label of variable to be plotted along X-axis
111+
- variableX: global X-variable that will be updated throughout program
112+
- labelY: String with label of variable to be plotted along Y-axis
113+
- variableY: global Y-variable that will be updated throughout program
114+
115+
### void Plot()
116+
117+
*Send most recent values for all plotted variables to the listener application*
118+
119+
### bool Remove( int index )
120+
121+
*Removes the graph at the specified position with zero-indexing. (ie passing 0 would remove the first graph added)
122+
- index: position of graph to remove
123+
Returns:
124+
- bool: true if successful

0 commit comments

Comments
 (0)