Skip to content

com.inscoper.api.DriverDescription

DriverDescription base class. More...

Inherited by com.inscoper.api.ExternalDriverDescription, com.inscoper.api.InscoperBoxDriverDescription

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.
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

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

Detailed Description

public class com.inscoper.api.DriverDescription;

DriverDescription base class.

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

This class serves as a base for specific driver descriptions. It provides a common interface for polymorphism.

Public Functions Documentation

function delete

public synchronized void delete()

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

function getDriverType

public EDriverType getDriverType()

Get the driver type.

Return: The driver type

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

Retrieves the specific type of driver described by this object.

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

Reimplemented by: com.inscoper.api.CustomDriverDescription.isEqual, com.inscoper.api.ExternalDriverDescription.isEqual, com.inscoper.api.InscoperBoxDriverDescription.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 getRealType

public int getRealType()

Reimplemented by: com.inscoper.api.ExternalDriverDescription.getRealType

function createProxy

public static DriverDescription createProxy(
    long cPtr,
    boolean cMemoryOwn
)

Reimplemented by: com.inscoper.api.ExternalDriverDescription.createProxy

function castToCustomDriverDescription

public static CustomDriverDescription castToCustomDriverDescription(
    DriverDescription driverDescription
)

function castToInscoperBoxDriverDescription

public static InscoperBoxDriverDescription castToInscoperBoxDriverDescription(
    DriverDescription driverDescription
)

function castToMicroManagerDriverDescription

public static MicroManagerDriverDescription castToMicroManagerDriverDescription(
    DriverDescription driverDescription
)

function castToExternalDriverDescription

public static ExternalDriverDescription castToExternalDriverDescription(
    DriverDescription driverDescription
)

Protected Functions Documentation

function DriverDescription

protected DriverDescription(
    long cPtr,
    boolean cMemoryOwn
)

function swigSetCMemOwn

protected void swigSetCMemOwn(
    boolean own
)

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

function finalize

protected void finalize()

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

function getCPtr

protected static long getCPtr(
    DriverDescription obj
)

Updated on 2026-06-23 at 10:35:24 +0200