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

Class IdentifierDefinition

java.lang.Object

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

public class IdentifierDefinition
extends java.lang.Object

An Identifier is a pieces of information that identifies a particular signal source and can be used to separate signals from different sources

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"
DisplayType	DisplayType	The field type of this identifer - currently String, Integer, or Float.
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	SeparateExportFiles	If set to true, CSV export files from command will be separated based on this identifier.
int	SortIndex	Indicates where this value should be listed relative to other details of the signal

Constructor Summary

Constructors

Constructor	Description
IdentifierDefinition(java.lang.String fieldName, java.lang.String displayName, java.lang.String displayFormat, java.lang.String exportFormat, boolean separateExportFiles, DisplayType displayType, 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)

SeparateExportFiles

public final boolean SeparateExportFiles

If set to true, CSV export files from command will be separated based on this identifier. For instance, if there is a channel index as an identifier than each channel index present will get a separate CSV file

DisplayType

public final DisplayType DisplayType

The field type of this identifer - currently String, Integer, or Float. This type must match with the format display and export format strings

SortIndex

public final int SortIndex

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

Constructor Detail

IdentifierDefinition

public IdentifierDefinition(java.lang.String fieldName,
                            java.lang.String displayName,
                            java.lang.String displayFormat,
                            java.lang.String exportFormat,
                            boolean separateExportFiles,
                            DisplayType displayType,
                            int sortIndex)

This is used by the signal measurement builder Use the SignalMeasurementBuilder instead

See Also:

SignalMeasurementBuilder