Programming Reference:ApplicationBase Class - Revision history

Zfreudenburg: /* Application Log */

2012-02-10T18:39:36Z

Application Log

← Older revision		Revision as of 18:39, 10 February 2012
Line 58:		Line 58:
	// Write a message to both screen and file:		// Write a message to both screen and file:
	AppLog << "This message is displayed by the operator module, and written into the log file." << endl;		AppLog << "This message is displayed by the operator module, and written into the log file." << endl;

			Make sure to include the "endl" as nothing is written until the AppLog receives a newline command.

	The application log file is located in the current session directory, and named after the current session; it carries an '''.applog''' extension.		The application log file is located in the current session directory, and named after the current session; it carries an '''.applog''' extension.

Mellinger: /* Access to Application Windows */

2011-08-23T12:41:01Z

Access to Application Windows

← Older revision		Revision as of 12:41, 23 August 2011
Line 13:		Line 13:
	The <tt>ApplicationBase</tt> class inherits from the [[Programming Reference:ApplicationWindowClient Class\|<tt>ApplicationWindowClient</tt> class]], and thus provides access to framework-managed [[Programming Reference:ApplicationWindow Class\|application windows]].		The <tt>ApplicationBase</tt> class inherits from the [[Programming Reference:ApplicationWindowClient Class\|<tt>ApplicationWindowClient</tt> class]], and thus provides access to framework-managed [[Programming Reference:ApplicationWindow Class\|application windows]].
	To access, and possibly create, the main application window from your <tt>ApplicationBase</tt>-derived application filter class, initialize an <tt>ApplicationWindow</tt> reference in its constructor with the <tt>ApplicationWindowClient::Window()</tt> function:		To access, and possibly create, the main application window from your <tt>ApplicationBase</tt>-derived application filter class, initialize an <tt>ApplicationWindow</tt> reference in its constructor with the <tt>ApplicationWindowClient::Window()</tt> function:
			<pre>
	class MyTaskFilter : public ApplicationBase		class MyTaskFilter : public ApplicationBase
	{		{
Line 33:		Line 34:
	...		...
	}		}
	You may also test windows for existence from the <tt>Preflight()</tt> function, and only use them when they already exist. This way, your code can adapt to the presence of certain filters in the application module. For more details, see the [[Programming Reference:ApplicationWindowClient Class\|ApplicationWindowClient class]] reference page.		</pre>
			You may also test windows for existence from the <tt>Preflight()</tt> function, and only use them when they already exist. This way, your code can adapt to the presence of certain filters in the application module. For more details, see the [[Programming Reference:ApplicationWindowClient Class\|<tt>ApplicationWindowClient</tt> class]] reference page.

	==RandomNumberGenerator==		==RandomNumberGenerator==

Mellinger: /* Access to Application Windows */

2011-08-23T12:40:29Z

Access to Application Windows

← Older revision		Revision as of 12:40, 23 August 2011
Line 33:		Line 33:
	...		...
	}		}
	You may also test windows for existence from the <tt>Preflight()</tt> function, and only use them when they already exist. This way, your code can adapt to the presence of certain filters in the application module.		You may also test windows for existence from the <tt>Preflight()</tt> function, and only use them when they already exist. This way, your code can adapt to the presence of certain filters in the application module. For more details, see the [[Programming Reference:ApplicationWindowClient Class\|ApplicationWindowClient class]] reference page.

	==RandomNumberGenerator==		==RandomNumberGenerator==

Mellinger: /* Access to Application Windows */

2011-08-23T12:39:40Z

Access to Application Windows

@@ Line 12: / Line 12: @@
 ==Access to Application Windows==
 The <tt>ApplicationBase</tt> class inherits from the [[Programming Reference:ApplicationWindowClient Class|<tt>ApplicationWindowClient</tt> class]], and thus provides access to framework-managed [[Programming Reference:ApplicationWindow Class|application windows]].
 ==RandomNumberGenerator==

Mellinger: /* Usage */

2011-08-23T12:28:24Z

Usage

