Unify 3 SDK/com.kaelus.unify3sdk

Package-level declarations

Types

BatchedTestResult

class BatchedTestResult(var traceIndex: Int, var tracePoints: List<Point>, var featureResults: List<FeatureResult>)

A batched test result.

BatteryState

class BatteryState(var status: BatteryStatus, var percentage: Int)

The battery state.

BatteryStatus

enum BatteryStatus : Enum<BatteryStatus>

The battery status.

CaaCableLossFrequencyTrace

class CaaCableLossFrequencyTrace(var id: Long? = null, var enabled: Boolean? = null, var calibrated: Boolean? = null, var format: CaaCableLossFrequencyTraceFormat? = null, var frequencyUnit: FrequencyUnit? = null, var phaseUnit: PhaseUnit? = null, var instrumentSerialNumber: String? = null, var instrumentModel: String, var frequencyRangeHz: Extent, var numberOfPoints: Int, var durationS: Double) : Trace

A CAA cable loss frequency trace.

CaaCableLossFrequencyTraceBlocker

enum CaaCableLossFrequencyTraceBlocker : Enum<CaaCableLossFrequencyTraceBlocker>

A blocker for the CAA cable loss frequency trace.

CaaCableLossFrequencyTraceConfigurationResult

class CaaCableLossFrequencyTraceConfigurationResult(var validationErrors: List<CaaCableLossFrequencyTraceValidationError>, var trace: CaaCableLossFrequencyTrace, var calKitNames: List<String>, var calibration: OslCalibration? = null) : TraceConfigurationResult

The result of configuring the CAA cable loss frequency trace.

CaaCableLossFrequencyTraceContext

class CaaCableLossFrequencyTraceContext(var blockers: List<CaaCableLossFrequencyTraceBlocker>, var calibrationStatus: CalibrationStatus, var lastCalibration: Instant? = null, var nextCalibration: Instant? = null) : TraceContext

The context for the CAA cable loss frequency trace.

CaaCableLossFrequencyTraceFormat

enum CaaCableLossFrequencyTraceFormat : Enum<CaaCableLossFrequencyTraceFormat>

The available CAA cable loss frequency trace format values.

CaaCableLossFrequencyTraceValidationError

class CaaCableLossFrequencyTraceValidationError(var type: CaaCableLossFrequencyTraceValidationErrorType)

A validation error for the CAA cable loss frequency trace.

CaaCableLossFrequencyTraceValidationErrorType

enum CaaCableLossFrequencyTraceValidationErrorType : Enum<CaaCableLossFrequencyTraceValidationErrorType>

The validation error types for the CAA cable loss frequency trace.

CaaCableLossTimeTrace

class CaaCableLossTimeTrace(var id: Long? = null, var enabled: Boolean? = null, var calibrated: Boolean? = null, var format: CaaCableLossTimeTraceFormat? = null, var timeUnit: TimeUnit? = null, var phaseUnit: PhaseUnit? = null, var instrumentSerialNumber: String? = null, var instrumentModel: String, var frequencyHz: Double, var durationS: Double) : Trace

A CAA cable loss time trace.

CaaCableLossTimeTraceBlocker

enum CaaCableLossTimeTraceBlocker : Enum<CaaCableLossTimeTraceBlocker>

A blocker for the CAA cable loss time trace.

CaaCableLossTimeTraceConfigurationResult

class CaaCableLossTimeTraceConfigurationResult(var validationErrors: List<CaaCableLossTimeTraceValidationError>, var trace: CaaCableLossTimeTrace, var calKitNames: List<String>, var calibration: OslCalibration? = null) : TraceConfigurationResult

The result of configuring the CAA cable loss time trace.

CaaCableLossTimeTraceContext

class CaaCableLossTimeTraceContext(var blockers: List<CaaCableLossTimeTraceBlocker>, var calibrationStatus: CalibrationStatus, var lastCalibration: Instant? = null, var nextCalibration: Instant? = null) : TraceContext

The context for the CAA cable loss time trace.

CaaCableLossTimeTraceFormat

enum CaaCableLossTimeTraceFormat : Enum<CaaCableLossTimeTraceFormat>

The available CAA cable loss time trace format values.

CaaCableLossTimeTraceValidationError

class CaaCableLossTimeTraceValidationError(var type: CaaCableLossTimeTraceValidationErrorType)

A validation error for the CAA cable loss time trace.

CaaCableLossTimeTraceValidationErrorType

enum CaaCableLossTimeTraceValidationErrorType : Enum<CaaCableLossTimeTraceValidationErrorType>

The validation error types for the CAA cable loss time trace.

CaaInstrumentDefinition

class CaaInstrumentDefinition(var type: InstrumentType, var model: String, var durationRangeS: Extent, var frequencyRangeHz: Extent, var oslCalKits: List<OslCalKit>) : InstrumentDefinition

A CAA instrument definition.

CaaInstrumentState

class CaaInstrumentState(var serialNumber: String, var model: String, var softwareVersions: List<String>, var lastCalibration: Instant? = null, var nextCalibration: Instant? = null, var connectionState: ConnectionState, var batteryState: BatteryState) : InstrumentState

A CAA instrument state.

CaaPreampMode

enum CaaPreampMode : Enum<CaaPreampMode>

The available CAA preamp modes.

CaaReturnLossDistanceTrace

class CaaReturnLossDistanceTrace(var id: Long? = null, var enabled: Boolean? = null, var calibrated: Boolean? = null, var format: CaaReturnLossDistanceTraceFormat? = null, var lengthUnit: LengthUnit? = null, var phaseUnit: PhaseUnit? = null, var instrumentSerialNumber: String? = null, var instrumentModel: String, var frequencyRangeHz: Extent, var maximumDistanceM: Double, var velocityFactor: Double, var cableLossDBPerM: Double, var durationS: Double) : Trace

A CAA return loss distance trace.

CaaReturnLossDistanceTraceBlocker

enum CaaReturnLossDistanceTraceBlocker : Enum<CaaReturnLossDistanceTraceBlocker>

A blocker for the CAA return loss distance trace.

CaaReturnLossDistanceTraceConfigurationResult

class CaaReturnLossDistanceTraceConfigurationResult(var validationErrors: List<CaaReturnLossDistanceTraceValidationError>, var trace: CaaReturnLossDistanceTrace, var numberOfPoints: Int, var calKitNames: List<String>, var calibration: OslCalibration? = null) : TraceConfigurationResult

The result of configuring the CAA return loss distance trace.

CaaReturnLossDistanceTraceContext

class CaaReturnLossDistanceTraceContext(var blockers: List<CaaReturnLossDistanceTraceBlocker>, var calibrationStatus: CalibrationStatus, var lastCalibration: Instant? = null, var nextCalibration: Instant? = null) : TraceContext

The context for the CAA return loss distance trace.

CaaReturnLossDistanceTraceFormat

enum CaaReturnLossDistanceTraceFormat : Enum<CaaReturnLossDistanceTraceFormat>

The available CAA return loss distance trace format values.

CaaReturnLossDistanceTraceValidationError

class CaaReturnLossDistanceTraceValidationError(var type: CaaReturnLossDistanceTraceValidationErrorType)

