Traced
A view that wraps around another, collecting a log or trace of events while delegating its actual event-handling to the wrapped view. Provides additional methods for accessing such traces: trace, simulateAndGet, and startAndGet. A few examples of using these methods are given below.
simulate 500 clock ticks on the trace-collecing view and print the trace of clock ticks accompanied by descriptions of the view’äs model.
for (traceItem, traceEvent) <- myTracedView.simulateAndGet(500) do
println(traceEvent + ": " + traceItem)
Or, equivalently:
myTracedView.simulate(500)
for (traceItem, traceEvent) <- myTracedView.trace do
println(traceEvent + ": " + traceItem)
Alternatively, start the trace-collecting view and run it interactively until it is done or a tick limit is reached. Then print the trace of ticks and GUI events accompanied by descriptions of the view’s model.
val futureTrace = myTracedView.startAndGet(tickLimit=100) recover {
case Aborted(message, partialTrace) => partialTrace
}
for trace <- futureTrace; (traceItem, traceEvent) <- trace do
println(traceEvent + ": " + traceItem)
Type parameters
- TraceData
-
the type of the model-state descriptions in the trace
Parameters
- extractTrace
-
a function that determines how to describe a model state in the generated trace
Attributes
Members list
Type members
Inherited classlikes
A view that wraps around another, collecting a log or trace of events while delegating its actual event-handling to the wrapped view. Provides additional methods for accessing such traces: trace, simulateAndGet, and startAndGet. A few examples of using these methods are given below.
A view that wraps around another, collecting a log or trace of events while delegating its actual event-handling to the wrapped view. Provides additional methods for accessing such traces: trace, simulateAndGet, and startAndGet. A few examples of using these methods are given below.
simulate 500 clock ticks on the trace-collecing view and print the trace of clock ticks accompanied by descriptions of the view’äs model.
for (traceItem, traceEvent) <- myTracedView.simulateAndGet(500) do
println(traceEvent + ": " + traceItem)
Or, equivalently:
myTracedView.simulate(500)
for (traceItem, traceEvent) <- myTracedView.trace do
println(traceEvent + ": " + traceItem)
Alternatively, start the trace-collecting view and run it interactively until it is done or a tick limit is reached. Then print the trace of ticks and GUI events accompanied by descriptions of the view’s model.
val futureTrace = myTracedView.startAndGet(tickLimit=100) recover {
case Aborted(message, partialTrace) => partialTrace
}
for trace <- futureTrace; (traceItem, traceEvent) <- trace do
println(traceEvent + ": " + traceItem)
Type parameters
- TraceData
-
the type of the model-state descriptions in the trace
Parameters
- extractTrace
-
a function that determines how to describe a model state in the generated trace
Attributes
Value members
Inherited methods
Sets a new tick rate for the view, replacing any previously set by the constructor or this method.
Sets a new tick rate for the view, replacing any previously set by the constructor or this method.
Attributes
- Inherited from:
- ViewFrameImpl
Closes the view: stops it (as per stop), does any onClose effects, hides the GUI window, and possibly terminates the entire application (as per the constructor parameter).
Closes the view: stops it (as per stop), does any onClose effects, hides the GUI window, and possibly terminates the entire application (as per the constructor parameter).
Attributes
- Inherited from:
- ViewFrameImpl
The icon to be displayed in the title bar of this view’s GUI frame.
The icon to be displayed in the title bar of this view’s GUI frame.
Attributes
- Inherited from:
- ViewFrameImpl
Sets the icon to be displayed in the title bar of this view’s GUI frame.
Sets the icon to be displayed in the title bar of this view’s GUI frame.
Parameters
- icon
-
a picture to be used as the icon
Attributes
- Inherited from:
- ViewFrameImpl
Sets the icon to be displayed in the title bar of this view’s GUI frame.
Sets the icon to be displayed in the title bar of this view’s GUI frame.
Parameters
- icon
-
a picture to be used as the icon; if
None, en empty icon image will be displayed
Attributes
- Inherited from:
- ViewFrameImpl
Determines if the given state is a “done state” for the view. This implementation delegates to the underlying View that is being traced.
Determines if the given state is a “done state” for the view. This implementation delegates to the underlying View that is being traced.
Parameters
- state
-
a state of the model (possibly a done state)
Attributes
- Definition Classes
- Inherited from:
- TraceGeneratingView
Indicates whether the view is paused. This implementation delegates to the underlying View that is being traced.
Indicates whether the view is paused. This implementation delegates to the underlying View that is being traced.
Attributes
- Definition Classes
- Inherited from:
- GeneratesTrace
Returns a Pic that graphically represents the current state of the view’s model object. This implementation delegates to the underlying View that is being traced.
Returns a Pic that graphically represents the current state of the view’s model object. This implementation delegates to the underlying View that is being traced.
Parameters
- state
-
a state of the model to be displayed
Attributes
- Inherited from:
- TraceGeneratingView
Handles a GUI event and adds it to the view’s trace. Delegates the actual event-handling to the corresponding method on the underlying View that is being traced.
Handles a GUI event and adds it to the view’s trace. Delegates the actual event-handling to the corresponding method on the underlying View that is being traced.
Attributes
- Definition Classes
- Inherited from:
- TraceGeneratingView
Handles a GUI event and adds it to the view’s trace. Delegates the actual event-handling to the corresponding method on the underlying View that is being traced.
Handles a GUI event and adds it to the view’s trace. Delegates the actual event-handling to the corresponding method on the underlying View that is being traced.
Attributes
- Definition Classes
- Inherited from:
- TraceGeneratingView
Causes an effect when the view’s GUI window is closed for any reason. By default, this method does nothing.
Causes an effect when the view’s GUI window is closed for any reason. By default, this method does nothing.
Attributes
- Inherited from:
- ViewFrameImpl
Handles a GUI event and adds it to the view’s trace. Delegates the actual event-handling to the corresponding method on the underlying View that is being traced.
Handles a GUI event and adds it to the view’s trace. Delegates the actual event-handling to the corresponding method on the underlying View that is being traced.
Attributes
- Definition Classes
- Inherited from:
- TraceGeneratingView
Handles a GUI event and adds it to the view’s trace. Delegates the actual event-handling to the corresponding method on the underlying View that is being traced.
Handles a GUI event and adds it to the view’s trace. Delegates the actual event-handling to the corresponding method on the underlying View that is being traced.
Attributes
- Definition Classes
- Inherited from:
- TraceGeneratingView
Handles a GUI event and adds it to the view’s trace. Delegates the actual event-handling to the corresponding method on the underlying View that is being traced.
Handles a GUI event and adds it to the view’s trace. Delegates the actual event-handling to the corresponding method on the underlying View that is being traced.
Attributes
- Definition Classes
- Inherited from:
- TraceGeneratingView
Handles a GUI event and adds it to the view’s trace. Delegates the actual event-handling to the corresponding method on the underlying View that is being traced.
Handles a GUI event and adds it to the view’s trace. Delegates the actual event-handling to the corresponding method on the underlying View that is being traced.
Attributes
- Definition Classes
- Inherited from:
- TraceGeneratingView
Handles a GUI event and adds it to the view’s trace. Delegates the actual event-handling to the corresponding method on the underlying View that is being traced.
Handles a GUI event and adds it to the view’s trace. Delegates the actual event-handling to the corresponding method on the underlying View that is being traced.
Attributes
- Definition Classes
- Inherited from:
- TraceGeneratingView
Handles a GUI event and adds it to the view’s trace. Delegates the actual event-handling to the corresponding method on the underlying View that is being traced.
Handles a GUI event and adds it to the view’s trace. Delegates the actual event-handling to the corresponding method on the underlying View that is being traced.
Attributes
- Definition Classes
- Inherited from:
- TraceGeneratingView
Handles a GUI event and adds it to the view’s trace. Delegates the actual event-handling to the corresponding method on the underlying View that is being traced.
Handles a GUI event and adds it to the view’s trace. Delegates the actual event-handling to the corresponding method on the underlying View that is being traced.
Attributes
- Definition Classes
- Inherited from:
- TraceGeneratingView
Handles a GUI event and adds it to the view’s trace. Delegates the actual event-handling to the corresponding method on the underlying View that is being traced.
Handles a GUI event and adds it to the view’s trace. Delegates the actual event-handling to the corresponding method on the underlying View that is being traced.
Attributes
- Definition Classes
- Inherited from:
- TraceGeneratingView
Handles a GUI event and adds it to the view’s trace. Delegates the actual event-handling to the corresponding method on the underlying View that is being traced.
Handles a GUI event and adds it to the view’s trace. Delegates the actual event-handling to the corresponding method on the underlying View that is being traced.
Attributes
- Definition Classes
- Inherited from:
- TraceGeneratingView
Handles a GUI event and adds it to the view’s trace. Delegates the actual event-handling to the corresponding method on the underlying View that is being traced.
Handles a GUI event and adds it to the view’s trace. Delegates the actual event-handling to the corresponding method on the underlying View that is being traced.
Attributes
- Definition Classes
- Inherited from:
- TraceGeneratingView
Handles a GUI event and adds it to the view’s trace. Delegates the actual event-handling to the corresponding method on the underlying View that is being traced.
Handles a GUI event and adds it to the view’s trace. Delegates the actual event-handling to the corresponding method on the underlying View that is being traced.
Attributes
- Definition Classes
- Inherited from:
- TraceGeneratingView
Handles a GUI event and adds it to the view’s trace. Delegates the actual event-handling to the corresponding method on the underlying View that is being traced.
Handles a GUI event and adds it to the view’s trace. Delegates the actual event-handling to the corresponding method on the underlying View that is being traced.
Attributes
- Definition Classes
- Inherited from:
- TraceGeneratingView
Handles a GUI event and adds it to the view’s trace. Delegates the actual event-handling to the corresponding method on the underlying View that is being traced.
Handles a GUI event and adds it to the view’s trace. Delegates the actual event-handling to the corresponding method on the underlying View that is being traced.
Attributes
- Definition Classes
- Inherited from:
- TraceGeneratingView
Handles a GUI event and adds it to the view’s trace. Delegates the actual event-handling to the corresponding method on the underlying View that is being traced.
Handles a GUI event and adds it to the view’s trace. Delegates the actual event-handling to the corresponding method on the underlying View that is being traced.
Attributes
- Definition Classes
- Inherited from:
- TraceGeneratingView
Causes an additional effect when the view is stopped (with stop()). This implementation delegates to the underlying View that is being traced. In addition, if the traced view had been started with startAndGet and reaches its tick limit before being done, this method causes the returned future to complete with a failure.
Causes an additional effect when the view is stopped (with stop()). This implementation delegates to the underlying View that is being traced. In addition, if the traced view had been started with startAndGet and reaches its tick limit before being done, this method causes the returned future to complete with a failure.
Attributes
- Definition Classes
- Inherited from:
- GeneratesTrace
Handles a clock tick and adds it to the view’s trace. Delegates the actual event-handling to the corresponding method on the underlying View that is being traced.
Handles a clock tick and adds it to the view’s trace. Delegates the actual event-handling to the corresponding method on the underlying View that is being traced.
Attributes
- Definition Classes
- Inherited from:
- TraceGeneratingView
Handles a clock tick and adds it to the view’s trace. Delegates the actual event-handling to the corresponding method on the underlying View that is being traced.
Handles a clock tick and adds it to the view’s trace. Delegates the actual event-handling to the corresponding method on the underlying View that is being traced.
Attributes
- Definition Classes
- Inherited from:
- TraceGeneratingView
Handles a GUI event and adds it to the view’s trace. Delegates the actual event-handling to the corresponding method on the underlying View that is being traced.
Handles a GUI event and adds it to the view’s trace. Delegates the actual event-handling to the corresponding method on the underlying View that is being traced.
Attributes
- Definition Classes
- Inherited from:
- TraceGeneratingView
Handles a GUI event and adds it to the view’s trace. Delegates the actual event-handling to the corresponding method on the underlying View that is being traced.
Handles a GUI event and adds it to the view’s trace. Delegates the actual event-handling to the corresponding method on the underlying View that is being traced.
Attributes
- Definition Classes
- Inherited from:
- TraceGeneratingView
Handles a GUI event and adds it to the view’s trace. Delegates the actual event-handling to the corresponding method on the underlying View that is being traced.
Handles a GUI event and adds it to the view’s trace. Delegates the actual event-handling to the corresponding method on the underlying View that is being traced.
Attributes
- Definition Classes
- Inherited from:
- TraceGeneratingView
Handles a GUI event and adds it to the view’s trace. Delegates the actual event-handling to the corresponding method on the underlying View that is being traced.
Handles a GUI event and adds it to the view’s trace. Delegates the actual event-handling to the corresponding method on the underlying View that is being traced.
Attributes
- Definition Classes
- Inherited from:
- TraceGeneratingView
Programmatically requests an update to the graphics of the view (even though no clock tick or triggering GUI event occurred).
Programmatically requests an update to the graphics of the view (even though no clock tick or triggering GUI event occurred).
Attributes
- Inherited from:
- ViewFrameImpl
Runs the view as if by calling start except that it runs “headless”, with no actual GUI window visible and independently of a real-time clock. A number of simulated clock ticks are immediately sent to the view; this continues until either the view determines it is done or a predetermined maximum number of ticks has been reached.
Runs the view as if by calling start except that it runs “headless”, with no actual GUI window visible and independently of a real-time clock. A number of simulated clock ticks are immediately sent to the view; this continues until either the view determines it is done or a predetermined maximum number of ticks has been reached.
Parameters
- tickLimit
-
the maximum number of ticks to simulate;
Int.MaxValue(which is the default) means there is no such limit
Attributes
- Inherited from:
- ViewFrameImpl
Simulates this trace-generating view with simulate and returns the resulting trace. This is equivalent to calling first simulate, then trace. See also startAndGet.
Simulates this trace-generating view with simulate and returns the resulting trace. This is equivalent to calling first simulate, then trace. See also startAndGet.
Parameters
- tickLimit
-
the maximum number of ticks to simulate;
Int.MaxValue(which is the default) means there is no such limit
Attributes
- Inherited from:
- GeneratesTrace
Determines whether the view should play a sound, given a state of its model. This implementation delegates to the underlying underlying View that is being traced.
Determines whether the view should play a sound, given a state of its model. This implementation delegates to the underlying underlying View that is being traced.
Parameters
- state
-
a state of the model
Attributes
- Definition Classes
- Inherited from:
- TraceGeneratingView
Starts the view: loads the model in the GUI window, makes the window visible oncreen, and starts the clock. Cf. simulate.
Starts the view: loads the model in the GUI window, makes the window visible oncreen, and starts the clock. Cf. simulate.
Attributes
- Inherited from:
- ViewFrameImpl
Starts this trace-generating view with start and returns a Future that evaluates to the resulting trace. The Future succeeds when the view is done; if the view isn’t done after a given number of clock ticks, the Future fails with TraceAborted, producing a partial trace. See also simulateAndGet.
Starts this trace-generating view with start and returns a Future that evaluates to the resulting trace. The Future succeeds when the view is done; if the view isn’t done after a given number of clock ticks, the Future fails with TraceAborted, producing a partial trace. See also simulateAndGet.
Parameters
- tickLimit
-
the maximum number of ticks to process before the future completes with a failure; defaults to
Long.MaxValue
Attributes
- Inherited from:
- GeneratesTrace
Stops the view: stops the clock, stops listening to events, and disposes of the GUI window. A stopped view cannot be restarted.
Stops the view: stops the clock, stops listening to events, and disposes of the GUI window. A stopped view cannot be restarted.
Attributes
- Inherited from:
- ViewFrameImpl
Returns a brief textual description of the view.
Returns a brief textual description of the view.
Attributes
- Definition Classes
- Inherited from:
- GeneratesTrace
the tooltip text to be displayed while the mouse hovers on the view
the tooltip text to be displayed while the mouse hovers on the view
Attributes
- Inherited from:
- ViewFrameImpl
Sets the tooltip text to be displayed while the mouse hovers on the view.
Sets the tooltip text to be displayed while the mouse hovers on the view.
Attributes
- Inherited from:
- ViewFrameImpl
Returns a trace of the events processed by this view. The trace comes in a collection of pairs, each of which is composed of a TraceData value that describes at the time of the event and a TraceEvent value that describes the event itself.
Returns a trace of the events processed by this view. The trace comes in a collection of pairs, each of which is composed of a TraceData value that describes at the time of the event and a TraceEvent value that describes the event itself.
Attributes
- Inherited from:
- GeneratesTrace
Returns a View that stores a trace of the ticks and GUI events that its event handlers process. This parameterless method stores, at each event, the (immutable) state of the View’s model. This is equivalent to calling tracedWith and passing in identity.
Returns a View that stores a trace of the ticks and GUI events that its event handlers process. This parameterless method stores, at each event, the (immutable) state of the View’s model. This is equivalent to calling tracedWith and passing in identity.
Attributes
- Inherited from:
- Controls
Returns a View that stores a pictorial trace of the ticks and GUI events that the View’s event handlers process. This is equivalent to calling tracedWith and passing in the View’s makePic method.
Returns a View that stores a pictorial trace of the ticks and GUI events that the View’s event handlers process. This is equivalent to calling tracedWith and passing in the View’s makePic method.
Attributes
- Inherited from:
- Controls
Returns a view that collects of the ticks and GUI events that the View’s event handlers process, using the given function to generate that trace. That trace-collecting view, which an instance of the Traced subclass, delegates the actual event handling to this original view but provides an additional interface for tracing.
Returns a view that collects of the ticks and GUI events that the View’s event handlers process, using the given function to generate that trace. That trace-collecting view, which an instance of the Traced subclass, delegates the actual event handling to this original view but provides an additional interface for tracing.
Type parameters
- TraceData
-
the type of the model-state descriptions in the trace
Parameters
- extractTrace
-
a function that determines how to describe a model state in the generated trace
Attributes
- See also
- Inherited from:
- ViewFrame
whether this view’s GUI frame is visible onscreen
Sets whether this view’s GUI frame is visible onscreen.
Inherited fields
Attributes
- Inherited from:
- ViewFrameImpl
Attributes
- Inherited from:
- ViewFrameImpl
Attributes
- Inherited from:
- ViewFrameImpl
Attributes
- Inherited from:
- ViewFrameImpl