Technical Reference:States of Operation - Revision history

Mellinger: /* System Termination */

2008-10-22T10:41:39Z

System Termination

← Older revision		Revision as of 10:41, 22 October 2008
Line 158:		Line 158:
	==System Termination==		==System Termination==
	To each of the three core modules, the operator module indicates		To each of the three core modules, the operator module indicates
	system termination		regular system termination
	by closing the connection to that module.		by closing the connection to that module.

	~~When~~ a core module loses connection to the two other core modules it		Irregular system termination takes place when a core module loses connection to any of the two other core modules it
	is connected		is connected
	to, it will send an error message to the operator, and then quit.		to.
	The operator module, in turn, will close ~~the~~ connections to the		In this case, it will send an error message to the operator, and then quit.
			The operator module, in turn, will close connections to the
	remaining core		remaining core
	modules.		modules.

	[[Category:Specification]]		[[Category:Specification]]

Mellinger: /* System is Running */

2008-10-22T10:39:51Z

System is Running

← Older revision		Revision as of 10:39, 22 October 2008
Line 144:		Line 144:

	==System is Running==		==System is Running==
	During system operation, the Operator module must send states only to		The system is started when the Operator module sets the special state variable
			''Running''
			to 1 and sends it to the Source module.

			During system operation, the Operator module may modify any state variable by sending
			state messages to the Source module.
			The Operator module must send states only to
	the Source		the Source
	module; Signal Processing and Application must disregard any state		module; Signal Processing and Application must disregard any state
	that the		that the
	Operator does send to them.		Operator does send to them.
	~~The system is started when the Operator module sets the state~~
	~~''Running''~~
	~~to 1 and sends it to the Source module.~~

	==System Termination==		==System Termination==

Mellinger: /* System is Suspended */

2008-10-22T10:37:43Z

System is Suspended

← Older revision		Revision as of 10:37, 22 October 2008
Line 125:		Line 125:
	==System is Suspended==		==System is Suspended==
	At the end of the Initialization Phase, the system is fully		At the end of the Initialization Phase, the system is fully
	configured. All		configured.
	parameters, states, and state vector, are globally		All parameters, states, and state vector, are now defined and available globally.
	~~defined~~.

	The system is ~~suspended while the~~ special ''Running'' state variable is 0.		The system's state is now determined by a special ''Running'' state variable, which is initially set to "0", indicating that the system is suspended.

			As long as operation is suspended, any module might update system parameters and send them back to the Operator.
	Any module shall		Any module shall
	disregard a		disregard a
	change in parameters if the system is ~~not~~ suspended. ~~Data flows~~		change in parameters unless the system is in suspended state.

			While the system is suspended, data may still flow
	through the		through the
	system ~~and it~~ is up to each module to decide how to process these		system.
	data. The		It is up to each module to decide how to process these
	Application, for example, might give visual feedback that indicates		data.
	that the		The Application, for example, might give visual feedback that indicates
	system is suspended~~. As long as operation is suspended (i.e.,~~		that the system is suspended.
	~~''Running''~~
	~~is 0), any module might update system parameters and send them back to~~
	~~the~~
	~~Operator~~.

	==System is Running==		==System is Running==

Mellinger: /* System is Suspended */

2008-10-22T10:29:42Z

System is Suspended

← Older revision		Revision as of 10:29, 22 October 2008
Line 126:		Line 126:
	At the end of the Initialization Phase, the system is fully		At the end of the Initialization Phase, the system is fully
	configured. All		configured. All
	parameters ~~and~~ states (and ~~positions thereof in the~~ state vector) are		parameters, states, and state vector, are globally
	defined.		defined.
	The system is suspended ~~when~~ ''Running'' is 0. Any module shall
			The system is suspended while the special ''Running'' state variable is 0.
			Any module shall
	disregard a		disregard a
	change in parameters if the system is not suspended. Data flows		change in parameters if the system is not suspended. Data flows

Mellinger: /* Information Phase */

2008-10-22T10:26:54Z

Information Phase

← Older revision		Revision as of 10:26, 22 October 2008
Line 84:		Line 84:
	module now		module now
	knows where to connect to.		knows where to connect to.
			Accordingly, each core module opens a client
			connection
			to the core module it must connect to, i.e., Source opens a
			connection to Signal Processing, Signal Processing to Application, and
			Application to Source.

	The connections from core modules to		The connections from core modules to
	the		the
	operator module remain open. All subsequent ~~traffic~~ will go through		operator module remain open. All subsequent core-to-operator communication will go through
	these		these
	connections.		connections.

Mellinger: /* Initialization Phase */

2008-10-22T10:23:45Z

Initialization Phase

← Older revision		Revision as of 10:23, 22 October 2008
Line 109:		Line 109:
	Each core module uses the information in the received parameters to		Each core module uses the information in the received parameters to
	configure and		configure and
	initialize its operation. ~~It also opens an active (i.e., client)~~		initialize its operation.
	~~connection~~		Then, each core module sends a [[Technical Reference:BCI2000 Messages\|status message]]
	~~to the other core module it must connect to, i.e.~~, ~~Source opens a~~
	~~connection to Signal Processing, Signal Processing to Application and~~
	~~Application to Source.~~
	~~Each~~ core module sends a [[Technical Reference:BCI2000 Messages\|status message]]
	to the		to the
	operator that indicates either successful or failed initialization.		operator that indicates either successful or failed initialization.

	The		The
	Initialization Phase ends when all core modules indicate successful		Initialization Phase ends when all core modules indicate successful

