py_canoe.core.measurement.Measurement
Source code in src\py_canoe\core\measurement.py
57 58 59 60 61 62 63 64 65 66 67 68 69 | |
animation_delay
property
writable
Returns the current animation delay in milliseconds.
measurement_index
property
writable
Return the current measurement index. The measurement index is an integer that uniquely identifies the current measurement session.
running
property
Return True if the measurement is currently running, False otherwise.
break_measurement_in_offline_mode()
Break the measurement in offline mode. This is typically used to pause the measurement for debugging or analysis purposes. Returns True if the break was applied successfully, False otherwise.
Source code in src\py_canoe\core\measurement.py
195 196 197 198 199 200 201 202 203 204 205 206 | |
process_measurement_event_in_single_step()
Process the next measurement event in single step mode. This is typically used for debugging or analysis purposes. Returns True if the event was processed successfully, False otherwise.
Source code in src\py_canoe\core\measurement.py
218 219 220 221 222 223 224 225 226 | |
reset_measurement_in_offline_mode()
Reset the measurement in offline mode. This is typically used to reset the measurement state for debugging or analysis purposes. Returns True if the reset was applied successfully, False otherwise.
Source code in src\py_canoe\core\measurement.py
208 209 210 211 212 213 214 215 216 | |
start(timeout=30)
Start the measurement and wait for it to be running. Returns True if the measurement started successfully, False otherwise.
Source code in src\py_canoe\core\measurement.py
100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 | |
start_measurement_in_animation_mode(animation_delay=100, timeout=30)
Start the measurement in animation mode with a specified animation delay (in milliseconds) and wait for it to start. Returns True if the measurement started successfully, False otherwise.
Source code in src\py_canoe\core\measurement.py
176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 | |
stop(timeout=30, post_stop_pump=10)
Stop the measurement and wait for it to be stopped. Returns True if the measurement stopped successfully, False otherwise.
Source code in src\py_canoe\core\measurement.py
129 130 131 | |
stop_ex(timeout=30, post_stop_pump=10)
Stop the measurement and wait for it to be stopped. Returns True if the measurement stopped successfully, False otherwise. Optionally specify a timeout (in seconds) for waiting and a post-stop pump duration (in seconds) to drain COM callbacks after stopping.
Source code in src\py_canoe\core\measurement.py
133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 | |