com.inscoper.api.CustomDriverDescription¶

CustomDriverDescription class provides information for custom drivers. More...

Inherits from com.inscoper.api.ExternalDriverDescription, com.inscoper.api.DriverDescription

Public Functions¶

	Name
synchronized void	delete()
	CustomDriverDescription() Default constructor.
EDriverType	getDriverType() Get the driver type.
boolean	isEqual(DriverDescription other) Checks whether this driver description is identical to another one.
String	getDriverName() Get the driver name.
void	setDriverName(String driverName) Set the driver name.

Protected Functions¶

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

Additional inherited members¶

Public Functions inherited from com.inscoper.api.ExternalDriverDescription

	Name
EDeviceType	getDeviceType() Get the device type.
void	setDeviceType(EDeviceType deviceType) Set the device type.
int	getRealType()
ExternalDriverDescription	createProxy(long cPtr, boolean cMemoryOwn)

Protected Functions inherited from com.inscoper.api.ExternalDriverDescription

	Name
	ExternalDriverDescription(long cPtr, boolean cMemoryOwn)

Public Functions inherited from com.inscoper.api.DriverDescription

	Name
int	getRealType()
DriverDescription	createProxy(long cPtr, boolean cMemoryOwn)
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.CustomDriverDescription;

CustomDriverDescription class provides information for custom drivers.

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

This class extends ExternalDriverDescription to provide specific details for custom drivers.

Public Functions Documentation¶

function delete¶

public synchronized void delete()

Reimplements: com.inscoper.api.ExternalDriverDescription.delete

function CustomDriverDescription¶

public CustomDriverDescription()

Default constructor.

Initializes a new instance of the CustomDriverDescription class.

function getDriverType¶

public EDriverType getDriverType()

Get the driver type.

Return: The driver type

Reimplements: com.inscoper.api.ExternalDriverDescription.getDriverType

Retrieves the specific type of driver (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.ExternalDriverDescription.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 getDriverName¶

public String getDriverName()

Get the driver name.

Return: The driver name

Retrieves the name of the custom driver.

function setDriverName¶

public void setDriverName(
    String driverName
)

Set the driver name.

Parameters:

driverName : The driver name

Sets the name of the custom driver.

Protected Functions Documentation¶

function CustomDriverDescription¶

protected CustomDriverDescription(
    long cPtr,
    boolean cMemoryOwn
)

function swigSetCMemOwn¶

protected void swigSetCMemOwn(
    boolean own
)

Reimplements: com.inscoper.api.ExternalDriverDescription.swigSetCMemOwn

function finalize¶

protected void finalize()

Reimplements: com.inscoper.api.ExternalDriverDescription.finalize

function getCPtr¶

protected static long getCPtr(
    CustomDriverDescription obj
)

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