com.inscoper.api.ModifiableStatusParam

ModifiableStatusParam class represents a status parameter that can be modified during a sequence execution. More...

Inherits from com.inscoper.api.ParentStatusParam, com.inscoper.api.StatusParam

Public Functions

	Name
synchronized void	delete()
	ModifiableStatusParam(ModifiableStatusParam other) Copy constructor.
	ModifiableStatusParam(SubDeviceId subDeviceId, long modifIndex) Constructor without value.
	ModifiableStatusParam(SubDeviceId subDeviceId, long modifIndex, String value) Constructor from string value.
	ModifiableStatusParam(SubDeviceId subDeviceId, long modifIndex, char value) Constructor from char value.
	ModifiableStatusParam(SubDeviceId subDeviceId, long modifIndex, short value) Constructor from short value.
	ModifiableStatusParam(SubDeviceId subDeviceId, long modifIndex, int value) Constructor from int value.
	ModifiableStatusParam(SubDeviceId subDeviceId, long modifIndex, java.math.BigInteger value) Constructor from unsigned long long value.
	ModifiableStatusParam(SubDeviceId subDeviceId, long modifIndex, long value) Constructor from long long value.
	ModifiableStatusParam(SubDeviceId subDeviceId, long modifIndex, float value) Constructor from float value.
	ModifiableStatusParam(SubDeviceId subDeviceId, long modifIndex, double value) Constructor from double value.
	ModifiableStatusParam(SubDeviceId subDeviceId, long modifIndex, boolean value) Constructor from boolean value.
StatusParam	clone() Clone object.

Protected Functions

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

Additional inherited members

Public Functions inherited from com.inscoper.api.ParentStatusParam

	Name
long	getModifierIndex() Get modifiable parameter identifier.
int	getRealType()
ParentStatusParam	createProxy(long cPtr, boolean cMemoryOwn)

Protected Functions inherited from com.inscoper.api.ParentStatusParam

	Name
	ParentStatusParam(long cPtr, boolean cMemoryOwn)

Public Functions inherited from com.inscoper.api.StatusParam

	Name
	StatusParam(SubDeviceId subDeviceId, Object value)
void	setValue(Object value)
void	addValue(int tag, Object value)
void	addValue(int index, int tag, Object value)
Object	getValue()
SubDeviceId	getSubDeviceId()
void	setSubDeviceId(SubDeviceId subDeviceId)
	StatusParam(StatusParam other) Copy constructor.
	StatusParam(SubDeviceId subDeviceId) Constructor from sub-device ID.
	StatusParam(SubDeviceId subDeviceId, String value) Constructor from sub-device ID and string value.
	StatusParam(SubDeviceId subDeviceId, char value) Constructor from sub-device ID and char value.
	StatusParam(SubDeviceId subDeviceId, short value) Constructor from sub-device ID and short value.
	StatusParam(SubDeviceId subDeviceId, int value) Constructor from sub-device ID and int value.
	StatusParam(SubDeviceId subDeviceId, java.math.BigInteger value) Constructor from sub-device ID and unsigned long long value.
	StatusParam(SubDeviceId subDeviceId, long value) Constructor from sub-device ID and long long value.
	StatusParam(SubDeviceId subDeviceId, float value) Constructor from sub-device ID and float value.
	StatusParam(SubDeviceId subDeviceId, double value) Constructor from sub-device ID and double value.
	StatusParam(SubDeviceId subDeviceId, boolean value) Constructor from sub-device ID and boolean value.
boolean	hasValue() Check if the status parameter has a value.
String	getStringValue() Get value as string.
char	getCharValue() Get value as char.
short	getShortValue() Get value as short.
int	getIntValue() Get value as int.
java.math.BigInteger	getUnsignedLongValue() Get value as unsigned long long.
long	getLongValue() Get value as long long.
float	getFloatValue() Get value as float.
double	getDoubleValue() Get value as double.
void	setValue(String value) Set value from string.
void	setValue(char value) Set value from char.
void	setValue(short value) Set value from short.
void	setValue(int value) Set value from int.
void	setValue(java.math.BigInteger value) Set value from unsigned long long.
void	setValue(long value) Set value from long long.
void	setValue(float value) Set value from float.
void	setValue(double value) Set value from double.
void	setValue(boolean value) Set value from bool.
void	addValue(int tag, String value) Add a string value for a specific parameter index.
void	addValue(int tag, char value) Add a tagged char value for a specific parameter index.
void	addValue(int tag, short value) Add a tagged short value for a specific parameter index.
void	addValue(int tag, int value) Add a tagged int value for a specific parameter index.
void	addValue(int tag, java.math.BigInteger value) Add a tagged unsigned long long value for a specific parameter index.
void	addValue(int tag, long value) Add a tagged long long value for a specific parameter index.
void	addValue(int tag, float value) Add a tagged float value for a specific parameter index.
void	addValue(int tag, double value) Add a tagged double value for a specific parameter index.
void	addValue(int tag, boolean value) Add a tagged boolean value for a specific parameter index.
void	addValue(int index, int tag, String value) Add a string value associated with a specific parameter index and value index.
void	addValue(int index, int tag, char value) Add a char value associated with a specific parameter index and value index.
void	addValue(int index, int tag, short value) Add a short value associated with a specific parameter index and value index.
void	addValue(int index, int tag, int value) Add an int value associated with a specific parameter index and value index.
void	addValue(int index, int tag, java.math.BigInteger value) Add an unsigned long long value associated with a specific parameter index and value index.
void	addValue(int index, int tag, long value) Add a long long value associated with a specific parameter index and value index.
void	addValue(int index, int tag, float value) Add a float value associated with a specific parameter index and value index.
void	addValue(int index, int tag, double value) Add a double value associated with a specific parameter index and value index.
void	addValue(int index, int tag, boolean value) Add a bool value associated with a specific parameter index and value index.
String	getType() Get type as string (deprecated).
String	print() Get string representation.
EParamType	getValueType() Get value type.
int	getRealType()
StatusParam	createProxy(long cPtr, boolean cMemoryOwn)