A validation error for the CAA return loss distance trace.

CaaReturnLossDistanceTraceValidationErrorType

enum CaaReturnLossDistanceTraceValidationErrorType : Enum<CaaReturnLossDistanceTraceValidationErrorType>

The validation error types for the CAA return loss distance trace.

CaaReturnLossFrequencyTrace

class CaaReturnLossFrequencyTrace(var id: Long? = null, var enabled: Boolean? = null, var calibrated: Boolean? = null, var format: CaaReturnLossFrequencyTraceFormat? = null, var frequencyUnit: FrequencyUnit? = null, var phaseUnit: PhaseUnit? = null, var instrumentSerialNumber: String? = null, var instrumentModel: String, var frequencyRangeHz: Extent, var numberOfPoints: Int, var durationS: Double) : Trace

A CAA return loss frequency trace.

CaaReturnLossFrequencyTraceBlocker

enum CaaReturnLossFrequencyTraceBlocker : Enum<CaaReturnLossFrequencyTraceBlocker>

A blocker for the CAA return loss frequency trace.

CaaReturnLossFrequencyTraceConfigurationResult

class CaaReturnLossFrequencyTraceConfigurationResult(var validationErrors: List<CaaReturnLossFrequencyTraceValidationError>, var trace: CaaReturnLossFrequencyTrace, var calKitNames: List<String>, var calibration: OslCalibration? = null) : TraceConfigurationResult

The result of configuring the CAA return loss frequency trace.

CaaReturnLossFrequencyTraceContext

class CaaReturnLossFrequencyTraceContext(var blockers: List<CaaReturnLossFrequencyTraceBlocker>, var calibrationStatus: CalibrationStatus, var lastCalibration: Instant? = null, var nextCalibration: Instant? = null) : TraceContext

The context for the CAA return loss frequency trace.

CaaReturnLossFrequencyTraceFormat

enum CaaReturnLossFrequencyTraceFormat : Enum<CaaReturnLossFrequencyTraceFormat>

The available CAA return loss frequency trace format values.

CaaReturnLossFrequencyTraceValidationError

class CaaReturnLossFrequencyTraceValidationError(var type: CaaReturnLossFrequencyTraceValidationErrorType)

A validation error for the CAA return loss frequency trace.

CaaReturnLossFrequencyTraceValidationErrorType

enum CaaReturnLossFrequencyTraceValidationErrorType : Enum<CaaReturnLossFrequencyTraceValidationErrorType>

The validation error types for the CAA return loss frequency trace.

CaaReturnLossTimeTrace

class CaaReturnLossTimeTrace(var id: Long? = null, var enabled: Boolean? = null, var calibrated: Boolean? = null, var format: CaaReturnLossTimeTraceFormat? = null, var timeUnit: TimeUnit? = null, var phaseUnit: PhaseUnit? = null, var instrumentSerialNumber: String? = null, var instrumentModel: String, var frequencyHz: Double, var durationS: Double) : Trace

A CAA return loss time trace.

CaaReturnLossTimeTraceBlocker

enum CaaReturnLossTimeTraceBlocker : Enum<CaaReturnLossTimeTraceBlocker>

A blocker for the CAA return loss time trace.

CaaReturnLossTimeTraceConfigurationResult

class CaaReturnLossTimeTraceConfigurationResult(var validationErrors: List<CaaReturnLossTimeTraceValidationError>, var trace: CaaReturnLossTimeTrace, var calKitNames: List<String>, var calibration: OslCalibration? = null) : TraceConfigurationResult

The result of configuring the CAA return loss time trace.

CaaReturnLossTimeTraceContext

class CaaReturnLossTimeTraceContext(var blockers: List<CaaReturnLossTimeTraceBlocker>, var calibrationStatus: CalibrationStatus, var lastCalibration: Instant? = null, var nextCalibration: Instant? = null) : TraceContext

The context for the CAA return loss time trace.

CaaReturnLossTimeTraceFormat

enum CaaReturnLossTimeTraceFormat : Enum<CaaReturnLossTimeTraceFormat>

The available CAA return loss time trace format values.

CaaReturnLossTimeTraceValidationError

class CaaReturnLossTimeTraceValidationError(var type: CaaReturnLossTimeTraceValidationErrorType)

A validation error for the CAA return loss time trace.

CaaReturnLossTimeTraceValidationErrorType

enum CaaReturnLossTimeTraceValidationErrorType : Enum<CaaReturnLossTimeTraceValidationErrorType>

The validation error types for the CAA return loss time trace.

CaaSpectrumFrequencyTrace

class CaaSpectrumFrequencyTrace(var id: Long? = null, var enabled: Boolean? = null, var frequencyUnit: FrequencyUnit? = null, var powerUnit: PowerUnit? = null, var instrumentSerialNumber: String? = null, var instrumentModel: String, var frequencyRangeHz: Extent, var numberOfPoints: Int, var preampMode: CaaPreampMode, var durationS: Double) : Trace

A CAA spectrum frequency trace.

CaaSpectrumFrequencyTraceBlocker

enum CaaSpectrumFrequencyTraceBlocker : Enum<CaaSpectrumFrequencyTraceBlocker>

A blocker for the CAA spectrum frequency trace.

CaaSpectrumFrequencyTraceConfigurationResult

class CaaSpectrumFrequencyTraceConfigurationResult(var validationErrors: List<CaaSpectrumFrequencyTraceValidationError>, var trace: CaaSpectrumFrequencyTrace) : TraceConfigurationResult

The result of configuring the CAA spectrum frequency trace.

CaaSpectrumFrequencyTraceContext

class CaaSpectrumFrequencyTraceContext(var blockers: List<CaaSpectrumFrequencyTraceBlocker>) : TraceContext

The context for the CAA spectrum frequency trace.

CaaSpectrumFrequencyTraceValidationError

class CaaSpectrumFrequencyTraceValidationError(var type: CaaSpectrumFrequencyTraceValidationErrorType)

A validation error for the CAA spectrum frequency trace.

CaaSpectrumFrequencyTraceValidationErrorType

enum CaaSpectrumFrequencyTraceValidationErrorType : Enum<CaaSpectrumFrequencyTraceValidationErrorType>

The validation error types for the CAA spectrum frequency trace.

CaaSpectrumTimeTrace

class CaaSpectrumTimeTrace(var id: Long? = null, var enabled: Boolean? = null, var timeUnit: TimeUnit? = null, var powerUnit: PowerUnit? = null, var instrumentSerialNumber: String? = null, var instrumentModel: String, var frequencyHz: Double, var preampMode: CaaPreampMode, var durationS: Double) : Trace

A CAA spectrum time trace.

CaaSpectrumTimeTraceBlocker

enum CaaSpectrumTimeTraceBlocker : Enum<CaaSpectrumTimeTraceBlocker>

A blocker for the CAA spectrum time trace.

CaaSpectrumTimeTraceConfigurationResult

class CaaSpectrumTimeTraceConfigurationResult(var validationErrors: List<CaaSpectrumTimeTraceValidationError>, var trace: CaaSpectrumTimeTrace) : TraceConfigurationResult

