MM Namespace Reference

Classes
class	Action
	Device action implementation. More...
class	ActionEx
	Extended device action implementation. More...
class	ActionFunctor
	Abstract interface to invoke specific action in the device. More...
class	ActionLambda
	Action implementation using std::function to wrap arbitrary callables. More...
class	AutoFocus
	Auto-focus device API. More...
class	Camera
	Camera API. More...
class	CameraImageMetadata
class	Core
	Callback API to the core control module. More...
class	Device
	Generic device interface. More...
class	FloatProperty
	Floating point property class (uses double type for value representation). More...
class	Galvo
	Galvo API. More...
class	Generic
	Generic Device. More...
class	Hub
	HUB device. More...
class	ImageProcessor
	Image processor API. More...
class	IntegerProperty
	Integer property class. More...
class	Magnifier
	Devices that can change magnification of the system. More...
class	MMTime
	Utility class used both MMCore and devices to maintain time intervals in the uniform, platform independent way. More...
class	PressurePump
	Pressure Pump API. More...
class	Property
	Property API with most of the Property mechanism implemented. More...
class	PropertyBase
	Base API for all device properties. More...
class	PropertyCollection
	An array of properties supported by a device. More...
class	Serial
	Serial port API. More...
class	Shutter
	Shutter API. More...
class	SignalIO
	ADC and DAC interface. More...
class	SLM
	Spatial Light Modulator (SLM) API. More...
class	Stage
	Single axis stage API. More...
class	State
	State device API, e.g. filter wheel, objective turret, etc. More...
class	StringProperty
	String property class. More...
class	TimeoutMs
	Timeout utility class. More...
class	VolumetricPump
	Volumetric Pump API. More...
class	XYStage
	Dual axis stage API. More...

Enumerations
enum	DeviceType {   UnknownType = 0 , AnyType , CameraDevice , ShutterDevice ,   StateDevice , StageDevice , XYStageDevice , SerialDevice ,   GenericDevice , AutoFocusDevice , CoreDevice , ImageProcessorDevice ,   SignalIODevice , MagnifierDevice , SLMDevice , HubDevice ,   GalvoDevice , PressurePumpDevice , VolumetricPumpDevice }
enum	PropertyType { Undef , String , Float , Integer }
enum	ActionType {   NoAction , BeforeGet , AfterSet , IsSequenceable ,   AfterLoadSequence , StartSequence , StopSequence }
enum	PortType { InvalidPort , SerialPort , USBPort , HIDPort }
enum	FocusDirection { FocusDirectionUnknown = 0 , FocusDirectionTowardSample = +1 , FocusDirectionAwayFromSample = -1 }
enum	DeviceNotification { Attention , Done , StatusChanged }
enum	DeviceDetectionStatus { Unimplemented = -2 , Misconfigured = -1 , CanNotCommunicate = 0 , CanCommunicate = 1 }

