Namespaces
namespace	MM

Macros
#define	MMDEVICE_DEPRECATED [[deprecated]]

#define	DEVICE_OK 0

#define	DEVICE_ERR 1

#define	DEVICE_INVALID_PROPERTY 2

#define	DEVICE_INVALID_PROPERTY_VALUE 3

#define	DEVICE_DUPLICATE_PROPERTY 4

#define	DEVICE_INVALID_PROPERTY_TYPE 5

#define	DEVICE_NATIVE_MODULE_FAILED 6

#define	DEVICE_UNSUPPORTED_DATA_FORMAT 7

#define	DEVICE_INTERNAL_INCONSISTENCY 8

#define	DEVICE_NOT_SUPPORTED 9

#define	DEVICE_UNKNOWN_LABEL 10

#define	DEVICE_UNSUPPORTED_COMMAND 11

#define	DEVICE_UNKNOWN_POSITION 12

#define	DEVICE_NO_CALLBACK_REGISTERED 13

#define	DEVICE_SERIAL_COMMAND_FAILED 14

#define	DEVICE_SERIAL_BUFFER_OVERRUN 15

#define	DEVICE_SERIAL_INVALID_RESPONSE 16

#define	DEVICE_SERIAL_TIMEOUT 17

#define	DEVICE_SELF_REFERENCE 18

#define	DEVICE_NO_PROPERTY_DATA 19

#define	DEVICE_DUPLICATE_LABEL 20

#define	DEVICE_INVALID_INPUT_PARAM 21

#define	DEVICE_BUFFER_OVERFLOW 22

#define	DEVICE_NONEXISTENT_CHANNEL 23

#define	DEVICE_INVALID_PROPERTY_LIMTS 24

#define	DEVICE_SNAP_IMAGE_FAILED 25

#define	DEVICE_IMAGE_PARAMS_FAILED 26

#define	DEVICE_CORE_FOCUS_STAGE_UNDEF 27

#define	DEVICE_CORE_EXPOSURE_FAILED 28

#define	DEVICE_CORE_CONFIG_FAILED 29

#define	DEVICE_CAMERA_BUSY_ACQUIRING 30

#define	DEVICE_INCOMPATIBLE_IMAGE 31

#define	DEVICE_CAN_NOT_SET_PROPERTY 32

#define	DEVICE_CORE_CHANNEL_PRESETS_FAILED 33

#define	DEVICE_LOCALLY_DEFINED_ERROR 34

#define	DEVICE_NOT_CONNECTED 35

#define	DEVICE_COMM_HUB_MISSING 36

#define	DEVICE_DUPLICATE_LIBRARY 37

#define	DEVICE_PROPERTY_NOT_SEQUENCEABLE 38

#define	DEVICE_SEQUENCE_TOO_LARGE 39

#define	DEVICE_OUT_OF_MEMORY 40

#define	DEVICE_NOT_YET_IMPLEMENTED 41

#define	DEVICE_PUMP_IS_RUNNING 42

Enumerations
enum	MM::DeviceType { MM::UnknownType = 0 , MM::AnyType , MM::CameraDevice , MM::ShutterDevice , MM::StateDevice , MM::StageDevice , MM::XYStageDevice , MM::SerialDevice , MM::GenericDevice , MM::AutoFocusDevice , MM::CoreDevice , MM::ImageProcessorDevice , MM::SignalIODevice , MM::MagnifierDevice , MM::SLMDevice , MM::HubDevice , MM::GalvoDevice , MM::PressurePumpDevice , MM::VolumetricPumpDevice }

enum	MM::PropertyType { MM::Undef , MM::String , MM::Float , MM::Integer }

enum	MM::ActionType { MM::NoAction , MM::BeforeGet , MM::AfterSet , MM::IsSequenceable , MM::AfterLoadSequence , MM::StartSequence , MM::StopSequence }

enum	MM::PortType { MM::InvalidPort , MM::SerialPort , MM::USBPort , MM::HIDPort }

enum	MM::FocusDirection { MM::FocusDirectionUnknown = 0 , MM::FocusDirectionTowardSample = +1 , MM::FocusDirectionAwayFromSample = -1 }

enum	MM::DeviceNotification { MM::Attention , MM::Done , MM::StatusChanged }

enum	MM::DeviceDetectionStatus { MM::Unimplemented = -2 , MM::Misconfigured = -1 , MM::CanNotCommunicate = 0 , MM::CanCommunicate = 1 }

Variables
const int	MM_CODE_OK = 0

const int	MM_CODE_ERR = 1

const int	MM::MaxStrLength = 1024

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

const int	MM::_DATABITS_5 = 5

const int	MM::_DATABITS_6 = 6

const int	MM::_DATABITS_7 = 7

const int	MM::_DATABITS_8 = 8

const int	MM::_FLOWCONTROL_NONE = 0

const int	MM::_FLOWCONTROL_RTSCTS_IN = 1

const int	MM::_FLOWCONTROL_RTSCTS_OUT = 2

const int	MM::_FLOWCONTROL_XONXOFF_IN = 4

const int	MM::_FLOWCONTROL_XONXOFF_OUT = 8

const int	MM::_PARITY_EVEN = 2

const int	MM::_PARITY_MARK = 3

const int	MM::_PARITY_NONE = 0

const int	MM::_PARITY_ODD = 1

const int	MM::_PARITY_SPACE = 4

const int	MM::_STOPBITS_1 = 1

const int	MM::_STOPBITS_1_5 = 3

const int	MM::_STOPBITS_2 = 2

Macro Definition Documentation

◆ DEVICE_BUFFER_OVERFLOW