The result of configuring the CAA spectrum time trace.

CaaSpectrumTimeTraceContext

class CaaSpectrumTimeTraceContext(var blockers: List<CaaSpectrumTimeTraceBlocker>) : TraceContext

The context for the CAA spectrum time trace.

CaaSpectrumTimeTraceValidationError

class CaaSpectrumTimeTraceValidationError(var type: CaaSpectrumTimeTraceValidationErrorType)

A validation error for the CAA spectrum time trace.

CaaSpectrumTimeTraceValidationErrorType

enum CaaSpectrumTimeTraceValidationErrorType : Enum<CaaSpectrumTimeTraceValidationErrorType>

The validation error types for the CAA spectrum time trace.

CableLossFrequencyRecord

class CableLossFrequencyRecord(var id: String, var tags: List<String>, var comment: String? = null, var time: Instant? = null, var location: Location? = null, var instruments: List<InstrumentRecord>, var format: CableLossFrequencyRecordFormat, var frequencyUnit: FrequencyUnit, var phaseUnit: PhaseUnit, var frequencyRangeHz: Extent, var numberOfPoints: Int, var tracePoints: List<Point>, var overlays: List<Overlay>, var overlayResults: List<OverlayResult>, var viewport: Viewport, var imageFilePath: String? = null, var thumbnailFilePath: String? = null) : Record

A cable loss frequency record.

CableLossFrequencyRecordFormat

enum CableLossFrequencyRecordFormat : Enum<CableLossFrequencyRecordFormat>

The available cable loss frequency record format values.

CableLossTimeRecord

class CableLossTimeRecord(var id: String, var tags: List<String>, var comment: String? = null, var time: Instant? = null, var location: Location? = null, var instruments: List<InstrumentRecord>, var format: CableLossTimeRecordFormat, var timeUnit: TimeUnit, var phaseUnit: PhaseUnit, var frequencyHz: Double, var tracePoints: List<Point>, var overlays: List<Overlay>, var overlayResults: List<OverlayResult>, var viewport: Viewport, var imageFilePath: String? = null, var thumbnailFilePath: String? = null) : Record

A cable loss time record.

CableLossTimeRecordFormat

enum CableLossTimeRecordFormat : Enum<CableLossTimeRecordFormat>

The available cable loss time record format values.

Calibration

sealed interface Calibration

A calibration.

CalibrationConfigurationResult

sealed interface CalibrationConfigurationResult

The result of configuring the calibration.

CalibrationState

sealed interface CalibrationState

The calibration state.

CalibrationStatus

enum CalibrationStatus : Enum<CalibrationStatus>

The instrument or trace calibration status.

CalibrationStep

class CalibrationStep(var id: String, var name: String, var instruction: String, var enabled: Boolean, var complete: Boolean)

A calibration step.

Cardinality

enum Cardinality : Enum<Cardinality>

Defines how often a trace is executed during a test.

ChannelPowerMeasurement

class ChannelPowerMeasurement(var name: String, var frequencyRangeHz: Extent, var type: ChannelPowerMeasurementType) : Feature

A channel power measurement.

ChannelPowerMeasurementResult

class ChannelPowerMeasurementResult(var featureIndex: Int, var totalPower: Double) : FeatureResult

A channel power measurement result.

ChannelPowerMeasurementType

enum ChannelPowerMeasurementType : Enum<ChannelPowerMeasurementType>

The type of channel power measurement.

ConnectionResult

enum ConnectionResult : Enum<ConnectionResult>

The result of a connection attempt.

ConnectionState

class ConnectionState(var type: ConnectionType, var status: ConnectionStatus, var progress: Double)

The connection state.

ConnectionStatus

enum ConnectionStatus : Enum<ConnectionStatus>

The available connection statuses.

ConnectionType

enum ConnectionType : Enum<ConnectionType>

The available connection types.

Extent

class Extent(var start: Double, var end: Double)

A structure defining a range of values.

Feature

sealed interface Feature

An additional measurement associated with a trace.

FeatureResult

sealed interface FeatureResult

The result of an additional measurement associated with a trace.

FixedMarker

class FixedMarker(var traceIndex: Int, var name: String, var x: Double, var y: Double, var referenceMarker: String? = null) : Overlay

Puts a marker at a fixed x,y point on the plot

FixedMarkerConfigurationResult

class FixedMarkerConfigurationResult(var validationErrors: List<FixedMarkerValidationError>, var marker: FixedMarker) : OverlayConfigurationResult

The result of configuring the fixed marker.

FixedMarkerValidationError

class FixedMarkerValidationError(var type: FixedMarkerValidationErrorType)

A validation error for the fixed marker.

FixedMarkerValidationErrorType

enum FixedMarkerValidationErrorType : Enum<FixedMarkerValidationErrorType>

The validation error types for the fixed marker.

FrequencyUnit

enum FrequencyUnit : Enum<FrequencyUnit>

The available frequency unit values.

ImageRecord

class ImageRecord(var id: String, var tags: List<String>, var comment: String? = null, var time: Instant? = null, var location: Location? = null, var imageFilePath: String, var thumbnailFilePath: String) : Record

An image record.

Instrument

class Instrument(var type: InstrumentType, var serialNumber: String, var model: String)

An instrument.

InstrumentDefinition

sealed interface InstrumentDefinition

An instrument definition.

InstrumentLockedException

class InstrumentLockedException(message: String? = null, cause: Throwable? = null, var instrument: Instrument) : Exception

Raised when an instrument is locked and cannot be used

InstrumentNotConnectedException

class InstrumentNotConnectedException(message: String? = null, cause: Throwable? = null, var instrument: Instrument) : Exception

Raised when an instrument is not connected and cannot be used

InstrumentRecord

class InstrumentRecord(var serialNumber: String, var model: String, var softwareVersions: List<String>, var lastCalibration: Instant? = null, var nextCalibration: Instant? = null)

The instrument details recorded in the report.

InstrumentState

sealed interface InstrumentState

An instrument state.

InstrumentType

enum InstrumentType : Enum<InstrumentType>

The available instrument types.

IpaBand

class IpaBand(var name: String, var transceiverConfiguration: String, var rxPorts: List<Port>, var rxBandNumbers: List<Int>, var rxFrequencyRangeHz: Extent, var rxFrequencyStepHz: Double, var pimProducts: List<Product>, var rtfProducts: List<Product>, var rtfModels: List<String>, var rtfDefaultMaximumDistanceM: Double, var txPorts: List<Port>, var txBandNumbers: List<Int>, var tx1FrequencyRangeHz: Extent, var tx2FrequencyRangeHz: Extent, var tx1FrequencyStepHz: Double, var tx2FrequencyStepHz: Double, var tx1PowerRangeDBm: Extent, var tx2PowerRangeDBm: Extent, var tx1PowerStepDB: Double, var tx2PowerStepDB: Double, var txDefaultFrequencyPairs: List<TxDefaultFrequencyPair>)

A definition of an IPA band.

IpaInstrumentDefinition

class IpaInstrumentDefinition(var type: InstrumentType, var model: String, var bands: List<IpaBand>, var durationRangeS: Extent, var frequencyResolutionHz: Double) : InstrumentDefinition