Mellinger: /* System Initialization */

2008-10-22T10:22:15Z

System Initialization

← Older revision		Revision as of 10:22, 22 October 2008
Line 103:		Line 103:
	The Signal Processing module, in turn, sends its output signal properties to the Application module.		The Signal Processing module, in turn, sends its output signal properties to the Application module.

	During the preflight phase, modules indicate errors by sending [[status messages]] containing plain-text error ~~messages~~.		During the preflight phase, modules indicate errors by sending [[Technical Reference:BCI2000 Messages\|status messages]] containing plain-text error descriptions.
	If any errors are found during the preflight phase, a module will not initiate its initialization phase. The operator module will display error messages received from core modules, prompting the user to fix the problems detected rather than offering a "Start" option.		If any errors are found during the preflight phase, a module will not initiate its initialization phase. The operator module will display error messages received from core modules, prompting the user to fix the problems detected rather than offering a "Start" option.

Mellinger: /* Preflight Phase */

2008-10-22T10:20:52Z

Preflight Phase

← Older revision		Revision as of 10:20, 22 October 2008
Line 96:		Line 96:

	===Preflight Phase===		===Preflight Phase===
	In the preflight phase, each core module declares to the ~~operator~~ module whether it is able to properly process data using current parameters and states.		In the preflight phase, each core module declares to the Operator module whether it is able to properly process data using current parameters and states.
	In addition, it reports the properties of its output signal to the core module next in the chain.		In addition, it reports the properties of its output signal to the core module next in the chain.

	The ~~operator~~ module opens the preflight phase by sending an empty [[Technical Reference:BCI2000 Messages\|signal properties message]] to the ~~source~~ module.		The Operator module opens the preflight phase by sending an empty [[Technical Reference:BCI2000 Messages\|signal properties message]] to the Source module.
	The ~~source~~ module then reports its output signal properties to the ~~signal processing~~ module by sending it an appropriate signal properties message.		The Source module then reports its output signal properties to the Signal Processing module by sending it an appropriate signal properties message.
	The ~~signal processing~~ module, in turn, sends its output signal properties to the ~~application~~ module.		The Signal Processing module, in turn, sends its output signal properties to the Application module.

	During the preflight phase, modules indicate errors by sending plain-text error messages		During the preflight phase, modules indicate errors by sending [[status messages]] containing plain-text error messages.
	~~into an error channel~~.		If any errors are found during the preflight phase, a module will not initiate its initialization phase. The operator module will display error messages received from core modules, prompting the user to fix the problems detected rather than offering a "Start" option.
	If any errors are ~~indicated~~ during the preflight phase, a module will not initiate its initialization phase. The operator module will display error messages received from core modules, prompting the user to fix the problems detected rather than offering a "Start" option.

	===Initialization Phase===		===Initialization Phase===

Mellinger: /* Preflight Phase */

2008-10-22T10:18:05Z

Preflight Phase

← Older revision		Revision as of 10:18, 22 October 2008
Line 96:		Line 96:

	===Preflight Phase===		===Preflight Phase===
	In the preflight phase, each core module declares whether it ~~can~~ process data ~~with the~~		In the preflight phase, each core module declares to the operator module whether it is able to properly process data using current parameters and states.
	~~received~~ parameters and states, ~~and~~ reports the properties of its output signal.		In addition, it reports the properties of its output signal to the core module next in the chain.

	The operator module opens the preflight phase by sending an empty [[Technical Reference:BCI2000 Messages\|signal properties message]] to the source module.		The operator module opens the preflight phase by sending an empty [[Technical Reference:BCI2000 Messages\|signal properties message]] to the source module.
Line 103:		Line 103:
	The signal processing module, in turn, sends its output signal properties to the application module.		The signal processing module, in turn, sends its output signal properties to the application module.

	During the preflight phase, modules indicate errors by sending ~~descriptions~~		During the preflight phase, modules indicate errors by sending plain-text error messages
	into an error channel.		into an error channel.
	If any errors are indicated during the preflight phase, ~~the~~ module will not initiate ~~the~~ initialization phase~~; the~~ operator module will display ~~the errors~~, prompting the user to fix the problems detected~~, and not offer the~~ "Start" option.		If any errors are indicated during the preflight phase, a module will not initiate its initialization phase. The operator module will display error messages received from core modules, prompting the user to fix the problems detected rather than offering a "Start" option.

	===Initialization Phase===		===Initialization Phase===

Mellinger: /* Information Phase */

2008-10-22T10:13:30Z

Information Phase

← Older revision		Revision as of 10:13, 22 October 2008
Line 77:		Line 77:
	received data from the core modules to send back to all core modules a		received data from the core modules to send back to all core modules a
	list of		list of
	system-wide parameters and system-wide states (in any order).		system-wide parameters and system-wide states, in any order.
	Since ~~the~~ IP		Since IP
	~~address~~ and port ~~number~~ on which the core modules listen for data from		addresses and port numbers on which the core modules listen for data from
	other		other
	core modules are ~~published~~ in system parameters as described, each		core modules are represented in system parameters as described above, each
	module now		module now
	knows where to ~~send its data~~. The connections from ~~the~~ core modules to		knows where to connect to.

			The connections from core modules to
	the		the
	operator module remain open ~~(all~~ subsequent traffic will go through		operator module remain open. All subsequent traffic will go through
	these		these
	connections).		connections.

	As for the publishing phase, the Information Phase ends when a system		As for the publishing phase, the Information Phase ends when a system
	command		command