Interface FrequencySweepMeasurement

Interface describing frequency sweep measurements.

Namespace: OmicronLab.MaterialAnalyzer.AutomationInterface.Interfaces.MeasurementModes.Sweep.FrequencySweep

Assembly: OmicronLab.MaterialAnalyzer.AutomationInterface.dll (1.60.627.0)

Syntax

public interface FrequencySweepMeasurement

Properties

CorrectedResults

Gets the corrected results.

Declaration

Results CorrectedResults { get; }

Property Value

Type	Description
Results	The corrected results.

Remarks

Reference Measurement is required.

FrequencySweepSettings

Gets the frequency sweep settings allowing creation of settings of various types.

Declaration

FrequencySweepSettings FrequencySweepSettings { get; }

Property Value

Type	Description
FrequencySweepSettings	The frequency sweep settings.

IsCompleted

Gets a value indicating whether this measurement is completed.

Declaration

bool IsCompleted { get; }

Property Value

Type	Description
System.Boolean	true if this measurement is completed; otherwise, false.

MeasurementSettings

Gets the measurement settings.

Declaration

MeasurementSettings MeasurementSettings { get; }

Property Value

Type	Description
MeasurementSettings	The measurement settings.

PreMeasurement

Gets the pre measurement settings.

Declaration

PreMeasurement PreMeasurement { get; }

Property Value

Type	Description
PreMeasurement	The pre measurement.

ReferenceMeasurements

Gets the reference measurements.

Declaration

ReferenceMeasurements ReferenceMeasurements { get; }

Property Value

Type	Description
ReferenceMeasurements	The reference measurements.

Results

Gets the results.

Declaration

Results Results { get; }

Property Value

Type	Description
Results	The results.

TestCell

Gets the test cell.

Declaration

TestCell TestCell { get; }

Property Value

Type	Description
TestCell	The test cell.

TestCellSample

Gets the test cell sample.

Declaration

TestCellSample TestCellSample { get; }

Property Value

Type	Description
TestCellSample	The test cell sample.

Methods

EstimateMeasurementTime()

Estimates the measurement time in seconds.

Declaration

double EstimateMeasurementTime()

Returns

Type	Description
System.Double

ExecuteMeasurement()

Executes the measurement.

Declaration

ExecutionState ExecuteMeasurement()

Returns

Type	Description
ExecutionState

Remarks

Already measured results will be deleted.

ExecuteMeasurementAsync()

Executes the measurement asynchronous.

Declaration

Task<ExecutionState> ExecuteMeasurementAsync()

Returns

Type	Description
Task<ExecutionState>

Remarks

Already measured results will be deleted.

ReconnectMeasurementToDevice()

Reconnects the measurement to an already running device.

Declaration

ReconnectionState ReconnectMeasurementToDevice()

Returns

Type	Description
ReconnectionState

ReconnectMeasurementToDeviceAsync()

Reconnects the measurement to an already running device asynchronous.

Declaration

Task<ReconnectionState> ReconnectMeasurementToDeviceAsync()

Returns

Type	Description
Task<ReconnectionState>

Remarks

This function is not visible via COM.

StopMeasurement()

Stops the measurement.

Declaration

StopState StopMeasurement()

Returns

Type	Description
StopState

StopMeasurementAsync()

Stops the measurement asynchronous.

Declaration

Task<StopState> StopMeasurementAsync()

Returns

Type	Description
Task<StopState>

Remarks

This function is not visible via COM.

UploadResultsFromDevice()

Uploads the results from the device.

Declaration

UploadState UploadResultsFromDevice()

Returns

Type	Description
UploadState

UploadResultsFromDeviceAsync()

Uploads the results from the device asynchronous.

Declaration

Task<UploadState> UploadResultsFromDeviceAsync()

Returns

Type	Description
Task<UploadState>

Remarks

This function is not visible via COM.

Events

ExecutionProgressUpdate

Occurs on every measurement progress update.

Declaration

event FrequencySweepEventDelegates.ExecutionProgressUpdateDelegate ExecutionProgressUpdate

Event Type

Type	Description
FrequencySweepEventDelegates.ExecutionProgressUpdateDelegate

NewFdsResultAvailable

Occurs when new FDS results are available.

Declaration

event FrequencySweepEventDelegates.NewFdsResultAvailableDelegate NewFdsResultAvailable

Event Type

Type	Description
FrequencySweepEventDelegates.NewFdsResultAvailableDelegate

NewPdcResultAvailable

Occurs when new PDC results are available.

Declaration

event FrequencySweepEventDelegates.NewPdcResultAvailableDelegate NewPdcResultAvailable

Event Type

Type	Description
FrequencySweepEventDelegates.NewPdcResultAvailableDelegate