ModuleInterface.h

Go to the documentation of this file.

 
// FILE:          ModuleInterface.h
// PROJECT:       Micro-Manager
// SUBSYSTEM:     MMDevice - Device adapter kit
//-----------------------------------------------------------------------------
// DESCRIPTION:   The interface to the Micro-Manager plugin modules - (device
//                adapters)
// AUTHOR:        Nenad Amodaj, nenad@amodaj.com, 08/08/2005
//
// NOTE:          This file is also used in the main control module MMCore.
//                Do not change it unless as a part of the MMCore module
//                revision. Discrepancy between this file and the one used to
//                build MMCore will cause malfunction and likely crash.
//
// COPYRIGHT:     University of California, San Francisco, 2006
//
// LICENSE:       This file is distributed under the BSD license.
//                License text is included with the source distribution.
//
//                This file is distributed in the hope that it will be useful,
//                but WITHOUT ANY WARRANTY; without even the implied warranty
//                of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
//
//                IN NO EVENT SHALL THE COPYRIGHT OWNER OR
//                CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
//                INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES.
 
#pragma once
 
#include "MMDevice.h"
 
// If any of the exported module API calls (below) changes, the interface
// version must be incremented. Note that the signature and name of
// GetModuleVersion() must never change.
#define MODULE_INTERFACE_VERSION 10
 
extern "C" {
#ifndef MMDEVICE_CLIENT_BUILD
 
// Make the module interface functions visible from outside the module.
#ifdef _MSC_VER
#   define MODULE_API __declspec(dllexport)
#else
#   define MODULE_API __attribute__((visibility("default")))
#endif
 
   /*
    * Exported module interface
    */
 
   MODULE_API void InitializeModuleData();
 
   MODULE_API MM::Device* CreateDevice(const char* name);
 
   MODULE_API void DeleteDevice(MM::Device* pDevice);
 
   // A common implementation is provided for the following functions.
   // Individual device adapters need not concern themselves with these
   // details.
   MODULE_API long GetModuleVersion();
   MODULE_API long GetDeviceInterfaceVersion();
   MODULE_API unsigned GetNumberOfDevices();
   MODULE_API bool GetDeviceName(unsigned deviceIndex, char* name, unsigned bufferLength);
   MODULE_API bool GetDeviceType(const char* deviceName, int* type);
   MODULE_API bool GetDeviceDescription(const char* deviceName, char* name, unsigned bufferLength);
#endif // MMDEVICE_CLIENT_BUILD
 
#ifdef MMDEVICE_CLIENT_BUILD
   // Function pointer types for module interface functions
   typedef void (*fnInitializeModuleData)();
   typedef MM::Device* (*fnCreateDevice)(const char*);
   typedef void (*fnDeleteDevice)(MM::Device*);
   typedef long (*fnGetModuleVersion)();
   typedef long (*fnGetDeviceInterfaceVersion) ();
   typedef unsigned (*fnGetNumberOfDevices)();
   typedef bool (*fnGetDeviceName)(unsigned, char*, unsigned);
   typedef bool (*fnGetDeviceType)(const char*, int*);
   typedef bool (*fnGetDeviceDescription)(const char*, char*, unsigned);
#endif // MMDEVICE_CLIENT_BUILD
}
 
#ifndef MMDEVICE_CLIENT_BUILD
 
/*
 * Functions for use by the device adapter module
 */
 
void RegisterDevice(const char* deviceName, MM::DeviceType deviceType, const char* description);
 
#endif // MMDEVICE_CLIENT_BUILD