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

Class HeatmapDefinition

  • public class HeatmapDefinition
extends java.lang.Object
    A Heatmap Definition defines a float value that can be displayed in a heatmap or a colored signal measurement

    • Field Summary

      Fields 
      Modifier and Type Field Description
      java.lang.String DisplayFormat
      A Java-style format string for display purposes - for instance "%.2f dBm" to display a dBm measurement to two decimal places (-76.25 dBm)
      java.lang.String DisplayName
      The string to use when displaying this signal in NEON Signal Mapper and Command, such as "Channel Power"
      java.lang.String ExportFormat
      A Java-style format string for CSV export purposes - for instance "%.2f" to display a dBm measurement to two decimal places (-76.25)
      java.lang.String FieldName
      The name of this value, which should be unique in the signal, such as "ChannelPower"
      boolean LocateSources
      If set to true, NEON Command will attempt to use heatmaps to localize the source of this signal.
      float Max
      The maximum value that this measurement will contain
      float Min
      The minimum value that this measurement will contain
      int SortIndex
      Indicates where this value should be listed relative to other details of the signal
      float Threshold
      A threshold value between min and max that can be used as a default level to define a "good" signal for grid testing
      java.lang.String Units
      The unit of measurement, "dBm" for example

    • Constructor Summary

      Constructors 
      Constructor Description
      HeatmapDefinition​(java.lang.String fieldName, java.lang.String displayName, java.lang.String displayFormat, java.lang.String exportFormat, java.lang.String units, float min, float max, float threshold, boolean locateSources, int sortIndex)
      This is used by the signal measurement builder Use the SignalMeasurementBuilder instead

    • Method Summary

      • Methods inherited from class java.lang.Object

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

    • Field Detail

      • FieldName

        public java.lang.String FieldName
        The name of this value, which should be unique in the signal, such as "ChannelPower"

      • DisplayName

        public java.lang.String DisplayName
        The string to use when displaying this signal in NEON Signal Mapper and Command, such as "Channel Power"

      • DisplayFormat

        public java.lang.String DisplayFormat
        A Java-style format string for display purposes - for instance "%.2f dBm" to display a dBm measurement to two decimal places (-76.25 dBm)

      • ExportFormat

        public java.lang.String ExportFormat
        A Java-style format string for CSV export purposes - for instance "%.2f" to display a dBm measurement to two decimal places (-76.25)

      • Units

        public java.lang.String Units
        The unit of measurement, "dBm" for example

      • Min

        public float Min
        The minimum value that this measurement will contain

      • Max

        public float Max
        The maximum value that this measurement will contain

      • Threshold

        public float Threshold
        A threshold value between min and max that can be used as a default level to define a "good" signal for grid testing

      • LocateSources

        public boolean LocateSources
        If set to true, NEON Command will attempt to use heatmaps to localize the source of this signal. This should only be used for local sources such as iBeacons or Wi-Fi access points for good results

      • SortIndex

        public int SortIndex
        Indicates where this value should be listed relative to other details of the signal

    • Constructor Detail

      • HeatmapDefinition

        public HeatmapDefinition​(java.lang.String fieldName,
                         java.lang.String displayName,
                         java.lang.String displayFormat,
                         java.lang.String exportFormat,
                         java.lang.String units,
                         float min,
                         float max,
                         float threshold,
                         boolean locateSources,
                         int sortIndex)
        This is used by the signal measurement builder Use the SignalMeasurementBuilder instead
        See Also:
        SignalMeasurementBuilder