Class Spectano100

Start class for the Automation interface.

Inheritance

System.Object

Spectano100

Implements

SpectanoDevice

System.IDisposable

Inherited Members

System.Object.ToString()

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

Namespace: OmicronLab.MaterialAnalyzer.AutomationInterface

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

Syntax

public class Spectano100 : SpectanoDevice, IDisposable

Constructors

Spectano100()

Initializes a new instance of the Spectano100 class.

Declaration

public Spectano100()

Remarks

Automatically connects to the first found device.

Properties

CurrentDeviceStatus

Gets the current device status.

Declaration

public DeviceStatus CurrentDeviceStatus { get; }

Property Value

Type	Description
DeviceStatus	The current device status.

FirmwareFilePath

Gets the firmware file path.

Declaration

public string FirmwareFilePath { get; }

Property Value

Type	Description
System.String

IsDown

Gets a value indicating whether the device is down.

Declaration

public bool IsDown { get; }

Property Value

Type	Description
System.Boolean	true if the device is down; otherwise, false.

Remarks

This is an indicator for the completion of the ShutDown(Boolean).

IsOnline

Gets a value indicating whether the device is online.

Declaration

public bool IsOnline { get; }

Property Value

Type	Description
System.Boolean	true if the device is online; otherwise, false.

Recording

Gets the recorder.

Declaration

public Recording Recording { get; }

Property Value

Type	Description
Recording	The recorder.

SerialNumber

Gets the serial number.

Declaration

public string SerialNumber { get; }

Property Value

Type	Description
System.String	The serial number.

Sweep

Gets the sweep measurements.

Declaration

public Sweep Sweep { get; }

Property Value

Type	Description
Sweep	The sweep.

Methods

Dispose()

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

Declaration

public void Dispose()

Dispose(Boolean)

Releases unmanaged and - optionally - managed resources.

Declaration

protected virtual void Dispose(bool disposing)

Parameters

Type	Name	Description
System.Boolean	disposing	true to release both managed and unmanaged resources; false to release only unmanaged resources.

Finalize()

Finalizes an instance of the Spectano100 class.

Declaration

protected void Finalize()

IsOnlineDelayed(Int32)

Determines whether the device is online waiting for a specified delay time.

Declaration

public bool IsOnlineDelayed(int delayTime)

Parameters

Type	Name	Description
System.Int32	delayTime	The delay time in milliseconds.

Returns

Type	Description
System.Boolean	true if the device is online; otherwise, false.

IsOnlineDelayedAsync(Int32)

Determines whether the device is online asynchronous waiting for a specified delay time.

Declaration

public Task<bool> IsOnlineDelayedAsync(int delayTime)

Parameters

Type	Name	Description
System.Int32	delayTime	The delay time.

Returns

Type	Description
Task<System.Boolean>	true if the device is online; otherwise, false.

Remarks

This function is not visible via COM.

SetLogToFile(String, LogLevel)

Sets the logging file path and the log level.

Declaration

public void SetLogToFile(string path, LogLevel logLevel)

Parameters

Type	Name	Description
System.String	path	The path.
LogLevel	logLevel	The log level.

Remarks

The path parameter is permitted to specify relative or absolute path information.Relative path information is interpreted as relative to the current working directory.

SetLogToStream(UInt16, LogLevel)

Sets the port and the log level for logging to network stream.

Declaration

public void SetLogToStream(ushort port, LogLevel logLevel)

Parameters

Type	Name	Description
System.UInt16	port	The port.
LogLevel	logLevel	The log level.

ShutDown(Boolean)

Shuts down the device.

Declaration

public void ShutDown(bool keepMeasurementRunning)

Parameters

Type	Name	Description
System.Boolean	keepMeasurementRunning	if set to true the measurement stays running on the device.

Remarks

The running measurement will be stopped and the SPECTANO 100 Device will be disconnected.

ShutDownAsync(Boolean)

Shuts down the device asynchronous.

Declaration

public Task ShutDownAsync(bool keepMeasurementRunning)

Parameters

Type	Name	Description
System.Boolean	keepMeasurementRunning	if set to true the measurement stays running on the device.

Returns

Type	Description
Task

Remarks

ShutDown(Boolean).

Stop()

Stops this instance.

Declaration

public bool Stop()

Returns

Type	Description
System.Boolean

StopAsync()

Stops this instance asynchronous.

Declaration

public Task<bool> StopAsync()

Returns

Type	Description
Task<System.Boolean>

Events

DeviceStatusChanged

Occurs when the device status changed.

Declaration

public event DeviceEventDelegates.DeviceStatusChangedDelegate DeviceStatusChanged

Event Type

Type	Description
DeviceEventDelegates.DeviceStatusChangedDelegate

RuntimeError

Occurs when a runtime error on the device happened.

Declaration

public event DeviceEventDelegates.RuntimeErrorDelegate RuntimeError

Event Type

Type	Description
DeviceEventDelegates.RuntimeErrorDelegate

Implements

SpectanoDevice

System.IDisposable