Inscoper::Shutter¶

Shutter class defines the interface for shutter devices. More...

#include <Shutter.h>

Public Functions¶

	Name
virtual	~Shutter() =default Destructor.
virtual unsigned char	getShutterState() =0 Get the shutter state.
virtual void	setShutterState(unsigned char state) =0 Set the shutter state.
virtual void	checkShutterState() =0 Wait until the shutter state is set.

Public Functions inherited from Inscoper::AbstractSystem

	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.

class Inscoper::Shutter;

Shutter class defines the interface for shutter devices.

This class extends AbstractSystem to provide control for optical shutters, allowing for opening, closing, and checking the state of the shutter.

virtual ~Shutter() =default

Destructor.

virtual unsigned char getShutterState() =0

Get the shutter state.

Return: The shutter state as an unsigned char

Retrieves the current state of the shutter (0 for closed, 1 for open).

virtual void setShutterState(
    unsigned char state
) =0

Set the shutter state.

Parameters:

Sets the desired state of the shutter (0 for closed, 1 for open).

virtual void checkShutterState() =0

Wait until the shutter state is set.

Waits until the shutter state is effectively set.

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