An IPA instrument definition.

IpaInstrumentState

class IpaInstrumentState(var serialNumber: String, var model: String, var softwareVersions: List<String>, var lastCalibration: Instant? = null, var nextCalibration: Instant? = null, var connectionState: ConnectionState, var batteryState: BatteryState, var rtfState: RtfState, var isSoundOn: Boolean) : InstrumentState

An IPA instrument state.

IpaNextGenInstrumentState

class IpaNextGenInstrumentState(var serialNumber: String, var model: String, var softwareVersions: List<String>, var lastCalibration: Instant? = null, var nextCalibration: Instant? = null, var connectionState: ConnectionState, var batteryState: BatteryState, var isSoundOn: Boolean) : InstrumentState

An IPA Next Gen instrument state.

IpaNextGenPimFrequencyTrace

class IpaNextGenPimFrequencyTrace(var id: Long? = null, var enabled: Boolean? = null, var frequencyUnit: FrequencyUnit? = null, var pimUnit: PimUnit? = null, var instrumentSerialNumber: String? = null, var instrumentModel: String, var bandName: String, var productName: String, var rxFrequencyStepHz: Double, var tx1FrequencyRangeHz: Extent, var tx2FrequencyRangeHz: Extent, var tx1PowerSetpointDBm: Double, var tx2PowerSetpointDBm: Double, var durationS: Double, var tx1Enabled: Boolean? = null, var tx2Enabled: Boolean? = null) : Trace

An IPA next gen PIM frequency trace.

IpaNextGenPimFrequencyTraceBlocker

enum IpaNextGenPimFrequencyTraceBlocker : Enum<IpaNextGenPimFrequencyTraceBlocker>

A blocker for the IPA next gen PIM frequency trace.

IpaNextGenPimFrequencyTraceConfigurationResult

class IpaNextGenPimFrequencyTraceConfigurationResult(var validationErrors: List<IpaNextGenPimFrequencyTraceValidationError>, var trace: IpaNextGenPimFrequencyTrace, var rxFrequencyRangeHz: Extent) : TraceConfigurationResult

The result of configuring the IPA next gen PIM frequency trace.

IpaNextGenPimFrequencyTraceContext

class IpaNextGenPimFrequencyTraceContext(var blockers: List<IpaNextGenPimFrequencyTraceBlocker>) : TraceContext

The context for the IPA next gen PIM frequency trace.

IpaNextGenPimFrequencyTraceValidationError

class IpaNextGenPimFrequencyTraceValidationError(var type: IpaNextGenPimFrequencyTraceValidationErrorType)

A validation error for the IPA next gen PIM frequency trace.

IpaNextGenPimFrequencyTraceValidationErrorType

enum IpaNextGenPimFrequencyTraceValidationErrorType : Enum<IpaNextGenPimFrequencyTraceValidationErrorType>

The validation error types for the IPA next gen PIM frequency trace.

IpaPimDistanceTrace

class IpaPimDistanceTrace(var id: Long? = null, var enabled: Boolean? = null, var lengthUnit: LengthUnit? = null, var pimUnit: PimUnit? = null, var instrumentSerialNumber: String? = null, var instrumentModel: String, var bandName: String, var productName: String, var maximumDistanceM: Double, var velocityFactor: Double, var tx1FrequencyRangeHz: Extent, var tx2FrequencyRangeHz: Extent, var tx1PowerSetpointDBm: Double, var tx2PowerSetpointDBm: Double, var enhanced: Boolean) : Trace

An IPA PIM distance trace.

IpaPimDistanceTraceBlocker

enum IpaPimDistanceTraceBlocker : Enum<IpaPimDistanceTraceBlocker>

A blocker for the IPA PIM distance trace.

IpaPimDistanceTraceConfigurationResult

class IpaPimDistanceTraceConfigurationResult(var validationErrors: List<IpaPimDistanceTraceValidationError>, var trace: IpaPimDistanceTrace, var calibration: RtfZeroingCalibration? = null) : TraceConfigurationResult

The result of configuring the IPA PIM distance trace.

IpaPimDistanceTraceContext

class IpaPimDistanceTraceContext(var blockers: List<IpaPimDistanceTraceBlocker>, var calibrationStatus: CalibrationStatus, var lastCalibration: Instant? = null, var nextCalibration: Instant? = null) : TraceContext

The context for the IPA PIM distance trace.

IpaPimDistanceTraceValidationError

class IpaPimDistanceTraceValidationError(var type: IpaPimDistanceTraceValidationErrorType)

A validation error for the IPA PIM distance trace.

IpaPimDistanceTraceValidationErrorType

enum IpaPimDistanceTraceValidationErrorType : Enum<IpaPimDistanceTraceValidationErrorType>

The validation error types for the IPA PIM distance trace.

IpaPimFrequencyTrace

class IpaPimFrequencyTrace(var id: Long? = null, var enabled: Boolean? = null, var frequencyUnit: FrequencyUnit? = null, var pimUnit: PimUnit? = null, var instrumentSerialNumber: String? = null, var instrumentModel: String, var bandName: String, var productName: String, var rxFrequencyStepHz: Double, var tx1FrequencyRangeHz: Extent, var tx2FrequencyRangeHz: Extent, var tx1PowerSetpointDBm: Double, var tx2PowerSetpointDBm: Double, var durationS: Double, var tx1Enabled: Boolean? = null, var tx2Enabled: Boolean? = null) : Trace

An IPA PIM frequency trace.

IpaPimFrequencyTraceBlocker

enum IpaPimFrequencyTraceBlocker : Enum<IpaPimFrequencyTraceBlocker>

A blocker for the IPA PIM frequency trace.

IpaPimFrequencyTraceConfigurationResult

class IpaPimFrequencyTraceConfigurationResult(var validationErrors: List<IpaPimFrequencyTraceValidationError>, var trace: IpaPimFrequencyTrace, var rxFrequencyRangeHz: Extent) : TraceConfigurationResult

The result of configuring the IPA PIM frequency trace.

IpaPimFrequencyTraceContext

class IpaPimFrequencyTraceContext(var blockers: List<IpaPimFrequencyTraceBlocker>) : TraceContext

The context for the IPA PIM frequency trace.

IpaPimFrequencyTraceValidationError

class IpaPimFrequencyTraceValidationError(var type: IpaPimFrequencyTraceValidationErrorType)

A validation error for the IPA PIM frequency trace.

IpaPimFrequencyTraceValidationErrorType

enum IpaPimFrequencyTraceValidationErrorType : Enum<IpaPimFrequencyTraceValidationErrorType>

The validation error types for the IPA PIM frequency trace.

IpaPimIdleTrace

class IpaPimIdleTrace(var id: Long? = null, var enabled: Boolean? = null, var pimUnit: PimUnit? = null, var instrumentSerialNumber: String? = null, var instrumentModel: String, var bandName: String, var productName: String, var tx1FrequencyHz: Double, var tx2FrequencyHz: Double, var tx1PowerSetpointDBm: Double, var tx2PowerSetpointDBm: Double) : Trace

An IPA PIM idle trace.

IpaPimIdleTraceBlocker

