MMDevice  70
Public Member Functions | List of all members
MM::Device Class Referenceabstract

#include <MMDevice.h>

Inheritance diagram for MM::Device:
MM::AutoFocus MM::Camera MM::Galvo MM::Generic MM::Hub MM::ImageProcessor MM::Magnifier MM::SLM MM::Serial MM::Shutter MM::SignalIO MM::Stage MM::State MM::XYStage

Public Member Functions

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
 
virtual int GetPropertySequenceMaxLength (const char *propertyName, long &nrEvents) const =0
 
virtual int StartPropertySequence (const char *propertyName)=0
 
virtual int StopPropertySequence (const char *propertyName)=0
 
virtual int ClearPropertySequence (const char *propertyName)=0
 
virtual int AddToPropertySequence (const char *propertyName, const char *value)=0
 
virtual int SendPropertySequence (const char *propertyName)=0
 
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
 
 MM_DEPRECATED (virtual HDEVMODULE GetModuleHandle() const)=0
 
 MM_DEPRECATED (virtual void SetModuleHandle(HDEVMODULE hLibraryHandle))=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
 
virtual DeviceType GetType () const =0
 
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
 

Detailed Description

Generic device interface.

Member Function Documentation

◆ AddToPropertySequence()

virtual int MM::Device::AddToPropertySequence ( const char *  propertyName,
const char *  value 
)
pure virtual

Add one value to the sequence

Implemented in CDeviceBase< MM::Hub, U >, CDeviceBase< MM::Stage, U >, CDeviceBase< MM::Serial, U >, CDeviceBase< MM::ImageProcessor, U >, CDeviceBase< MM::XYStage, U >, CDeviceBase< MM::SignalIO, U >, CDeviceBase< MM::Shutter, U >, CDeviceBase< MM::Generic, U >, CDeviceBase< MM::AutoFocus, U >, CDeviceBase< MM::State, U >, CDeviceBase< MM::SLM, U >, CDeviceBase< MM::Galvo, U >, CDeviceBase< MM::Magnifier, U >, and CDeviceBase< MM::Camera, U >.

◆ ClearPropertySequence()

virtual int MM::Device::ClearPropertySequence ( const char *  propertyName)
pure virtual

remove previously added sequence

Implemented in CDeviceBase< MM::Hub, U >, CDeviceBase< MM::Stage, U >, CDeviceBase< MM::Serial, U >, CDeviceBase< MM::ImageProcessor, U >, CDeviceBase< MM::XYStage, U >, CDeviceBase< MM::SignalIO, U >, CDeviceBase< MM::Shutter, U >, CDeviceBase< MM::Generic, U >, CDeviceBase< MM::AutoFocus, U >, CDeviceBase< MM::State, U >, CDeviceBase< MM::SLM, U >, CDeviceBase< MM::Galvo, U >, CDeviceBase< MM::Magnifier, U >, and CDeviceBase< MM::Camera, U >.

◆ GetPropertySequenceMaxLength()

virtual int MM::Device::GetPropertySequenceMaxLength ( const char *  propertyName,
long &  nrEvents 
) const
pure virtual

The largest sequence that can be stored in the device

Implemented in CDeviceBase< MM::Hub, U >, CDeviceBase< MM::Stage, U >, CDeviceBase< MM::Serial, U >, CDeviceBase< MM::ImageProcessor, U >, CDeviceBase< MM::XYStage, U >, CDeviceBase< MM::SignalIO, U >, CDeviceBase< MM::Shutter, U >, CDeviceBase< MM::Generic, U >, CDeviceBase< MM::AutoFocus, U >, CDeviceBase< MM::State, U >, CDeviceBase< MM::SLM, U >, CDeviceBase< MM::Galvo, U >, CDeviceBase< MM::Magnifier, U >, and CDeviceBase< MM::Camera, U >.

◆ IsPropertySequenceable()

virtual int MM::Device::IsPropertySequenceable ( const char *  name,
bool &  isSequenceable 
) const
pure virtual

