com.inscoper.api.SubDeviceConfig¶

SubDeviceConfig class provides required information for sub-device configuration. More...

Public Functions¶

	Name
synchronized void	delete()
	SubDeviceConfig() Default constructor.
void	fromXML(XMLNode subDeviceNode) Provide sub-device information from the XML node.
void	toXML(XMLNode xmlParent) Export sub-device information in an XML node attached to the parent XML node.
String	getId() Get the ID of the sub-device.
void	setId(String id) Set the ID of the sub-device.
int	getTag() Get the sub-device tag.
void	setTag(int tag) Set the sub-device tag.
com.inscoper.nbo.ENBOType	getNBOType() Get the NBO type of the sub-device.
boolean	hasNBOType() Check if the NBO type of the sub-device is set.
void	setNBOType(com.inscoper.nbo.ENBOType nboType) Set the NBO type of the sub-device.
void	unsetNBOType() Unset the NBO type of the sub-device.
boolean	isPostInit() Check if post-initialization is required.
void	setPostInit(boolean postInit) Set post-initialization status.
String	getRecipeId() Get the recipe ID of the sub-device.
void	setRecipeId(String recipeId) Set the recipe ID of the sub-device.
ParamConfigVector	getParams() Get the parameter configuration list of the sub-device.
ParamConfig	getParam(int tag) Get the parameter configuration corresponding to the given tag.
void	setParams(ParamConfigVector params) Set the parameter configuration list of the sub-device.
void	addParam(ParamConfig param) Add a parameter configuration to the list.
ESubDeviceLabelVector	getLabelList() get the label list of the sub-device.

Protected Functions¶

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

Detailed Description¶

public class com.inscoper.api.SubDeviceConfig;

SubDeviceConfig class provides required information for sub-device configuration.

This class manages the configuration settings for a sub-device, including its ID, tag, associated parameters, and initialization status.

Public Functions Documentation¶

function delete¶

public synchronized void delete()

function SubDeviceConfig¶

public SubDeviceConfig()

Default constructor.

Initializes a new instance of the SubDeviceConfig class.

function fromXML¶

public void fromXML(
    XMLNode subDeviceNode
)

Provide sub-device information from the XML node.

Parameters:

subDeviceNode : The XML node containing sub-device information

Exceptions:

InscoperException if an error occurred

Populates the sub-device configuration from the provided XML node.

function toXML¶

public void toXML(
    XMLNode xmlParent
)

Export sub-device information in an XML node attached to the parent XML node.

Parameters:

xmlParent : The parent XML node

Exceptions:

InscoperException if an error occurred

Serializes the sub-device configuration to the specified parent XML node.

function getId¶

public String getId()

Get the ID of the sub-device.

Return: The ID of the sub-device

Retrieves the unique identifier of the sub-device.

function setId¶

public void setId(
    String id
)

Set the ID of the sub-device.

Parameters:

id : The ID of the sub-device

Assigns a unique identifier to the sub-device.

function getTag¶

public int getTag()

Get the sub-device tag.

Return: The sub-device tag

Retrieves the tag associated with this sub-device.

function setTag¶

public void setTag(
    int tag
)

Set the sub-device tag.

Parameters:

tag : The sub-device tag

Assigns a tag to this sub-device.

function getNBOType¶

public com.inscoper.nbo.ENBOType getNBOType()

Get the NBO type of the sub-device.

Return: The NBO type of the sub-device

Retrieves the NBO type of the sub-device.

function hasNBOType¶

public boolean hasNBOType()

Check if the NBO type of the sub-device is set.

Return: True if the NBO type is set, false otherwise

Checks whether an NBO type has been explicitly defined for this sub-device.

function setNBOType¶

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

Set the NBO type of the sub-device.

Parameters:

nboType : The NBO type of the sub-device

Sets the NBO type of the sub-device.

function unsetNBOType¶

public void unsetNBOType()

Unset the NBO type of the sub-device.

Removes the NBO type definition, making hasNBOType() return false.

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.

function getRecipeId¶

public String getRecipeId()

Get the recipe ID of the sub-device.

Return: The recipe ID of the sub-device

Retrieves the recipe ID associated with this sub-device.

function setRecipeId¶

public void setRecipeId(
    String recipeId
)

Set the recipe ID of the sub-device.

Parameters:

recipeId : The recipe ID of the sub-device

Assigns a recipe ID to this sub-device.

function getParams¶

public ParamConfigVector getParams()

Get the parameter configuration list of the sub-device.

Return: The list of parameter configurations of the sub-device

Retrieves the list of parameter configurations associated with this sub-device.

function getParam¶

public ParamConfig getParam(
    int tag
)

Get the parameter configuration corresponding to the given tag.

Parameters:

tag : The parameter tag

Return: The parameter configuration

Retrieves the parameter configuration for the specified tag.

function setParams¶

public void setParams(
    ParamConfigVector params
)

Set the parameter configuration list of the sub-device.

Parameters:

params : The list of parameter configurations of the sub-device

Replaces the list of parameter configurations for this sub-device.

function addParam¶

public void addParam(
    ParamConfig param
)

Add a parameter configuration to the list.

Parameters:

param : The parameter configuration to add

Appends a new parameter configuration to 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.

Protected Functions Documentation¶

function SubDeviceConfig¶

protected SubDeviceConfig(
    long cPtr,
    boolean cMemoryOwn
)

function swigSetCMemOwn¶

protected void swigSetCMemOwn(
    boolean own
)

function finalize¶

protected void finalize()

function getCPtr¶

protected static long getCPtr(
    SubDeviceConfig obj
)

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