com.glneurotech.devices.bioradio.configuration.ChannelConfiguration Class Reference

Inheritance diagram for com.glneurotech.devices.bioradio.configuration.ChannelConfiguration:

Public Member Functions
abstract ChannelTypeCode	getTypeCode ()
final String	getChannelType ()
final int	getChannelIndex ()
final void	setChannelIndex (int value)
final String	getName ()
final void	setName (String value)
final boolean	getEnabled ()
final void	setEnabled (boolean value)
final boolean	getSaved ()
final void	setSaved (boolean value)
final boolean	getStreamed ()
final void	setStreamed (boolean value)
final int	getPresetCode ()
final void	setPresetCode (int value)
final boolean	getConnected ()
final void	setConnected (boolean value)
	ChannelConfiguration ()
byte []	getBytes () throws IOException
boolean	equals (Object obj)
int	hashCode ()
final void	assignFrom (Object channelConfig)
final int	getExternalSensorPodId ()

Static Public Attributes
static final int	CustomParametersStartIndex = 35
static final int	MaxChannelNameLength = 30

Protected Member Functions
	ChannelConfiguration (byte[] bytes) throws IOException

Detailed Description

This class describes all settings that apply across all device channels.

Constructor & Destructor Documentation

ChannelConfiguration() [1/2]

com.glneurotech.devices.bioradio.configuration.ChannelConfiguration.ChannelConfiguration

(

)

Default constructor

ChannelConfiguration() [2/2]

com.glneurotech.devices.bioradio.configuration.ChannelConfiguration.ChannelConfiguration ( byte []  bytes ) throws IOException

protected

Constructor initializes the configuration with the passed byte array

Parameters

bytes

Take a byte array as parameter.

Exceptions

IOException

See also

getBytes()

Member Function Documentation

assignFrom()

final void com.glneurotech.devices.bioradio.configuration.ChannelConfiguration.assignFrom

(

Object

channelConfig

)

Copies the contents from the passed object into this object

Parameters

channelConfig

Take an object as parameter.

equals()

boolean com.glneurotech.devices.bioradio.configuration.ChannelConfiguration.equals

(

Object

obj

)

Provides a logical comparison of this object versus the passed object

Parameters

obj	Take an object as parameter.

Returns

boolean

getBytes()

byte [] com.glneurotech.devices.bioradio.configuration.ChannelConfiguration.getBytes

(

)

throws IOException

Gets the byte array that defines this configuration

Returns

byte[]

Exceptions

IOException

See also

ChannelConfiguration(byte[] array)

getChannelIndex()

final int com.glneurotech.devices.bioradio.configuration.ChannelConfiguration.getChannelIndex

(

)

Gets the one-based channel ID that corresponds to the channel label on the device.

Returns

int

getChannelType()

final String com.glneurotech.devices.bioradio.configuration.ChannelConfiguration.getChannelType

(

)

A text label to describe the type of channel

Returns

String

getConnected()

final boolean com.glneurotech.devices.bioradio.configuration.ChannelConfiguration.getConnected

(

)

Indicates whether this channel is connected. This is a read-only property.

Returns

boolean

getEnabled()

final boolean com.glneurotech.devices.bioradio.configuration.ChannelConfiguration.getEnabled

(

)

Indicates whether this channel is enabled. If true, data will be acquired on this channel. Otherwise, no data will be acquired.

Returns

boolean

getExternalSensorPodId()

final int com.glneurotech.devices.bioradio.configuration.ChannelConfiguration.getExternalSensorPodId

(

)

Gets the sensor pod id based on this objects channel index

Returns

int

Exceptions

IndexOutOfBoundsException

"The channel index i is not contained within an external sensor pod."

getName()

final String com.glneurotech.devices.bioradio.configuration.ChannelConfiguration.getName

(

)

Gets the name associated with this channel. Names cannot exceed 30 characters.

Returns

String

getPresetCode()

final int com.glneurotech.devices.bioradio.configuration.ChannelConfiguration.getPresetCode

(

)

Gets the code to indicate an application-specific use for this channel.

Returns

int

getSaved()

final boolean com.glneurotech.devices.bioradio.configuration.ChannelConfiguration.getSaved

(

)

Indicates whether this channel will be saved to internal device memory when acquiring.

Returns

boolean

getStreamed()

final boolean com.glneurotech.devices.bioradio.configuration.ChannelConfiguration.getStreamed

(

)

Indicates whether channel data will be wirelessly streamed to a connected client when acquisition is started.

Returns

boolean

getTypeCode()

abstract ChannelTypeCode com.glneurotech.devices.bioradio.configuration.ChannelConfiguration.getTypeCode ( )

abstract

Gets the type code for the specific channel type

Returns

ChannelTypeCode

hashCode()

int com.glneurotech.devices.bioradio.configuration.ChannelConfiguration.hashCode

(

)

Gets a consistent hashcode based on the contents of this object

Returns

int

setChannelIndex()

final void com.glneurotech.devices.bioradio.configuration.ChannelConfiguration.setChannelIndex

(

int

value

)

Sets the one-based channel ID that corresponds to the channel label on the device.

Parameters

value

Take an integer as parameter.

setConnected()

final void com.glneurotech.devices.bioradio.configuration.ChannelConfiguration.setConnected

(

boolean

value

)

Indicates whether this channel is connected. For internal use only.

Parameters

value

Take a boolean value as parameter.

setEnabled()

final void com.glneurotech.devices.bioradio.configuration.ChannelConfiguration.setEnabled

(

boolean

value

)

Indicates whether this channel is enabled. If true, data will be acquired on this channel. Otherwise, no data will be acquired.

Parameters

value

Take a boolean value as parameter.

setName()

final void com.glneurotech.devices.bioradio.configuration.ChannelConfiguration.setName

(

String

value

)

Sets the name associated with this channel. Names cannot exceed 30 characters.

Parameters

value

Take a string as parameter for the channel name

setPresetCode()

final void com.glneurotech.devices.bioradio.configuration.ChannelConfiguration.setPresetCode

(

int

value

)

Gets the code to indicate an application-specific use for this channel.

Parameters

value

Take an integer as parameter.

setSaved()

final void com.glneurotech.devices.bioradio.configuration.ChannelConfiguration.setSaved

(

boolean

value

)

Indicates whether this channel will be saved to internal device memory when acquiring.

Parameters

value

Take a boolean value as parameter.

setStreamed()

final void com.glneurotech.devices.bioradio.configuration.ChannelConfiguration.setStreamed

(

boolean

value

)

Indicates whether channel data will be wirelessly streamed to a connected client when acquisition is started.

Parameters

value

Take a boolean value as parameter.

Member Data Documentation

CustomParametersStartIndex

final int com.glneurotech.devices.bioradio.configuration.ChannelConfiguration.CustomParametersStartIndex = 35

static

Starting location in the byte array of a channel configuration for the channel's custom parameters

MaxChannelNameLength

final int com.glneurotech.devices.bioradio.configuration.ChannelConfiguration.MaxChannelNameLength = 30

static

Maximum number of characters for the name of a channel

---

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

• BioRadioApi/src/main/java/com/glneurotech/devices/bioradio/configuration/ChannelConfiguration.java