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

Classes
class	ChannelCollection

Public Member Functions
final String	getName ()

final void	setName (String value)

final BioPotentialTermination	getTermination ()

final void	setTermination (BioPotentialTermination value)

final boolean	getPatientGroundDriven ()

final void	setPatientGroundDriven (boolean value)

final boolean	getPerformLeadOffDetection ()

final void	setPerformLeadOffDetection (boolean value)

final int	getSampleRate ()

final void	setSampleRate (int value)

final List< ChannelConfiguration >	getChannels ()

final void	setChannels (List< ChannelConfiguration > value)

final Collection< BioPotentialChannelConfiguration >	getBioPotentialChannels ()

final EventMarkerChannelConfiguration	getEventMarkerChannel ()

void	setEventMarkerChannelConfiguration (EventMarkerChannelConfiguration value)

final MemsChannelConfiguration	getMemsChannel ()

final void	setMemsChannel (MemsChannelConfiguration value)

final ChannelConfiguration []	getExternalSensors ()

final void	setExternalSensors (ChannelConfiguration[] value)

void	addExternalSensor (ChannelConfiguration channel)

void	addBioPotentialChannelConfiguration (BioPotentialChannelConfiguration channel)

final TempExternalSensor	getDummySensors ()

final void	setDummySensors (TempExternalSensor value)

	BioRadioConfiguration ()

	BioRadioConfiguration (boolean prePopulate)

	BioRadioConfiguration (byte[] array) throws IOException

final byte []	toGlobalConfigByteArray () throws IOException

boolean	equals (Object obj)

int	hashCode ()

final Object	clone ()

final void	readXml (StringReader reader) throws IOException

final void	writeXml (StringWriter writer) throws IOException

Static Public Attributes
static final int	MaxNameLength = 16

Detailed Description

The BioRadioConfiguration class encapsulates all settings that can be defined and programmed for the BioRadio.

Constructor & Destructor Documentation

◆ BioRadioConfiguration() [1/3]

com.glneurotech.devices.bioradio.configuration.BioRadioConfiguration.BioRadioConfiguration ( )

Default constructor

◆ BioRadioConfiguration() [2/3]

com.glneurotech.devices.bioradio.configuration.BioRadioConfiguration.BioRadioConfiguration ( boolean prePopulate )

Constructor initializes a new, pre-populated BioRadioConfiguration

◆ BioRadioConfiguration() [3/3]

com.glneurotech.devices.bioradio.configuration.BioRadioConfiguration.BioRadioConfiguration ( byte [] array ) throws IOException

Constructor initializes configuration with data in byte array.

See also: toGlobalConfigByteArray />

Parameters

array Take a byte array as parameter.

Exceptions

IOException

Member Function Documentation

◆ addBioPotentialChannelConfiguration()

void com.glneurotech.devices.bioradio.configuration.BioRadioConfiguration.addBioPotentialChannelConfiguration ( BioPotentialChannelConfiguration channel )

Adds a BioPotentialChannelConfiguration to the collection of biopotential sensors for this configuration

Parameters

channel Take a BioPotentialChannelConfiguration as parameter.

◆ addExternalSensor()

void com.glneurotech.devices.bioradio.configuration.BioRadioConfiguration.addExternalSensor ( ChannelConfiguration channel )

Adds an external sensor to the array of external sensors for this configuration.

Parameters

channel Take a ChannelConfiguration as parameter.

◆ clone()

final Object com.glneurotech.devices.bioradio.configuration.BioRadioConfiguration.clone ( )

Creates a "copy" of this object, and returns the new instance

Returns: Object

◆ equals()

boolean com.glneurotech.devices.bioradio.configuration.BioRadioConfiguration.equals ( Object obj )

Performs a logical comparison of this object versus the passed object

Parameters

obj	Take an object as parameter.

Returns: boolean

◆ getBioPotentialChannels()

final Collection<BioPotentialChannelConfiguration> com.glneurotech.devices.bioradio.configuration.BioRadioConfiguration.getBioPotentialChannels ( )

Gets the collection of BioPotential Channel definitions

Returns: Collection<BioPotentialChannelConfiguration>

◆ getChannels()

final List<ChannelConfiguration> com.glneurotech.devices.bioradio.configuration.BioRadioConfiguration.getChannels ( )

Gets the collection of channel configurations

Returns: List<ChannelConfiguration>

◆ getDummySensors()

final TempExternalSensor com.glneurotech.devices.bioradio.configuration.BioRadioConfiguration.getDummySensors ( )

Gets the collection of external sensors for this configuration. For serialization use only.

Returns: TempExternalSensor

◆ getEventMarkerChannel()

final EventMarkerChannelConfiguration com.glneurotech.devices.bioradio.configuration.BioRadioConfiguration.getEventMarkerChannel ( )

Gets the configuration of the Event Marker channel for the device.

Returns: EventMarkerChannelConfiguration

◆ getExternalSensors()

final ChannelConfiguration [] com.glneurotech.devices.bioradio.configuration.BioRadioConfiguration.getExternalSensors ( )

Gets the array of external sensors for this configuration.

Returns: ChannelConfiguration[]

◆ getMemsChannel()

final MemsChannelConfiguration com.glneurotech.devices.bioradio.configuration.BioRadioConfiguration.getMemsChannel ( )

Gets the configuration of the Mems sensor for the device.

Returns: MemsChannelConfiguration

◆ getName()

final String com.glneurotech.devices.bioradio.configuration.BioRadioConfiguration.getName ( )

Gets the name of this configuration. The BioRadio can accept up to 16 ASCII characters.

Returns: String

◆ getPatientGroundDriven()

final boolean com.glneurotech.devices.bioradio.configuration.BioRadioConfiguration.getPatientGroundDriven ( )

Specifies whether the device is patient ground driven.

Returns: boolean

◆ getPerformLeadOffDetection()

final boolean com.glneurotech.devices.bioradio.configuration.BioRadioConfiguration.getPerformLeadOffDetection ( )

Determines whether the device performs lead-off detection.

Lead off detection will cause any unconnected biopotential channels to blink if they are configured for data collection. This will give the user an indication as to whether a proper connection has been established.

Returns: boolean

◆ getSampleRate()

final int com.glneurotech.devices.bioradio.configuration.BioRadioConfiguration.getSampleRate ( )

The sampling rate applied to the BioPotential channels. This value is in Hz

Returns: int

◆ getTermination()

final BioPotentialTermination com.glneurotech.devices.bioradio.configuration.BioRadioConfiguration.getTermination ( )

Specifies whether the BioRadio is configured for single-ended or differential biopotential inputs

Returns: BioPotentialTermination

◆ hashCode()

int com.glneurotech.devices.bioradio.configuration.BioRadioConfiguration.hashCode ( )

Gets a consistent hashcode based on the contents of this object

Returns: int

◆ readXml()

final void com.glneurotech.devices.bioradio.configuration.BioRadioConfiguration.readXml ( StringReader reader ) throws IOException

Reads the BioRadioConfiguration class as XML.

Parameters

reader Take a StringReader as parameter.

Exceptions

IOException

◆ setChannels()

final void com.glneurotech.devices.bioradio.configuration.BioRadioConfiguration.setChannels ( List< ChannelConfiguration > value )

Sets the collection of channel configurations

Parameters

value Take a list of ChannelConfiguration as value.

◆ setDummySensors()

final void com.glneurotech.devices.bioradio.configuration.BioRadioConfiguration.setDummySensors ( TempExternalSensor value )

Sets the collection of external sensors for this configuration. For serialization use only.

Parameters

value Take a TempExternalSensor as parameter.

◆ setEventMarkerChannelConfiguration()

void com.glneurotech.devices.bioradio.configuration.BioRadioConfiguration.setEventMarkerChannelConfiguration ( EventMarkerChannelConfiguration value )

Sets the configuration of the Event Marker channel for the device.

Parameters

value Take a EventMarkerChannelConfiguration as parameter.

◆ setExternalSensors()

