MMDevice  1.4
Public Member Functions | Static Public Attributes | List of all members
MM::Galvo Class Referenceabstract

#include <MMDevice.h>

Inheritance diagram for MM::Galvo:
MM::Device CDeviceBase< MM::Galvo, U > CGalvoBase< U >

Public Member Functions

virtual DeviceType GetType () const
 
virtual int PointAndFire (double x, double y, double time_us)=0
 
virtual int SetSpotInterval (double pulseInterval_us)=0
 
virtual int SetPosition (double x, double y)=0
 
virtual int GetPosition (double &x, double &y)=0
 
virtual int SetIlluminationState (bool on)=0
 
virtual double GetXRange ()=0
 
virtual double GetXMinimum ()=0
 
virtual double GetYRange ()=0
 
virtual double GetYMinimum ()=0
 
virtual int AddPolygonVertex (int polygonIndex, double x, double y)=0
 
virtual int DeletePolygons ()=0
 
virtual int RunSequence ()=0
 
virtual int LoadPolygons ()=0
 
virtual int SetPolygonRepetitions (int repetitions)=0
 
virtual int RunPolygons ()=0
 
virtual int StopSequence ()=0
 
virtual int GetChannel (char *channelName)=0
 
- 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
 
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
 
virtual HDEVMODULE GetModuleHandle () const =0
 
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 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 = GalvoDevice
 

Detailed Description

Galvo API

Member Function Documentation

◆ GetXMinimum()

virtual double MM::Galvo::GetXMinimum ( )
pure virtual

Minimum X value for the device in native units Must be implemented if it is not 0.0

◆ GetXRange()

virtual double MM::Galvo::GetXRange ( )
pure virtual

X range of the device in native units

◆ GetYMinimum()

virtual double MM::Galvo::GetYMinimum ( )
pure virtual

Minimum Y value for the device in native units Must be implemented if it is not 0.0

◆ GetYRange()

virtual double MM::Galvo::GetYRange ( )
pure virtual

Y range of the device in native units

◆ PointAndFire()

virtual int MM::Galvo::PointAndFire ( double  x,
double  y,
double  time_us 
)
pure virtual

Moves the galvo devices to the requested position, activates the light source, waits for the specified amount of time (in microseconds), and deactivates the light source


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