com.inscoper.api.SubDeviceGroupDescription¶

SubDeviceGroupDescription class provides sub-device group information. More...

Public Functions¶

	Name
synchronized void	delete()
	SubDeviceGroupDescription() default constructor
String	getName() Get the name of the group.
void	setName(String name) Set the name of the group.
int	getTag() Get the tag of the group.
void	setTag(int tag) Set the tag of the group.
com.inscoper.nbo.ENBOType	getNBOType() Get the NBO type of the group.
void	setNBOType(com.inscoper.nbo.ENBOType nboType) Set the NBO type of the group.
void	addSubDeviceDescription(SubDeviceDescription subDeviceDescription) Add a description to the group.
SubDeviceDescriptionVector	getSubDeviceDescriptionList() Get the list of descriptions for this group.
void	setSubDeviceDescriptionList(SubDeviceDescriptionVector subDeviceDescriptionList) Set the list of descriptions for this group.
SubDeviceDescription	getSubDeviceDescription(int subDeviceTag) Get the description corresponding to the given tag.

Protected Functions¶

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

Detailed Description¶

public class com.inscoper.api.SubDeviceGroupDescription;

SubDeviceGroupDescription class provides sub-device group information.

This class holds comprehensive information about a sub device groupe, including name, tag, NBO correspondign type, and associated sub-devices and parameters.

Public Functions Documentation¶

function delete¶

public synchronized void delete()

function SubDeviceGroupDescription¶

public SubDeviceGroupDescription()

default constructor

function getName¶

public String getName()

Get the name of the group.

Return: The name of the group

Retrieves the name of the sub-device group.

function setName¶

public void setName(
    String name
)

Set the name of the group.

Parameters:

name : The name of the group

Sets the name of the sub-device group.

function getTag¶

public int getTag()

Get the tag of the group.

Return: The tag of the group

Retrieves the tag of the sub-device group.

function setTag¶

public void setTag(
    int tag
)

Set the tag of the group.

Parameters:

tag The tag of the group

Sets the tag of the sub-device group.

function getNBOType¶

public com.inscoper.nbo.ENBOType getNBOType()

Get the NBO type of the group.

Return: The NBO type of the group

Retrieves the NBO type of the sub-device group.

function setNBOType¶

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

Set the NBO type of the group.

Parameters:

nboType The NBO type of the group

Sets the NBO type of the sub-device group.

function addSubDeviceDescription¶

public void addSubDeviceDescription(
    SubDeviceDescription subDeviceDescription
)

Add a description to the group.

Parameters:

subDeviceDescription : The description to add

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

function getSubDeviceDescriptionList¶

public SubDeviceDescriptionVector getSubDeviceDescriptionList()

Get the list of descriptions for this group.

Return: The list of descriptions

Retrieves the list of sub-device descriptions associated with this device.

function setSubDeviceDescriptionList¶

public void setSubDeviceDescriptionList(
    SubDeviceDescriptionVector subDeviceDescriptionList
)

Set the list of descriptions for this group.

Parameters:

subDeviceDescriptionList : The list of descriptions to set

Replaces the current list of sub-device descriptions with a new one.

function getSubDeviceDescription¶

public SubDeviceDescription getSubDeviceDescription(
    int subDeviceTag
)

Get the description corresponding to the given tag.

Parameters:

subDeviceTag : the tag

Return: : the sub-device if present, nullptr otherwise

Retrieves the sub-device description corresponding to a tag .

Protected Functions Documentation¶

function SubDeviceGroupDescription¶

protected SubDeviceGroupDescription(
    long cPtr,
    boolean cMemoryOwn
)

function swigSetCMemOwn¶

protected void swigSetCMemOwn(
    boolean own
)

function finalize¶

protected void finalize()

function getCPtr¶

protected static long getCPtr(
    SubDeviceGroupDescription obj
)

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