Programming Reference:FeedbackDemo Application - Revision history

Mellinger: /* Feedback Window */

2019-01-18T14:44:36Z

Feedback Window

← Older revision		Revision as of 14:44, 18 January 2019
Line 11:		Line 11:

	==Feedback Window==		==Feedback Window==
	The ''FeedbackDemo'' application uses a ~~VCL~~ ''~~TForm~~'' object as its output window. In the ~~form~~, it maintains a ~~VCL~~ ''~~TLabel~~'' object to display output messages, and two ~~VCL~~ ''~~TShape~~'' objects, one for cursor and target each.		The ''FeedbackDemo'' application uses a Qt ''QWidget'' object as its output window, which contains a ''QGraphicsScene''. In the ''QGraphicsScene'', it maintains a ''QGraphicsSimpleTextItem'' object to display output messages, and two ''QGraphicsEllipseItem'' objects, one for cursor and target each.

	==Parameters==		==Parameters==

Mellinger: /* Synopsis */

2019-01-18T14:39:02Z

Synopsis

← Older revision		Revision as of 14:39, 18 January 2019
Line 3:		Line 3:

	==Synopsis==		==Synopsis==
	The ''FeedbackDemo'' application module is a simple cursor feedback application that demonstrates how to write a BCI2000 application module using ~~the Borland VCL resp.~~ the Qt GUI library.		The ''FeedbackDemo'' application module is a simple cursor feedback application that demonstrates how to write a BCI2000 application module using the Qt GUI library.

	It may serve as a starting point to create your own feedback application in BCI2000.		It may serve as a starting point to create your own feedback application in BCI2000.

Mellinger: /* Synopsis */

2012-06-13T14:41:07Z

Synopsis

← Older revision		Revision as of 14:41, 13 June 2012
Line 3:		Line 3:

	==Synopsis==		==Synopsis==
	The ''FeedbackDemo'' application module is a simple cursor feedback application that demonstrates how to write a BCI2000 application module using the Borland VCL library.		The ''FeedbackDemo'' application module is a simple cursor feedback application that demonstrates how to write a BCI2000 application module using the Borland VCL resp. the Qt GUI library.

	It may serve as a starting point to create your own feedback application in BCI2000.		It may serve as a starting point to create your own feedback application in BCI2000.

Mellinger: /* See also */

2008-09-12T14:56:52Z

Mellinger: /* Inheritance */

2008-09-12T14:56:40Z

Inheritance

← Older revision		Revision as of 14:56, 12 September 2008
Line 8:		Line 8:

	==Inheritance==		==Inheritance==
	The ''FeedbackDemo'' application's task filter class is <tt>FeedbackDemoTask</tt>, and inherits from the [[Programming Reference:FeedbackTask\|FeedbackTask]] base class. Thus, it needs not deal with trial sequencing, target sequences, and similar issues; rather, it provides a window, populates it with the elements of a feedback screen such as a cursor, and a target, and implements a number of hooks, or event handlers.		The ''FeedbackDemo'' application's task filter class is <tt>FeedbackDemoTask</tt>, and inherits from the [[Programming Reference:FeedbackTask Class\|FeedbackTask]] base class. Thus, it needs not deal with trial sequencing, target sequences, and similar issues; rather, it provides a window, populates it with the elements of a feedback screen such as a cursor, and a target, and implements a number of hooks, or event handlers.

	==Feedback Window==		==Feedback Window==

Mellinger: /* Parameters */

2008-09-12T14:56:27Z

Parameters

← Older revision		Revision as of 14:56, 12 September 2008
Line 14:		Line 14:

	==Parameters==		==Parameters==
	Most parameters required for a feedback application are already provided by the [[Programming Reference:FeedbackTask\|FeedbackTask]] base class. Two parameters are added by the ''FeedbackDemo'' application:		Most parameters required for a feedback application are already provided by the [[Programming Reference:FeedbackTask Class\|FeedbackTask]] base class. Two parameters are added by the ''FeedbackDemo'' application:
	===CursorColor===		===CursorColor===
	This is a RGB color value defining the cursor's color.		This is a RGB color value defining the cursor's color.

