SharpBCI
A multi-threaded brain control interface (BCI) library in C#
 All Classes Namespaces Files Functions Variables Enumerations Enumerator Properties Pages
SharpBCI.InstrumentedDummyAdapter Class Reference

An EEGDeviceAdapter which is used to emit a certain set of signals via StartSignal. More...

Inheritance diagram for SharpBCI.InstrumentedDummyAdapter:
SharpBCI.EEGDeviceAdapter SharpBCI.DummyAdapter

Public Member Functions

 InstrumentedDummyAdapter (DummyAdapterSignal[] signals, double sampleRate, double signalToNoiseRatio)
 
void StartSignal (int signal)
 Creates the model for generating sample dummy data. More...
 
override void Start ()
 Overwrite of the Start function from EEGDeviceAdapter class. More...
 
override void Stop ()
 Sets isCancelled to true to stop the Run function and joins the thread when complete. More...
 
- Public Member Functions inherited from SharpBCI.EEGDeviceAdapter
delegate void DataHandler (EEGEvent evt)
 
void AddHandler (EEGDataType type, DataHandler handler)
 Use this function to add a handler function that is called for each EEGEvent of the specified EEGDataType. More...
 
void RemoveHandler (EEGDataType type, DataHandler handler)
 Use this function to remove a handler that has been added with the AddHandler function. More...
 
void FlushEvents ()
 Thread safe function that removes events from the event queue and calls FlushEvent (without a s) on each event to send data through pipelines. More...
 

Public Attributes

const int SAMPLE_LENGTH = 256 * 10
 
- Public Attributes inherited from SharpBCI.EEGDeviceAdapter
readonly int channels
 Number of channels or sensors collecting data from. More...
 
readonly double sampleRate
 The rate per second that data is expected to be received. More...
 

Additional Inherited Members

- Protected Member Functions inherited from SharpBCI.EEGDeviceAdapter
 EEGDeviceAdapter (int channels, double sampleRate)
 
void EmitData (EEGEvent evt)
 Puts EEGEvents into the eventQueue to wait; events are flushed and handlers operate on the events. More...
 

Detailed Description

An EEGDeviceAdapter which is used to emit a certain set of signals via StartSignal.

Generally used for smoke-testing / debugging your SharpBCI pipeline. The primarily used is for smoke-testing / debugging IPredictorPipeable implementations, but can be used for other applications.

Constructor & Destructor Documentation

SharpBCI.InstrumentedDummyAdapter.InstrumentedDummyAdapter ( DummyAdapterSignal[]  signals,
double  sampleRate,
double  signalToNoiseRatio 
)

Member Function Documentation

override void SharpBCI.InstrumentedDummyAdapter.Start ( )
virtual

Overwrite of the Start function from EEGDeviceAdapter class.

Creates a new thread to run the Run function.

Implements SharpBCI.EEGDeviceAdapter.

void SharpBCI.InstrumentedDummyAdapter.StartSignal ( int  signal)

Creates the model for generating sample dummy data.

override void SharpBCI.InstrumentedDummyAdapter.Stop ( )
virtual

Sets isCancelled to true to stop the Run function and joins the thread when complete.

Implements SharpBCI.EEGDeviceAdapter.

Member Data Documentation

const int SharpBCI.InstrumentedDummyAdapter.SAMPLE_LENGTH = 256 * 10

The documentation for this class was generated from the following file: