Package com.trx.neon.api.neonMeasurement.model.definitions

Class SignalDefinition

java.lang.Object

com.trx.neon.api.neonMeasurement.model.definitions.SignalDefinition

public class SignalDefinition
extends java.lang.Object

A signal definition provides everything needed for NEON Signal Mapper to display signal information on Android and Neon Command, display signal measurements and heatmaps, and export reports The Signal Key uniquely identifies a signal Identifier Definitions are pieces of information that identify a particular signal source and can be used to separate individual signal types Heatmap Definitions describe measurements that can be displayed in a heatmap and viewed as colored signal dots Display Definitions are additional pieces of information that are displayed with a particular signal measurement

Field Summary

Fields

Modifier and Type	Field	Description
SignalKey	Key	The key that uniquely identifies a signal

Constructor Summary

Constructors

Constructor	Description
SignalDefinition(SignalKey key, java.util.ArrayList<HeatmapDefinition> heatmapDefinitions, java.util.ArrayList<IdentifierDefinition> identifierDefinitions, java.util.ArrayList<DisplayDefinition> displayDefinitions)	This is used by the signal definition builder Use the SignalDefinitionBuilder instead

Method Summary

Modifier and Type	Method	Description
SignalMeasurementBuilder	generateSignalMeasurementBuilder()	Retrieves a Signal Measurement Builder for this Signal Definition In order to generate a signal measurement, you should get the builder from here
java.util.ArrayList<DisplayDefinition>	getDisplay()
java.util.ArrayList<IdentifierDefinition>	getIdentifiers()
java.util.ArrayList<HeatmapDefinition>	getMeasurements()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

Key

public final SignalKey Key

The key that uniquely identifies a signal

See Also:

SignalKey

Constructor Detail

SignalDefinition

public SignalDefinition(SignalKey key,
                        java.util.ArrayList<HeatmapDefinition> heatmapDefinitions,
                        java.util.ArrayList<IdentifierDefinition> identifierDefinitions,
                        java.util.ArrayList<DisplayDefinition> displayDefinitions)

This is used by the signal definition builder Use the SignalDefinitionBuilder instead

See Also:

SignalDefinitionBuilder

Method Detail

generateSignalMeasurementBuilder

public SignalMeasurementBuilder generateSignalMeasurementBuilder()

Retrieves a Signal Measurement Builder for this Signal Definition In order to generate a signal measurement, you should get the builder from here

Returns:

SignalMeasurementBuilder for this Signal Definition

getMeasurements

public java.util.ArrayList<HeatmapDefinition> getMeasurements()

Returns:

The list of heatmap definitions for this signal

getIdentifiers

public java.util.ArrayList<IdentifierDefinition> getIdentifiers()

Returns:

The list of identifier definitions for this signal

getDisplay

public java.util.ArrayList<DisplayDefinition> getDisplay()

Returns:

The list of display definitions for this signal