Programming Reference:SignalSharingDemoClient C++ App - Revision history

Mellinger: /* See also */

2026-03-12T15:36:56Z

2024-10-22T18:44:13Z

Synopsis

← Older revision		Revision as of 18:44, 22 October 2024
Line 5:		Line 5:
	The ''SignalSharingDemo'' client demonstrates how to receive signal data from BCI2000, using shared memory.		The ''SignalSharingDemo'' client demonstrates how to receive signal data from BCI2000, using shared memory.
	SignalSharing allows to tap into BCI2000 processing by receiving any filter output signal through a combination of a TCP connection, and shared memory.		SignalSharing allows to tap into BCI2000 processing by receiving any filter output signal through a combination of a TCP connection, and shared memory.

			For clarity, this page describes a simplified version of the ''SignalSharingDemo'' client, receiving only signal data, and not using the back channel to send back signal and state data. The full version in SVN shows how to use the full possibilities available to a SignalSharing client.

	==Function==		==Function==

2024-10-15T14:59:49Z

Receiving thread function

← Older revision		Revision as of 14:59, 15 October 2024
Line 85:		Line 85:
	bool OnVisSignalProperties(std::istream&) override;		bool OnVisSignalProperties(std::istream&) override;
	bool OnVisSignal(std::istream&) override;		bool OnVisSignal(std::istream&) override;
			bool OnParam(std::istream&) override;
	};		};

Line 129:		Line 130:
	visSignal.Unserialize(is);		visSignal.Unserialize(is);
	mpSignal.Mutable()->AssignValues(visSignal.Signal()); // get current signal content		mpSignal.Mutable()->AssignValues(visSignal.Signal()); // get current signal content
			Invalidate(); // request window update
			return true; // indicate we read our data from the stream
			}

			bool SignalSharingDemoWidget::Private::OnParam(std::istream& is)
			{
			Param param;
			param.Unserialize(is);
			mpParamList.Mutable()->Add(param);
	Invalidate(); // request window update		Invalidate(); // request window update
	return true; // indicate we read our data from the stream		return true; // indicate we read our data from the stream

2024-10-15T14:57:34Z

Declaration of internal variables

← Older revision		Revision as of 14:57, 15 October 2024
Line 37:		Line 37:
	#include "Thread.h"		#include "Thread.h"
	#include "GenericSignal.h"		#include "GenericSignal.h"
			#include "ParamList.h"
	#include "Synchronized.h"		#include "Synchronized.h"
	#include "Runnable.h"		#include "Runnable.h"
Line 51:		Line 52:
	Synchronized<bool> mConnected;		Synchronized<bool> mConnected;
	SynchronizedObject<GenericSignal> mpSignal;		SynchronizedObject<GenericSignal> mpSignal;
			SynchronizedObject<ParamList> mpParameters;

	Thread mThread;		Thread mThread;

2024-08-02T13:34:46Z

ShareTransmissionFilter

← Older revision		Revision as of 13:34, 2 August 2024
Line 161:		Line 161:
	IP address and port number of the client application. The client's default address is <tt>localhost:1879</tt> but may be changed on the client's command line.		IP address and port number of the client application. The client's default address is <tt>localhost:1879</tt> but may be changed on the client's command line.

	The example uses the ShareTransmissionFilter parameter but any other filter's Share<FilterName> parameter under the SignalSharing tab will work as well to visualize the chosen filter's output signal.		The example uses the ''ShareTransmissionFilter'' parameter but any other filter's ''Share<FilterName>'' parameter under the ''SignalSharing'' tab will work as well to visualize the chosen filter's output signal.

	==See also==		==See also==

2024-08-02T13:33:39Z

← Older revision		Revision as of 13:33, 2 August 2024
(No difference)

2024-08-02T13:31:49Z

SignalSharingDemoClientAddress

← Older revision		Revision as of 13:31, 2 August 2024
Line 158:		Line 158:

	==Parameters==		==Parameters==
	===~~SignalSharingDemoClientAddress~~===		===ShareTransmissionFilter===
	IP address and port number of the client application.		IP address and port number of the client application. The client's default address is <tt>localhost:1879</tt> but may be changed on the client's command line.

			The example uses the ShareTransmissionFilter parameter but any other filter's Share<FilterName> parameter under the SignalSharing tab will work as well to visualize the chosen filter's output signal.

	==See also==		==See also==

2024-08-02T13:24:23Z

Client application code

← Older revision		Revision as of 13:24, 2 August 2024
Line 24:		Line 24:
	in your CMake file if it is part of the BCI2000 project.		in your CMake file if it is part of the BCI2000 project.

	Otherwise, you might to have to create code for dealing with BCI2000 messages yourself (definitions may be found		Otherwise, you might to have to create code for dealing with BCI2000 messages yourself (message format definitions may be found
	[[Technical_Reference:BCI2000_Messages#Descriptor_Supplement=3:_Signal_Properties\|here]] and		[[Technical_Reference:BCI2000_Messages#Descriptor_Supplement=3:_Signal_Properties\|here]] and
	[[Technical_Reference:BCI2000_Messages#Descriptor_Supplement=1:_Signal_Data\|here]]).		[[Technical_Reference:BCI2000_Messages#Descriptor_Supplement=1:_Signal_Data\|here]]).

2024-08-02T13:24:03Z

Client application code

← Older revision		Revision as of 13:24, 2 August 2024
Line 19:		Line 19:

	==Client application code==		==Client application code==
			The client application uses parts of the BCI2000 framework to efficiently receive and decode BCI2000 messages.
			To include it into your own project, use
			utils_include(Frameworks/Core)
			in your CMake file if it is part of the BCI2000 project.

			Otherwise, you might to have to create code for dealing with BCI2000 messages yourself (definitions may be found
			[[Technical_Reference:BCI2000_Messages#Descriptor_Supplement=3:_Signal_Properties\|here]] and
			[[Technical_Reference:BCI2000_Messages#Descriptor_Supplement=1:_Signal_Data\|here]]).

	===Declaration of internal variables===		===Declaration of internal variables===
	<syntaxhighlight lang="cpp">		<syntaxhighlight lang="cpp">

2024-08-02T13:15:48Z

Filter Code

@@ Line 17: / Line 17: @@
 File:SignalSharingDemo2.PNG|Client application displaying data
 </gallery>
 ==Client application code==

← Older revision		Revision as of 15:36, 12 March 2026
Line 178:		Line 178:

	==See also==		==See also==
	[[User Reference:SignalSharing]], [[Programming Reference:GenericSignal Class]], [[Programming Reference:~~SignalSharing Python Demo\|~~SignalSharing Python Demo]]		[[User Reference:SignalSharing]], [[Programming Reference:GenericSignal Class]], [[Programming Reference:SignalSharing Python Demo]], [[Programming Reference:SignalSharingClientLibDemo]]


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