enum IpaPimIdleTraceBlocker : Enum<IpaPimIdleTraceBlocker>

A blocker for the IPA PIM idle trace.

IpaPimIdleTraceConfigurationResult

class IpaPimIdleTraceConfigurationResult(var validationErrors: List<IpaPimIdleTraceValidationError>, var trace: IpaPimIdleTrace, var rxFrequencyHz: Double) : TraceConfigurationResult

The result of configuring the IPA PIM idle trace.

IpaPimIdleTraceContext

class IpaPimIdleTraceContext(var blockers: List<IpaPimIdleTraceBlocker>) : TraceContext

The context for the IPA PIM idle trace.

IpaPimIdleTraceValidationError

class IpaPimIdleTraceValidationError(var type: IpaPimIdleTraceValidationErrorType)

A validation error for the IPA PIM idle trace.

IpaPimIdleTraceValidationErrorType

enum IpaPimIdleTraceValidationErrorType : Enum<IpaPimIdleTraceValidationErrorType>

The validation error types for the IPA PIM idle trace.

IpaPimTimeTrace

class IpaPimTimeTrace(var id: Long? = null, var enabled: Boolean? = null, var timeUnit: TimeUnit? = null, var pimUnit: PimUnit? = null, var instrumentSerialNumber: String? = null, var instrumentModel: String, var bandName: String, var productName: String, var tx1FrequencyHz: Double, var tx2FrequencyHz: Double, var tx1PowerSetpointDBm: Double, var tx2PowerSetpointDBm: Double, var durationS: Double, var tx1Enabled: Boolean? = null, var tx2Enabled: Boolean? = null, var singleToneCw: Boolean? = null) : Trace

An IPA PIM time trace.

IpaPimTimeTraceBlocker

enum IpaPimTimeTraceBlocker : Enum<IpaPimTimeTraceBlocker>

A blocker for the IPA PIM time trace.

IpaPimTimeTraceConfigurationResult

class IpaPimTimeTraceConfigurationResult(var validationErrors: List<IpaPimTimeTraceValidationError>, var trace: IpaPimTimeTrace, var rxFrequencyHz: Double) : TraceConfigurationResult

The result of configuring the IPA PIM time trace.

IpaPimTimeTraceContext

class IpaPimTimeTraceContext(var blockers: List<IpaPimTimeTraceBlocker>) : TraceContext

The context for the IPA PIM time trace.

IpaPimTimeTraceValidationError

class IpaPimTimeTraceValidationError(var type: IpaPimTimeTraceValidationErrorType)

A validation error for the IPA PIM time trace.

IpaPimTimeTraceValidationErrorType

enum IpaPimTimeTraceValidationErrorType : Enum<IpaPimTimeTraceValidationErrorType>

The validation error types for the IPA PIM time trace.

IpaReturnLossDistanceTrace

class IpaReturnLossDistanceTrace(var id: Long? = null, var enabled: Boolean? = null, var format: IpaReturnLossDistanceTraceFormat? = null, var lengthUnit: LengthUnit? = null, var instrumentSerialNumber: String? = null, var instrumentModel: String, var bandName: String, var maximumDistanceM: Double, var velocityFactor: Double, var enhanced: Boolean) : Trace

An IPA return loss distance trace.

IpaReturnLossDistanceTraceBlocker

enum IpaReturnLossDistanceTraceBlocker : Enum<IpaReturnLossDistanceTraceBlocker>

A blocker for the IPA return loss distance trace.

IpaReturnLossDistanceTraceConfigurationResult

class IpaReturnLossDistanceTraceConfigurationResult(var validationErrors: List<IpaReturnLossDistanceTraceValidationError>, var trace: IpaReturnLossDistanceTrace) : TraceConfigurationResult

The result of configuring the IPA return loss distance trace.

IpaReturnLossDistanceTraceContext

class IpaReturnLossDistanceTraceContext(var blockers: List<IpaReturnLossDistanceTraceBlocker>) : TraceContext

The context for the IPA return loss distance trace.

IpaReturnLossDistanceTraceFormat

enum IpaReturnLossDistanceTraceFormat : Enum<IpaReturnLossDistanceTraceFormat>

The available IPA return loss distance trace format values.

IpaReturnLossDistanceTraceValidationError

class IpaReturnLossDistanceTraceValidationError(var type: IpaReturnLossDistanceTraceValidationErrorType)

A validation error for the IPA return loss distance trace.

IpaReturnLossDistanceTraceValidationErrorType

enum IpaReturnLossDistanceTraceValidationErrorType : Enum<IpaReturnLossDistanceTraceValidationErrorType>

The validation error types for the IPA return loss distance trace.

IpaSpectrumFrequencyTrace

class IpaSpectrumFrequencyTrace(var id: Long? = null, var enabled: Boolean? = null, var frequencyUnit: FrequencyUnit? = null, var powerUnit: PowerUnit? = null, var instrumentSerialNumber: String? = null, var instrumentModel: String, var bandName: String, var rxFrequencyStepHz: Double, var tx1FrequencyHz: Double, var tx2FrequencyHz: Double, var tx1PowerSetpointDBm: Double, var tx2PowerSetpointDBm: Double, var durationS: Double, var tx1Enabled: Boolean? = null, var tx2Enabled: Boolean? = null) : Trace

An IPA spectrum frequency trace.

IpaSpectrumFrequencyTraceBlocker

enum IpaSpectrumFrequencyTraceBlocker : Enum<IpaSpectrumFrequencyTraceBlocker>

A blocker for the IPA spectrum frequency trace.

IpaSpectrumFrequencyTraceConfigurationResult

class IpaSpectrumFrequencyTraceConfigurationResult(var validationErrors: List<IpaSpectrumFrequencyTraceValidationError>, var trace: IpaSpectrumFrequencyTrace) : TraceConfigurationResult

The result of configuring the IPA spectrum frequency trace.

IpaSpectrumFrequencyTraceContext

class IpaSpectrumFrequencyTraceContext(var blockers: List<IpaSpectrumFrequencyTraceBlocker>) : TraceContext

The context for the IPA spectrum frequency trace.

IpaSpectrumFrequencyTraceValidationError

class IpaSpectrumFrequencyTraceValidationError(var type: IpaSpectrumFrequencyTraceValidationErrorType)

A validation error for the IPA spectrum frequency trace.

IpaSpectrumFrequencyTraceValidationErrorType

enum IpaSpectrumFrequencyTraceValidationErrorType : Enum<IpaSpectrumFrequencyTraceValidationErrorType>

The validation error types for the IPA spectrum frequency trace.

LengthUnit

enum LengthUnit : Enum<LengthUnit>

The available length unit values.

Location

class Location(var accuracyM: Double? = null, var latitude: Double, var longitude: Double)

A location.

Log

class Log(var time: Instant, var level: LogLevel, var logger: String, var message: String)

A log entry.

LogLevel

enum LogLevel : Enum<LogLevel>

The available log levels.

MarkerResult

class MarkerResult(var traceIndex: Int, var name: String, var position: Point? = null, var delta: Point? = null) : OverlayResult

A marker result.

MaximumLimit

