data-monitors

Class summary
csv-data-file-writer inherits from text-data-file-writer
data-file-writer inherits from data-handler
data-handler inherits from monitor
data-printer inherits from data-handler
data-recorder inherits from monitor
lisp-data-file-writer inherits from data-file-writer
lisp-data-file-writer-v2 inherits from data-file-writer
text-data-file-writer inherits from data-file-writer
Method summary
activate-monitor-method (monitor data-handler) &optional active
add-experiment-to-file-name data-file-writer
add-job-and-task-id-to-file-name data-file-writer
add-time-and-experiment-to-file-name data-file-writer
average-window data-recorder
column-separator text-data-file-writer
column-separator csv-data-file-writer
comment-string text-data-file-writer
current-value data-recorder
default-value data-recorder
file-name data-file-writer
format-string data-printer
get-average-values data-recorder
get-values data-recorder
handle-batch-finished-event (monitor data-file-writer) (monitor-id symbol) (event (eql (quote batch-finished))) (experiment-class string)
handle-interaction-finished-event (monitor data-recorder) (monitor-id symbol) (event (eql (quote interaction-finished))) (experiment t) (interaction t) (interaction-number number)
handle-interaction-finished-event (monitor data-printer) (monitor-id symbol) (event (eql (quote interaction-finished))) (experiment t) (interaction t) (interaction-number number)
handle-interaction-started-event (monitor data-recorder) (monitor-id symbol) (event (eql (quote interaction-started))) (experiment t) (interaction t) (interaction-number number)
handle-reset-monitors-event (monitor data-recorder) (monitor-id symbol) (event (eql (quote reset-monitors)))
handle-run-series-finished-event (monitor data-recorder) (monitor-id symbol) (event (eql (quote run-series-finished))) (experiment t)
handle-series-finished-event (monitor data-recorder) (monitor-id symbol) (event (eql (quote series-finished))) (series-number number)
incf-value monitor value
initialize-instance (monitor data-recorder) &key id &allow-other-keys
initialize-instance (monitor data-handler) &key data-sources &allow-other-keys
initialize-instance (monitor data-printer) &key id format-string &allow-other-keys
initialize-instance (monitor data-file-writer) &key id file-name &allow-other-keys
initialize-instance (monitor text-data-file-writer) &key column-separator comment-string &allow-other-keys
initialize-instance (monitor csv-data-file-writer) &key column-separator comment-string &allow-other-keys
interval data-printer
monitor-ids-of-sources data-handler
print-object (monitor data-recorder) stream
record-value monitor value
sources data-handler
write-data-to-file monitor stream
data-recorder   inherits from monitor  [Class]

Records a batch of series of values + their average

:default-value    [Initarg]
:average-window    [Initarg]
values    [Slot]

A batch of series of 'values' for each interaction

average-values    [Slot]

The average values for the batch of series

default-value    [Slot]

A default value that is pushed onto 'values' if no other value was passed

current-value    [Slot]

The value that was recorded or the initial value

average-window    [Slot]

Values are averaged over the last n interactions

average-window   data-recorder  [Generic function]

Returns and (with setf) changes the average-window of the specified data-recorder

current-value   data-recorder  [Generic function]

Returns the current-value of the specified data-recorder

default-value   data-recorder  [Generic function]

Returns and (with setf) changes the default-value of the specified data-recorder

get-average-values   data-recorder  [Generic function]

Returns the average-values of the specified data-recorder

get-values   data-recorder  [Generic function]

Returns the values of the specified data-recorder

data-handler   inherits from monitor  [Class]

Handles (outputs) the data of a set of data recorders

sources    [Slot]

Pointers to the 'values or 'average-values slots of the associated data recorders

monitor-ids-of-sources    [Slot]

The monitor ids of associated recorders, needed for activating.

monitor-ids-of-sources   data-handler  [Generic function]

Returns the monitor-ids-of-sources of the specified data-handler

sources   data-handler  [Generic function]

Returns the sources of the specified data-handler

data-printer   inherits from data-handler  [Class]

Prints the values of the sources using 'format-string' after each interaction

:format-string    [Initarg]
:interval    [Initarg]
format-string    [Slot]

Is passed to 'format' to print the most recent values of the sources

interval    [Slot]

Only every nth interaction is printed

interval   data-printer  [Generic function]

Returns and (with setf) changes the interval of the specified data-printer

format-string   data-printer  [Generic function]

Returns and (with setf) changes the format-string of the specified data-printer

data-file-writer   inherits from data-handler  [Class]

