com.inscoper.api.DeviceDescription¶

DeviceDescription class provides device information coming from drivers. More...

Public Functions¶

	Name
synchronized void	delete()
	DeviceDescription() Default constructor.
String	getDescription() Get the description of the device.
void	setDescription(String description) Set the description of the device.
String	getVersion() Get the version of the device driver.
void	setVersion(String version) Set the version of the device driver.
String	getBrand() Get the brand of the device.
void	setBrand(String brand) Set the brand of the device.
String	getModel() Get the model of the device.
void	setModel(String model) Set the model of the device.
String	getReleaseDate() Get the release date of the device driver.
void	setReleaseDate(String releaseDate) Set the release date of the device driver.
String	getAuthor() Get the author of the device driver.
void	setAuthor(String author) Set the author of the device driver.
String	getChangeLog() Get the change log of the device driver.
void	setChangeLog(String changeLog) Set the change log of the device driver.
String	getFxmlContent() Get the fxml content of the device driver.
void	setFxmlContent(String fxmlContent) Set the fxml content of the device driver.
EDriverType	getDriverType() Get the driver type of the device.
com.inscoper.nbo.ENBOType	getNBOType() get the nbo type of the device
void	setNBOType(com.inscoper.nbo.ENBOType nboType) set the nbo type of the device
boolean	isInitialized() Return whether the device is initialized or not.
void	setInitialized(boolean initialized) Set the status of the initialization of the device.
void	addSubDeviceDescription(SubDeviceDescription subDeviceDescription) Add a sub-device description to the device.
SubDeviceDescriptionVector	getSubDeviceDescriptionList() Get all sub-device descriptions across all groups.
SubDeviceDescription	getSubDeviceDescription(int subDeviceTag) Get the description corresponding to the given tag.
void	addParamsDescription(ParamDescription paramsDescription) Add a parameter description to the device.
ParamDescription	getParamsDescription(int paramTag) Get the parameter description by tag.
ParamDescriptionVector	getParamsDescriptionList() Get the list of parameter descriptions.
void	setParamDescriptionList(ParamDescriptionVector paramDescriptionList) Set the list of parameter descriptions.
DriverDescription	getDriverDescription() Get the driver description.
void	setDriverDescription(DriverDescription driverDescription) Set the driver description.
void	addSubDeviceGroupDescription(SubDeviceGroupDescription subDeviceGroupDescription) Set a description to the device.
SubDeviceGroupDescriptionVector	getSubDeviceGroupDescriptionList() get the Sub Device Group Description list
void	setSubDeviceGroupDescriptionList(SubDeviceGroupDescriptionVector subDeviceGroupDescriptionList) set the Sub Device Group Description list
SubDeviceGroupDescription	getSubDeviceGroupDescription(int groupTag) get the Sub Device Group Description corresponding to the given tag

Protected Functions¶

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

Detailed Description¶

public class com.inscoper.api.DeviceDescription;

DeviceDescription class provides device information coming from drivers.

This class holds comprehensive information about a device as reported by its driver, including version, brand, model, author, change log, and associated sub-devices and parameters.

Public Functions Documentation¶

function delete¶

public synchronized void delete()

function DeviceDescription¶

public DeviceDescription()

Default constructor.

Initializes a new instance of the DeviceDescription class.

function getDescription¶

public String getDescription()

Get the description of the device.

Return: The description of the device

Retrieves the textual description of the device.

function setDescription¶

public void setDescription(
    String description
)

Set the description of the device.

Parameters:

description : The description of the device

Sets the textual description of the device.

function getVersion¶

public String getVersion()

Get the version of the device driver.

Return: The version of the device driver

Retrieves the version of the device driver.

function setVersion¶

public void setVersion(
    String version
)

Set the version of the device driver.

Parameters:

version : The version of the device driver

Sets the version of the device driver.

function getBrand¶

public String getBrand()

Get the brand of the device.

Return: The brand of the device

Retrieves the brand name of the device.

function setBrand¶

public void setBrand(
    String brand
)

Set the brand of the device.

Parameters:

brand : The brand of the device

Sets the brand name of the device.

function getModel¶

public String getModel()

Get the model of the device.

Return: The model of the device

Retrieves the model name of the device.

function setModel¶

public void setModel(
    String model
)

Set the model of the device.

Parameters:

model : The model of the device

Sets the model name of the device.

function getReleaseDate¶

public String getReleaseDate()

Get the release date of the device driver.

Return: The release date of the device driver

Retrieves the release date of the device driver.

function setReleaseDate¶

public void setReleaseDate(
    String releaseDate
)

Set the release date of the device driver.

Parameters:

releaseDate : The release date of the device driver

Sets the release date of the device driver.

function getAuthor¶

public String getAuthor()

Get the author of the device driver.

Return: The author of the device driver

Retrieves the author of the device driver.

function setAuthor¶

public void setAuthor(
    String author
)

Set the author of the device driver.

Parameters:

author : The author of the device driver

Sets the author of the device driver.

function getChangeLog¶

public String getChangeLog()

Get the change log of the device driver.

Return: The change log of the device driver

