Programming Reference:States - Revision history

Mellinger: /* See also */

2011-04-28T15:34:17Z

Mellinger: /* Properties */

2010-06-29T15:44:22Z

Properties

← Older revision		Revision as of 15:44, 29 June 2010
Line 72:		Line 72:
	====int Samples (r)====		====int Samples (r)====
	The number of samples contained in the state vector.		The number of samples contained in the state vector.
			====int Length (r)====
			The state vector's length, in bytes.
			====StateList (r)====
			The <tt>StateList</tt> object specified when creating the <tt>StateVector</tt> object.
			====int StateValue( string name, int sample = 0 )====
			The value of the specified state inside the state vector, at the specified sample position. In the online system, sample position may refer to [0..sample block size]; when using the [[Programming Reference:BCI2000FileReader Class\|BCI2000FileReader Class]] to access data from a file, sample position must always be 0.

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

Mellinger: /* Methods */

2010-06-29T15:37:57Z

Methods

← Older revision		Revision as of 15:37, 29 June 2010
Line 58:		Line 58:
	==StateVector Class==		==StateVector Class==
	===Methods===		===Methods===
			====StateVector( StateList, int numSamples = 1 )====
			Creates a <tt>StateVector</tt> object from the given <tt>StateList</tt>, with the specified number of samples. Typically, the number of samples in a <tt>StateVector</tt> matches the system's sample block size in the online system, and is 1 when accessing data files via the [[Programming Reference:BCI2000FileReader Class\|BCI2000FileReader Class]].
	====PostStateChange( string name, int value )====		====PostStateChange( string name, int value )====
	Post a state change by buffering the new value in the associated <tt>State</tt> object's '''Value''' property.		Post a state change by buffering the new value in the associated <tt>State</tt> object's '''Value''' property.

Mellinger: /* Properties */

2010-06-29T15:34:23Z

Properties

← Older revision		Revision as of 15:34, 29 June 2010
Line 68:		Line 68:

	===Properties===		===Properties===
			====int Samples (r)====
			The number of samples contained in the state vector.

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

Mellinger: /* Methods */

2010-06-29T15:32:10Z

Methods

← Older revision		Revision as of 15:32, 29 June 2010
Line 58:		Line 58:
	==StateVector Class==		==StateVector Class==
	===Methods===		===Methods===
			====PostStateChange( string name, int value )====
			Post a state change by buffering the new value in the associated <tt>State</tt> object's '''Value''' property.
			====CommitStateChanges()====
			Commits all buffered state changes to the state vector.
			====ostream WriteToStream( ostream ), istream ReadFromStream( istream )====
			Writes/reads the entire parameter list to/from a stream in human readable format.
			====ostream WriteBinary( ostream ), istream ReadBinary( istream )====
			Writes/reads the entire parameter list to/from a BCI2000 binary stream (such as used for communication between modules).

	===Properties===		===Properties===

Mellinger: /* Add( string stateDefinition ) */

2010-06-29T15:25:54Z

Add( string stateDefinition )

← Older revision		Revision as of 15:25, 29 June 2010
Line 39:		Line 39:
	Adds the given <tt>State</tt> object to the list.		Adds the given <tt>State</tt> object to the list.
	====Add( string stateDefinition )====		====Add( string stateDefinition )====
	Creates a <tt>State</tt> object from the specified [[Technical Reference:State Definition\|~~Parameter~~ Definition]], and adds it to the list.		Creates a <tt>State</tt> object from the specified [[Technical Reference:State Definition\|State Definition]], and adds it to the list.

	====Delete( string name )====		====Delete( string name )====
	Deletes the <tt>State</tt> object with the specified name from the list.		Deletes the <tt>State</tt> object with the specified name from the list.

Mellinger: /* StateList Class */

2010-06-29T15:25:34Z

StateList Class

@@ Line 24: / Line 24: @@
 ==StateList Class==
 ===Methods===
 ===Properties===
 ==StateVector Class==

Mellinger: /* Properties */

2010-06-29T15:17:15Z

Properties

← Older revision		Revision as of 15:17, 29 June 2010
Line 13:		Line 13:

	===Properties===		===Properties===
			====string Name (r)====
			The state's name.
			====int Location (r)====
			The state's location in the state vector.
			====int Length (r)====
			The state's length in bits.
			====int Value (w)====
			The state's value. Write-only to avoid confusion with the state's value in the associated <tt>StateVector</tt> object.

	==StateList Class==		==StateList Class==

Mellinger: /* Methods */

2010-06-29T15:14:11Z

Methods

← Older revision		Revision as of 15:14, 29 June 2010
Line 3:		Line 3:
	==State Class==		==State Class==
	===Methods===		===Methods===
			====bool operator==( State ), bool operator!=( State )====
			Tests two <tt>State</tt> objects for equality.
			====State AssignValue( State )====
			Assigns the value of the specified <tt>State</tt> object.
			====ostream WriteToStream( ostream ), istream ReadFromStream( istream )====
			Writes/reads the <tt>Param</tt> object to/from a stream in human readable format.
			====ostream WriteBinary( ostream ), istream ReadBinary( istream )====
			Writes/reads the <tt>Param</tt> object to/from a BCI2000 binary stream (such as the streams connecting BCI2000 modules).

	===Properties===		===Properties===

Mellinger at 15:09, 29 June 2010

2010-06-29T15:09:33Z

New page

In BCI2000, states have the function of event markers. <tt>State</tt> objects are grouped into <tt>StateList</tt>s, and their values are transported in a global <tt>StateVector</tt> object. This page lists the methods and properties of <tt>State</tt>, <tt>StateList</tt>, and <tt>StateVector</tt> classes; for a general discussion of the state concept in BCI2000, see the [[Technical Reference:State Definition|State Definition page]].

==State Class==
===Methods===
===Properties===

==StateList Class==
===Methods===
===Properties===

==StateVector Class==
===Methods===
===Properties===

==See also==
[[Technical Reference:State Definition]]

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

← Older revision		Revision as of 15:34, 28 April 2011
Line 80:		Line 80:

	==See also==		==See also==
	[[Technical Reference:State Definition]]		[[Technical Reference:State Definition]], [[Programming Reference:Accessing Parameters and States]]

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