Protected Functions inherited from com.inscoper.api.StatusParam

	Name
	StatusParam(long cPtr, boolean cMemoryOwn)

Detailed Description

public class com.inscoper.api.ModifiableStatusParam;

ModifiableStatusParam class represents a status parameter that can be modified during a sequence execution.

This class serves as a status parameter where the value is associated with a specific index, allowing for indexed modifications during a sequence execution.

Public Functions Documentation

function delete

public synchronized void delete()

Reimplements: com.inscoper.api.ParentStatusParam.delete

function ModifiableStatusParam

public ModifiableStatusParam(
    ModifiableStatusParam other
)

Copy constructor.

Parameters:

• other : The ModifiableStatusParam to copy

function ModifiableStatusParam

public ModifiableStatusParam(
    SubDeviceId subDeviceId,
    long modifIndex
)

Constructor without value.

Parameters:

• subDeviceId : The sub-device ID of the associated sub-device
• modifIndex : The modifiable parameter identifier

function ModifiableStatusParam

public ModifiableStatusParam(
    SubDeviceId subDeviceId,
    long modifIndex,
    String value
)

Constructor from string value.

Parameters:

• subDeviceId : The sub-device ID of the associated sub-device
• modifIndex : The modifiable parameter identifier
• value : The string value

function ModifiableStatusParam

public ModifiableStatusParam(
    SubDeviceId subDeviceId,
    long modifIndex,
    char value
)

Constructor from char value.

Parameters:

• subDeviceId : The sub-device ID of the associated sub-device
• modifIndex : The modifiable parameter identifier
• value : The char value

function ModifiableStatusParam

public ModifiableStatusParam(
    SubDeviceId subDeviceId,
    long modifIndex,
    short value
)

Constructor from short value.

Parameters:

• subDeviceId : The sub-device ID of the associated sub-device
• modifIndex : The modifiable parameter identifier
• value : The short value

function ModifiableStatusParam

public ModifiableStatusParam(
    SubDeviceId subDeviceId,
    long modifIndex,
    int value
)

Constructor from int value.

Parameters:

• subDeviceId : The sub-device ID of the associated sub-device
• modifIndex : The modifiable parameter identifier
• value : The int value

function ModifiableStatusParam

public ModifiableStatusParam(
    SubDeviceId subDeviceId,
    long modifIndex,
    java.math.BigInteger value
)

Constructor from unsigned long long value.

Parameters:

• subDeviceId : The sub-device ID of the associated sub-device
• modifIndex : The modifiable parameter identifier
• value : The unsigned long long value

function ModifiableStatusParam

public ModifiableStatusParam(
    SubDeviceId subDeviceId,
    long modifIndex,
    long value
)

Constructor from long long value.

Parameters:

• subDeviceId : The sub-device ID of the associated sub-device
• modifIndex : The modifiable parameter identifier
• value : The long long value

function ModifiableStatusParam

public ModifiableStatusParam(
    SubDeviceId subDeviceId,
    long modifIndex,
    float value
)

Constructor from float value.

Parameters:

• subDeviceId : The sub-device ID of the associated sub-device
• modifIndex : The modifiable parameter identifier
• value : The float value

function ModifiableStatusParam

public ModifiableStatusParam(
    SubDeviceId subDeviceId,
    long modifIndex,
    double value
)

Constructor from double value.

Parameters:

• subDeviceId : The sub-device ID of the associated sub-device
• modifIndex : The modifiable parameter identifier
• value : The double value

function ModifiableStatusParam

public ModifiableStatusParam(
    SubDeviceId subDeviceId,
    long modifIndex,
    boolean value
)

Constructor from boolean value.

Parameters:

• subDeviceId : The sub-device ID of the associated sub-device
• modifIndex : The modifiable parameter identifier
• value : The boolean value

function clone

public StatusParam clone()

Clone object.

Return: The copy

Reimplements: com.inscoper.api.StatusParam.clone

Creates a deep copy.

Protected Functions Documentation

function ModifiableStatusParam

protected ModifiableStatusParam(
    long cPtr,
    boolean cMemoryOwn
)

function swigSetCMemOwn

protected void swigSetCMemOwn(
    boolean own
)

Reimplements: com.inscoper.api.ParentStatusParam.swigSetCMemOwn

function finalize

protected void finalize()

Reimplements: com.inscoper.api.ParentStatusParam.finalize

function getCPtr

protected static long getCPtr(
    ModifiableStatusParam obj
)

---

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