Retrieves the change log history of the device driver.

function setChangeLog¶

public void setChangeLog(
    String changeLog
)

Set the change log of the device driver.

Parameters:

changeLog : The change log of the device driver

Sets the change log history of the device driver.

function getFxmlContent¶

public String getFxmlContent()

Get the fxml content of the device driver.

Return: The fxml content of the device driver

Retrieves the fxml content of the device driver.

function setFxmlContent¶

public void setFxmlContent(
    String fxmlContent
)

Set the fxml content of the device driver.

Parameters:

fxmlContent : The fxml content of the device driver

Sets the fxml content of the device driver.

function getDriverType¶

public EDriverType getDriverType()

Get the driver type of the device.

Return: The driver type of the device

Retrieves the type of driver controlling this device.

function getNBOType¶

public com.inscoper.nbo.ENBOType getNBOType()

get the nbo type of the device

Return: the nbo type of the device

function setNBOType¶

public void setNBOType(
    com.inscoper.nbo.ENBOType nboType
)

set the nbo type of the device

Parameters:

nboType : the nbo type of the device

function isInitialized¶

public boolean isInitialized()

Return whether the device is initialized or not.

Return: True if the device is initialized, false otherwise

Checks if the device has been successfully initialized.

function setInitialized¶

public void setInitialized(
    boolean initialized
)

Set the status of the initialization of the device.

Parameters:

initialized : True if the device must be initialized

Updates the initialization status of the device.

function addSubDeviceDescription¶

public void addSubDeviceDescription(
    SubDeviceDescription subDeviceDescription
)

Add a sub-device description to the device.

Parameters:

subDeviceDescription : the description to add

Adds the sub-device description into a default "Others" group. If the group does not exist yet, it is created automatically.

function getSubDeviceDescriptionList¶

public SubDeviceDescriptionVector getSubDeviceDescriptionList()

Get all sub-device descriptions across all groups.

Return: A concatenated list of all sub-device descriptions

Aggregates and returns the sub-device descriptions from every SubDeviceGroupDescription attached to this device.

function getSubDeviceDescription¶

public SubDeviceDescription getSubDeviceDescription(
    int subDeviceTag
)

Get the description corresponding to the given tag.

Parameters:

subDeviceTag : The tag

Return: The description if found, nullptr otherwise

Retrieves the sub-device description corresponding to the given tag.

function addParamsDescription¶

public void addParamsDescription(
    ParamDescription paramsDescription
)

Add a parameter description to the device.

Parameters:

paramsDescription : The parameter description to add

Appends a parameter description to the device's list of parameter descriptions.

function getParamsDescription¶

public ParamDescription getParamsDescription(
    int paramTag
)

Get the parameter description by tag.

Parameters:

paramTag : The tag of the parameter description

Return: The parameter description if found, nullptr otherwise

Retrieves the parameter description corresponding to the given tag.

function getParamsDescriptionList¶

public ParamDescriptionVector getParamsDescriptionList()

Get the list of parameter descriptions.

Return: The list of parameter descriptions

Retrieves the list of parameter descriptions associated with this device.

function setParamDescriptionList¶

public void setParamDescriptionList(
    ParamDescriptionVector paramDescriptionList
)

Set the list of parameter descriptions.

Parameters:

paramDescriptionList : The new list of parameter descriptions

Replaces the current list of parameter descriptions with a new one.

function getDriverDescription¶

public DriverDescription getDriverDescription()

Get the driver description.

Return: The driver description

Retrieves the description of the driver associated with this device.

function setDriverDescription¶

public void setDriverDescription(
    DriverDescription driverDescription
)

Set the driver description.

Parameters:

driverDescription : The driver description

Sets the description of the driver associated with this device.

function addSubDeviceGroupDescription¶

public void addSubDeviceGroupDescription(
    SubDeviceGroupDescription subDeviceGroupDescription
)

Set a description to the device.

Parameters:

subDeviceGroupDescription : the Sub Device Group Description to add

function getSubDeviceGroupDescriptionList¶

public SubDeviceGroupDescriptionVector getSubDeviceGroupDescriptionList()

get the Sub Device Group Description list

Return: the Sub Device Group Description list

function setSubDeviceGroupDescriptionList¶

public void setSubDeviceGroupDescriptionList(
    SubDeviceGroupDescriptionVector subDeviceGroupDescriptionList
)

set the Sub Device Group Description list

Parameters:

subDeviceGroupDescriptionList : the Sub Device Group Description list

function getSubDeviceGroupDescription¶

public SubDeviceGroupDescription getSubDeviceGroupDescription(
    int groupTag
)

get the Sub Device Group Description corresponding to the given tag

Parameters:

groupTag : the Sub Device Group Description's tag

Return: : the Sub Device Group Description if found or nullptr

Protected Functions Documentation¶

function DeviceDescription¶

protected DeviceDescription(
    long cPtr,
    boolean cMemoryOwn
)

function swigSetCMemOwn¶

protected void swigSetCMemOwn(
    boolean own
)

function finalize¶

protected void finalize()

function getCPtr¶

protected static long getCPtr(
    DeviceDescription obj
)

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