MMDevice
Loading...
Searching...
No Matches
Public Member Functions | Static Public Attributes | List of all members
MM::Shutter Class Referenceabstract

Shutter API. More...

#include <MMDevice.h>

Inherits MM::Device.

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

Public Member Functions

 Shutter ()
 
virtual ~Shutter ()
 
virtual DeviceType GetType () const
 
virtual int SetOpen (bool open=true)=0
 
virtual int GetOpen (bool &open)=0
 
virtual int Fire (double deltaT)=0
 Open the shutter for the given duration, then close it again.
 
- 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 = ShutterDevice
 

Detailed Description

Shutter API.

Constructor & Destructor Documentation

◆ Shutter()

MM::Shutter::Shutter ( )
inline

◆ ~Shutter()

virtual MM::Shutter::~Shutter ( )
inlinevirtual

Member Function Documentation

◆ Fire()

virtual int MM::Shutter::Fire ( double deltaT)
pure virtual

Open the shutter for the given duration, then close it again.

Currently not implemented in any shutter adapters.

◆ GetOpen()

virtual int MM::Shutter::GetOpen ( bool & open)
pure virtual

◆ GetType()

virtual DeviceType MM::Shutter::GetType ( ) const
inlinevirtual

Implements MM::Device.

◆ SetOpen()

virtual int MM::Shutter::SetOpen ( bool open = true)
pure virtual

Member Data Documentation

◆ Type

const DeviceType MM::Shutter::Type = ShutterDevice
static

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