class MaximumLimit(var traceIndex: Int, var name: String, var xRange: Extent? = null, var yMaximum: Double) : Overlay

A maximum limit.

MaximumLimitConfigurationResult

class MaximumLimitConfigurationResult(var validationErrors: List<MaximumLimitValidationError>, var limit: MaximumLimit) : OverlayConfigurationResult

The result of configuring the maximum limit.

MaximumLimitResult

class MaximumLimitResult(var traceIndex: Int, var name: String, var pass: Boolean, var maximum: Point? = null) : OverlayResult

A maximum limit result.

MaximumLimitValidationError

class MaximumLimitValidationError(var type: MaximumLimitValidationErrorType)

A validation error for the maximum limit.

MaximumLimitValidationErrorType

enum MaximumLimitValidationErrorType : Enum<MaximumLimitValidationErrorType>

The validation error types for the maximum limit.

MeasurementFaultException

class MeasurementFaultException(message: String? = null, cause: Throwable? = null, var instrument: Instrument) : Exception

Raised when a fault is detected during a measurement

MinimumLimit

class MinimumLimit(var traceIndex: Int, var name: String, var xRange: Extent? = null, var yMinimum: Double) : Overlay

A minimum limit.

MinimumLimitConfigurationResult

class MinimumLimitConfigurationResult(var validationErrors: List<MinimumLimitValidationError>, var limit: MinimumLimit) : OverlayConfigurationResult

The result of configuring the minimum limit.

MinimumLimitResult

class MinimumLimitResult(var traceIndex: Int, var name: String, var pass: Boolean, var minimum: Point? = null) : OverlayResult

A minimum limit result.

MinimumLimitValidationError

class MinimumLimitValidationError(var type: MinimumLimitValidationErrorType)

A validation error for the minimum limit.

MinimumLimitValidationErrorType

enum MinimumLimitValidationErrorType : Enum<MinimumLimitValidationErrorType>

The validation error types for the minimum limit.

NearestPeakMarker

class NearestPeakMarker(var traceIndex: Int, var name: String, var x: Double, var lowerYBound: Double? = null, var lowerXBoundMarker: String? = null, var upperXBoundMarker: String? = null, var referenceMarker: String? = null) : Overlay

Puts a marker on the trace at the nearest peak to a fixed x position

NearestPeakMarkerConfigurationResult

class NearestPeakMarkerConfigurationResult(var validationErrors: List<NearestPeakMarkerValidationError>, var marker: NearestPeakMarker) : OverlayConfigurationResult

The result of configuring the nearest peak marker.

NearestPeakMarkerValidationError

class NearestPeakMarkerValidationError(var type: NearestPeakMarkerValidationErrorType)

A validation error for the nearest peak marker.

NearestPeakMarkerValidationErrorType

enum NearestPeakMarkerValidationErrorType : Enum<NearestPeakMarkerValidationErrorType>

The validation error types for the nearest peak marker.

NearestValleyMarker

class NearestValleyMarker(var traceIndex: Int, var name: String, var x: Double, var upperYBound: Double? = null, var lowerXBoundMarker: String? = null, var upperXBoundMarker: String? = null, var referenceMarker: String? = null) : Overlay

Puts a marker on the trace at the nearest valley to a fixed x position

NearestValleyMarkerConfigurationResult

class NearestValleyMarkerConfigurationResult(var validationErrors: List<NearestValleyMarkerValidationError>, var marker: NearestValleyMarker) : OverlayConfigurationResult

The result of configuring the nearest valley marker.

NearestValleyMarkerValidationError

class NearestValleyMarkerValidationError(var type: NearestValleyMarkerValidationErrorType)

A validation error for the nearest valley marker.

NearestValleyMarkerValidationErrorType

enum NearestValleyMarkerValidationErrorType : Enum<NearestValleyMarkerValidationErrorType>

The validation error types for the nearest valley marker.

OffsetMarker

class OffsetMarker(var traceIndex: Int, var name: String, var deltaX: Double, var referenceMarker: String) : Overlay

Puts a marker on the trace at an x position that is offset from the reference marker

OffsetMarkerConfigurationResult

class OffsetMarkerConfigurationResult(var validationErrors: List<OffsetMarkerValidationError>, var marker: OffsetMarker) : OverlayConfigurationResult

The result of configuring the offset marker.

OffsetMarkerValidationError

class OffsetMarkerValidationError(var type: OffsetMarkerValidationErrorType)

A validation error for the offset marker.

OffsetMarkerValidationErrorType

enum OffsetMarkerValidationErrorType : Enum<OffsetMarkerValidationErrorType>

The validation error types for the offset marker.

Ordering

enum Ordering : Enum<Ordering>

Defines whether traces are executed one after another or at the same time.

Orientation

enum Orientation : Enum<Orientation>

The available orientation values.

OslCalibration

class OslCalibration(var id: Long? = null, var instrumentSerialNumber: String, var frequencyRangeHz: Extent, var numberOfPoints: Int, var calKitName: String) : Calibration

An OSL calibration.

OslCalibrationConfigurationResult

class OslCalibrationConfigurationResult(var validationErrors: List<OslCalibrationValidationError>, var calibration: OslCalibration) : CalibrationConfigurationResult

The result of configuring the OSL calibration.

OslCalibrationState

class OslCalibrationState(var steps: List<CalibrationStep>) : CalibrationState

The OSL calibration state.

OslCalibrationValidationError

class OslCalibrationValidationError(var type: OslCalibrationValidationErrorType)

A validation error for the OSL calibration.

OslCalibrationValidationErrorType

enum OslCalibrationValidationErrorType : Enum<OslCalibrationValidationErrorType>

The validation error types for the OSL calibration.

OslCalKit

class OslCalKit(var name: String, var frequencyRangeHz: Extent)

An OSL cal kit.

Overlay

sealed interface Overlay

An overlay.

OverlayConfigurationResult

sealed interface OverlayConfigurationResult

The result of configuring the overlay.

OverlayResult

sealed interface OverlayResult

An overlay result.

OverlaySet

class OverlaySet(var overlays: List<Overlay>)

An overlay set.

OverlaySetConfigurationResult

class OverlaySetConfigurationResult(var valid: Boolean, var validationErrors: List<OverlaySetValidationError>, var overlayConfigurationResults: List<OverlayConfigurationResult>, var initialOverlayResults: List<OverlayResult>)

The result of configuring the overlay set.

OverlaySetValidationError

class OverlaySetValidationError(var type: OverlaySetValidationErrorType, var message: String)

A validation error for the overlay set.

OverlaySetValidationErrorType

enum OverlaySetValidationErrorType : Enum<OverlaySetValidationErrorType>

The validation error types for the overlay set.

PeakMarker

class PeakMarker(var traceIndex: Int, var name: String, var lowerXBoundMarker: String? = null, var upperXBoundMarker: String? = null, var referenceMarker: String? = null) : Overlay

Puts a marker on the trace at the highest point

PeakMarkerConfigurationResult

class PeakMarkerConfigurationResult(var validationErrors: List<PeakMarkerValidationError>, var marker: PeakMarker) : OverlayConfigurationResult

The result of configuring the peak marker.

