com.inscoper.api.ExternalDriverDescription¶

ExternalDriverDescription class for external device drivers. More...

Inherits from com.inscoper.api.DriverDescription

Inherited by com.inscoper.api.CustomDriverDescription, com.inscoper.api.MicroManagerDriverDescription

Public Functions¶

	Name
synchronized void	delete()
EDriverType	getDriverType() Get the driver type.
boolean	isEqual(DriverDescription other) Checks whether this driver description is identical to another one.
EDeviceType	getDeviceType() Get the device type.
void	setDeviceType(EDeviceType deviceType) Set the device type.
int	getRealType()
ExternalDriverDescription	createProxy(long cPtr, boolean cMemoryOwn)

Protected Functions¶

	Name
	ExternalDriverDescription(long cPtr, boolean cMemoryOwn)
void	swigSetCMemOwn(boolean own)
void	finalize()
long	getCPtr(ExternalDriverDescription obj)

Additional inherited members¶

Public Functions inherited from com.inscoper.api.DriverDescription

	Name
CustomDriverDescription	castToCustomDriverDescription(DriverDescription driverDescription)
InscoperBoxDriverDescription	castToInscoperBoxDriverDescription(DriverDescription driverDescription)
MicroManagerDriverDescription	castToMicroManagerDriverDescription(DriverDescription driverDescription)
ExternalDriverDescription	castToExternalDriverDescription(DriverDescription driverDescription)

Protected Functions inherited from com.inscoper.api.DriverDescription

	Name
	DriverDescription(long cPtr, boolean cMemoryOwn)

Detailed Description¶

public class com.inscoper.api.ExternalDriverDescription;

ExternalDriverDescription class for external device drivers.

Note: This class is non-copyable and non-movable.

This class provides a description for drivers associated with devices connected directly to the computer, including their specific device type.

Public Functions Documentation¶

function delete¶

public synchronized void delete()

Reimplements: com.inscoper.api.DriverDescription.delete

Reimplemented by: com.inscoper.api.CustomDriverDescription.delete, com.inscoper.api.MicroManagerDriverDescription.delete

function getDriverType¶

public EDriverType getDriverType()

Get the driver type.

Return: The driver type

Reimplements: com.inscoper.api.DriverDescription.getDriverType

Reimplemented by: com.inscoper.api.CustomDriverDescription.getDriverType, com.inscoper.api.MicroManagerDriverDescription.getDriverType

Retrieves the specific type of external driver (e.g., MICRO_MANAGER, CUSTOM_DRIVER).

function isEqual¶

public boolean isEqual(
    DriverDescription other
)

Checks whether this driver description is identical to another one.

Parameters:

other The description to compare against

Return: True if the configurations are identical, false otherwise

Reimplements: com.inscoper.api.DriverDescription.isEqual

Reimplemented by: com.inscoper.api.CustomDriverDescription.isEqual, com.inscoper.api.MicroManagerDriverDescription.isEqual

This method determines if two driver descriptions represent the same configuration. The application uses this to avoid unnecessary driver restarts when the configuration is unchanged.

function getDeviceType¶

public EDeviceType getDeviceType()

Get the device type.

Return: The device type

Retrieves the type of device associated with this driver.

function setDeviceType¶

public void setDeviceType(
    EDeviceType deviceType
)

Set the device type.

Parameters:

deviceType : The device type

Sets the type of device associated with this driver.

function getRealType¶

public int getRealType()

Reimplements: com.inscoper.api.DriverDescription.getRealType

function createProxy¶

public static ExternalDriverDescription createProxy(
    long cPtr,
    boolean cMemoryOwn
)

Reimplements: com.inscoper.api.DriverDescription.createProxy

Protected Functions Documentation¶

function ExternalDriverDescription¶

protected ExternalDriverDescription(
    long cPtr,
    boolean cMemoryOwn
)

function swigSetCMemOwn¶

protected void swigSetCMemOwn(
    boolean own
)

Reimplements: com.inscoper.api.DriverDescription.swigSetCMemOwn

Reimplemented by: com.inscoper.api.CustomDriverDescription.swigSetCMemOwn, com.inscoper.api.MicroManagerDriverDescription.swigSetCMemOwn

function finalize¶

protected void finalize()

Reimplements: com.inscoper.api.DriverDescription.finalize

Reimplemented by: com.inscoper.api.CustomDriverDescription.finalize, com.inscoper.api.MicroManagerDriverDescription.finalize

function getCPtr¶

protected static long getCPtr(
    ExternalDriverDescription obj
)

Updated on 2026-09-03 at 12:14:19 +0200