.Net Windows DECL Reference
 
Loading...
Searching...
No Matches
MWSDK.NetCore Namespace Reference

Classes

class  MedWandControllerBase
 Serves as the base class for managing and interacting with MedWand devices. More...
 
class  MedWandReading
 Class used to return reading data from MedWand sensor. More...
 

Enumerations

enum  DeviceState {
  NotConnected , Connecting , Connected , Initializing ,
  Initialized , DisConnecting , Error
}
 Represents the various states of a device within the device state machine. More...
 
enum  StethoscopeFilter { Off , Heart , Lungs , Bowel }
 Enumeration for MedWand stethoscope filter selection. More...
 
enum  MedWandGeneration {
  Generation1 , Generation2 , Generation25 , Unknown ,
  NotReady
}
 Enumeration for MedWand Device. More...
 
enum  LicenseState { Invalid , InvalidFeature , Expiring , Expired }
 Defines the various states of a license within the system. More...
 
enum  ReadingState {
  Stopped , Starting , Started , Reading ,
  Recording , Stopping , Error
}
 Represents the various states of the reading process in the MedWand SDK. More...
 
enum  MedWandSensor {
  None , Thermometer , PulseOximeter , Ecg ,
  Stethoscope , Otoscope
}
 Enumeration for MedWand device sensor selection. More...
 
enum  ErrorCode {
  Generic , DeviceNotFound , SerialPortConnectionError , SerialPortOpenError ,
  SerialPortError , SerialPortClosedError , SerialPortTransmitError , SerialPortNotification
}
 Enumeration for MedWand device/communication errors. More...
 

Functions

readonly struct LicenseError (LicenseState state, Exception exception)
 Represents an error associated with a license, including its state and any related exception details.
 
readonly struct MedWandDeviceError (ErrorCode code, Exception exception)
 Represents an error encountered by a MedWand device or during communication with it.
 

Enumeration Type Documentation

◆ DeviceState

Represents the various states of a device within the device state machine.

Enumerator
NotConnected 

Indicates that the device is not currently connected.

Connecting 

Indicates that the device is in the process of establishing a connection.

Connected 

Indicates that the device is successfully connected and ready for further operations.

Initializing 

Indicates that the device is in the process of initializing. This state occurs after the device has connected but before it is fully initialized.

Initialized 

Indicates that the device has completed the initialization process and is ready for operation.

DisConnecting 

Represents the state where the device is in the process of disconnecting from its current connection.

Error 

Represents an error state in the device state machine, indicating that the device has encountered an issue.

◆ ErrorCode

Enumeration for MedWand device/communication errors.

Enumerator
Generic 

An un specified error has occured.

DeviceNotFound 

The MedWand device was not found.

SerialPortConnectionError 

The serial port has failed to connect.

SerialPortOpenError 

The serial port has failed to open.

SerialPortError 

The serial port has failed.

SerialPortClosedError 

The serial port has failed.

SerialPortTransmitError 

The serial port transmission has failed.

SerialPortNotification 

The serial port notification.

◆ LicenseState

Defines the various states of a license within the system.

The license is invalid or not recognized.

The license has been issued but is not yet active.

The license is currently active and valid.

The license is nearing its expiration date.

The license has expired and is no longer valid.

Enumerator
Invalid 

Represents an invalid state of the license, indicating that the license is either missing, corrupted, or otherwise unusable.

InvalidFeature 

Indicates that the license is does not support the feature requested.

Expiring 

Indicates that the license is nearing its expiration date but is still valid.

Expired 

Indicates that the license has expired and is no longer valid.

◆ MedWandGeneration

Enumeration for MedWand Device.

Enumerator
Generation1 

Generation 1.0 MedWand Device.

Generation2 

Generation 2.0 MedWand Device.

Generation25 

Generation 2.5 MedWand Device.

Unknown 

Unknown Generation MedWand Device.

NotReady 

Initial state of generation.

◆ MedWandSensor

Enumeration for MedWand device sensor selection.

Enumerator
None 

No sensor selected.

Thermometer 

Thermometer sensor.

PulseOximeter 

PulseOximeter sensor.

Ecg 

Ecg sensor.

Stethoscope 

Stethoscope sensor.

Otoscope 

Otoscope sensor.

◆ ReadingState

Represents the various states of the reading process in the MedWand SDK.

Enumerator
Stopped 

Indicates that the reading process is stopped and no active operations are being performed.

Starting 

Indicates that the reading process is in the initial phase of starting.

Started 

Indicates that the reading process has successfully started and is actively running.

Reading 

Indicates the state where the MedWand device is actively relaying readings.

Recording 

Indicates that the MedWand SDK is actively recording data during the reading process.

Stopping 

Indicates that the reading process is in the phase of stopping.

Error 

Indicates that an error has occurred during the reading process in the MedWand SDK.

◆ StethoscopeFilter

Enumeration for MedWand stethoscope filter selection.

Enumerator
Off 

Default audio filter used when initialized.

Heart 

Heart audio filter.

Lungs 

Lungs audio filter.

Bowel 

Bowel audio filter.

Function Documentation

◆ LicenseError()

readonly struct MWSDK.NetCore.LicenseError ( LicenseState state,
Exception exception )

Represents an error associated with a license, including its state and any related exception details.

Represents the current state of the license.

Exception details.

◆ MedWandDeviceError()

readonly struct MWSDK.NetCore.MedWandDeviceError ( ErrorCode code,
Exception exception )

Represents an error encountered by a MedWand device or during communication with it.

This struct encapsulates an error code and an associated exception, providing detailed information about the nature of the error. It is used throughout the MedWand SDK to standardize error reporting and handling.

Error code.

Exception details.