Serial Framework C++ Edition
CwclSerialMonitor Class Reference

The Serial Monitor allows your application to enumerate available serial devices and to monitor changes in its configuration. More...

#include <wclSerialDevices.h>

Inheritance diagram for CwclSerialMonitor:
CwclCustomSerialMonitor

Public Member Functions

 CwclSerialMonitor ()
 Creates a new Serial Monitor component.
 
int EnumDevices (wclSerialDevices &Devices) const
 Enumerates available serial devices.
 
__event void OnInserted (void *Sender, const wclSerialDevice &Device)
 The event fires when a new serial device appeared in the system.
 
__event void OnRemoved (void *Sender, const wclSerialDevice &Device)
 The event fires when a serial device has been removed from the system.
 
- Public Member Functions inherited from CwclCustomSerialMonitor
 CwclCustomSerialMonitor ()
 Creates a new Monitor component.
 
virtual ~CwclCustomSerialMonitor ()
 Frees the component.
 
int Start ()
 Starts monitoring hardware changes.
 
int Stop ()
 Stops monitoring hardware changes.
 
bool GetMonitoring ()
 Gets the hardware monitoring state.
 
 __declspec (property(get=GetMonitoring)) bool Monitoring
 Gets the hardware monitoring state.
 
wclMessageProcessingMethod GetMessageProcessing () const
 Gets a message processing method used by the monitor.
 
void SetMessageProcessing (const wclMessageProcessingMethod Value)
 Sets a message processing method used by the monitor.
 
 __declspec (property(get=GetMessageProcessing, put=SetMessageProcessing)) wclMessageProcessingMethod MessageProcessing
 Gets and sets a message processing method used by the monitor.
 
__event void OnStarted (void *Sender)
 The event called when the monitor was started.
 
__event void OnStopped (void *Sender)
 The event called when the monitor was stopped.
 

Protected Member Functions

virtual void MessageReceived (const CwclMessage *const Message) override
 The method called when a new notification message received.
 
virtual void DoInserted (const wclSerialDevice &Device)
 Fires the OnInserted event.
 
virtual void DoRemoved (const wclSerialDevice &Device)
 Fires the OnRemoved event.
 
- Protected Member Functions inherited from CwclCustomSerialMonitor
virtual void DoStarted ()
 Calls the OnStarted event.
 
virtual void DoStopped ()
 Calls the OnStopped event.
 

Detailed Description

The Serial Monitor allows your application to enumerate available serial devices and to monitor changes in its configuration.

See also
CwclCustomSerialMonitor