com.inscoper.api.AbstractSystem

AbstractSystem class is the base class for all device types. More...

Inherited by com.inscoper.api.Camera, com.inscoper.api.Shutter, com.inscoper.api.Stage, com.inscoper.api.XYStage

Public Functions

	Name
synchronized void	delete()
EDeviceType	getDeviceType() Get the type of the device.
String	getLastError() Get the last error message.
StringVector	getProperties() Get the list of available properties.
SubDeviceIdVector	getModifiedProperties() Get the list of modified properties.
String	getProperty(String name) Get the value of a property.
void	setProperty(String name, String value) Set the value of a property.
void	checkProperty(String name) Check if a property value is valid.
boolean	isReadOnly(String propName) Check if a property is read-only.
EParamType	getType(String propName) Get the data type of a property.
String	getMin(String propName) Get the minimum value of a property.
String	getMax(String propName) Get the maximum value of a property.
String	getStep(String propName) Get the step size of a property.
StringVector	getValueList(String propName) Get the list of allowed values for a property.
boolean	isAccessibleInSequence(String propName) Check if a property is accessible during sequence execution.
int	getRealType()
AbstractSystem	createProxy(long cPtr, boolean cMemoryOwn)

Protected Functions

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

Detailed Description

public class com.inscoper.api.AbstractSystem;

AbstractSystem class is the base class for all device types.

For Micro-Manager and Custom devices. This abstract class is the base class for all device types (e.g. Camera, Shutter, Stage, XYStage).

Public Functions Documentation

function delete

public synchronized void delete()

Reimplemented by: com.inscoper.api.Camera.delete, com.inscoper.api.Shutter.delete, com.inscoper.api.Stage.delete, com.inscoper.api.XYStage.delete

function getDeviceType

public EDeviceType getDeviceType()

Get the type of the device.

Return: The device type

Retrieves the specific category of the device.

function getLastError

public String getLastError()

Get the last error message.

Return: The last error message

Retrieves the description of the most recent error that occurred on the device.

function getProperties

public StringVector getProperties()

Get the list of available properties.

Return: A vector of property names

Retrieves a list of names for all properties supported by the device.

function getModifiedProperties

public SubDeviceIdVector getModifiedProperties()

Get the list of modified properties.

Return: A vector of modified sub-device IDs

Retrieves a list of sub-device IDs for properties that have been modified.

function getProperty

public String getProperty(
    String name
)

Get the value of a property.

Parameters:

• name : The name of the property

Return: The value of the property

Retrieves the current value of the specified property as a string.

function setProperty

public void setProperty(
    String name,
    String value
)

Set the value of a property.

Parameters:

• name : The name of the property
• value : The value to set, as a string

Sets the value of the specified property.

function checkProperty

public void checkProperty(
    String name
)

Check if a property value is valid.

Parameters:

• name : The name of the property

Validates the current or pending value of the specified property.

function isReadOnly

public boolean isReadOnly(
    String propName
)

Check if a property is read-only.

Parameters:

• propName : The name of the property

Return: True if the property is read-only, false otherwise

Determines if the specified property can only be read.

function getType

public EParamType getType(
    String propName
)

Get the data type of a property.

Parameters:

• propName : The name of the property

Return: The parameter type of the property

Retrieves the data type (e.g., Integer, Double, String) of the specified property.

function getMin

public String getMin(
    String propName
)

Get the minimum value of a property.

Parameters:

• propName : The name of the property

Return: The minimum value as a string

Retrieves the minimum allowable value for the specified property.

function getMax

public String getMax(
    String propName
)

Get the maximum value of a property.

Parameters:

• propName : The name of the property

Return: The maximum value as a string

Retrieves the maximum allowable value for the specified property.

function getStep

public String getStep(
    String propName
)

Get the step size of a property.

Parameters:

• propName : The name of the property

Return: The step size

Retrieves the increment step size for the specified property.

function getValueList

public StringVector getValueList(
    String propName
)

Get the list of allowed values for a property.

Parameters:

• propName : The name of the property

Return: The list of allowed string values

Retrieves the list of valid values for an enumerated property.

function isAccessibleInSequence

public boolean isAccessibleInSequence(
    String propName
)

Check if a property is accessible during sequence execution.

Parameters:

• propName : The name of the property

Return: True if accessible in sequence, false otherwise

Determines if the specified property can be accessed or modified while an acquisition sequence is running.

function getRealType

public int getRealType()

function createProxy

public static AbstractSystem createProxy(
    long cPtr,
    boolean cMemoryOwn
)

Protected Functions Documentation

function AbstractSystem

protected AbstractSystem(
    long cPtr,
    boolean cMemoryOwn
)

function swigSetCMemOwn

protected void swigSetCMemOwn(
    boolean own
)

Reimplemented by: com.inscoper.api.Camera.swigSetCMemOwn, com.inscoper.api.Shutter.swigSetCMemOwn, com.inscoper.api.Stage.swigSetCMemOwn, com.inscoper.api.XYStage.swigSetCMemOwn

function finalize

protected void finalize()

Reimplemented by: com.inscoper.api.Camera.finalize, com.inscoper.api.Shutter.finalize, com.inscoper.api.Stage.finalize, com.inscoper.api.XYStage.finalize

function getCPtr

protected static long getCPtr(
    AbstractSystem obj
)

---

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