Inscoper::AbstractSystem¶

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

#include <AbstractSystem.h>

Inherited by Inscoper::Camera, Inscoper::Shutter, Inscoper::Stage, Inscoper::XYStage

Public Functions¶

	Name
virtual	~AbstractSystem() =default Destructor.
virtual Inscoper::EDeviceType	getDeviceType() =0 Get the type of the device.
virtual std::string	getLastError() =0 Get the last error message.
virtual std::vector< std::string >	getProperties() =0 Get the list of available properties.
virtual std::vector< Inscoper::SubDeviceId >	getModifiedProperties() =0 Get the list of modified properties.
virtual std::string	getProperty(const std::string & name) =0 Get the value of a property.
virtual void	setProperty(const std::string & name, const std::string & value) =0 Set the value of a property.
virtual void	checkProperty(const std::string & name) =0 Check if a property value is valid.
virtual bool	isReadOnly(const std::string & propName) =0 Check if a property is read-only.
virtual Inscoper::EParamType	getType(const std::string & propName) =0 Get the data type of a property.
virtual std::string	getMin(const std::string & propName) =0 Get the minimum value of a property.
virtual std::string	getMax(const std::string & propName) =0 Get the maximum value of a property.
virtual std::string	getStep(const std::string & propName) =0 Get the step size of a property.
virtual std::vector< std::string >	getValueList(const std::string & propName) =0 Get the list of allowed values for a property.
virtual bool	isAccessibleInSequence(const std::string & propName) =0 Check if a property is accessible during sequence execution.

Detailed Description¶

class Inscoper::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 ~AbstractSystem¶

virtual ~AbstractSystem() =default

Destructor.

function getDeviceType¶

virtual Inscoper::EDeviceType getDeviceType() =0

Get the type of the device.

Return: The device type

Retrieves the specific category of the device.

function getLastError¶

virtual std::string getLastError() =0

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¶

virtual std::vector< std::string > getProperties() =0

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¶

virtual std::vector< Inscoper::SubDeviceId > getModifiedProperties() =0

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¶

virtual std::string getProperty(
    const std::string & name
) =0

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¶

virtual void setProperty(
    const std::string & name,
    const std::string & value
) =0

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¶

virtual void checkProperty(
    const std::string & name
) =0

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¶

virtual bool isReadOnly(
    const std::string & propName
) =0

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¶

virtual Inscoper::EParamType getType(
    const std::string & propName
) =0

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¶

virtual std::string getMin(
    const std::string & propName
) =0

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¶

virtual std::string getMax(
    const std::string & propName
) =0

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¶

virtual std::string getStep(
    const std::string & propName
) =0

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¶

virtual std::vector< std::string > getValueList(
    const std::string & propName
) =0

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¶

virtual bool isAccessibleInSequence(
    const std::string & propName
) =0

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.

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