Properties and Events | |
| Property | filename |
| Class topsTreeNodeTopNode. More... | |
| controlFlags | |
| Flags for on-line flow control (used by run GUI) | |
| Property | randSeed = true |
| Flag to re-seed random number generator. | |
| Property | closingMessage = 'All done. Thank you!' |
| Closing message. | |
 Properties and Events inherited from topsTreeNode | |
| Property | iterations = 1 |
| number of times to run through this node's children | |
| Property | iterationCount = 0 |
| count of iterations while running | |
| Property | iterationMethod = 'sequential' |
| how to run through this node's children–'sequential' or 'random' order | |
| Property | nodeData = [] |
| For any node-specific data. | |
| Property | helpers = struct() |
| The helpers. | |
| Property | inheritHelpers = 'all' |
| Flag indicating whether to inherit all helpers from parent. | |
| Property | helperTypes = {'drawable', 'targets', 'playable', 'readable', 'writable', 'message', 'general'} |
| List of helper types. | |
| Properties and Events inherited from topsRunnableComposite | |
| Property | children = {} |
| cell array of topsRunnable (or subclass) objects | |
| Properties and Events inherited from topsRunnable | |
| Property | startFevalable = {} |
| optional fevalable cell array to invoke just before running | |
| Property | finishFevalable = {} |
| optional fevalable cell array to invoke just after running | |
| Property | isRunning = false |
| true or false, whether this object is currently busy running | |
| Property | caller |
| topsRunnable that invoked run() on this object, or empty | |
| Property | startString = 'start' |
| string used for topsDataLog entry just before run() | |
| Property | finishString = 'finish' |
| string used for topsDataLog entry just after run() | |
| Properties and Events inherited from topsFoundation | |
| Property | name = '' |
| a string name to indentify the object | |
| Property | clockFunction =@topsClock |
| clock function, to standardize | |
Private Properties | |
| GUIs | |
| GUIs. | |
| Property | isStarted = false |
| silly flag to avoid errors with GUI startup | |
Methods | |
| self | topsTreeNodeTopNode (name, filename, addControlKeyboard) |
| % Constructor method More... | |
| addGUIs (self, varargin) | |
| % Utility: add GUIs | |
| theHelper | addReadable (self, readableName, varargin) |
| % Add readable, with initialization/cleanup More... | |
| start (self) | |
| % Start More... | |
| finish (self) | |
| % Finish More... | |
| updateGUI (self, name, varargin) | |
| % updateGUI More... | |
| ret | checkFlags (self, child) |
| % checkFlags More... | |
| Methods inherited from topsTreeNode | |
| self | topsTreeNode (varargin) |
| Constuct with name optional. More... | |
| child | newChildNode (self, varargin) |
| Create a new topsTreeNode child and add it beneath this node. More... | |
| addChild (self, child) | |
| Add a child and process inheritance. | |
| abort (self) | |
| Convenient routine to abort running self and children. | |
| addCall (self, tag, fevalable, name, theObject) | |
| Add fevalable to the start/finish fevalable call list. It's a. More... | |
| theHelpers | addHelpers (self, constructor, varargin) |
| Add helper(s) to the node. More... | |
| helper | getHelperByClassName (self, name) |
| Find a helper of the named class. | |
| helper | getControlHelper (self) |
| Get the control helper (see topsTreeNodeTopNode) | |
| run (self) | |
| Recursively run(), starting with this node. More... | |
| Methods inherited from topsRunnableComposite | |
| self | topsRunnableComposite (varargin) |
| Constuct with name optional. More... | |
| fig | gui (self) |
| Open a GUI to view object details. More... | |
| addChild (self, child) | |
| Add a child beneath this object. More... | |
| removeChild (self, child) | |
| Remove a child beneath this object. More... | |
| selector | isChild (self, child) |
| Check if child is there. | |
| Methods inherited from topsRunnable | |
| self | topsRunnable (varargin) |
| Constuct with name optional. More... | |
| run (self) | |
| Do flow control. More... | |
| g | gui (self) |
| Show heirarchy of topsRunnable[Composite] objects. | |
| start (self) | |
| Log action and prepare to do flow control. More... | |
| finish (self) | |
| Log, action and finish doing flow control. More... | |
| logAction (self, actionName, actionData) | |
| Log an event of interest with topsDataLog. More... | |
| logFeval (self, fevalName, fevalable) | |
| Log a function call with topsDataLog. More... | |
| Methods inherited from topsFoundation | |
| self | topsFoundation (name) |
| Constuct with name optional. More... | |
| fig | gui (self) |
| Open a GUI to view object details. More... | |
| p | guiPanel (self, varargin) |
| Make a topsDetailPanel with details about this object. More... | |
Static Methods | |
| static pathname filename | getFileparts (studyTag, sessionTag, dataTag) |
| % getFileparts More... | |
| static topNode FIRA | loadRawData (studyTag, sessionTag) |
| % getDataFromFile More... | |
| Static Methods inherited from topsFoundation | |
| static c index | cellAdd (c, item, index) |
| Add an item to a cell array. More... | |
| static selector | cellContains (c, item) |
| Does a cell array conatin an item? More... | |
| static c | cellRemoveItem (c, item) |
| Remove an item from a cell array. More... | |
| static c | cellRemoveElement (c, index) |
| Remove indexed elements from a cell array. More... | |
| static index selector | findStructName (s, name) |
| Where is the given name in the given struct array? More... | |
Constructor
◆ topsTreeNodeTopNode()
| self topsTreeNodeTopNode | ( | name | , |
| filename | , | ||
| addControlKeyboard | |||
| ) |
% Constructor method
Constuct with optional argument: name ... string name of the top node filename ... string name of file (with path) addControlKeyboard ... flag to add control keyboard <default true>="">
Methods
◆ addReadable()
| theHelper addReadable | ( | self | , |
| readableName | , | ||
| varargin | |||
| ) |
% Add readable, with initialization/cleanup
Arguments (required): readableName ... string name of the readable to use Parameters (optional): doRecording ... flag to start/stop recording automatically doCalibration ... flag to automatically do calibration at start doShow ... flag to show output (usu. eye position) after calibration varargin ... arguments to helper constructor
◆ start()
| start | ( | self | ) |
% Start
Overloaded start function, which checks for gui(s) and sets up the topsDataLog
◆ finish()
| finish | ( | self | ) |
% Finish
Overloaded finish function, needed because we might have started GUI but did not run anything
◆ updateGUI()
| updateGUI | ( | self | , |
| name | , | ||
| varargin | |||
| ) |
% updateGUI
Does GUI need updating?
◆ checkFlags()
| ret checkFlags | ( | self | , |
| child | |||
| ) |
% checkFlags
Check status flags, which might be set by the GUI. Return ~0 if something happened
◆ getFileparts()
|
static |
% getFileparts
Standard pathname for data studyTag ... string name identifying the study sessionTag ... string name identifying the session dataTag ... string suffix for data file
◆ loadRawData()
|
static |
% getDataFromFile
Utility for making FIRA from a standard data file created by an experiment run using a topsTreeNodeTopNode Calls topsDataLog.parseEcodes, which assumes that the tag 'trial' corresponds to a trial data structure in the topsDataLog. Also calls dotsReadable.readDataFromFile using the given ui studyTag ... string name identifying the study sessionTag ... string name identifying the session Created 5/26/18 by jig
Properties and Events
◆ filename
| Property filename |
Class topsTreeNodeTopNode.
Special sub-class of topsTreeNode intended to be at the top level of a tree-like structure that runs all of its children as an experiment. Unlike other topsTreeNodes because it has guis and other helper objects associated with it. After creating, use these methods to extend functionality (see below for details): addGUIs addDrawables addHelpers (see topsTreeNode) Created 7/24/18 by jig Data filename with path
The documentation for this class was generated from the following file:
- topsTreeNodeTopNode.m
