;;;; SUMMARY
;; There can be only one! (Non-concurrent buttons)
;;;; COPYRIGHT
;; Copyright (C) 2006 James P. Steiner
;; Some Rights Reserved
;; Licensed under Creative Commons 2.5 at-nc-sa license
;;
globals
[ go1? go2? button-1 button-2 mon-ticks ;; non-concurrent buttons
  greeting? ;; used by startup greeting procedures
]

to startup
   setup
end   

to setup
   ca
   set go1? 0
   set go2? 0
   cct 1000
   [ jump 5 ]
   show-greeting
end   

to go1
  no-display
   if greeting? = true [ clear-greeting ]
   ask patches [ set pcolor blue + 3 * sin ( timer * 100 + pycor) * cos (timer * 95 + abs pxcor) ]
  display
end


to go2
   no-display
   if greeting? = true [ clear-greeting ]
   ask turtles
   [ jump .5
     rt -5 + random-float 10
   ]
   display
end

;; @@@@@@@@@@@@@@@@@@@@@@@@
;;
;; Greeting code here
;;
;; @@@@@@@@@@@@@@@@@@@@@@@@

to show-greeting
   ask patch screen-edge-x (screen-edge-y - 2)
   [ set plabel "Click GO1 or GO2 to begin." ]
   set greeting? true
end   

to clear-greeting
   set greeting? false
   ask patch screen-edge-x (screen-edge-y - 2)
   [ set plabel no-label ]
end  

;; @@@@@@@@@@@@@@@@@@@@@
;;
;; END OF GREETING CODE
;;
;; @@@@@@@@@@@@@@@@@@@@@


;; ####################################
;; 
;;  Non-Concurrent Button Code follows
;;
;; ####################################

to stop-all
   ;; if go1 is running, tell it to stop...
   if go1? = 2 [ set go1? 3 ]
   ;; if go2? is running, tell it to stop...
   if go2? = 2 [ set go2? 3 ]
   ;; if both have acknowledged the stop
   ;; (or the monitor has done so),
   ;; stop this button (all stop complete)
   if go1? = 0 and go2? = 0 [ stop ]
end
 
to go1-control
   ;; 0 = stopped
   ;; 2 = started
   ;; 3 = stop requested
   ifelse( go1? = 2 and go2? = 0 )
   [ ;; run
     set button-1 true
     ;;;; #############################
     ;;;;
     go1  ;; <<<===  GO COMMAND ONE GOES HERE
     ;;;;
     ;;;;###############################
   ]
   [ ;; is a stop request from the other pending?
     ifelse go1? = 3
     [ ;; yes, show stop complete
       set go1? 0 ;; stopped
       stop ;; stop this button
     ] 
     [ ;; This is a new start request (go? = 0 and button was pushed)
       ;; is other stopped?
       ifelse go2? = 0
       [ ;; yes.
         ;; indicate start completed.
         set go1? 2
       ]
       [ ;; no.
         ;; request other to stop
         set go2? 3
       ]
     ]
   ]  
end

to go2-control
   ;; same as go1-control, comments removed
   ifelse( go2? = 2 and go1? = 0 )
   [ set button-2 true
     ;;;; #############################
     ;;;;
     go2  ;; <<<===  GO COMMAND TWO GOES HERE
     ;;;;
     ;;;;###############################
   ]
   [ ifelse go2? = 3 [ set go2? 0 set go1? 2 stop ]
     [ ifelse go1? = 0 [ set go2? 2 ] [ set go1? 3 ]
   ] ] 
end

to-report button-status
   ;; has button 1 asserted itself as running while the
   ;; go flag is in a non-stopped state recently?
   if button-1 = false and go1? != 0
   [ ;;no, so confirm that button-1 is off.
     set go1? 0
   ]
   if button-2 = false and go2? != 0
   [ set go2? 0
   ]
   set button-1 false
   set button-2 false
   ;; NOTE that mon-ticks is optional, and used mainly to update the 
   ;; monitor display.
   set mon-ticks mon-ticks + 1
   let td1 item (mon-ticks mod 4) [ "    (" "   ( " "  (  " " (   " "(    " ]
   let td2 item (mon-ticks mod 4) [ ")    " " )   " "  )  " "   ) " "    )" ]
   let b1 item go1? [ "off" "" "on" "stopping" ]
   let b2 item go2? [ "off" "" "on" "stopping" ]
   
   ;; you can alter the output as desired.
   ;; to show no output, change to ""
   report (word td1 " 1:" b1 " -- "  "2:" b2 " " td2 )
end      

