com.glneurotech.devices.common.SignalGroup Class Reference

Inheritance diagram for com.glneurotech.devices.common.SignalGroup:

Public Member Functions
final Iterator< Signal >	iterator ()
final Signal	get (int index)
final Signal	get (String name)
final void	add (Signal signal)
final int	getCount ()
final long	getSampleInterval ()
final long	getSamplesPerSecond ()
final String	getName ()
final void	setName (String value)
final Iterator	getEnumerator ()
final int	getDataArrivedEventThreshold ()
final void	setDataArrivedEventThreshold (int value)
final void	onDataArrived (SignalDataEventArgs e)
void	fireDataArrivedEvent (Object e)
final void	close () throws IOException

Public Attributes
Event< EventHandler< SignalDataEventArgs > >	SignalDataAvailable = new Event<EventHandler<SignalDataEventArgs>>()

Detailed Description

Represents a logical group of signals from a Great Lakes NeuroTechnologies device.

Signal groups are used to group together signals that share common characteristics, such as sample rates, or physical properties of the device (i.e. multiple signals recorded from a single physical sensor). Signals can be referenced by numerical index or by name.

Member Function Documentation

add()

final void com.glneurotech.devices.common.SignalGroup.add

(

Signal

signal

)

Adds signal.

Parameters

signal

Take a Signal as parameter.

close()

final void com.glneurotech.devices.common.SignalGroup.close

(

)

throws IOException

Dispose a signal.

Exceptions

IOException

fireDataArrivedEvent()

void com.glneurotech.devices.common.SignalGroup.fireDataArrivedEvent

(

Object

e

)

Fire data arrived event.

Parameters

e

get() [1/2]

final Signal com.glneurotech.devices.common.SignalGroup.get

(

int

index

)

Returns a signal referenced by position within the group.

Parameters

index

The zero-based index of the signal to be returned

Returns

get() [2/2]

final Signal com.glneurotech.devices.common.SignalGroup.get

(

String

name

)

Returns a signal referenced by a unique string name.

Parameters

name	The name of the signal to retrieve.

Returns

The signal corresponding to the specified name.

getCount()

final int com.glneurotech.devices.common.SignalGroup.getCount

(

)

Gets the number of signals contained in the SignalGroup

getDataArrivedEventThreshold()

final int com.glneurotech.devices.common.SignalGroup.getDataArrivedEventThreshold

(

)

The number of samples to read before raising the SignalDataAvailable event.

getEnumerator()

final Iterator com.glneurotech.devices.common.SignalGroup.getEnumerator

(

)

Gets the enumerator.

Returns

getName()

final String com.glneurotech.devices.common.SignalGroup.getName

(

)

Gets the name of this Signal Group.

getSampleInterval()

final long com.glneurotech.devices.common.SignalGroup.getSampleInterval

(

)

Gets the interval between sample readings for this Signal Group.

getSamplesPerSecond()

final long com.glneurotech.devices.common.SignalGroup.getSamplesPerSecond

(

)

Gets the number of samples read per second.

onDataArrived()

final void com.glneurotech.devices.common.SignalGroup.onDataArrived

(

SignalDataEventArgs

e

)

On data arrived event.

Parameters

e

setDataArrivedEventThreshold()

final void com.glneurotech.devices.common.SignalGroup.setDataArrivedEventThreshold

(

int

value

)

Sets data arrivel event threshold.

Parameters

value

Take an integer.

setName()

final void com.glneurotech.devices.common.SignalGroup.setName

(

String

value

)

Sets name.

Parameters

value

Take a string value.

Member Data Documentation

SignalDataAvailable

Event<EventHandler<SignalDataEventArgs> > com.glneurotech.devices.common.SignalGroup.SignalDataAvailable = new Event<EventHandler<SignalDataEventArgs>>()

Notifies subscribers that new signal data is available to be read. The frequency at which this event is raised is controlled by DataArrivedEventThreshold

---

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

• GLNeuroTech/src/main/java/com/glneurotech/devices/common/SignalGroup.java