com.inscoper.api.ParamConfig¶

ParamConfig class provides required information for parameter configuration. More...

Public Functions¶

	Name
synchronized void	delete()
	ParamConfig() Default constructor.
void	fromXML(XMLNode paramNode) Provide parameter information from the XML node.
void	toXML(XMLNode xmlParent) Export parameter information in an XML node attached to the parent XML node.
int	getTag() Get tag of the current parameter.
void	setTag(int tag) Set tag of the current parameter.
boolean	isFixed() Return whether the parameter is fixed or not.
void	setFixed(boolean fixed) Set the parameter as fixed or not.
String	getDefaultValue() Get the default value of the parameter.
void	setDefaultValue(String defaultValue) Set the default value of the parameter.
String	getMin() Get the minimum value of the parameter.
void	setMin(String min) Set the minimum value of the parameter.
String	getMax() Get the maximum value of the parameter.
void	setMax(String max) Set the maximum value of the parameter.
String	getStep() Get the step size of the parameter.
void	setStep(String step) Set the step size of the parameter.

Protected Functions¶

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

Detailed Description¶

public class com.inscoper.api.ParamConfig;

ParamConfig class provides required information for parameter configuration.

This class handles the configuration details for device parameters, including default values, ranges (min/max), step sizes, and whether the parameter is fixed.

Public Functions Documentation¶

function delete¶

public synchronized void delete()

function ParamConfig¶

public ParamConfig()

Default constructor.

Initializes a new instance of the ParamConfig class.

function fromXML¶

public void fromXML(
    XMLNode paramNode
)

Provide parameter information from the XML node.

Parameters:

paramNode : The XML node containing parameter information

Exceptions:

InscoperException If an error occurred

Populates the parameter configuration from the provided XML node.

function toXML¶

public void toXML(
    XMLNode xmlParent
)

Export parameter 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 parameter configuration to the specified parent XML node.

function getTag¶

public int getTag()

Get tag of the current parameter.

Return: The current parameter tag

Retrieves the tag associated with this parameter.

function setTag¶

public void setTag(
    int tag
)

Set tag of the current parameter.

Parameters:

tag : The current parameter tag

Assigns a tag to this parameter.

function isFixed¶

public boolean isFixed()

Return whether the parameter is fixed or not.

Return: True if the parameter value is fixed, false otherwise

Checks if the parameter value is fixed (unmodifiable).

function setFixed¶

public void setFixed(
    boolean fixed
)

Set the parameter as fixed or not.

Parameters:

fixed : True if the parameter is fixed

Specifies whether the parameter value should be fixed (unmodifiable).

function getDefaultValue¶

public String getDefaultValue()

Get the default value of the parameter.

Return: The default value

Retrieves the default value of this parameter.

function setDefaultValue¶

public void setDefaultValue(
    String defaultValue
)

Set the default value of the parameter.

Parameters:

defaultValue : The default value

Sets the default value of this parameter.

function getMin¶

public String getMin()

Get the minimum value of the parameter.

Return: The minimum value

Retrieves the minimum allowed value of this parameter.

function setMin¶

public void setMin(
    String min
)

Set the minimum value of the parameter.

Parameters:

min : The minimum value

Sets the minimum allowed value of this parameter.

function getMax¶

public String getMax()

Get the maximum value of the parameter.

Return: The maximum value

Retrieves the maximum allowed value of this parameter.

function setMax¶

public void setMax(
    String max
)

Set the maximum value of the parameter.

Parameters:

max : The maximum value

Sets the maximum allowed value of this parameter.

function getStep¶

public String getStep()

Get the step size of the parameter.

Return: The step size of the parameter

Retrieves the step size used to increment this parameter.

function setStep¶

public void setStep(
    String step
)

Set the step size of the parameter.

Parameters:

step : The step size of the parameter

Sets the step size used to increment this parameter.

Protected Functions Documentation¶

function ParamConfig¶

protected ParamConfig(
    long cPtr,
    boolean cMemoryOwn
)

function swigSetCMemOwn¶

protected void swigSetCMemOwn(
    boolean own
)

function finalize¶

protected void finalize()

function getCPtr¶

protected static long getCPtr(
    ParamConfig obj
)

Updated on 2026-04-02 at 10:55:38 +0200