;; #####################################
;;
;; END OF NON-CONCURRENT BUTTON CODE
;;
;; #####################################
@#$#@#$#@
GRAPHICS-WINDOW
187
10
617
461
17
17
12.0
1
24
1
1
1
0
1
1
1

CC-WINDOW
5
475
626
570
Command Center
0

BUTTON
21
72
84
105
go1
go1-control 
T
1
T
OBSERVER
NIL
NIL

BUTTON
26
164
89
197
stop
stop-all
T
1
T
OBSERVER
NIL
NIL

BUTTON
22
109
85
142
go2
go2-control
T
1
T
OBSERVER
NIL
NIL

BUTTON
19
11
82
44
NIL
setup
NIL
1
T
OBSERVER
T
NIL

MONITOR
15
220
164
269
NIL
button-status
3
1

TEXTBOX
88
72
173
104
Patch color shifting

TEXTBOX
89
117
167
141
Turtles walking

TEXTBOX
17
291
167
411
This model demonstrates a technique to enforce a rule that only one of two 'forever' buttons may be operated at a time. Pushing one button stops the other button. A monitor is used to detect the status of the buttons

TEXTBOX
94
172
141
190
stop all

@#$#@#$#@
= WHAT IS IT? =

This model demonstrates a technique to enforce a rule that only one of two 'forever' buttons may be operated at a time. 

= HOW IT WORKS =

Pushing a button causes the button to first check the state variable (goN?) of the other button. If the other button seems to be in the running state, the button sends a "stop request" to the other button. It does this by changing the other button's status flag from 2 (running) to 3 (please stop).

If a buttons status is 3, then it changes its own status to 0, and stops.

If a button's status is 0 (and it is running) that means one of two things:
1. the button was stopped, and the user pressed it, OR
2. the button was already pressed, but was waiting for the other button to stop.

Which one this is is determined by the other buttons status flag.. in either case, if the other button's status is now 0 (stopped), then this button's status is raised to 2 (running) and the button continues to run.

However, since a non-pressed button will never acknowledge the stop request, some trickery is used. A monitor runs code that repeatedly sets a flag for the running buttons to FALSE as the last thing the monitor does. The next time the monitor runs, it checks the status of these flags. If a supposedly "running" button (a button with status other than 0) has not set its flag to "true", then the monitor deduces that the button is not pressed, and sets that button's status to 0, letting the other button start running.

Since monitors run less often to allow slow code to run, the monitor will, under most circumstances, not stop a running button by accident, even if the button code is very slow.

= HOW TO USE IT =

This code is designed to be easily integrated into an existing model.

1. Copy the three procedures GO1-CONTROL, GO2-CONTROL, and BUTTON-STATE into your own model.
2. Include the four global variables: go1? go2? button-1 button-2 mon-ticks
3. In the -CONTROL procedures, change the name of GO1 and GO2 in the procedures to the names of your own GO procedures.
4. Add a monitor with the reporter "button-status"
5. Add your GO1, GO2 and STOP-ALL buttons as FOREVER buttons.

If you wish to hide the button-status monitor, you can put other controls on top of it. A blank text-box or an output-box work well.

= NETLOGO FEATURES = 

This model takes advantage of the idea that user-defined reporters can change the state of other areas of the model, not just report a result. This is called a "side-effect" of a reporter. This model also takes advantage of the way the monitors work: they run the code in their reporters repeatedly, even if no button is pressed; and they run slower when button code is running, to give the button code time to complete.
@#$#@#$#@
default
true
0
Polygon -7500403 true true 150 5 40 250 150 205 260 250

airplane
true
0
Polygon -7500403 true true 150 0 135 15 120 60 120 105 15 165 15 195 120 180 135 240 105 270 120 285 150 270 180 285 210 270 165 240 180 180 285 195 285 165 180 105 180 60 165 15

arrow
true
0
Polygon -7500403 true true 150 0 0 150 105 150 105 293 195 293 195 150 300 150

box
false
0
Polygon -7500403 true true 150 285 285 225 285 75 150 135
Polygon -7500403 true true 150 135 15 75 150 15 285 75
Polygon -7500403 true true 15 75 15 225 150 285 150 135
Line -16777216 false 150 285 150 135
Line -16777216 false 150 135 15 75
Line -16777216 false 150 135 285 75

bug
true
0
Circle -7500403 true true 96 182 108
Circle -7500403 true true 110 127 80
Circle -7500403 true true 110 75 80
Line -7500403 true 150 100 80 30
Line -7500403 true 150 100 220 30

