Overview
Superclass for objects that run just by running other objects.
The topsRunnableComposite superclass provides a common interface for runnable objects that compose other runnable objects, and refer to these as "children". topsRunnableComposite objects run() by combining the run() behaviors of their children. They may do this in any way.
Properties and Events | |
| 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 | |
Methods | |
| 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... | |
Additional Inherited Members | |
| 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
◆ topsRunnableComposite()
| self topsRunnableComposite | ( | varargin | ) |
Constuct with name optional.
- Parameters
-
name optional name for this object
If name is provided, assigns name to this object.
Methods
◆ gui()
| fig gui | ( | self | ) |
Open a GUI to view object details.
Opens a new GUI with components suitable for viewing objects of this class. Returns a topsFigure object which contains the GUI.
◆ addChild()
| addChild | ( | self | , |
| child | |||
| ) |
Add a child beneath this object.
- Parameters
-
child a topsRunnable to add beneath this object.
Appends child to the children array of this object.
◆ removeChild()
| removeChild | ( | self | , |
| child | |||
| ) |
Remove a child beneath this object.
- Parameters
-
child a topsRunnable to remove fmor beneath this object.
Removes all instances of child from the children array of this object.
The documentation for this class was generated from the following file:
- topsRunnableComposite.m
