Programming Reference:States

In BCI2000, states have the function of event markers. State objects are grouped into StateLists, and their values are transported in a global StateVector object. This page lists the methods and properties of State, StateList, and StateVector classes; for a general discussion of the state concept in BCI2000, see the State Definition page.

State Class

Methods

bool operator==( State ), bool operator!=( State )

Tests two State objects for equality.

State AssignValue( State )

Assigns the value of the specified State object.

ostream WriteToStream( ostream ), istream ReadFromStream( istream )

Writes/reads the Param object to/from a stream in human readable format.

ostream WriteBinary( ostream ), istream ReadBinary( istream )

Writes/reads the Param object to/from a BCI2000 binary stream (such as the streams connecting BCI2000 modules).

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 StateVector object.

See also

Technical Reference:State Definition