butterfly
true
0
Polygon -7500403 true true 150 165 209 199 225 225 225 255 195 270 165 255 150 240
Polygon -7500403 true true 150 165 89 198 75 225 75 255 105 270 135 255 150 240
Polygon -7500403 true true 139 148 100 105 55 90 25 90 10 105 10 135 25 180 40 195 85 194 139 163
Polygon -7500403 true true 162 150 200 105 245 90 275 90 290 105 290 135 275 180 260 195 215 195 162 165
Polygon -16777216 true false 150 255 135 225 120 150 135 120 150 105 165 120 180 150 165 225
Circle -16777216 true false 135 90 30
Line -16777216 false 150 105 195 60
Line -16777216 false 150 105 105 60

car
false
0
Polygon -7500403 true true 300 180 279 164 261 144 240 135 226 132 213 106 203 84 185 63 159 50 135 50 75 60 0 150 0 165 0 225 300 225 300 180
Circle -16777216 true false 180 180 90
Circle -16777216 true false 30 180 90
Polygon -16777216 true false 162 80 132 78 134 135 209 135 194 105 189 96 180 89
Circle -7500403 true true 47 195 58
Circle -7500403 true true 195 195 58

circle
false
0
Circle -7500403 true true 0 0 300

circle 2
false
0
Circle -7500403 true true 0 0 300
Circle -16777216 true false 30 30 240

cow
false
0
Polygon -7500403 true true 200 193 197 249 179 249 177 196 166 187 140 189 93 191 78 179 72 211 49 209 48 181 37 149 25 120 25 89 45 72 103 84 179 75 198 76 252 64 272 81 293 103 285 121 255 121 242 118 224 167
Polygon -7500403 true true 73 210 86 251 62 249 48 208
Polygon -7500403 true true 25 114 16 195 9 204 23 213 25 200 39 123

cylinder
false
0
Circle -7500403 true true 0 0 300

dot
false
0
Circle -7500403 true true 90 90 120

face happy
false
0
Circle -7500403 true true 8 8 285
Circle -16777216 true false 60 75 60
Circle -16777216 true false 180 75 60
Polygon -16777216 true false 150 255 90 239 62 213 47 191 67 179 90 203 109 218 150 225 192 218 210 203 227 181 251 194 236 217 212 240

face neutral
false
0
Circle -7500403 true true 8 7 285
Circle -16777216 true false 60 75 60
Circle -16777216 true false 180 75 60
Rectangle -16777216 true false 60 195 240 225

face sad
false
0
Circle -7500403 true true 8 8 285
Circle -16777216 true false 60 75 60
Circle -16777216 true false 180 75 60
Polygon -16777216 true false 150 168 90 184 62 210 47 232 67 244 90 220 109 205 150 198 192 205 210 220 227 242 251 229 236 206 212 183

fish
false
0
Polygon -1 true false 44 131 21 87 15 86 0 120 15 150 0 180 13 214 20 212 45 166
Polygon -1 true false 135 195 119 235 95 218 76 210 46 204 60 165
Polygon -1 true false 75 45 83 77 71 103 86 114 166 78 135 60
Polygon -7500403 true true 30 136 151 77 226 81 280 119 292 146 292 160 287 170 270 195 195 210 151 212 30 166
Circle -16777216 true false 215 106 30

flag
false
0
Rectangle -7500403 true true 60 15 75 300
Polygon -7500403 true true 90 150 270 90 90 30
Line -7500403 true 75 135 90 135
Line -7500403 true 75 45 90 45

flower
false
0
Polygon -10899396 true false 135 120 165 165 180 210 180 240 150 300 165 300 195 240 195 195 165 135
Circle -7500403 true true 85 132 38
Circle -7500403 true true 130 147 38
Circle -7500403 true true 192 85 38
Circle -7500403 true true 85 40 38
Circle -7500403 true true 177 40 38
Circle -7500403 true true 177 132 38
Circle -7500403 true true 70 85 38
Circle -7500403 true true 130 25 38
Circle -7500403 true true 96 51 108
Circle -16777216 true false 113 68 74
Polygon -10899396 true false 189 233 219 188 249 173 279 188 234 218
Polygon -10899396 true false 180 255 150 210 105 210 75 240 135 240

house
false
0
Rectangle -7500403 true true 45 120 255 285
Rectangle -16777216 true false 120 210 180 285
Polygon -7500403 true true 15 120 150 15 285 120
Line -16777216 false 30 120 270 120