← Older revision		Revision as of 12:28, 23 August 2011
Line 9:		Line 9:
	==Usage==		==Usage==
	An application module uses the <tt>ApplicationBase</tt> class by deriving its [[BCI2000 Glossary#Task\|task filter]] from <tt>ApplicationBase</tt> rather than <tt>GenericFilter</tt> directly. It has then access to the facilities explained below.		An application module uses the <tt>ApplicationBase</tt> class by deriving its [[BCI2000 Glossary#Task\|task filter]] from <tt>ApplicationBase</tt> rather than <tt>GenericFilter</tt> directly. It has then access to the facilities explained below.

			==Access to Application Windows==
			The <tt>ApplicationBase</tt> class inherits from the [[Programming Reference:ApplicationWindowClient Class\|<tt>ApplicationWindowClient</tt> class]], and thus provides access to framework-managed [[Programming Reference:ApplicationWindow Class\|application windows]].

	==RandomNumberGenerator==		==RandomNumberGenerator==

Mellinger: /* See also */

2011-08-23T12:25:27Z

Mellinger at 17:45, 4 July 2011

2011-07-04T17:45:12Z

@@ Line 5: / Line 5: @@
 The <tt>ApplicationBase</tt> class bundles base functionality which is useful for any BCI2000 application module. This base functionality comprises
 *generation of random numbers,
-*maintaining an application log file, and application log messages to the operator user,
+*maintaining an application log file, and application log messages to the operator user.
 ==Usage==
@@ Line 37: / Line 35: @@
 Operator log window messages have ''APLG'' as their [[Technical Reference:BCI2000 Messages|visualization source ID]].
 ==Remarks==

Mellinger: /* Display Parameterization and Visualization */

2008-09-11T15:53:56Z

Display Parameterization and Visualization

← Older revision		Revision as of 15:53, 11 September 2008
Line 39:		Line 39:

	==Display Parameterization and Visualization==		==Display Parameterization and Visualization==
	Typically, a BCI2000 application module displays feedback or other stimuli in an application window. In the GUI abstraction layer of the BCI2000 framework, the application window's drawing area is represented as an object that inherits the [[Programming Reference~~:GUI:~~:GraphDisplay Class\|<tt>GUI::GraphDisplay</tt>]] interface.		Typically, a BCI2000 application module displays feedback or other stimuli in an application window. In the GUI abstraction layer of the BCI2000 framework, the application window's drawing area is represented as an object that inherits the [[Programming Reference:GraphDisplay Class\|<tt>GUI::GraphDisplay</tt>]] interface.

	When a derived class provides its underlying <tt>ApplicationBase</tt> with a <tt>GUI::GraphDisplay</tt> pointer at construction time, the <tt>ApplicationBase</tt> class will handle display visualization transparently.		When a derived class provides its underlying <tt>ApplicationBase</tt> with a <tt>GUI::GraphDisplay</tt> pointer at construction time, the <tt>ApplicationBase</tt> class will handle display visualization transparently.

Mellinger at 12:46, 19 August 2008

2008-08-19T12:46:23Z

← Older revision		Revision as of 12:46, 19 August 2008
Line 63:		Line 63:
	*evoking responses using stimulus presentation,		*evoking responses using stimulus presentation,
	*continuously presenting feedback of brain activity.		*continuously presenting feedback of brain activity.
	A BCI2000 task filter implementing one of these paradigms will not inherit from the <tt>ApplicationBase</tt> directly but either from the [[Programming Reference:~~StimulusPresentationTask~~ Class\|~~StimulusPresentationTask~~]] or [[Programming Reference:FeedbackTask Class\|FeedbackTask]].		A BCI2000 task filter implementing one of these paradigms will not inherit from the <tt>ApplicationBase</tt> directly but either from the [[Programming Reference:StimulusTask Class\|StimulusTask]] or [[Programming Reference:FeedbackTask Class\|FeedbackTask]].
	Still, such a task filter has access to all functionality provided by <tt>ApplicationBase</tt>.		Still, such a task filter has access to all functionality provided by <tt>ApplicationBase</tt>.

	==See also==		==See also==
	[[Programming Reference:~~StimulusPresentationTask~~ Class]], [[Programming Reference:FeedbackTask Class]]		[[Programming Reference:StimulusTask Class]], [[Programming Reference:FeedbackTask Class]]

	[[Category:Framework API]][[Category:Development]]		[[Category:Framework API]][[Category:Development]]

Mellinger at 18:19, 18 August 2008

2008-08-18T18:19:42Z

← Older revision		Revision as of 18:19, 18 August 2008
Line 39:		Line 39:

	==Display Parameterization and Visualization==		==Display Parameterization and Visualization==
	Typically, a BCI2000 application module displays feedback or other stimuli in an application window. In the GUI abstraction layer of the BCI2000 framework, the application window's drawing area is represented as an object that inherits the [[Programming Reference:GUI:GraphDisplay Class\|<tt>GUI::GraphDisplay</tt>]] interface.		Typically, a BCI2000 application module displays feedback or other stimuli in an application window. In the GUI abstraction layer of the BCI2000 framework, the application window's drawing area is represented as an object that inherits the [[Programming Reference:GUI::GraphDisplay Class\|<tt>GUI::GraphDisplay</tt>]] interface.

	When a derived class provides its underlying <tt>ApplicationBase</tt> with a <tt>GUI::GraphDisplay</tt> pointer at construction time, the <tt>ApplicationBase</tt> class will handle display visualization transparently.		When a derived class provides its underlying <tt>ApplicationBase</tt> with a <tt>GUI::GraphDisplay</tt> pointer at construction time, the <tt>ApplicationBase</tt> class will handle display visualization transparently.

← Older revision		Revision as of 12:25, 23 August 2011
Line 44:		Line 44:

	==See also==		==See also==
	[[Programming Reference:StimulusTask Class]], [[Programming Reference:FeedbackTask Class]]		[[Programming Reference:StimulusTask Class]], [[Programming Reference:FeedbackTask Class]], [[Programming Reference:ApplicationWindowClient Class]]


	[[Category:Framework API]][[Category:Development]]		[[Category:Framework API]][[Category:Development]]