MM::PressurePump Class Reference

Pressure Pump API. More...

#include <MMDevice.h>

Inheritance diagram for MM::PressurePump:

Public Member Functions
virtual DeviceType	GetType () const
virtual int	Stop ()=0
	Stop the pump.
virtual int	Calibrate ()=0
	Calibrate the pressure controller.
virtual bool	RequiresCalibration ()=0
	Return whether the pressure controller is functional before calibration, or it needs to undergo internal calibration before any commands can be executed.
virtual int	SetPressureKPa (double pressureKPa)=0
	Set the pressure of the pressure controller.
virtual int	GetPressureKPa (double &pressureKPa)=0
	Get the pressure of the pressure controller.
Public Member Functions inherited from MM::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 = PressurePumpDevice

Detailed Description

Pressure Pump API.

Member Function Documentation

Calibrate()

virtual int MM::PressurePump::Calibrate ( )

pure virtual

Calibrate the pressure controller.

If no internal calibration is supported, just return DEVICE_UNSUPPORTED_COMMAND.

Optional function of PressurePump API.

GetPressureKPa()

virtual int MM::PressurePump::GetPressureKPa ( double &  pressureKPa )

pure virtual

Get the pressure of the pressure controller.

The returned value has to be in kPa. The implementation, therefore, should convert the value provided by the pressure controller to kPa.

Required function of PressurePump API.

GetType()

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

inlinevirtual

Implements MM::Device.

RequiresCalibration()

virtual bool MM::PressurePump::RequiresCalibration ( )

pure virtual

Return whether the pressure controller is functional before calibration, or it needs to undergo internal calibration before any commands can be executed.

Required function of PressurePump API.

SetPressureKPa()

virtual int MM::PressurePump::SetPressureKPa ( double  pressureKPa )

pure virtual

Set the pressure of the pressure controller.

The provided value will be in kPa. The implementation should convert the unit from kPa to the desired unit by the device.

Required function of PressurePump API.

Stop()

virtual int MM::PressurePump::Stop ( )

pure virtual

Stop the pump.

The implementation should halt any dispensing/withdrawal, and make the pump available again (make Busy() return false).

Required function of PressurePump API.

---

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

• MMDevice.h
• MMDevice.cpp