com.inscoper.api.AbstractSubDevice¶

AbstractSubDevice class implements custom sub-devices. More...

Public Functions¶

	Name
synchronized void	delete()
void	swigReleaseOwnership()
void	swigTakeOwnership()
	AbstractSubDevice(SubDeviceId subDeviceId) Constructor.
	AbstractSubDevice(SubDeviceId subDeviceId, String recipeId) Constructor with recipe ID.
void	setValue(UCharVector data) Set the value of the sub-device.
UCharVector	getValue() Get the current value of the sub-device.
void	checkValue() Check if the sub-device value has been properly set.
SubDeviceId	getSubDeviceId() Get the sub-device ID.
String	getRecipeId() Get the recipe ID.

Protected Functions¶

	Name
	AbstractSubDevice(long cPtr, boolean cMemoryOwn)
void	finalize()
void	swigDirectorDisconnect()
long	getCPtr(AbstractSubDevice obj)
long	swigRelease(AbstractSubDevice obj)

Protected Attributes¶

	Name
transient boolean	swigCMemOwn

Detailed Description¶

public class com.inscoper.api.AbstractSubDevice;

AbstractSubDevice class implements custom sub-devices.

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

This abstract class establishes the contract for sub-devices, forcing the implementation of core accessors (get/set) and validation logic (check).

Public Functions Documentation¶

function delete¶

public synchronized void delete()

function swigReleaseOwnership¶

public void swigReleaseOwnership()

function swigTakeOwnership¶

public void swigTakeOwnership()

function AbstractSubDevice¶

public AbstractSubDevice(
    SubDeviceId subDeviceId
)

Constructor.

Parameters:

subDeviceId : The unique identifier for the sub-device

Initializes a new instance of the AbstractSubDevice class with a specific sub-device ID.

function AbstractSubDevice¶

public AbstractSubDevice(
    SubDeviceId subDeviceId,
    String recipeId
)

Constructor with recipe ID.

Parameters:

subDeviceId : The unique identifier for the sub-device
recipeId : The recipe identifier associated with this sub-device

Initializes a new instance of the AbstractSubDevice class with a specific sub-device ID and an associated recipe ID.

function setValue¶

public void setValue(
    UCharVector data
)

Set the value of the sub-device.

Parameters:

data : The value to set, represented as a byte vector

Sets the operational value or state of the sub-device. Must be overridden.

function getValue¶

public UCharVector getValue()

Get the current value of the sub-device.

Return: The current value as a byte vector

Retrieves the current operational value or state of the sub-device. Must be overridden.

function checkValue¶

public void checkValue()

Check if the sub-device value has been properly set.

Verifies if last set is effective. Must be overridden.

function getSubDeviceId¶

public SubDeviceId getSubDeviceId()

Get the sub-device ID.

Return: The sub-device ID

Retrieves the unique identifier of this sub-device.

function getRecipeId¶

public String getRecipeId()

Get the recipe ID.

Return: The recipe ID

Retrieves the recipe identifier associated with this sub-device.

Protected Functions Documentation¶

function AbstractSubDevice¶

protected AbstractSubDevice(
    long cPtr,
    boolean cMemoryOwn
)

function finalize¶

protected void finalize()

function swigDirectorDisconnect¶

protected void swigDirectorDisconnect()

function getCPtr¶

protected static long getCPtr(
    AbstractSubDevice obj
)

function swigRelease¶

protected static long swigRelease(
    AbstractSubDevice obj
)

Protected Attributes Documentation¶

variable swigCMemOwn¶

transient boolean swigCMemOwn;

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