Mellinger at 14:56, 12 September 2008

2008-09-12T14:56:11Z

New page

==Location==
<tt>src/core/Application/FeedbackDemo</tt>

==Synopsis==
The ''FeedbackDemo'' application module is a simple cursor feedback application that demonstrates how to write a BCI2000 application module using the Borland VCL library.

It may serve as a starting point to create your own feedback application in BCI2000.

==Inheritance==
The ''FeedbackDemo'' application's task filter class is <tt>FeedbackDemoTask</tt>, and inherits from the [[Programming Reference:FeedbackTask|FeedbackTask]] base class. Thus, it needs not deal with trial sequencing, target sequences, and similar issues; rather, it provides a window, populates it with the elements of a feedback screen such as a cursor, and a target, and implements a number of hooks, or event handlers.

==Feedback Window==
The ''FeedbackDemo'' application uses a VCL ''TForm'' object as its output window. In the form, it maintains a VCL ''TLabel'' object to display output messages, and two VCL ''TShape'' objects, one for cursor and target each.

==Parameters==
Most parameters required for a feedback application are already provided by the [[Programming Reference:FeedbackTask|FeedbackTask]] base class. Two parameters are added by the ''FeedbackDemo'' application:
===CursorColor===
This is a RGB color value defining the cursor's color.
===CursorWidth===
The cursor's width in percent of total screen width.

==Localization==
The ''FeedbackDemo'' application provides an example for a translation table, giving translations for application screen messages, and shows how to wrap string literals in a <tt>LocalizableString</tt> call in order to look them up in the translation table.

==Cursor Speed==
A feedback application's input signal consists of a normalized, zero-mean signal from the signal processing module. The ''FeedbackDemo'' demonstrates how to use these properties to determine an appropriate signal scaling (cursor speed) in the <tt>FeedbackDemoTask::OnInitialize()</tt> event handler.

==Feedback==
In the <tt>FeedbackDemoTask::DoFeedback()</tt> event handler, the ''FeedbackDemo'' shows
*how to use the control signal to update cursor position,
*how to end the trial when the cursor hits the right margin,
*how to set the ''ResultCode'' state.

==Trial Statistics==
The ''FeedbackDemo'' uses a [[Programming Reference:TrialStatistics Class|<tt>TrialStatistics</tt>]] object to store information about trial outcomes, and demonstrates how to update this information in <tt>FeedbackDemoTask::OnFeedbackEnd()</tt>, and how to obtain run statistics in <tt>FeedbackDemoTask::OnStopRun()</tt>.

==Application Log==
The demo uses the <tt>AppLog</tt> object provided by the [[Programming Reference:ApplicationBase Class|<tt>ApplicationBase</tt>]] class in order to write to a file and a screen log.

==See also==
[[Programming Reference:FeedbackTask Class]], [[Programming Reference:ApplicationBase Class]], [[Programming Reference:Localization]], [[Programming Reference:TrialStatistics Class]]

[[Category:Framwork API]][[Category:Howto]][[Category:Development]]

← Older revision		Revision as of 14:56, 12 September 2008
Line 41:		Line 41:
	[[Programming Reference:FeedbackTask Class]], [[Programming Reference:ApplicationBase Class]], [[Programming Reference:Localization]], [[Programming Reference:TrialStatistics Class]]		[[Programming Reference:FeedbackTask Class]], [[Programming Reference:ApplicationBase Class]], [[Programming Reference:Localization]], [[Programming Reference:TrialStatistics Class]]

	[[Category:~~Framwork~~ API]][[Category:Howto]][[Category:Development]]		[[Category:Framework API]][[Category:Howto]][[Category:Development]]