Sequences can be used for fast acquisitions, synchronized by TTLs rather than computer commands. Sequences of states can be uploaded to the device. The device will cycle through the uploaded list of states (triggered by an external trigger - most often coming from the camera). If the device is capable (and ready) to do so isSequenceable will be true

Implemented in CDeviceBase< MM::Hub, U >, CDeviceBase< MM::Stage, U >, CDeviceBase< MM::Serial, U >, CDeviceBase< MM::ImageProcessor, U >, CDeviceBase< MM::XYStage, U >, CDeviceBase< MM::SignalIO, U >, CDeviceBase< MM::Shutter, U >, CDeviceBase< MM::Generic, U >, CDeviceBase< MM::AutoFocus, U >, CDeviceBase< MM::State, U >, CDeviceBase< MM::SLM, U >, CDeviceBase< MM::Galvo, U >, CDeviceBase< MM::Magnifier, U >, and CDeviceBase< MM::Camera, U >.

◆ SendPropertySequence()

virtual int MM::Device::SendPropertySequence ( const char *  propertyName)
pure virtual

Signal that we are done sending sequence values so that the adapter can send the whole sequence to the device

Implemented in CDeviceBase< MM::Hub, U >, CDeviceBase< MM::Stage, U >, CDeviceBase< MM::Serial, U >, CDeviceBase< MM::ImageProcessor, U >, CDeviceBase< MM::XYStage, U >, CDeviceBase< MM::SignalIO, U >, CDeviceBase< MM::Shutter, U >, CDeviceBase< MM::Generic, U >, CDeviceBase< MM::AutoFocus, U >, CDeviceBase< MM::State, U >, CDeviceBase< MM::SLM, U >, CDeviceBase< MM::Galvo, U >, CDeviceBase< MM::Magnifier, U >, and CDeviceBase< MM::Camera, U >.

◆ Shutdown()

virtual int MM::Device::Shutdown ( )
pure virtual

Shuts down (unloads) the device. Required by the MM::Device API. Ideally this method will completely unload the device and release all resources. Shutdown() may be called multiple times in a row. After Shutdown() we should be allowed to call Initialize() again to load the device without causing problems.

◆ StartPropertySequence()

virtual int MM::Device::StartPropertySequence ( const char *  propertyName)
pure virtual

Starts execution of the sequence

Implemented in CDeviceBase< MM::Hub, U >, CDeviceBase< MM::Stage, U >, CDeviceBase< MM::Serial, U >, CDeviceBase< MM::ImageProcessor, U >, CDeviceBase< MM::XYStage, U >, CDeviceBase< MM::SignalIO, U >, CDeviceBase< MM::Shutter, U >, CDeviceBase< MM::Generic, U >, CDeviceBase< MM::AutoFocus, U >, CDeviceBase< MM::State, U >, CDeviceBase< MM::SLM, U >, CDeviceBase< MM::Galvo, U >, CDeviceBase< MM::Magnifier, U >, and CDeviceBase< MM::Camera, U >.

◆ StopPropertySequence()

virtual int MM::Device::StopPropertySequence ( const char *  propertyName)
pure virtual

Stops execution of the device

Implemented in CDeviceBase< MM::Hub, U >, CDeviceBase< MM::Stage, U >, CDeviceBase< MM::Serial, U >, CDeviceBase< MM::ImageProcessor, U >, CDeviceBase< MM::XYStage, U >, CDeviceBase< MM::SignalIO, U >, CDeviceBase< MM::Shutter, U >, CDeviceBase< MM::Generic, U >, CDeviceBase< MM::AutoFocus, U >, CDeviceBase< MM::State, U >, CDeviceBase< MM::SLM, U >, CDeviceBase< MM::Galvo, U >, CDeviceBase< MM::Magnifier, U >, and CDeviceBase< MM::Camera, U >.

The documentation for this class was generated from the following file:
Generated by doxygen 1.9.1