Variables
const int	MaxStrLength = 1024
const char *const	g_Keyword_Name = "Name"
const char *const	g_Keyword_Description = "Description"
const char *const	g_Keyword_CameraName = "CameraName"
const char *const	g_Keyword_CameraID = "CameraID"
const char *const	g_Keyword_CameraChannelName = "CameraChannelName"
const char *const	g_Keyword_CameraChannelIndex = "CameraChannelIndex"
const char *const	g_Keyword_Binning = "Binning"
const char *const	g_Keyword_Exposure = "Exposure"
const char *const	g_Keyword_ActualExposure = "ActualExposure"
const char *const	g_Keyword_ActualInterval_ms = "ActualInterval-ms"
const char *const	g_Keyword_Interval_ms = "Interval-ms"
const char *const	g_Keyword_Elapsed_Time_ms = "ElapsedTime-ms"
const char *const	g_Keyword_PixelType = "PixelType"
const char *const	g_Keyword_ReadoutTime = "ReadoutTime"
const char *const	g_Keyword_ReadoutMode = "ReadoutMode"
const char *const	g_Keyword_Gain = "Gain"
const char *const	g_Keyword_EMGain = "EMGain"
const char *const	g_Keyword_Offset = "Offset"
const char *const	g_Keyword_CCDTemperature = "CCDTemperature"
const char *const	g_Keyword_CCDTemperatureSetPoint = "CCDTemperatureSetPoint"
const char *const	g_Keyword_State = "State"
const char *const	g_Keyword_Label = "Label"
const char *const	g_Keyword_Position = "Position"
const char *const	g_Keyword_Type = "Type"
const char *const	g_Keyword_Delay = "Delay_ms"
const char *const	g_Keyword_BaudRate = "BaudRate"
const char *const	g_Keyword_DataBits = "DataBits"
const char *const	g_Keyword_StopBits = "StopBits"
const char *const	g_Keyword_Parity = "Parity"
const char *const	g_Keyword_Handshaking = "Handshaking"
const char *const	g_Keyword_DelayBetweenCharsMs = "DelayBetweenCharsMs"
const char *const	g_Keyword_Port = "Port"
const char *const	g_Keyword_AnswerTimeout = "AnswerTimeout"
const char *const	g_Keyword_Speed = "Speed"
const char *const	g_Keyword_CoreDevice = "Core"
const char *const	g_Keyword_CoreInitialize = "Initialize"
const char *const	g_Keyword_CoreCamera = "Camera"
const char *const	g_Keyword_CoreShutter = "Shutter"
const char *const	g_Keyword_CoreXYStage = "XYStage"
const char *const	g_Keyword_CoreFocus = "Focus"
const char *const	g_Keyword_CoreAutoFocus = "AutoFocus"
const char *const	g_Keyword_CoreAutoShutter = "AutoShutter"
const char *const	g_Keyword_CoreChannelGroup = "ChannelGroup"
const char *const	g_Keyword_CoreImageProcessor = "ImageProcessor"
const char *const	g_Keyword_CoreSLM = "SLM"
const char *const	g_Keyword_CoreGalvo = "Galvo"
const char *const	g_Keyword_CorePressurePump = "PressurePump"
const char *const	g_Keyword_CoreVolumetricPump = "VolumetricPump"
const char *const	g_Keyword_CoreTimeoutMs = "TimeoutMs"
const char *const	g_Keyword_Channel = "Channel"
const char *const	g_Keyword_Version = "Version"
const char *const	g_Keyword_ColorMode = "ColorMode"
const char *const	g_Keyword_Transpose_SwapXY = "TransposeXY"
const char *const	g_Keyword_Transpose_MirrorX = "TransposeMirrorX"
const char *const	g_Keyword_Transpose_MirrorY = "TransposeMirrorY"
const char *const	g_Keyword_Transpose_Correction = "TransposeCorrection"
const char *const	g_Keyword_Closed_Position = "ClosedPosition"
const char *const	g_Keyword_HubID = "HubID"
const char *const	g_Keyword_PixelType_GRAY8 = "GRAY8"
const char *const	g_Keyword_PixelType_GRAY16 = "GRAY16"
const char *const	g_Keyword_PixelType_GRAY32 = "GRAY32"
const char *const	g_Keyword_PixelType_RGB32 = "RGB32"
const char *const	g_Keyword_PixelType_RGB64 = "RGB64"
const char *const	g_Keyword_PixelType_Unknown = "Unknown"
const char *const	g_Keyword_Current_Volume = "Volume_uL"
const char *const	g_Keyword_Min_Volume = "Min_Volume_uL"
const char *const	g_Keyword_Max_Volume = "Max_Volume_uL"
const char *const	g_Keyword_Flowrate = "Flowrate_uL_per_sec"
const char *const	g_Keyword_Pressure_Imposed = "Pressure Imposed"
const char *const	g_Keyword_Pressure_Measured = "Pressure Measured"
const char *const	g_Keyword_Metadata_Width = "Width"
const char *const	g_Keyword_Metadata_Height = "Height"
const char *const	g_Keyword_Metadata_CameraLabel = "Camera"
const char *const	g_Keyword_Metadata_Exposure = "Exposure-ms"
const char *const	g_Keyword_Meatdata_Exposure = "Exposure-ms"
const char *const	g_Keyword_Metadata_Score = "Score"
const char *const	g_Keyword_Metadata_ImageNumber = "ImageNumber"
const char *const	g_Keyword_Metadata_ROI_X = "ROI-X-start"
const char *const	g_Keyword_Metadata_ROI_Y = "ROI-Y-start"
const char *const	g_Keyword_Metadata_TimeInCore = "TimeReceivedByCore"
const char *const	g_FieldDelimiters = ","
const char *const	g_CFGCommand_Device = "Device"
const char *const	g_CFGCommand_Label = "Label"
const char *const	g_CFGCommand_Property = "Property"
const char *const	g_CFGCommand_Configuration = "Config"
const char *const	g_CFGCommand_ConfigGroup = "ConfigGroup"
const char *const	g_CFGCommand_Equipment = "Equipment"
const char *const	g_CFGCommand_Delay = "Delay"
const char *const	g_CFGCommand_ImageSynchro = "ImageSynchro"
const char *const	g_CFGCommand_ConfigPixelSize = "ConfigPixelSize"
const char *const	g_CFGCommand_PixelSize_um = "PixelSize_um"
const char *const	g_CFGCommand_PixelSizeAffine = "PixelSizeAffine"
const char *const	g_CFGCommand_PixelSizedxdz = "PixelSizeAngle_dxdz"
const char *const	g_CFGCommand_PixelSizedydz = "PixelSizeAngle_dydz"
const char *const	g_CFGCommand_PixelSizeOptimalZUm = "PixelSizeOptimalZ_Um"
const char *const	g_CFGCommand_ParentID = "Parent"
const char *const	g_CFGCommand_FocusDirection = "FocusDirection"
const char *const	g_CFGGroup_System = "System"
const char *const	g_CFGGroup_System_Startup = "Startup"
const char *const	g_CFGGroup_System_Shutdown = "Shutdown"
const char *const	g_CFGGroup_PixelSizeUm = "PixelSize_um"
const int	_DATABITS_5 = 5
const int	_DATABITS_6 = 6
const int	_DATABITS_7 = 7
const int	_DATABITS_8 = 8
const int	_FLOWCONTROL_NONE = 0
const int	_FLOWCONTROL_RTSCTS_IN = 1
const int	_FLOWCONTROL_RTSCTS_OUT = 2
const int	_FLOWCONTROL_XONXOFF_IN = 4
const int	_FLOWCONTROL_XONXOFF_OUT = 8
const int	_PARITY_EVEN = 2
const int	_PARITY_MARK = 3
const int	_PARITY_NONE = 0
const int	_PARITY_ODD = 1
const int	_PARITY_SPACE = 4
const int	_STOPBITS_1 = 1
const int	_STOPBITS_1_5 = 3
const int	_STOPBITS_2 = 2