leaf
false
0
Polygon -7500403 true true 150 210 135 195 120 210 60 210 30 195 60 180 60 165 15 135 30 120 15 105 40 104 45 90 60 90 90 105 105 120 120 120 105 60 120 60 135 30 150 15 165 30 180 60 195 60 180 120 195 120 210 105 240 90 255 90 263 104 285 105 270 120 285 135 240 165 240 180 270 195 240 210 180 210 165 195
Polygon -7500403 true true 135 195 135 240 120 255 105 255 105 285 135 285 165 240 165 195

line
true
0
Line -7500403 true 150 0 150 300

line half
true
0
Line -7500403 true 150 0 150 150

pentagon
false
0
Polygon -7500403 true true 150 15 15 120 60 285 240 285 285 120

person
false
0
Circle -7500403 true true 110 5 80
Polygon -7500403 true true 105 90 120 195 90 285 105 300 135 300 150 225 165 300 195 300 210 285 180 195 195 90
Rectangle -7500403 true true 127 79 172 94
Polygon -7500403 true true 195 90 240 150 225 180 165 105
Polygon -7500403 true true 105 90 60 150 75 180 135 105

plant
false
0
Rectangle -7500403 true true 135 90 165 300
Polygon -7500403 true true 135 255 90 210 45 195 75 255 135 285
Polygon -7500403 true true 165 255 210 210 255 195 225 255 165 285
Polygon -7500403 true true 135 180 90 135 45 120 75 180 135 210
Polygon -7500403 true true 165 180 165 210 225 180 255 120 210 135
Polygon -7500403 true true 135 105 90 60 45 45 75 105 135 135
Polygon -7500403 true true 165 105 165 135 225 105 255 45 210 60
Polygon -7500403 true true 135 90 120 45 150 15 180 45 165 90

square
false
0
Rectangle -7500403 true true 30 30 270 270

square 2
false
0
Rectangle -7500403 true true 30 30 270 270
Rectangle -16777216 true false 60 60 240 240

star
false
0
Polygon -7500403 true true 151 1 185 108 298 108 207 175 242 282 151 216 59 282 94 175 3 108 116 108

target
false
0
Circle -7500403 true true 0 0 300
Circle -16777216 true false 30 30 240
Circle -7500403 true true 60 60 180
Circle -16777216 true false 90 90 120
Circle -7500403 true true 120 120 60

tree
false
0
Circle -7500403 true true 118 3 94
Rectangle -6459832 true false 120 195 180 300
Circle -7500403 true true 65 21 108
Circle -7500403 true true 116 41 127
Circle -7500403 true true 45 90 120
Circle -7500403 true true 104 74 152

triangle
false
0
Polygon -7500403 true true 150 30 15 255 285 255

triangle 2
false
0
Polygon -7500403 true true 150 30 15 255 285 255
Polygon -16777216 true false 151 99 225 223 75 224

truck
false
0
Rectangle -7500403 true true 4 45 195 187
Polygon -7500403 true true 296 193 296 150 259 134 244 104 208 104 207 194
Rectangle -1 true false 195 60 195 105
Polygon -16777216 true false 238 112 252 141 219 141 218 112
Circle -16777216 true false 234 174 42
Rectangle -7500403 true true 181 185 214 194
Circle -16777216 true false 144 174 42
Circle -16777216 true false 24 174 42
Circle -7500403 false true 24 174 42
Circle -7500403 false true 144 174 42
Circle -7500403 false true 234 174 42

turtle
true
0
Polygon -10899396 true false 215 204 240 233 246 254 228 266 215 252 193 210
Polygon -10899396 true false 195 90 225 75 245 75 260 89 269 108 261 124 240 105 225 105 210 105
Polygon -10899396 true false 105 90 75 75 55 75 40 89 31 108 39 124 60 105 75 105 90 105
Polygon -10899396 true false 132 85 134 64 107 51 108 17 150 2 192 18 192 52 169 65 172 87
Polygon -10899396 true false 85 204 60 233 54 254 72 266 85 252 107 210
Polygon -7500403 true true 119 75 179 75 209 101 224 135 220 225 175 261 128 261 81 224 74 135 88 99

wheel
false
0
Circle -7500403 true true 3 3 294
Circle -16777216 true false 30 30 240
Line -7500403 true 150 285 150 15
Line -7500403 true 15 150 285 150
Circle -7500403 true true 120 120 60
Line -7500403 true 216 40 79 269
Line -7500403 true 40 84 269 221
Line -7500403 true 40 216 269 79
Line -7500403 true 84 40 221 269

x
false
0
Polygon -7500403 true true 270 75 225 30 30 225 75 270
Polygon -7500403 true true 30 75 75 30 270 225 225 270

@#$#@#$#@
NetLogo 3.0.2
@#$#@#$#@
@#$#@#$#@
@#$#@#$#@
@#$#@#$#@