PeakMarkerValidationError

class PeakMarkerValidationError(var type: PeakMarkerValidationErrorType)

A validation error for the peak marker.

PeakMarkerValidationErrorType

enum PeakMarkerValidationErrorType : Enum<PeakMarkerValidationErrorType>

The validation error types for the peak marker.

PhaseUnit

enum PhaseUnit : Enum<PhaseUnit>

The available phase unit values.

PimDistanceRecord

class PimDistanceRecord(var id: String, var tags: List<String>, var comment: String? = null, var time: Instant? = null, var location: Location? = null, var instruments: List<InstrumentRecord>, var lengthUnit: LengthUnit, var pimUnit: PimUnit, var bandName: String, var productName: String, var maximumDistanceM: Double, var velocityFactor: Double, var tx1FrequencyRangeHz: Extent, var tx2FrequencyRangeHz: Extent, var tx1PowerSetpointDBm: Double, var tx2PowerSetpointDBm: Double, var tracePoints: List<Point>, var overlays: List<Overlay>, var overlayResults: List<OverlayResult>, var viewport: Viewport, var imageFilePath: String? = null, var thumbnailFilePath: String? = null) : Record

A PIM distance record.

PimFrequencyRecord

class PimFrequencyRecord(var id: String, var tags: List<String>, var comment: String? = null, var time: Instant? = null, var location: Location? = null, var instruments: List<InstrumentRecord>, var frequencyUnit: FrequencyUnit, var pimUnit: PimUnit, var bandName: String, var productName: String, var rxFrequencyRangeHz: Extent, var rxFrequencyStepHz: Double, var tx1FrequencyRangeHz: Extent, var tx2FrequencyRangeHz: Extent, var tx1PowerSetpointDBm: Double, var tx2PowerSetpointDBm: Double, var tracePoints: List<Point>, var overlays: List<Overlay>, var overlayResults: List<OverlayResult>, var viewport: Viewport, var imageFilePath: String? = null, var thumbnailFilePath: String? = null) : Record

A PIM frequency record.

PimTimeRecord

class PimTimeRecord(var id: String, var tags: List<String>, var comment: String? = null, var time: Instant? = null, var location: Location? = null, var instruments: List<InstrumentRecord>, var timeUnit: TimeUnit, var pimUnit: PimUnit, var bandName: String, var productName: String, var rxFrequencyHz: Double, var tx1FrequencyHz: Double, var tx2FrequencyHz: Double, var tx1PowerSetpointDBm: Double, var tx2PowerSetpointDBm: Double, var tracePoints: List<Point>, var overlays: List<Overlay>, var overlayResults: List<OverlayResult>, var viewport: Viewport, var imageFilePath: String? = null, var thumbnailFilePath: String? = null) : Record

A PIM time record.

PimUnit

enum PimUnit : Enum<PimUnit>

The available PIM unit values.

Point

class Point(var values: List<Double>)

A point.

Port

enum Port : Enum<Port>

The instrument ports.

PowerUnit

enum PowerUnit : Enum<PowerUnit>

The available power unit values.

Product

class Product(var name: String, var order: Int, var type: ProductType, var side: ProductSide)

A measurable RF product (intermodulation or harmonic) generated during a PIM test.

ProductSide

enum ProductSide : Enum<ProductSide>

The spectral side of an intermodulation product.

ProductType

enum ProductType : Enum<ProductType>

The type of RF product generated during a PIM measurement.

RealtimeTestResult

class RealtimeTestResult(var traceIndex: Int, var traceChanges: List<TraceChange>, var featureResults: List<FeatureResult>)

A realtime test result.

Record

sealed interface Record

A report record.

ReportDetails

class ReportDetails(var comment: String, var contactName: String, var contactDetails: String, var operatorName: String, var siteName: String, var siteDescription: String)

The report details.

ReturnLossDistanceRecord

class ReturnLossDistanceRecord(var id: String, var tags: List<String>, var comment: String? = null, var time: Instant? = null, var location: Location? = null, var instruments: List<InstrumentRecord>, var format: ReturnLossDistanceRecordFormat, var lengthUnit: LengthUnit, var phaseUnit: PhaseUnit, var frequencyRangeHz: Extent, var maximumDistanceM: Double, var velocityFactor: Double, var cableLossDBPerM: Double, var tracePoints: List<Point>, var overlays: List<Overlay>, var overlayResults: List<OverlayResult>, var viewport: Viewport, var imageFilePath: String? = null, var thumbnailFilePath: String? = null) : Record

A return loss distance record.

ReturnLossDistanceRecordFormat

enum ReturnLossDistanceRecordFormat : Enum<ReturnLossDistanceRecordFormat>

The available return loss distance record format values.

ReturnLossFrequencyRecord

class ReturnLossFrequencyRecord(var id: String, var tags: List<String>, var comment: String? = null, var time: Instant? = null, var location: Location? = null, var instruments: List<InstrumentRecord>, var format: ReturnLossFrequencyRecordFormat, var frequencyUnit: FrequencyUnit, var phaseUnit: PhaseUnit, var frequencyRangeHz: Extent, var numberOfPoints: Int, var tracePoints: List<Point>, var overlays: List<Overlay>, var overlayResults: List<OverlayResult>, var viewport: Viewport, var imageFilePath: String? = null, var thumbnailFilePath: String? = null) : Record

A return loss frequency record.

ReturnLossFrequencyRecordFormat

enum ReturnLossFrequencyRecordFormat : Enum<ReturnLossFrequencyRecordFormat>

The available return loss frequency record format values.

ReturnLossTimeRecord

class ReturnLossTimeRecord(var id: String, var tags: List<String>, var comment: String? = null, var time: Instant? = null, var location: Location? = null, var instruments: List<InstrumentRecord>, var format: ReturnLossTimeRecordFormat, var timeUnit: TimeUnit, var phaseUnit: PhaseUnit, var frequencyHz: Double, var tracePoints: List<Point>, var overlays: List<Overlay>, var overlayResults: List<OverlayResult>, var viewport: Viewport, var imageFilePath: String? = null, var thumbnailFilePath: String? = null) : Record

A return loss time record.

ReturnLossTimeRecordFormat

enum ReturnLossTimeRecordFormat : Enum<ReturnLossTimeRecordFormat>

The available return loss time record format values.

RippleLimit

class RippleLimit(var traceIndex: Int, var name: String, var xRange: Extent? = null, var yRipple: Double) : Overlay

A ripple limit.

RippleLimitConfigurationResult

class RippleLimitConfigurationResult(var validationErrors: List<RippleLimitValidationError>, var limit: RippleLimit) : OverlayConfigurationResult

The result of configuring the ripple limit.

RippleLimitResult

class RippleLimitResult(var traceIndex: Int, var name: String, var pass: Boolean, var minimum: Point? = null, var maximum: Point? = null) : OverlayResult

A ripple limit result.

RippleLimitValidationError

class RippleLimitValidationError(var type: RippleLimitValidationErrorType)

A validation error for the ripple limit.

RippleLimitValidationErrorType

enum RippleLimitValidationErrorType : Enum<RippleLimitValidationErrorType>

The validation error types for the ripple limit.