Enumeration Type Documentation

ActionType

enum MM::ActionType

Enumerator
NoAction
BeforeGet
AfterSet
IsSequenceable
AfterLoadSequence
StartSequence
StopSequence

DeviceDetectionStatus

enum MM::DeviceDetectionStatus

Enumerator
Unimplemented
Misconfigured
CanNotCommunicate
CanCommunicate

DeviceNotification

enum MM::DeviceNotification

Enumerator
Attention
Done
StatusChanged

DeviceType

enum MM::DeviceType

Enumerator
UnknownType
AnyType
CameraDevice
ShutterDevice
StateDevice
StageDevice
XYStageDevice
SerialDevice
GenericDevice
AutoFocusDevice
CoreDevice
ImageProcessorDevice
SignalIODevice
MagnifierDevice
SLMDevice
HubDevice
GalvoDevice
PressurePumpDevice
VolumetricPumpDevice

FocusDirection

enum MM::FocusDirection

Enumerator
FocusDirectionUnknown
FocusDirectionTowardSample
FocusDirectionAwayFromSample

PortType

enum MM::PortType

Enumerator
InvalidPort
SerialPort
USBPort
HIDPort

PropertyType

enum MM::PropertyType

Enumerator
Undef
String
Float
Integer

Variable Documentation

_DATABITS_5

const int MM::_DATABITS_5 = 5

_DATABITS_6

const int MM::_DATABITS_6 = 6

_DATABITS_7

const int MM::_DATABITS_7 = 7

_DATABITS_8

const int MM::_DATABITS_8 = 8

_FLOWCONTROL_NONE

const int MM::_FLOWCONTROL_NONE = 0

_FLOWCONTROL_RTSCTS_IN

