|
Property | numComponents = 50 |
| dotsReadableDummy A 'dummy' readable to automatically generate inputs, usually for demo modes. More...
|
|
Property | returnValues = 'random' |
| values to return: 'random', 'all'
|
|
Property | pauseBeforeReturningData = 0 |
| pause before returning data, for pacing
|
|
Property | isAvailable = false |
|
whether or not the object is ready to read() from
|
|
Property | components |
|
struct array with details about each component
|
|
Property | state |
|
matrix of ID, latest value, and latest time indexed by ID
|
|
Property | history |
|
matrix of component ID, value, and time from previous read()
|
|
Property | isAutoRead = true |
|
whether or not to to invoke read() during getValue(), etc.
|
|
Property | eventDefinitions |
|
struct array defining events of interest, indexed by ID
|
|
Property | initialEventQueueSize = 100 |
|
initial size of queue for events of interest
|
|
Property | clockFunction |
|
any function that returns the current time as a number
|
|
Property | filename |
|
name of the data file for devices that store their own data
|
|
Property | filepath |
|
where the file is
|
|
Property | recordDuringCalibration = true |
|
controls whether or not to stop recording during calibration
|
|
Property | useGUI = false |
| Flag to use GUI for feedback, etc.
|
|
Property | useExistingCalibration = false |
| Flag to skip calibration routine.
|
|
Property | calibrationUI |
| Possibly use a keyboard or other UI to help with calibration.
|
|
Property | deactivateEventsAtStartTrial =false |
| Flag to deactivate all events at the beginning of each trial.
|
|
|
self | dotsReadableDummy () |
| % Public method More...
|
|
self | dotsReadable () |
|
Constructor takes no arguments.
|
|
| initialize (self) |
|
Locate, acquire, configure, etc. device and component resources.
|
|
| calibrate (self, varargin) |
|
Calibrate the device
More...
|
|
| record (self, onFlag, filename) |
|
Open/close data file associated with the device Arguments: onFlag ...
More...
|
|
| reset (self, varargin) |
| reset device More...
|
|
| close (self) |
|
Release any resources acquired by initialize().
|
|
| delete (self) |
|
Automatically close when Matlab is done with this object.
|
|
| read (self) |
|
Add incoming data to history and detect events of interest.
More...
|
|
| flushData (self, waitForNoEvents) |
|
Delete historical data and reset the current state.
More...
|
|
| logData (self) |
|
Record current and historical data in topsDataLog.
More...
|
|
stateAtTime | getState (self, time) |
|
Get the state of device components as of the given time.
More...
|
|
value data | getValue (self, ID) |
|
Get the latest value for the given component.
More...
|
|
event | defineEvent (self, name, varargin) |
|
Define the event of interest for one of the input components.
More...
|
|
| defineEventsFromComponents (self, names, varargin) |
| defineEventsFromComponents More...
|
|
| defineEventsFromStruct (self, eventStruct, setName, keepExisting, inactivate) |
| defineEventsFromStruct More...
|
|
| showActiveEvents (self) |
| Mostly for debugging.
|
|
| activateEventSet (self, name) |
| Swap in a set of events.
|
|
| activateEvents (self) |
| Activate all events. More...
|
|
| deactivateEvents (self) |
| Deactivate all events. More...
|
|
activeFlags | getActiveFlags (self) |
| Get all active flags.
|
|
| setActiveFlags (self, activeFlags) |
| Set all active flags from array.
|
|
| setEventsActiveFlag (self, activateList, deactivateList) |
| Set/unset activeFlag. More...
|
|
name data | getNextEvent (self, isPeek, acceptedEvents) |
|
Get the next event that was detected in read().
More...
|
|
lastName lastID names IDs | getHappeningEvent (self, time) |
|
Get events that are happening at the current time.
More...
|
|
name waitTime data | waitForEvents (self, eventNames, maxWait) |
| Wait for event(s)
|
|
nEvents | getNumberOfEvents (self) |
|
Get the number of events in eventQueue.
More...
|
|
IDs | getComponentIDs (self) |
|
Get an array of unique integer component IDs.
More...
|
|
ID | getComponentID (self, nameOrID) |
|
Get ID of component by name or ID
|
|
name | getComponentName (self, nameOrID) |
|
Get name of component by name or ID
|
|
indices | getComponentIndicesByID (self, IDs) |
|
Get array of indices for the given component IDs
|
|
indices | getComponentIndicesByName (self, names) |
|
Get array of indices for the given component names
|
|
time | getDeviceTime (self) |
|
Get the current time from clockFunction.
|
|
| setDeviceTime (self, val) |
|
Set the device time
|
|
| startTrial (self, varargin) |
|
startTrial()
More...
|
|
| finishTrial (self, varargin) |
|
finishTrial()
More...
|
|
| plotData (self) |
|
Open a figure with continuously read device data.
More...
|
|
| startTrialDevice (self, varargin) |
| Overloaded methods.
|
|
|
Property | eventQueue |
|
array of queued events (row indices into history)
|
|
Property | queueNext |
|
queue index of the next event to be dequeued
|
|
Property | queueLast =0 |
|
queue index of the last event enqueued
|
|
Property | isRecording =false |
|
keep track of whether device is currenly writing to a data file
|
|
Property | didCalibrate = true |
| Keep track of whether calibration occurs.
|
|
Property | defaultEventPrefix = 'event' |
| Default prefix for event names: <prefix>_<componentName>
|
|
Property | eventSets |
| Strutures with different named event definitions, in case we want to quickly swap between them.
|
|
static isHappening data readable | isEventHappening (readables, eventName) |
|
Is the named event happening now?
More...
|
|
static didHappen waitTime data readable name | waitForEvent (readables, eventName, maxWait) |
|
Wait for the named event to happen.
More...
|
|
static data | loadDataFile (filename, varargin) |
| Load data from file. More...
|
|