View source for Programming Reference:GenericVisualization Class

==Location==
<tt>src/shared/types</tt>

==Synopsis==
A filter may have information that it wants to present to the user - e.g., the EEG signal might appear graphically in a window, or an
application task log should be presented. Packaging this information into core messages, and sending these to the operator module, is handled by the
<tt>GenericVisualization</tt> class.
Typically, to visualize data this way, one will add a data member of type <tt>GenericVisualization</tt> to a filter class.

Note that visualization of a filter's output signal is handled transparently by the BCI2000 framework, and no code involving <tt>GenericVisualization</tt> needs to be written unless non-standard visualization behavior is required.

==Methods==
===GenericVisualization(string SourceID)===
Typically, a visualization's sourceID property is set from its constructor, and remains unchanged throughout the object's lifetime.
===Send(string|GenericSignal|SignalProperties|BitmapImage)===
Sends the specified object to the operator module, packaging it into an appropriate [[Technical_Reference:BCI2000_Messages|BCI2000 message]]. Strings are sent as log messages, a SignalProperties object is converted into a sequence of corresponding messages of type [[Technical_Reference:BCI2000_Messages#Content_Descriptor.3D255:_Visualization_Configuration|Visualization Configuration]].

Rather than using <tt>GenericVisualization::Send(string)</tt> to send a log message, it is possible to use the <tt>std::ostream::operator<<()</tt> inserter:
 GenericVisualization vis("MYLOG");
 vis << "Starting run number " << runNumber << std::endl;

==Properties==
===string SourceID (rw)===
The visualization source ID, identifying a target visualization window. This property corresponds to a [[Technical_Reference:BCI2000_Messages#Content_Descriptor.3D1:_Signal_Data|visualization messages']] source identifier field.

==See also==
[[Programming Reference:GenericFilter Class]], [[Technical Reference:Visualization Properties]], [[Programming Tutorial:Implementing a Signal Processing Filter]]

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