-
Notifications
You must be signed in to change notification settings - Fork 7
How it works
The whole package relies mostly on six Python classes embedded in the package's nodes:
- Journal
- JournalLine (and its subclasses)
- KeyboardShortcuts
- KeyboardShortcutCommand
- LoadedModel
- LoadedModelEvent
The Journal and KeyboardShortcuts have constructors that are exposed as Create nodes:
Journal.ByStringKeyboardShortcuts.ByString
So you would usually start by creating Journal objects and KeyboardShortcuts objects (if needed, depending on your goals).
JournalLines and KeyboardShortcutCommands are generated by the constructors as children of the respective class. LoadedModels and LoadedModelEvents are generated by the Journal.LoadedModels node.
Furthermore, Journals are structured into blocks. Each block starts with a JournalTimeStamp (except block 0). Each JournalLine knows its block.
JournalLines are further classified into different types, each type is represented by a separate subclass (see JournalLine types for more details).
Any nodes that retrieve object attributes are classified as Query nodes. Any nodes that call methods defined in the respective object (even though those methods usually do not alter the object and simply perform a query of their own) are classified as Actions nodes.