Properties and Events | |
| Property | defaultDuration |
| Class topsTaskHelperMessage. More... | |
| Property | defaultSpacing |
| For drawable object vertical spacing. | |
 Properties and Events inherited from topsTaskHelper | |
| Property | theObject |
| Class topsTaskHelper. More... | |
| Property | removeCopy = true |
| Flag to remove copy from treeNode (see start) | |
| Property | ensembleObjectNames |
| Keep track of the names of the objects in the ensemble. | |
| Property | ensembleObjectClasses |
| Keep track of the classes of objects in the ensemble. | |
| sync | |
| For time synchronization. | |
| topsBindings | |
| Below are properties used to bind the helper to a topsTreeNode Defaults are defined in the constructor method. | |
| Properties and Events inherited from topsFoundation | |
| Property | name = '' |
| a string name to indentify the object | |
| Property | clockFunction =@topsClock |
| clock function, to standardize | |
Private Properties | |
| Property | showDrawables |
| Flag to show drawables, based on whether there is an open screen. | |
| Property | messageGroups =[] |
| Message groups. | |
Methods | |
| self | topsTaskHelperMessage (varargin) |
| Constuctor. More... | |
| addGroup (self, groupName, varargin) | |
| addGroup message.addGroup(<groupName>, ... 'text', {'<string1>', {args1}, '<string2>'}, ... 'drawables', ... {{<function handle>="">, args}, {...}}, ... 'playable', '<filename>', ... <optional parameter/value pairs> More... | |
| removeGroup (self, groupName) | |
| Remove group. | |
| showMultiple (self, groupName, text, pauseDuration) | |
| showMultiple More... | |
| setText (self, groupName, text) | |
| setText More... | |
| showText (self, groupName, text, varargin) | |
| showText | |
| show (self, groupName, task, eventTag) | |
| Set and show messages with text, images, and sounds. More... | |
| Methods inherited from topsTaskHelper | |
| self | topsTaskHelper (varargin) |
| Specs to use when looking for a copy. More... | |
| theObject | parse (self, name, fevalable, settings, commonSettings, unmatched) |
| Parse constructor specs to make theObject – possibly recursive if making multiple objects and putting them into an ensemble. More... | |
| start (self, treeNode) | |
| start More... | |
| finish (self, treeNode) | |
| finish More... | |
| startTrial (self, treeNode) | |
| Function to prepare for use, called before each trial. More... | |
| finishTrial (self, treeNode) | |
| Finish trial method – should overload in subclass if needed. | |
| setProperty (self, varargin) | |
| Set property. More... | |
| synchronizedTime | getSynchronizedTime (self, unSynchronizedTime, useScreen) |
| % getSyncronizedTime More... | |
| saveSynchronizedTime (self, unSynchronizedTime, useScreen, task, eventTag) | |
| % saveSyncronizedTime 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... | |
Protected Methods | |
| drawables_ | parseDrawable (self, specs, fun, property) |
| Utility to add text, images to the drawables using simplified syntax; e.g., 'text', {'Great!', 'y', 3} 'images', {'thumbsUp.jpg', 'y', -3}. | |
| Protected Methods inherited from topsTaskHelper | |
| callFevalables (self, fevalables) | |
| Utility to call a list of fevalables. | |
Static Methods | |
| static | showTextMessage (textToShow, varargin) |
| Show a text message. More... | |
| Static Methods inherited from topsTaskHelper | |
| static synchronizationData | getSynchronizationData (helperName, varargin) |
| Get synchroniztion data from the current topsDataLog and make a maxtrix with columns: referenceTime offset. More... | |
| static helpers | makeHelpers (constructor, varargin) |
| Utility to make helpers. 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
◆ topsTaskHelperMessage()
| self topsTaskHelperMessage | ( | varargin | ) |
Constuctor.
Arguments are property/value pairs: 'name' ... string name for this helper 'defaultDuration' ... sets object property 'defaultSpacing' ... sets object property <group name>=""> ... struct of group specs sent to addGroup
Methods
◆ addGroup()
| addGroup | ( | self | , |
| groupName | , | ||
| varargin | |||
| ) |
addGroup message.addGroup(<groupName>, ... 'text', {'<string1>', {args1}, '<string2>'}, ... 'drawables', ... {{<function handle>="">, args}, {...}}, ... 'playable', '<filename>', ... <optional parameter/value pairs>
Other optional arguments are property/value pairs used by show method: text ... add text object(s). Syntax is detailed in parseDrawable. images ... add image object(s). Syntax is detailed in parseDrawable. drawables ... cell array of drawable specs, each is {<function handle>="">, 'arg1', val1', ...} playable ... filename for auditory object duration ... in sec bgStart ... background color [r g b] to use at start bgEnd ... background color [r g b] to use at end
◆ showMultiple()
| showMultiple | ( | self | , |
| groupName | , | ||
| text | , | ||
| pauseDuration | |||
| ) |
showMultiple
Set and show multiple messages with text, images, and sounds text is a cell array of strings columns are set to indexed values rows are shown sequentially
◆ setText()
| setText | ( | self | , |
| groupName | , | ||
| text | |||
| ) |
setText
Set text and prepare flag
◆ show()
| show | ( | self | , |
| groupName | , | ||
| task | , | ||
| eventTag | |||
| ) |
Set and show messages with text, images, and sounds.
Arguments groupName ... string task ... the topsTreeNode task caller eventTag ... string used to store timing information in trial struct. Assumes that the current trialData struct has an entry called time_<eventTag>.
◆ showTextMessage()
|
static |
Show a text message.
Optional arguments are sent to addGroup (see above)
Properties and Events
◆ defaultDuration
| Property defaultDuration |
Class topsTaskHelperMessage.
Add topsTaskHelperMessage, a subclass of topsTaskHelper includes text, image, and sound objects. Supercedes topsTaskHelperFeedback. The text and image objects are held in an ensemble The sound obects are private properties 7/16/19 jig revised to account for the possibility that no screen is used. In this case, text drawables can be spoken. Default duration for showing (in sec)
The documentation for this class was generated from the following file:
- topsTaskHelperMessage.m
