MM::Serial Class Reference

Serial port API. More...

#include <MMDevice.h>

Inherits MM::Device.

Inherited by CDeviceBase< MM::Serial, U >.

Public Member Functions
	Serial ()
virtual	~Serial ()
virtual DeviceType	GetType () const
virtual PortType	GetPortType () const =0
virtual int	SetCommand (const char *command, const char *term)=0
virtual int	GetAnswer (char *txt, unsigned maxChars, const char *term)=0
virtual int	Write (const unsigned char *buf, unsigned long bufLen)=0
virtual int	Read (unsigned char *buf, unsigned long bufLen, unsigned long &charsRead)=0
virtual int	Purge ()=0
Public Member Functions inherited from MM::Device
	Device ()
virtual	~Device ()
virtual unsigned	GetNumberOfProperties () const =0
virtual int	GetProperty (const char *name, char *value) const =0
virtual int	SetProperty (const char *name, const char *value)=0
virtual bool	HasProperty (const char *name) const =0
virtual bool	GetPropertyName (unsigned idx, char *name) const =0
virtual int	GetPropertyReadOnly (const char *name, bool &readOnly) const =0
virtual int	GetPropertyInitStatus (const char *name, bool &preInit) const =0
virtual int	HasPropertyLimits (const char *name, bool &hasLimits) const =0
virtual int	GetPropertyLowerLimit (const char *name, double &lowLimit) const =0
virtual int	GetPropertyUpperLimit (const char *name, double &hiLimit) const =0
virtual int	GetPropertyType (const char *name, MM::PropertyType &pt) const =0
virtual unsigned	GetNumberOfPropertyValues (const char *propertyName) const =0
virtual bool	GetPropertyValueAt (const char *propertyName, unsigned index, char *value) const =0
virtual int	IsPropertySequenceable (const char *name, bool &isSequenceable) const =0
	Check whether the given property can be used with sequences.
virtual int	GetPropertySequenceMaxLength (const char *propertyName, long &nrEvents) const =0
	Return the largest sequence that can be stored in the device.
virtual int	StartPropertySequence (const char *propertyName)=0
	Start execution of the sequence.
virtual int	StopPropertySequence (const char *propertyName)=0
	Stop execution of the sequence.
virtual int	ClearPropertySequence (const char *propertyName)=0
	Remove previously added sequence.
virtual int	AddToPropertySequence (const char *propertyName, const char *value)=0
	Add one value to the sequence.
virtual int	SendPropertySequence (const char *propertyName)=0
	Signal that we are done sending sequence values so that the adapter can send the whole sequence to the device.
virtual bool	GetErrorText (int errorCode, char *errMessage) const =0
virtual bool	Busy ()=0
virtual double	GetDelayMs () const =0
virtual void	SetDelayMs (double delay)=0
virtual bool	UsesDelay ()=0
virtual void	SetLabel (const char *label)=0
virtual void	GetLabel (char *name) const =0
virtual void	SetModuleName (const char *moduleName)=0
virtual void	GetModuleName (char *moduleName) const =0
virtual void	SetDescription (const char *description)=0
virtual void	GetDescription (char *description) const =0
virtual int	Initialize ()=0
virtual int	Shutdown ()=0
	Shut down (unload) the device.
virtual void	GetName (char *name) const =0
virtual void	SetCallback (Core *callback)=0
virtual bool	SupportsDeviceDetection (void)=0
virtual MM::DeviceDetectionStatus	DetectDevice (void)=0
virtual void	SetParentID (const char *parentId)=0
virtual void	GetParentID (char *parentID) const =0

Static Public Attributes
static const DeviceType	Type = SerialDevice

Detailed Description

Serial port API.

Constructor & Destructor Documentation

Serial()

MM::Serial::Serial ( )

inline

~Serial()

virtual MM::Serial::~Serial ( )

inlinevirtual

Member Function Documentation

GetAnswer()

virtual int MM::Serial::GetAnswer ( char * txt, unsigned maxChars, const char * term )

pure virtual

GetPortType()

virtual PortType MM::Serial::GetPortType ( ) const

pure virtual

GetType()

virtual DeviceType MM::Serial::GetType ( ) const

inlinevirtual

Implements MM::Device.

Purge()

virtual int MM::Serial::Purge ( )

pure virtual

Read()

virtual int MM::Serial::Read ( unsigned char * buf, unsigned long bufLen, unsigned long & charsRead )

pure virtual

SetCommand()

virtual int MM::Serial::SetCommand ( const char * command, const char * term )

pure virtual

Write()

virtual int MM::Serial::Write ( const unsigned char * buf, unsigned long bufLen )

pure virtual

Member Data Documentation

Type

const DeviceType MM::Serial::Type = SerialDevice

static

---

The documentation for this class was generated from the following files:

• MMDevice.h
• MMDevice.cpp