AmplMode Class Reference

#include <amplmode.h>

Inheritance diagram for AmplMode:

Collaboration diagram for AmplMode:

Public Member Functions
	AmplMode (DigitalIO &dio, const Options &opts)
	AmplMode (void)
virtual	~AmplMode (void)
virtual int	open (DigitalIO &dio)
virtual int	open (Device &device) override
virtual bool	isOpen (void) const
virtual void	close (void)
string	errorStr (void) const
bool	supportsBridgeMode (void) const
bool	supportsCurrentClampMode (void) const
bool	supportsVoltageClampMode (void) const
bool	supportsDynamicClampMode (void) const
int	setBridgeMode (void)
int	setCurrentClampMode (void)
int	setDynamicClampMode (double duration, double mode)
int	setVoltageClampMode (void)
int	setManualSelection (void)
int	startResistance (void)
int	stopResistance (void)
int	startBuzz (void)
int	stopBuzz (void)

Protected Member Functions
void	initOptions () override

Detailed Description

[Device] Control the mode of an amplifier via DigitalIO

Author

Jan Benda

Version

4.0 (Oct 5, 2015)

Options

• bridgepin: the dio line that switches the amplifier into bridge mode.
• cclamppin: the dio line that switches the amplifier into current clamp mode.
• vclamppin: the dio line that switches the amplifier into voltage clamp mode.
• dclamppin: the dio line that switches the amplifier into synchronized dynamic clamp mode.
• syncpin: the dio line on which synchronizing pulses for the amplifier are generated.
• resistancepin: the dio line that activates resistance measurement of the amplifier.
• buzzerpin: the dio line that activates the buzzer.

Constructor & Destructor Documentation

AmplMode	(	DigitalIO &	dio,
		const Options &	opts
	)

References AmplMode::open().

AmplMode

(

void

)

References AmplMode::initOptions().

~AmplMode ( void  )

virtual

References AmplMode::close().

Member Function Documentation

int open ( DigitalIO &  dio )

virtual

References DigitalIO::allocateLines(), DigitalIO::isOpen(), AmplMode::isOpen(), and AmplMode::open().

Referenced by AmplMode::AmplMode(), and AmplMode::open().

int open ( Device &  device )

overridevirtual

References AmplMode::open().

bool isOpen ( void  ) const

virtual

References DigitalIO::isOpen().

Referenced by AmplMode::close(), AmplMode::open(), AmplMode::setBridgeMode(), AmplMode::setCurrentClampMode(), AmplMode::setDynamicClampMode(), AmplMode::setManualSelection(), AmplMode::setVoltageClampMode(), AmplMode::startBuzz(), AmplMode::startResistance(), AmplMode::stopBuzz(), and AmplMode::stopResistance().

void close ( void  )

virtual

References DigitalIO::freeLines(), AmplMode::isOpen(), and DigitalIO::writeLines().

Referenced by AmplMode::~AmplMode().

string errorStr

(

void

)

const

In case of errors returns error string of last operation.

bool supportsBridgeMode

(

void

)

const

Returns

true if the amplifier supports a bridge mode.

See Also

setBridgeMode()

bool supportsCurrentClampMode

(

void

)

const

Returns

true if the amplifier supports a current-clamp mode.

See Also

setCurrentClampMode()

bool supportsVoltageClampMode

(

void

)

const

Returns

true if the amplifier supports a voltage-clamp mode.

See Also

setVoltageClampMode()

bool supportsDynamicClampMode

(

void

)

const

Returns

true if the amplifier supports a synchronized dynamic-clamp mode.

See Also

setDynamicClampMode()

Referenced by AmplMode::setBridgeMode(), AmplMode::setCurrentClampMode(), AmplMode::setDynamicClampMode(), AmplMode::setManualSelection(), and AmplMode::setVoltageClampMode().

int setBridgeMode

(

void

)

Activate the bridge mode of the amplifier.

Returns

the return value of DigitalIO::writeLines()

See Also

supportsBridgeMode(), setCurrentClampMode(), setVoltageClampMode(), setCurrentClampSyncMode(), setManualSelection(), startResistance(), startBuzz()

References DigitalIO::clearSyncPulse(), AmplMode::isOpen(), AmplMode::supportsDynamicClampMode(), and DigitalIO::writeLines().

int setCurrentClampMode

(

void

)

Activate the current-clamp mode of the amplifier.

Returns

the return value of DigitalIO::writeLines()

See Also

supportsCurrentClampMode(), setBridgeMode(), setVoltageClampMode(), setCurrentClampSyncMode(), setManualSelection(), startResistance(), startBuzz()

References DigitalIO::clearSyncPulse(), AmplMode::isOpen(), AmplMode::supportsDynamicClampMode(), and DigitalIO::writeLines().

int setDynamicClampMode	(	double	duration,
		double	mode
	)

Activate the current-clamp mode and external synchronization of the amplifier.

Returns

the return value of DigitalIO::writeLines() or -1000 if synchronizing mode is not supported by the dynamic clamp kernel module.

See Also

supportsDynamicClampMode(), setBridgeMode(), setCurrentClampMode(), setVoltageClampMode(), setManualSelection(), startResistance(), startBuzz()

References AmplMode::isOpen(), DigitalIO::setSyncPulse(), and AmplMode::supportsDynamicClampMode().

int setVoltageClampMode

(

void

)

Activate the voltage-clamp mode of the amplifier.

Returns

the return value of DigitalIO::writeLines()

See Also

supportsVoltageClampMode(), setBridgeMode(), setCurrentClampMode(), setCurrentClampSyncMode(), setManualSelection(), startResistance(), startBuzz()

References DigitalIO::clearSyncPulse(), AmplMode::isOpen(), AmplMode::supportsDynamicClampMode(), and DigitalIO::writeLines().

int setManualSelection

(

void

)

Activate the manual mode of the amplifier.

Returns

the return value of DigitalIO::writeLines()

See Also

setBridgeMode(), setCurrentClampMode(), setVoltageClampMode(), setCurrentClampSyncMode(), startResistance(), startBuzz()

References DigitalIO::clearSyncPulse(), AmplMode::isOpen(), AmplMode::supportsDynamicClampMode(), and DigitalIO::writeLines().

int startResistance

(

void

)

Switch the amplifier into resitance measurement mode.

Returns

the return value of DigitalIO::writeLines()

See Also

stopResistance()

References AmplMode::isOpen(), and DigitalIO::writeLines().

int stopResistance

(

void

)

Switch the amplifier back into its previous mode.

Returns

the return value of DigitalIO::writeLines()

See Also

startResistance()

References AmplMode::isOpen(), and DigitalIO::writeLines().

int startBuzz

(

void

)

Initiate buzzing by setting the pin for the buzzer high.

Returns

the return value of DigitalIO::write()

See Also

stopBuzz(), startResistance(), setBridgeMode()

References AmplMode::isOpen(), and DigitalIO::write().

int stopBuzz

(

void

)

Stop buzzing by setting the pin for the buzzer low.

Returns

the return value of DigitalIO::write()

See Also

startBuzz()

References AmplMode::isOpen(), and DigitalIO::write().

void initOptions ( void  )

overrideprotected

Referenced by AmplMode::AmplMode().

---

The documentation for this class was generated from the following files:

• amplmode.h
• amplmode.cc