final void com.glneurotech.devices.bioradio.configuration.BioRadioConfiguration.setExternalSensors ( ChannelConfiguration [] value )

Sets the array of external sensors for this configuration.

Parameters

value Take a ChannelConfiguration array as parameter.

◆ setMemsChannel()

final void com.glneurotech.devices.bioradio.configuration.BioRadioConfiguration.setMemsChannel ( MemsChannelConfiguration value )

Sets the configuration of the Mems sensor for the device.

Parameters

value Take a MemsChannelConfiguration as parameter.

◆ setName()

final void com.glneurotech.devices.bioradio.configuration.BioRadioConfiguration.setName ( String value )

Sets the name of this configuration. The BioRadio can accept up to 16 ASCII characters.

Parameters

value Take a string value for the configuration name.

◆ setPatientGroundDriven()

final void com.glneurotech.devices.bioradio.configuration.BioRadioConfiguration.setPatientGroundDriven ( boolean value )

Specifies whether the device is patient ground driven.

Parameters

value

◆ setPerformLeadOffDetection()

final void com.glneurotech.devices.bioradio.configuration.BioRadioConfiguration.setPerformLeadOffDetection ( boolean value )

Determines whether the device performs lead-off detection.

Lead off detection will cause any unconnected biopotential channels to blink if they are configured for data collection. This will give the user an indication as to whether a proper connection has been established.

Parameters

value Take a boolean value as parameter.

◆ setSampleRate()

final void com.glneurotech.devices.bioradio.configuration.BioRadioConfiguration.setSampleRate ( int value )

The sampling rate applied to the BioPotential channels. This value is in Hz

Parameters

value Take an integer value for the sample rate in Hz.

◆ setTermination()

final void com.glneurotech.devices.bioradio.configuration.BioRadioConfiguration.setTermination ( BioPotentialTermination value )

Specifies whether the BioRadio is configured for single-ended or differential biopotential inputs

Parameters

value take a BioPotentialTermination value as parameter.

◆ toGlobalConfigByteArray()

final byte [] com.glneurotech.devices.bioradio.configuration.BioRadioConfiguration.toGlobalConfigByteArray ( ) throws IOException

Gets byte array representing this configuration.

See also: BioRadioConfiguration(byte[] array)

Returns: byte[]

Exceptions

IOException

◆ writeXml()

final void com.glneurotech.devices.bioradio.configuration.BioRadioConfiguration.writeXml ( StringWriter writer ) throws IOException

Writes the BioRadioConfiguration class as XML.

Parameters

writer Take a StringWriter as parameter.

Exceptions

IOException

Member Data Documentation

◆ MaxNameLength

final int com.glneurotech.devices.bioradio.configuration.BioRadioConfiguration.MaxNameLength = 16

static

Maximum number of characters for radio name

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

BioRadioApi/src/main/java/com/glneurotech/devices/bioradio/configuration/BioRadioConfiguration.java

Classes

Public Member Functions

Static Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ BioRadioConfiguration() [1/3]

◆ BioRadioConfiguration() [2/3]

◆ BioRadioConfiguration() [3/3]

Member Function Documentation

◆ addBioPotentialChannelConfiguration()

◆ addExternalSensor()

◆ clone()

◆ equals()

◆ getBioPotentialChannels()

◆ getChannels()

◆ getDummySensors()

◆ getEventMarkerChannel()

◆ getExternalSensors()

◆ getMemsChannel()

◆ getName()

◆ getPatientGroundDriven()

◆ getPerformLeadOffDetection()

◆ getSampleRate()

◆ getTermination()

◆ hashCode()

◆ readXml()

◆ setChannels()

◆ setDummySensors()

◆ setEventMarkerChannelConfiguration()

◆ setExternalSensors()

◆ setMemsChannel()

◆ setName()

◆ setPatientGroundDriven()

◆ setPerformLeadOffDetection()

◆ setSampleRate()

◆ setTermination()

◆ toGlobalConfigByteArray()

◆ writeXml()

Member Data Documentation

◆ MaxNameLength