const int MM::_FLOWCONTROL_RTSCTS_IN = 1

_FLOWCONTROL_RTSCTS_OUT

const int MM::_FLOWCONTROL_RTSCTS_OUT = 2

_FLOWCONTROL_XONXOFF_IN

const int MM::_FLOWCONTROL_XONXOFF_IN = 4

_FLOWCONTROL_XONXOFF_OUT

const int MM::_FLOWCONTROL_XONXOFF_OUT = 8

_PARITY_EVEN

const int MM::_PARITY_EVEN = 2

_PARITY_MARK

const int MM::_PARITY_MARK = 3

_PARITY_NONE

const int MM::_PARITY_NONE = 0

_PARITY_ODD

const int MM::_PARITY_ODD = 1

_PARITY_SPACE

const int MM::_PARITY_SPACE = 4

_STOPBITS_1

const int MM::_STOPBITS_1 = 1

_STOPBITS_1_5

const int MM::_STOPBITS_1_5 = 3

_STOPBITS_2

const int MM::_STOPBITS_2 = 2

g_CFGCommand_ConfigGroup

const char* const MM::g_CFGCommand_ConfigGroup = "ConfigGroup"

g_CFGCommand_ConfigPixelSize

const char* const MM::g_CFGCommand_ConfigPixelSize = "ConfigPixelSize"

g_CFGCommand_Configuration

const char* const MM::g_CFGCommand_Configuration = "Config"

g_CFGCommand_Delay

const char* const MM::g_CFGCommand_Delay = "Delay"

g_CFGCommand_Device

const char* const MM::g_CFGCommand_Device = "Device"

g_CFGCommand_Equipment

const char* const MM::g_CFGCommand_Equipment = "Equipment"

g_CFGCommand_FocusDirection

const char* const MM::g_CFGCommand_FocusDirection = "FocusDirection"

g_CFGCommand_ImageSynchro

const char* const MM::g_CFGCommand_ImageSynchro = "ImageSynchro"

g_CFGCommand_Label

const char* const MM::g_CFGCommand_Label = "Label"

g_CFGCommand_ParentID

const char* const MM::g_CFGCommand_ParentID = "Parent"

g_CFGCommand_PixelSize_um

const char* const MM::g_CFGCommand_PixelSize_um = "PixelSize_um"

g_CFGCommand_PixelSizeAffine

const char* const MM::g_CFGCommand_PixelSizeAffine = "PixelSizeAffine"

g_CFGCommand_PixelSizedxdz

const char* const MM::g_CFGCommand_PixelSizedxdz = "PixelSizeAngle_dxdz"

g_CFGCommand_PixelSizedydz

const char* const MM::g_CFGCommand_PixelSizedydz = "PixelSizeAngle_dydz"

g_CFGCommand_PixelSizeOptimalZUm

const char* const MM::g_CFGCommand_PixelSizeOptimalZUm = "PixelSizeOptimalZ_Um"

g_CFGCommand_Property

const char* const MM::g_CFGCommand_Property = "Property"

g_CFGGroup_PixelSizeUm

const char* const MM::g_CFGGroup_PixelSizeUm = "PixelSize_um"

g_CFGGroup_System

const char* const MM::g_CFGGroup_System = "System"

g_CFGGroup_System_Shutdown

const char* const MM::g_CFGGroup_System_Shutdown = "Shutdown"

g_CFGGroup_System_Startup

const char* const MM::g_CFGGroup_System_Startup = "Startup"

g_FieldDelimiters

const char* const MM::g_FieldDelimiters = ","

g_Keyword_ActualExposure

const char* const MM::g_Keyword_ActualExposure = "ActualExposure"

g_Keyword_ActualInterval_ms

const char* const MM::g_Keyword_ActualInterval_ms = "ActualInterval-ms"

g_Keyword_AnswerTimeout

const char* const MM::g_Keyword_AnswerTimeout = "AnswerTimeout"

g_Keyword_BaudRate

const char* const MM::g_Keyword_BaudRate = "BaudRate"

g_Keyword_Binning

const char* const MM::g_Keyword_Binning = "Binning"

g_Keyword_CameraChannelIndex

const char* const MM::g_Keyword_CameraChannelIndex = "CameraChannelIndex"