RlCheckException

class RlCheckException(message: String? = null, cause: Throwable? = null, var instrument: Instrument, var ports: List<Port>) : Exception

Raised when the return loss check fails

RtfState

class RtfState(var connected: Boolean, var model: String? = null, var serialNumber: String? = null, var firmwareVersion: String? = null, var lastCalibration: Instant? = null, var nextCalibration: Instant? = null)

The RTF state.

RtfZeroingCalibration

class RtfZeroingCalibration(var id: Long? = null, var instrumentSerialNumber: String, var bandName: String, var productName: String, var maximumDistanceM: Double, var velocityFactor: Double, var tx1FrequencyRangeHz: Extent, var tx2FrequencyRangeHz: Extent, var tx1PowerSetpointDBm: Double, var tx2PowerSetpointDBm: Double) : Calibration

A RTF zeroing calibration.

RtfZeroingCalibrationConfigurationResult

class RtfZeroingCalibrationConfigurationResult(var validationErrors: List<RtfZeroingCalibrationValidationError>, var calibration: RtfZeroingCalibration) : CalibrationConfigurationResult

The result of configuring the RTF zeroing calibration.

RtfZeroingCalibrationState

class RtfZeroingCalibrationState(var steps: List<CalibrationStep>) : CalibrationState

The RTF zeroing calibration state.

RtfZeroingCalibrationValidationError

class RtfZeroingCalibrationValidationError(var type: RtfZeroingCalibrationValidationErrorType)

A validation error for the RTF zeroing calibration.

RtfZeroingCalibrationValidationErrorType

enum RtfZeroingCalibrationValidationErrorType : Enum<RtfZeroingCalibrationValidationErrorType>

The validation error types for the RTF zeroing calibration.

SpectrumFrequencyRecord

class SpectrumFrequencyRecord(var id: String, var tags: List<String>, var comment: String? = null, var time: Instant? = null, var location: Location? = null, var instruments: List<InstrumentRecord>, var frequencyUnit: FrequencyUnit, var powerUnit: PowerUnit, var frequencyRangeHz: Extent, var numberOfPoints: Int, var tracePoints: List<Point>, var features: List<Feature>, var featureResults: List<FeatureResult>, var overlays: List<Overlay>, var overlayResults: List<OverlayResult>, var viewport: Viewport, var imageFilePath: String? = null, var thumbnailFilePath: String? = null) : Record

A spectrum frequency record.

SpectrumTimeRecord

class SpectrumTimeRecord(var id: String, var tags: List<String>, var comment: String? = null, var time: Instant? = null, var location: Location? = null, var instruments: List<InstrumentRecord>, var timeUnit: TimeUnit, var powerUnit: PowerUnit, var frequencyHz: Double, var tracePoints: List<Point>, var overlays: List<Overlay>, var overlayResults: List<OverlayResult>, var viewport: Viewport, var imageFilePath: String? = null, var thumbnailFilePath: String? = null) : Record

A spectrum time record.

Test

class Test(var traces: List<Trace>, var cardinality: Cardinality? = null, var ordering: Ordering? = null)

Test is used to configure a collection of measurements.

TestConfigurationResult

class TestConfigurationResult(var valid: Boolean, var traceConfigurationResults: List<TraceConfigurationResult>, var initialTraceContexts: List<TraceContext>, var cardinality: Cardinality, var ordering: Ordering)

The result of configuring a test.

TestContext

class TestContext(var traceIndex: Int, var traceContext: TraceContext)

The context for the test.

TestProgress

class TestProgress(var traceIndex: Int, var traceProgress: Double, var traceTimeRemainingS: Double)

Progress information for a test.

TimeoutException

class TimeoutException(message: String? = null, cause: Throwable? = null, var instrument: Instrument) : Exception

Raised when a measurement takes longer than the allotted duration

TimeUnit

enum TimeUnit : Enum<TimeUnit>

The available time unit values.

ToleranceLimit

class ToleranceLimit(var traceIndex: Int, var name: String, var xRange: Extent? = null, var yCenter: Double, var yTolerance: Double) : Overlay

A tolerance limit.

ToleranceLimitConfigurationResult

class ToleranceLimitConfigurationResult(var validationErrors: List<ToleranceLimitValidationError>, var limit: ToleranceLimit) : OverlayConfigurationResult

The result of configuring the tolerance limit.

ToleranceLimitResult

class ToleranceLimitResult(var traceIndex: Int, var name: String, var pass: Boolean, var minimum: Point? = null, var maximum: Point? = null) : OverlayResult

A tolerance limit result.

ToleranceLimitValidationError

class ToleranceLimitValidationError(var type: ToleranceLimitValidationErrorType)

A validation error for the tolerance limit.

ToleranceLimitValidationErrorType

enum ToleranceLimitValidationErrorType : Enum<ToleranceLimitValidationErrorType>

The validation error types for the tolerance limit.

Trace

sealed interface Trace

A trace.

TraceChange

class TraceChange(var action: TraceChangeAction, var index: Int, var points: List<Point>)

A trace change.

TraceChangeAction

enum TraceChangeAction : Enum<TraceChangeAction>

The available trace change actions.

TraceConfigurationResult

sealed interface TraceConfigurationResult

The result of configuring the trace.

TraceContext

sealed interface TraceContext

Provides the current status of a configured trace, including trace-specific conditions that may prevent it from running.

TransmissionLossFrequencyRecord

class TransmissionLossFrequencyRecord(var id: String, var tags: List<String>, var comment: String? = null, var time: Instant? = null, var location: Location? = null, var instruments: List<InstrumentRecord>, var frequencyUnit: FrequencyUnit, var frequencyRangeHz: Extent, var numberOfPoints: Int, var tracePoints: List<Point>, var overlays: List<Overlay>, var overlayResults: List<OverlayResult>, var viewport: Viewport, var imageFilePath: String? = null, var thumbnailFilePath: String? = null) : Record

A transmission loss frequency record.

TransmissionLossTimeRecord

class TransmissionLossTimeRecord(var id: String, var tags: List<String>, var comment: String? = null, var time: Instant? = null, var location: Location? = null, var instruments: List<InstrumentRecord>, var timeUnit: TimeUnit, var frequencyHz: Double, var tracePoints: List<Point>, var overlays: List<Overlay>, var overlayResults: List<OverlayResult>, var viewport: Viewport, var imageFilePath: String? = null, var thumbnailFilePath: String? = null) : Record

A transmission loss time record.

TxDefaultFrequencyPair

class TxDefaultFrequencyPair(var productName: String, var tx1FrequencyHz: Double, var tx2FrequencyHz: Double)

The default transmitter frequencies for a band and IM product.

Unify

class Unify

The main unify interface

UserCancelledException

class UserCancelledException(message: String? = null, cause: Throwable? = null, var instrument: Instrument) : Exception

Raised when the user cancels a measurement

ValleyMarker

class ValleyMarker(var traceIndex: Int, var name: String, var lowerXBoundMarker: String? = null, var upperXBoundMarker: String? = null, var referenceMarker: String? = null) : Overlay

Puts a marker on the trace at the lowest point

ValleyMarkerConfigurationResult