#define DEVICE_BUFFER_OVERFLOW 22

◆ DEVICE_CAMERA_BUSY_ACQUIRING

#define DEVICE_CAMERA_BUSY_ACQUIRING 30

◆ DEVICE_CAN_NOT_SET_PROPERTY

#define DEVICE_CAN_NOT_SET_PROPERTY 32

◆ DEVICE_COMM_HUB_MISSING

#define DEVICE_COMM_HUB_MISSING 36

◆ DEVICE_CORE_CHANNEL_PRESETS_FAILED

#define DEVICE_CORE_CHANNEL_PRESETS_FAILED 33

◆ DEVICE_CORE_CONFIG_FAILED

#define DEVICE_CORE_CONFIG_FAILED 29

◆ DEVICE_CORE_EXPOSURE_FAILED

#define DEVICE_CORE_EXPOSURE_FAILED 28

◆ DEVICE_CORE_FOCUS_STAGE_UNDEF

#define DEVICE_CORE_FOCUS_STAGE_UNDEF 27

◆ DEVICE_DUPLICATE_LABEL

#define DEVICE_DUPLICATE_LABEL 20

◆ DEVICE_DUPLICATE_LIBRARY

#define DEVICE_DUPLICATE_LIBRARY 37

◆ DEVICE_DUPLICATE_PROPERTY

#define DEVICE_DUPLICATE_PROPERTY 4

◆ DEVICE_ERR

#define DEVICE_ERR 1

◆ DEVICE_IMAGE_PARAMS_FAILED

#define DEVICE_IMAGE_PARAMS_FAILED 26

◆ DEVICE_INCOMPATIBLE_IMAGE

#define DEVICE_INCOMPATIBLE_IMAGE 31

◆ DEVICE_INTERNAL_INCONSISTENCY

#define DEVICE_INTERNAL_INCONSISTENCY 8

◆ DEVICE_INVALID_INPUT_PARAM

#define DEVICE_INVALID_INPUT_PARAM 21

◆ DEVICE_INVALID_PROPERTY

#define DEVICE_INVALID_PROPERTY 2

◆ DEVICE_INVALID_PROPERTY_LIMTS

#define DEVICE_INVALID_PROPERTY_LIMTS 24

◆ DEVICE_INVALID_PROPERTY_TYPE

#define DEVICE_INVALID_PROPERTY_TYPE 5

◆ DEVICE_INVALID_PROPERTY_VALUE

#define DEVICE_INVALID_PROPERTY_VALUE 3

◆ DEVICE_LOCALLY_DEFINED_ERROR

#define DEVICE_LOCALLY_DEFINED_ERROR 34

◆ DEVICE_NATIVE_MODULE_FAILED

#define DEVICE_NATIVE_MODULE_FAILED 6

◆ DEVICE_NO_CALLBACK_REGISTERED

#define DEVICE_NO_CALLBACK_REGISTERED 13

◆ DEVICE_NO_PROPERTY_DATA

#define DEVICE_NO_PROPERTY_DATA 19

◆ DEVICE_NONEXISTENT_CHANNEL

#define DEVICE_NONEXISTENT_CHANNEL 23

◆ DEVICE_NOT_CONNECTED

#define DEVICE_NOT_CONNECTED 35

◆ DEVICE_NOT_SUPPORTED

#define DEVICE_NOT_SUPPORTED 9

◆ DEVICE_NOT_YET_IMPLEMENTED

#define DEVICE_NOT_YET_IMPLEMENTED 41

◆ DEVICE_OK

#define DEVICE_OK 0

◆ DEVICE_OUT_OF_MEMORY

#define DEVICE_OUT_OF_MEMORY 40

◆ DEVICE_PROPERTY_NOT_SEQUENCEABLE

#define DEVICE_PROPERTY_NOT_SEQUENCEABLE 38

◆ DEVICE_PUMP_IS_RUNNING

#define DEVICE_PUMP_IS_RUNNING 42

◆ DEVICE_SELF_REFERENCE

#define DEVICE_SELF_REFERENCE 18

◆ DEVICE_SEQUENCE_TOO_LARGE

#define DEVICE_SEQUENCE_TOO_LARGE 39

◆ DEVICE_SERIAL_BUFFER_OVERRUN

#define DEVICE_SERIAL_BUFFER_OVERRUN 15

◆ DEVICE_SERIAL_COMMAND_FAILED

#define DEVICE_SERIAL_COMMAND_FAILED 14

◆ DEVICE_SERIAL_INVALID_RESPONSE

#define DEVICE_SERIAL_INVALID_RESPONSE 16

◆ DEVICE_SERIAL_TIMEOUT

#define DEVICE_SERIAL_TIMEOUT 17

◆ DEVICE_SNAP_IMAGE_FAILED

#define DEVICE_SNAP_IMAGE_FAILED 25

◆ DEVICE_UNKNOWN_LABEL

#define DEVICE_UNKNOWN_LABEL 10

◆ DEVICE_UNKNOWN_POSITION

#define DEVICE_UNKNOWN_POSITION 12

◆ DEVICE_UNSUPPORTED_COMMAND

#define DEVICE_UNSUPPORTED_COMMAND 11

◆ DEVICE_UNSUPPORTED_DATA_FORMAT

#define DEVICE_UNSUPPORTED_DATA_FORMAT 7

◆ MMDEVICE_DEPRECATED

#define MMDEVICE_DEPRECATED [[deprecated]]

Variable Documentation

◆ MM_CODE_ERR

const int MM_CODE_ERR = 1

◆ MM_CODE_OK

const int MM_CODE_OK = 0

Namespaces

Macros

Enumerations

Variables