AbstractSystem

Bases: object

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).

getDeviceType()

Get the type of the device.

Retrieves the specific category of the device.

Returns:

Type	Description
int	The device type

getLastError()

Get the last error message.

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

Returns:

Type	Description
str	The last error message

getProperties()

Get the list of available properties.

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

Returns:

Type	Description
list[string]	A vector of property names

getModifiedProperties()

Get the list of modified properties.

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

Returns:

Type	Description
list[SubDeviceId]	A vector of modified sub-device IDs

getProperty(name)

Get the value of a property.

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

Parameters:

Name	Type	Description	Default
name	string	The name of the property	required

Returns:

Type	Description
str	The value of the property

setProperty(name, value)

Set the value of a property.

Sets the value of the specified property.

Parameters:

Name	Type	Description	Default
name	string	The name of the property	required
value	string	The value to set, as a string	required

checkProperty(name)

Check if a property value is valid.

Validates the current or pending value of the specified property.

Parameters:

Name	Type	Description	Default
name	string	The name of the property	required

isReadOnly(propName)

Check if a property is read-only.

Determines if the specified property can only be read.

Parameters:

Name	Type	Description	Default
propName	string	The name of the property	required

Returns:

Type	Description
boolean	True if the property is read-only, false otherwise

getType(propName)

Get the data type of a property.

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

Parameters:

Name	Type	Description	Default
propName	string	The name of the property	required

Returns:

Type	Description
int	The parameter type of the property

getMin(propName)

Get the minimum value of a property.

Retrieves the minimum allowable value for the specified property.

Parameters:

Name	Type	Description	Default
propName	string	The name of the property	required

Returns:

Type	Description
str	The minimum value as a string

getMax(propName)

Get the maximum value of a property.

Retrieves the maximum allowable value for the specified property.

Parameters:

Name	Type	Description	Default
propName	string	The name of the property	required

Returns:

Type	Description
str	The maximum value as a string

getStep(propName)

Get the step size of a property.

Retrieves the increment step size for the specified property.

Parameters:

Name	Type	Description	Default
propName	string	The name of the property	required

Returns:

Type	Description
str	The step size

getValueList(propName)

Get the list of allowed values for a property.

Retrieves the list of valid values for an enumerated property.

Parameters:

Name	Type	Description	Default
propName	string	The name of the property	required

Returns:

Type	Description
list[string]	The list of allowed string values

isAccessibleInSequence(propName)

Check if a property is accessible during sequence execution.

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

Parameters:

Name	Type	Description	Default
propName	string	The name of the property	required

Returns:

Type	Description
boolean	True if accessible in sequence, false otherwise