ModuleInterface.cpp File Reference

#include "ModuleInterface.h"
#include "RegisteredDeviceCollection.h"
#include <algorithm>
#include <string>
#include <vector>

Functions
MODULE_API long	GetModuleVersion ()
MODULE_API long	GetDeviceInterfaceVersion ()
MODULE_API unsigned	GetNumberOfDevices ()
MODULE_API bool	GetDeviceName (unsigned deviceIndex, char *name, unsigned bufLen)
MODULE_API bool	GetDeviceType (const char *deviceName, int *type)
MODULE_API bool	GetDeviceDescription (const char *deviceName, char *description, unsigned bufLen)
void	RegisterDevice (const char *deviceName, MM::DeviceType deviceType, const char *deviceDescription)
	Register a device class provided by the device adapter library.

Function Documentation

GetDeviceDescription()

MODULE_API bool GetDeviceDescription	(	const char *	deviceName,
		char *	description,
		unsigned	bufLen )

GetDeviceInterfaceVersion()

MODULE_API long GetDeviceInterfaceVersion

(

)

GetDeviceName()

MODULE_API bool GetDeviceName	(	unsigned	deviceIndex,
		char *	name,
		unsigned	bufLen )

GetDeviceType()

MODULE_API bool GetDeviceType	(	const char *	deviceName,
		int *	type )

GetModuleVersion()

MODULE_API long GetModuleVersion

(

)

GetNumberOfDevices()

MODULE_API unsigned GetNumberOfDevices

(

)

RegisterDevice()

void RegisterDevice	(	const char *	deviceName,
		MM::DeviceType	deviceType,
		const char *	description )

Register a device class provided by the device adapter library.

To be called in the device adapter module's implementation of InitializeModuleData().

Calling this function indicates that the module provides a device with the given name and type, and provides a user-visible description string.

See also

InitializeModuleData()