g_Keyword_CameraChannelName

const char* const MM::g_Keyword_CameraChannelName = "CameraChannelName"

g_Keyword_CameraID

const char* const MM::g_Keyword_CameraID = "CameraID"

g_Keyword_CameraName

const char* const MM::g_Keyword_CameraName = "CameraName"

g_Keyword_CCDTemperature

const char* const MM::g_Keyword_CCDTemperature = "CCDTemperature"

g_Keyword_CCDTemperatureSetPoint

const char* const MM::g_Keyword_CCDTemperatureSetPoint = "CCDTemperatureSetPoint"

g_Keyword_Channel

const char* const MM::g_Keyword_Channel = "Channel"

g_Keyword_Closed_Position

const char* const MM::g_Keyword_Closed_Position = "ClosedPosition"

g_Keyword_ColorMode

const char* const MM::g_Keyword_ColorMode = "ColorMode"

g_Keyword_CoreAutoFocus

const char* const MM::g_Keyword_CoreAutoFocus = "AutoFocus"

g_Keyword_CoreAutoShutter

const char* const MM::g_Keyword_CoreAutoShutter = "AutoShutter"

g_Keyword_CoreCamera

const char* const MM::g_Keyword_CoreCamera = "Camera"

g_Keyword_CoreChannelGroup

const char* const MM::g_Keyword_CoreChannelGroup = "ChannelGroup"

g_Keyword_CoreDevice

const char* const MM::g_Keyword_CoreDevice = "Core"

g_Keyword_CoreFocus

const char* const MM::g_Keyword_CoreFocus = "Focus"

g_Keyword_CoreGalvo

const char* const MM::g_Keyword_CoreGalvo = "Galvo"

g_Keyword_CoreImageProcessor

const char* const MM::g_Keyword_CoreImageProcessor = "ImageProcessor"

g_Keyword_CoreInitialize

const char* const MM::g_Keyword_CoreInitialize = "Initialize"

g_Keyword_CorePressurePump

const char* const MM::g_Keyword_CorePressurePump = "PressurePump"

g_Keyword_CoreShutter

const char* const MM::g_Keyword_CoreShutter = "Shutter"

g_Keyword_CoreSLM

const char* const MM::g_Keyword_CoreSLM = "SLM"

g_Keyword_CoreTimeoutMs

const char* const MM::g_Keyword_CoreTimeoutMs = "TimeoutMs"

g_Keyword_CoreVolumetricPump

const char* const MM::g_Keyword_CoreVolumetricPump = "VolumetricPump"

g_Keyword_CoreXYStage

const char* const MM::g_Keyword_CoreXYStage = "XYStage"

g_Keyword_Current_Volume

const char* const MM::g_Keyword_Current_Volume = "Volume_uL"

g_Keyword_DataBits

const char* const MM::g_Keyword_DataBits = "DataBits"

g_Keyword_Delay

const char* const MM::g_Keyword_Delay = "Delay_ms"

g_Keyword_DelayBetweenCharsMs

const char* const MM::g_Keyword_DelayBetweenCharsMs = "DelayBetweenCharsMs"

g_Keyword_Description

const char* const MM::g_Keyword_Description = "Description"

g_Keyword_Elapsed_Time_ms

const char* const MM::g_Keyword_Elapsed_Time_ms = "ElapsedTime-ms"

g_Keyword_EMGain

const char* const MM::g_Keyword_EMGain = "EMGain"

g_Keyword_Exposure

const char* const MM::g_Keyword_Exposure = "Exposure"

g_Keyword_Flowrate

const char* const MM::g_Keyword_Flowrate = "Flowrate_uL_per_sec"

g_Keyword_Gain

const char* const MM::g_Keyword_Gain = "Gain"

g_Keyword_Handshaking

const char* const MM::g_Keyword_Handshaking = "Handshaking"

g_Keyword_HubID

const char* const MM::g_Keyword_HubID = "HubID"

g_Keyword_Interval_ms

const char* const MM::g_Keyword_Interval_ms = "Interval-ms"

g_Keyword_Label

const char* const MM::g_Keyword_Label = "Label"

g_Keyword_Max_Volume

