Interface SpectanoDevice

SpectanoDevice device object.

Namespace: OmicronLab.MaterialAnalyzer.AutomationInterface.Interfaces

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

Syntax

public interface SpectanoDevice

Remarks

When creating this object the first available device will be initialized.

Properties

CurrentDeviceStatus

Gets the current device status.

Declaration

DeviceStatus CurrentDeviceStatus { get; }

Property Value

Type	Description
DeviceStatus	The current device status.

IsDown

Gets a value indicating whether the device is down.

Declaration

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

bool IsOnline { get; }

Property Value

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

Recording

Gets the recording interface handling the recorder creation.

Declaration

Recording Recording { get; }

Property Value

Type	Description
Recording	The recording interface.

SerialNumber

Gets the serial number of the device.

Declaration

string SerialNumber { get; }

Property Value

Type	Description
System.String	The serial number of the device.

Sweep

Gets the sweep interface handling the creation of sweep measurements.

Declaration

Sweep Sweep { get; }

Property Value

Type	Description
Sweep	The sweep interface.

Methods

IsOnlineDelayed(Int32)

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

Declaration

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 asyncronous waiting for a specified delay time.

Declaration

Task<bool> IsOnlineDelayedAsync(int delayTime)

Parameters

Type	Name	Description
System.Int32	delayTime	The delay time.

Returns

Type	Description
Task<System.Boolean>

Remarks

This function is not visible via COM.

SetLogToFile(String, LogLevel)

Sets the logging file path and the log level.

Declaration

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

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

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 depending on keepMeasurementRunning and the SPECTANO 100 Device will be disconnected.

ShutDownAsync(Boolean)

Shuts down the device asynchronous.

Declaration

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 the task running on the device.

Declaration

bool Stop()

Returns

Type	Description
System.Boolean	true if the device could be stopped; otherwise false.

StopAsync()

Stops the task running on the device asynchronous.

Declaration

Task<bool> StopAsync()

Returns

Type	Description
Task<System.Boolean>	true if the device could be stopped; otherwise false.

Events

DeviceStatusChanged

Occurs when the device status changed.

Declaration

event DeviceEventDelegates.DeviceStatusChangedDelegate DeviceStatusChanged

Event Type

Type	Description
DeviceEventDelegates.DeviceStatusChangedDelegate

RuntimeError

Occurs when a runtime error on the device happend.

Declaration

event DeviceEventDelegates.RuntimeErrorDelegate RuntimeError

Event Type

Type	Description
DeviceEventDelegates.RuntimeErrorDelegate