Class MiniscopeLog
- Namespace
- OpenEphys.Miniscope.Gui
- Assembly
- OpenEphys.Miniscope.Gui.dll
A thread-safe queue that accumulates console messages (errors, written file paths, and other notable
actions) for display in the GUI. A single instance is created per GUI scope and shared through the
workflow (via a BehaviorSubject): any producer can push to it directly, and the console panel
reads Snapshot() to render the scrollback history.
public class MiniscopeLog
- Inheritance
-
MiniscopeLog
- Inherited Members
Remarks
While a recording is active the log can additionally mirror every message to a CSV file. Call StartFile(string) when a recording begins and OpenEphys.Miniscope.Gui.MiniscopeLog.StopFile() when it ends; in between, any message passed to Log(LogLevel, string) is appended to the file as well as the in-memory queue.
Properties
- Version
Gets a monotonically increasing counter that changes whenever the log is modified. Renderers can compare against a cached value to avoid taking a Snapshot() every frame.
Methods
- Clear()
Removes all messages from the log.
- Error(string)
Appends an error message.
- Info(string)
Appends an informational message.
- Log(LogLevel, string)
Appends a message to the log. Empty messages are ignored. If a log file is currently open (see StartFile(string)), the message is also written to it.
- PropertyChanged(string)
Appends a message indicating that a property has changed.
- Snapshot()
Returns the current log contents in chronological order (oldest first).
- Warning(string)
Appends a warning message.