com.inscoper.api.SubDeviceDescription¶

SubDeviceDescription class provides sub-device information coming from drivers. More...

Public Functions¶

	Name
synchronized void	delete()
	SubDeviceDescription() Default constructor.
String	getName() Get the name of the sub-device.
void	setName(String name) Set the name of the sub-device.
FunctionDescriptionVector	getFunctions() Get the function list of the sub-device.
FunctionDescription	getFunction(EFunctionType type) Get the function corresponding to the given type.
void	setFunction(EFunctionType type, FunctionDescription function) Set the function of the given type.
int	getTag() Get the tag of the sub-device.
void	setTag(int tag) Set the tag of the sub-device.
ESubDeviceLabelVector	getLabelList() get the label list of the sub-device.
void	addLabel(ESubDeviceLabel label) add a label to the sub-device.
boolean	hasLabel(ESubDeviceLabel label) check if the sub-device has the label in param.
UShortVector	getParams() get the Param tag list of the sub-device : The list corresponds to the params needed for the declared functions.
boolean	isPostInit() Check if post-initialization is required.
void	setPostInit(boolean postInit) Set post-initialization status.

Protected Functions¶

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

Detailed Description¶

public class com.inscoper.api.SubDeviceDescription;

SubDeviceDescription class provides sub-device information coming from drivers.

This class stores details about a specific functional unit within a device (sub-device), such as its name, type, tag, and associated control functions.

Public Functions Documentation¶

function delete¶

public synchronized void delete()

function SubDeviceDescription¶

public SubDeviceDescription()

Default constructor.

Initializes a new instance of the SubDeviceDescription class.

function getName¶

public String getName()

Get the name of the sub-device.

Return: The name of the sub-device

Retrieves the display name of the sub-device.

function setName¶

public void setName(
    String name
)

Set the name of the sub-device.

Parameters:

name : The name of the sub-device

Sets the display name of the sub-device.

function getFunctions¶

public FunctionDescriptionVector getFunctions()

Get the function list of the sub-device.

Return: The list of functions of the sub-device

Retrieves all functions associated with this sub-device.

function getFunction¶

public FunctionDescription getFunction(
    EFunctionType type
)

Get the function corresponding to the given type.

Parameters:

type : The function's type

Return: The function if found, nullptr otherwise

Retrieves a specific function by its functional type.

function setFunction¶

public void setFunction(
    EFunctionType type,
    FunctionDescription function
)

Set the function of the given type.

Parameters:

type : The function's type
function : The function to set

Assigns a function to this sub-device for a specific functional type.

function getTag¶

public int getTag()

Get the tag of the sub-device.

Return: The tag of the sub-device

Retrieves the unique tag of the sub-device.

function setTag¶

public void setTag(
    int tag
)

Set the tag of the sub-device.

Parameters:

tag : The tag of the sub-device

Sets the unique tag of the sub-device.

function getLabelList¶

public ESubDeviceLabelVector getLabelList()

get the label list of the sub-device.

Return: The label list of the sub-device

Retrieves the list of all labels associated to this sub-device.

function addLabel¶

public void addLabel(
    ESubDeviceLabel label
)

add a label to the sub-device.

Parameters:

label : The label to add

Adds a label to be associated to this sub-device.

function hasLabel¶

public boolean hasLabel(
    ESubDeviceLabel label
)

check if the sub-device has the label in param.

Parameters:

label : the label to check

Return: True if the Sub Device has the label, false otherwise

Checks if a label is associated to this sub-device.

function getParams¶

public UShortVector getParams()

get the Param tag list of the sub-device : The list corresponds to the params needed for the declared functions.

Return: The list of associated parameter tags

Retrieves the list of parameter tags required by the declared functions of this sub-device.

function isPostInit¶

public boolean isPostInit()

Check if post-initialization is required.

Return: True if post-initialization is required, false otherwise

Determines whether this sub-device requires a post-initialization step.

function setPostInit¶

public void setPostInit(
    boolean postInit
)

Set post-initialization status.

Parameters:

postInit : True to enable post-initialization

Specifies whether this sub-device requires a post-initialization step.

Protected Functions Documentation¶

function SubDeviceDescription¶

protected SubDeviceDescription(
    long cPtr,
    boolean cMemoryOwn
)

function swigSetCMemOwn¶

protected void swigSetCMemOwn(
    boolean own
)

function finalize¶

protected void finalize()

function getCPtr¶

protected static long getCPtr(
    SubDeviceDescription obj
)

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