com.inscoper.api.InscoperBoxDriverDescription¶

The InscoperBoxDriverDescription class provides information for devices supported by the device controller. More...

Inherits from com.inscoper.api.DriverDescription

Public Functions¶

	Name
synchronized void	delete()
	InscoperBoxDriverDescription() Default constructor.
EDriverType	getDriverType() Get the driver type.
boolean	isEqual(DriverDescription other) Checks whether this driver description is identical to another one.
long	getHardwareId() Get the device hardware ID.
void	setHardwareId(long hardwareId) Set the device hardware ID.
String	getProjectName() Get the internal reference of the device.
void	setProjectName(String projectName) Set the internal reference of the device.
String	getFunctionProjectName() Get the internal reference of the function.
void	setFunctionProjectName(String functionProjectName) Set the internal reference of the function.
long	getCrc32() Get the CRC32 of the device.
void	setCrc32(long crc32) Set the CRC32 of the device.
void	addConnectionDescription(ConnectionDescription connectionDescription) Add a connection to the list.
void	setConnectionDescriptionList(ConnectionDescriptionVector connectionDescriptionList) Set the list of connection.
ConnectionDescriptionVector	getConnectionDescriptionList() Get the list of connections.
ConnectionDescription	getConnectionDescription(int tag) Get the connection corresponding to the given tag.

Protected Functions¶

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

Additional inherited members¶

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

The InscoperBoxDriverDescription class provides information for devices supported by the device controller.

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

This class describes the driver for a device supported by the controller, including its hardware identification, firmware CRC, and a list of available connections (e.g., TTL, PWM, Analog).

Public Functions Documentation¶

function delete¶

public synchronized void delete()

Reimplements: com.inscoper.api.DriverDescription.delete

function InscoperBoxDriverDescription¶

public InscoperBoxDriverDescription()

Default constructor.

Initializes a new instance of the InscoperBoxDriverDescription class.

function getDriverType¶

public EDriverType getDriverType()

Get the driver type.

Return: The driver type

Reimplements: com.inscoper.api.DriverDescription.getDriverType

Retrieves the specific type of driver (INSCOPER_BOX).

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

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 getHardwareId¶

public long getHardwareId()

Get the device hardware ID.

Return: The device hardware ID

Retrieves the unique hardware identifier of the device associated with this driver.

function setHardwareId¶

public void setHardwareId(
    long hardwareId
)

Set the device hardware ID.

Parameters:

hardwareId : The device hardware ID

Sets the unique hardware identifier of the device associated with this driver.

function getProjectName¶

public String getProjectName()

Get the internal reference of the device.

Return: The internal reference of the device

Retrieves the internal reference of the device in the firmware.

function setProjectName¶

public void setProjectName(
    String projectName
)

Set the internal reference of the device.

Parameters:

projectName : The internal reference of the device

Sets the internal reference of the device in the firmware.

function getFunctionProjectName¶

public String getFunctionProjectName()

Get the internal reference of the function.

Return: The internal reference of the function

Retrieves the internal reference of the function in the firmware.

function setFunctionProjectName¶

public void setFunctionProjectName(
    String functionProjectName
)

Set the internal reference of the function.

Parameters:

functionProjectName : The internal reference of the function

Sets the internal reference of the function in the firmware.

function getCrc32¶

public long getCrc32()

Get the CRC32 of the device.

Return: The CRC32 of the device

Retrieves the CRC32 of the device driver.

function setCrc32¶

public void setCrc32(
    long crc32
)

Set the CRC32 of the device.

Parameters:

crc32 : The CRC32 of the device

Sets the CRC32 of the device driver.

function addConnectionDescription¶

public void addConnectionDescription(
    ConnectionDescription connectionDescription
)

Add a connection to the list.

Parameters:

connectionDescription : The connection to add

Appends a connection to the connections list.

function setConnectionDescriptionList¶

public void setConnectionDescriptionList(
    ConnectionDescriptionVector connectionDescriptionList
)

Set the list of connection.

Parameters:

connectionDescriptionList : The list of connections

Replaces the current list of supported connections.

function getConnectionDescriptionList¶

public ConnectionDescriptionVector getConnectionDescriptionList()

Get the list of connections.

Return: The ConnectionDescription list

Retrieves the list of connections supported by this driver.

function getConnectionDescription¶

public ConnectionDescription getConnectionDescription(
    int tag
)

Get the connection corresponding to the given tag.

Parameters:

tag : The ConnectionDescription tag

Return: The ConnectionDescription if found, otherwise nullptr

Retrieves a specific connection by its tag.

Protected Functions Documentation¶

function InscoperBoxDriverDescription¶

protected InscoperBoxDriverDescription(
    long cPtr,
    boolean cMemoryOwn
)

function swigSetCMemOwn¶

protected void swigSetCMemOwn(
    boolean own
)

Reimplements: com.inscoper.api.DriverDescription.swigSetCMemOwn

function finalize¶

protected void finalize()

Reimplements: com.inscoper.api.DriverDescription.finalize

function getCPtr¶

protected static long getCPtr(
    InscoperBoxDriverDescription obj
)

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