Writes the recorded data into a file

:file-name    [Initarg]
:add-experiment-to-file-name    [Initarg]
:add-time-and-experiment-to-file-name    [Initarg]
:add-job-and-task-id-to-file-name    [Initarg]
file-name    [Slot]

The file name of the file to write

add-experiment-to-file-name    [Slot]

When t, the file name is prefixed with the name of the experiment class.

add-time-and-experiment-to-file-name    [Slot]

When t, the file name is prefixed with the name of the experiment class and a yyyy-mm-dd-hh-mm-ss string.

add-job-and-task-id-to-file-name    [Slot]

Adds the job and task id to the file name of the file written by the monitor. ONLY WORKS FOR SBCL

add-job-and-task-id-to-file-name   data-file-writer  [Generic function]

Returns and (with setf) changes the add-job-and-task-id-to-file-name of the specified data-file-writer

add-time-and-experiment-to-file-name   data-file-writer  [Generic function]

Returns and (with setf) changes the add-time-and-experiment-to-file-name of the specified data-file-writer

add-experiment-to-file-name   data-file-writer  [Generic function]

Returns and (with setf) changes the add-experiment-to-file-name of the specified data-file-writer

file-name   data-file-writer  [Generic function]

Returns the file-name of the specified data-file-writer

lisp-data-file-writer   inherits from data-file-writer  [Class]

Writes the data as s-expressions to a lisp file

lisp-data-file-writer-v2   inherits from data-file-writer  [Class]

Writes the data as s-expressions to a lisp file

text-data-file-writer   inherits from data-file-writer  [Class]

Writes the data in columns to a text file

:column-separator    [Initarg]
:comment-string    [Initarg]
colum-separator    [Slot]

a string used to separate columns

comment-string    [Slot]

how to start a comment line

comment-string   text-data-file-writer  [Generic function]

Returns and (with setf) changes the comment-string of the specified text-data-file-writer

column-separator   text-data-file-writer  [Generic function]

Returns and (with setf) changes the colum-separator of the specified text-data-file-writer

csv-data-file-writer   inherits from text-data-file-writer  [Class]

Writes the data in columns to a csv file

:column-separator    [Initarg]
colum-separator    [Slot]

a string used to separate columns

column-separator   csv-data-file-writer  [Generic function]

Returns and (with setf) changes the colum-separator of the specified csv-data-file-writer

record-value   monitor value  [Generic function]

Sets the current value of a data recorder.

incf-value   monitor value  [Generic function]

Increases the current value of a data recorder.

write-data-to-file   monitor stream  [Generic function]

Writes the sources of monitor to the stream

initialize-instance   (monitor data-recorder) &key id &allow-other-keys  [Around method]
handle-interaction-started-event   (monitor data-recorder) (monitor-id symbol) (event (eql (quote interaction-started))) (experiment t) (interaction t) (interaction-number number)  [Before method]
handle-interaction-finished-event   (monitor data-recorder) (monitor-id symbol) (event (eql (quote interaction-finished))) (experiment t) (interaction t) (interaction-number number)  [After method]
handle-run-series-finished-event   (monitor data-recorder) (monitor-id symbol) (event (eql (quote run-series-finished))) (experiment t)  [After method]
handle-series-finished-event   (monitor data-recorder) (monitor-id symbol) (event (eql (quote series-finished))) (series-number number)  [Before method]
handle-reset-monitors-event   (monitor data-recorder) (monitor-id symbol) (event (eql (quote reset-monitors)))  [Method]
print-object   (monitor data-recorder) stream  [Method]
initialize-instance   (monitor data-handler) &key data-sources &allow-other-keys  [Around method]
activate-monitor-method   (monitor data-handler) &optional active  [After method]

Activates all sources of that monitor whenever this one becomes active.

initialize-instance   (monitor data-printer) &key id format-string &allow-other-keys  [Around method]
handle-interaction-finished-event   (monitor data-printer) (monitor-id symbol) (event (eql (quote interaction-finished))) (experiment t) (interaction t) (interaction-number number)  [After method]
initialize-instance   (monitor data-file-writer) &key id file-name &allow-other-keys  [Around method]
handle-batch-finished-event   (monitor data-file-writer) (monitor-id symbol) (event (eql (quote batch-finished))) (experiment-class string)  [Method]
initialize-instance   (monitor text-data-file-writer) &key column-separator comment-string &allow-other-keys  [Around method]
initialize-instance   (monitor csv-data-file-writer) &key column-separator comment-string &allow-other-keys  [Around method]