const char* const MM::g_Keyword_Max_Volume = "Max_Volume_uL"

g_Keyword_Meatdata_Exposure

const char* const MM::g_Keyword_Meatdata_Exposure = "Exposure-ms"

g_Keyword_Metadata_CameraLabel

const char* const MM::g_Keyword_Metadata_CameraLabel = "Camera"

g_Keyword_Metadata_Exposure

const char* const MM::g_Keyword_Metadata_Exposure = "Exposure-ms"

g_Keyword_Metadata_Height

const char* const MM::g_Keyword_Metadata_Height = "Height"

g_Keyword_Metadata_ImageNumber

const char* const MM::g_Keyword_Metadata_ImageNumber = "ImageNumber"

g_Keyword_Metadata_ROI_X

const char* const MM::g_Keyword_Metadata_ROI_X = "ROI-X-start"

g_Keyword_Metadata_ROI_Y

const char* const MM::g_Keyword_Metadata_ROI_Y = "ROI-Y-start"

g_Keyword_Metadata_Score

const char* const MM::g_Keyword_Metadata_Score = "Score"

g_Keyword_Metadata_TimeInCore

const char* const MM::g_Keyword_Metadata_TimeInCore = "TimeReceivedByCore"

g_Keyword_Metadata_Width

const char* const MM::g_Keyword_Metadata_Width = "Width"

g_Keyword_Min_Volume

const char* const MM::g_Keyword_Min_Volume = "Min_Volume_uL"

g_Keyword_Name

const char* const MM::g_Keyword_Name = "Name"

g_Keyword_Offset

const char* const MM::g_Keyword_Offset = "Offset"

g_Keyword_Parity

const char* const MM::g_Keyword_Parity = "Parity"

g_Keyword_PixelType

const char* const MM::g_Keyword_PixelType = "PixelType"

g_Keyword_PixelType_GRAY16

const char* const MM::g_Keyword_PixelType_GRAY16 = "GRAY16"

g_Keyword_PixelType_GRAY32

const char* const MM::g_Keyword_PixelType_GRAY32 = "GRAY32"

g_Keyword_PixelType_GRAY8

const char* const MM::g_Keyword_PixelType_GRAY8 = "GRAY8"

g_Keyword_PixelType_RGB32

const char* const MM::g_Keyword_PixelType_RGB32 = "RGB32"

g_Keyword_PixelType_RGB64

const char* const MM::g_Keyword_PixelType_RGB64 = "RGB64"

g_Keyword_PixelType_Unknown

const char* const MM::g_Keyword_PixelType_Unknown = "Unknown"

g_Keyword_Port

const char* const MM::g_Keyword_Port = "Port"

g_Keyword_Position

const char* const MM::g_Keyword_Position = "Position"

g_Keyword_Pressure_Imposed

const char* const MM::g_Keyword_Pressure_Imposed = "Pressure Imposed"

g_Keyword_Pressure_Measured

const char* const MM::g_Keyword_Pressure_Measured = "Pressure Measured"

g_Keyword_ReadoutMode

const char* const MM::g_Keyword_ReadoutMode = "ReadoutMode"

g_Keyword_ReadoutTime

const char* const MM::g_Keyword_ReadoutTime = "ReadoutTime"

g_Keyword_Speed

const char* const MM::g_Keyword_Speed = "Speed"

g_Keyword_State

const char* const MM::g_Keyword_State = "State"

g_Keyword_StopBits

const char* const MM::g_Keyword_StopBits = "StopBits"

g_Keyword_Transpose_Correction

const char* const MM::g_Keyword_Transpose_Correction = "TransposeCorrection"

g_Keyword_Transpose_MirrorX

const char* const MM::g_Keyword_Transpose_MirrorX = "TransposeMirrorX"

g_Keyword_Transpose_MirrorY

const char* const MM::g_Keyword_Transpose_MirrorY = "TransposeMirrorY"

g_Keyword_Transpose_SwapXY

const char* const MM::g_Keyword_Transpose_SwapXY = "TransposeXY"

g_Keyword_Type

const char* const MM::g_Keyword_Type = "Type"

g_Keyword_Version

const char* const MM::g_Keyword_Version = "Version"

MaxStrLength

const int MM::MaxStrLength = 1024