A class to manage the details of one stage in a Zaber system. More...

#include <zaberStage.hpp>

Collaboration diagram for MagAOX::app::zaberStage< parentT >:

Public Member Functions
	zaberStage ()=delete

	zaberStage (parentT *parent)

std::string	name ()
	Get the device name.

int	name (const std::string &n)
	Set the device name.

std::string	serial ()
	Get the device serial number.

int	serial (const std::string &s)
	Set the device serial.

int	deviceAddress ()
	Get the device address.

int	deviceAddress (const int &da)
	Set the device address.

int	axisNumber ()
	Get the axis number.

int	axisNumber (const int &an)
	Set the axis number.

bool	commandStatus ()
	Get the command status.

char	deviceStatus ()
	Get the device status.

bool	homing ()
	Get the homing status.

time_t	lastHomed ()
	Get the time of last homing.

int	parked ()
	Get the parked status.

bool	knobEnabled ()
	Get the knob status.

bool	ledEnabled ()
	Get the LED status.

long	rawPos ()
	Get the current raw position, in counts.

long	tgtPos ()
	Get the current tgt position, in counts.

long	maxPos ()
	Get the max position, in counts.

bool	warn ()
	Get the status of the warning flag.

float	temp ()
	Get the temperature, in C.

bool	warningState ()
	Get the warning state.

bool	warnFD ()

bool	warnFQ ()

bool	warnFS ()

bool	warnFT ()

bool	warnFB ()

bool	warnFP ()

bool	warnFE ()

bool	warnWH ()

bool	warnWL ()

bool	warnWP ()

bool	warnWV ()

bool	warnWT ()

bool	warnWM ()

bool	warnWR ()

bool	warnNC ()

bool	warnNI ()

bool	warnND ()

bool	warnNU ()

bool	warnNJ ()

bool	warnUNK ()

int	getResponse (std::string &response, const std::string &repBuff)
	Get a response from the device, after a command has been sent.

int	getResponse (std::string &response, const za_reply &rep)
	Get a response from the device, after a command has been sent.

bool	isCommandReply (const za_reply &rep)
	Determine whether a decoded message is the awaited command reply.

int	sendCommand (std::string &response, z_port port, const std::string &command)
	Send a command and get the response.

int	sendCommand (z_port port, const std::string &command)
	Send a command for which no response is expected.

template<typename valT >
int	getValue (valT &val, z_port port, const std::string command)
	Get a value for this device.

int	getMaxPos (z_port port)
	Get the maximum position from the stage.

int	getParked (z_port port)
	Get the parked state from the stage.

int	getKnob (z_port port)

int	getLED (z_port port)

int	updatePos (z_port port)
	Update the position of the stage.

int	updateTemp (z_port port)
	Update the stage temperature.

int	enableKnob (z_port port, bool enable)
	Enable/Disable the knob.

int	enableLED (z_port port, bool enable)

int	stop (z_port port)
	Stop the stage.

int	estop (z_port port)
	Emergency stop the stage.

int	home (z_port port)
	Initiate homing.

int	park (z_port port)
	Park the stage.

int	unpark (z_port port)
	Unpark the stage.

int	moveAbs (z_port port, long rawPos)
	Move to a new absolute position.

int	unsetWarnings ()
	Sets all warning flags to false.

int	processWarning (std::string &warn)
	Process a single warning from the device, setting the appropriate flag.

int	parseWarnings (std::string &response)
	Parse the warning response from the device.

int	getWarnings (z_port port)
	Get warnings from the device.

int	onPowerOff ()
	Clear all state so that when the system is powered back on we get the correct new state.

int	writeStateFile (std::ofstream &fout)

int	readStateFile (std::ifstream &fin)

Protected Attributes
parentT *	m_parent { nullptr }

std::string	m_name
	The stage's name.

std::string	m_serial
	The stage's serial number.

int	m_deviceAddress { -1 }
	The device's address, a.k.a. its order in the chain.

int	m_axisNumber { 0 }
	The axis number at the address (normally 0 in MagAO-X)

bool	m_commandStatus { true }
	The status of the last command sent. true = OK, false = RJ (rejected)

char	m_deviceStatus
	Current status. Either 'I' for IDLE or 'B' for BUSY. Intializes to 'U' for UNKOWN.

bool	m_homing { false }

timespec	m_lastHomed { 0, 0 }
	Time stamp of the last time the stage was homed.

bool	m_parked { false }

long	m_rawPos
	The raw position reported by the device, in microsteps.

long	m_tgtPos { 0 }
	The tgt position last sent to the device, in microsteps.

long	m_maxPos
	The max position allowed for the device, set by config. Will be set to no larger m_maxPosHW.

float	m_temp { -999 }
	The driver temperature, in C.

bool	m_knobEnabled { false }

bool	m_ledEnabled { false }

bool	m_warn { false }

bool	m_warnFD { false }

bool	m_warnFDreported { false }

bool	m_warnFQ { false }

bool	m_warnFQreported { false }

bool	m_warnFS { false }

bool	m_warnFSreported { false }

bool	m_warnFT { false }

bool	m_warnFTreported { false }

bool	m_warnFB { false }

bool	m_warnFBreported { false }

bool	m_warnFP { false }

bool	m_warnFPreported { false }

bool	m_warnFE { false }

bool	m_warnFEreported { false }

bool	m_warnWH { false }

bool	m_warnWHreported { false }

bool	m_warnWL { false }

bool	m_warnWLreported { false }

bool	m_warnWP { false }

bool	m_warnWPreported { false }

bool	m_warnWV { false }

bool	m_warnWVreported { false }

bool	m_warnWT { false }

bool	m_warnWTreported { false }

bool	m_warnWM { false }

bool	m_warnWMreported { false }

bool	m_warnWR { false }

bool	m_warnWRreported { false }

bool	m_warnNC { false }

bool	m_warnNCreported { false }

bool	m_warnNI { false }

bool	m_warnNIreported { false }

bool	m_warnND { false }

bool	m_warnNDreported { false }

bool	m_warnNU { false }

bool	m_warnNUreported { false }

bool	m_warnNJ { false }

bool	m_warnNJreported { false }

bool	m_warnUNK { false }

Detailed Description

template<class parentT>
class MagAOX::app::zaberStage< parentT >

A class to manage the details of one stage in a Zaber system.

Definition at line 26 of file zaberStage.hpp.

Constructor & Destructor Documentation

◆ zaberStage() [1/2]

template<class parentT >

MagAOX::app::zaberStage< parentT >::zaberStage ( )

delete

◆ zaberStage() [2/2]

template<class parentT >

MagAOX::app::zaberStage< parentT >::zaberStage ( parentT * parent )

inline

Definition at line 107 of file zaberStage.hpp.

References MagAOX::app::zaberStage< parentT >::m_parent.

Member Function Documentation

◆ axisNumber() [1/2]

template<class parentT >

int MagAOX::app::zaberStage< parentT >::axisNumber ( )

Get the axis number.

Returns: the current value of m_axisNumber

Definition at line 441 of file zaberStage.hpp.

◆ axisNumber() [2/2]

template<class parentT >

int MagAOX::app::zaberStage< parentT >::axisNumber ( const int & an )

Set the axis number.

Returns: 0 on success; -1 on error

Parameters

[in] an the new axis number

Definition at line 447 of file zaberStage.hpp.

◆ commandStatus()

template<class parentT >

bool MagAOX::app::zaberStage< parentT >::commandStatus ( )

Get the command status.

Returns: the current value of m_commandStatus

Definition at line 454 of file zaberStage.hpp.

◆ deviceAddress() [1/2]

template<class parentT >

int MagAOX::app::zaberStage< parentT >::deviceAddress ( )

Get the device address.

Returns: the current value of m_deviceAddress

Definition at line 428 of file zaberStage.hpp.

Referenced by libXWCTest::zaberLowLevelTest::SCENARIO().

◆ deviceAddress() [2/2]

template<class parentT >

int MagAOX::app::zaberStage< parentT >::deviceAddress ( const int & da )

Set the device address.

Returns: 0 on success; -1 on error

Parameters

[in] da the new device address

Definition at line 434 of file zaberStage.hpp.

◆ deviceStatus()

template<class parentT >

char MagAOX::app::zaberStage< parentT >::deviceStatus ( )

Get the device status.

Returns: the current value of m_deviceStatus

Definition at line 460 of file zaberStage.hpp.

◆ enableKnob()

template<class parentT >

int MagAOX::app::zaberStage< parentT >::enableKnob	(	z_port	port,
		bool	enable
	)

Enable/Disable the knob.

Definition at line 1005 of file zaberStage.hpp.

References MagAOX::app::MagAOXApp< true >::log().

◆ enableLED()

template<class parentT >

int MagAOX::app::zaberStage< parentT >::enableLED	(	z_port	port,
		bool	enable
	)

Definition at line 1025 of file zaberStage.hpp.

References MagAOX::app::MagAOXApp< true >::log().

◆ estop()

template<class parentT >

int MagAOX::app::zaberStage< parentT >::estop ( z_port port )

Emergency stop the stage.

Definition at line 1063 of file zaberStage.hpp.

References MagAOX::app::MagAOXApp< true >::log().

◆ getKnob()

template<class parentT >

int MagAOX::app::zaberStage< parentT >::getKnob ( z_port port )

Parameters

[in] port the port with which to communicate

Definition at line 891 of file zaberStage.hpp.

References MagAOX::app::MagAOXApp< true >::log().

◆ getLED()

template<class parentT >

int MagAOX::app::zaberStage< parentT >::getLED ( z_port port )

Parameters

[in] port the port with which to communicate

Definition at line 909 of file zaberStage.hpp.

References MagAOX::app::MagAOXApp< true >::log().

◆ getMaxPos()

template<class parentT >

int MagAOX::app::zaberStage< parentT >::getMaxPos ( z_port port )

Get the maximum position from the stage.

Parameters

[in] port the port with which to communicate

Definition at line 855 of file zaberStage.hpp.

References MagAOX::app::MagAOXApp< true >::log().

◆ getParked()

template<class parentT >

int MagAOX::app::zaberStage< parentT >::getParked ( z_port port )

Get the parked state from the stage.

Parameters

[in] port the port with which to communicate

Definition at line 873 of file zaberStage.hpp.

References MagAOX::app::MagAOXApp< true >::log().

◆ getResponse() [1/2]

template<class parentT >

int MagAOX::app::zaberStage< parentT >::getResponse	(	std::string &	response,
		const std::string &	repBuff
	)

Get a response from the device, after a command has been sent.

Parses the standard parts of the response in this stage's fields, and extracts the response string.

Returns: 0 on success.; -1 on error.

Parameters

[out]	response	the text response
[in]	repBuff	the reply buffer, not decoded.

Definition at line 652 of file zaberStage.hpp.

References MagAOX::app::MagAOXApp< true >::log(), Z_SUCCESS, and za_decode().

◆ getResponse() [2/2]

template<class parentT >

int MagAOX::app::zaberStage< parentT >::getResponse	(	std::string &	response,
		const za_reply &	rep
	)

Get a response from the device, after a command has been sent.

Parses the standard parts of the response in this stages fields, and extracts the response string.

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Returns: 0 on success.; -1 on error.

Parameters

[out]	response	the text response component
[in]	rep	the decodedstage reply

Definition at line 671 of file zaberStage.hpp.

References za_reply::device_address, za_reply::device_status, MagAOX::app::MagAOXApp< true >::log(), za_reply::reply_flags, za_reply::response_data, and za_reply::warning_flags.

◆ getValue()

template<class parentT >

template<typename valT >

int MagAOX::app::zaberStage< parentT >::getValue	(	valT &	val,
		z_port	port,
		const std::string	command
	)

Get a value for this device.

Sends the command specified and converts the response to the specified type.

The command passed should include get if needed.

Template Parameters

valT	is the value type to convert to.

Parameters

[out]	val	the value to update
[in]	port	the port with which to communicate
[in]	command	the command to send

Definition at line 802 of file zaberStage.hpp.

References MagAOX::app::MagAOXApp< true >::log().

◆ getWarnings()

template<class parentT >

int MagAOX::app::zaberStage< parentT >::getWarnings ( z_port port )

Get warnings from the device.

Log entries will be made and flags will be set in this structure.

Returns: 0 on success; -1 on error.

Parameters

[in] port the port with which to communicate

Definition at line 1672 of file zaberStage.hpp.

References MagAOX::app::MagAOXApp< true >::log().

◆ home()

template<class parentT >

int MagAOX::app::zaberStage< parentT >::home ( z_port port )

Initiate homing.

Parameters

[in] port the port with which to communicate

Definition at line 1081 of file zaberStage.hpp.

References MagAOX::app::MagAOXApp< true >::log().

◆ homing()

template<class parentT >

bool MagAOX::app::zaberStage< parentT >::homing ( )

Get the homing status.

Returns: the current value of m_homing

Definition at line 466 of file zaberStage.hpp.

◆ isCommandReply()

template<class parentT >

bool MagAOX::app::zaberStage< parentT >::isCommandReply ( const za_reply & rep )

Determine whether a decoded message is the awaited command reply.

Parameters

[in] rep the decoded device message

Definition at line 717 of file zaberStage.hpp.

References za_reply::device_address, and za_reply::message_type.

Referenced by libXWCTest::zaberLowLevelTest::SCENARIO().

◆ knobEnabled()

template<class parentT >

bool MagAOX::app::zaberStage< parentT >::knobEnabled ( )

Get the knob status.

Returns: the current value of m_knobEnabled

Definition at line 484 of file zaberStage.hpp.

◆ lastHomed()

template<class parentT >

time_t MagAOX::app::zaberStage< parentT >::lastHomed ( )

Get the time of last homing.

Returns: the current value of m_lastHomed

Definition at line 472 of file zaberStage.hpp.

◆ ledEnabled()

template<class parentT >

bool MagAOX::app::zaberStage< parentT >::ledEnabled ( )

Get the LED status.

Returns: the current value of m_ledEnabled

Definition at line 490 of file zaberStage.hpp.

◆ maxPos()

template<class parentT >

long MagAOX::app::zaberStage< parentT >::maxPos ( )

Get the max position, in counts.

Returns: the current value of m_maxPos

Definition at line 508 of file zaberStage.hpp.

◆ moveAbs()

template<class parentT >

int MagAOX::app::zaberStage< parentT >::moveAbs	(	z_port	port,
		long	rawPos
	)

Move to a new absolute position.

Parameters

[in]	port	the port with which to communicate
[in]	rawPos	the position to move to, in counts

Definition at line 1140 of file zaberStage.hpp.

References MagAOX::app::MagAOXApp< true >::log().

◆ name() [1/2]

template<class parentT >

std::string MagAOX::app::zaberStage< parentT >::name ( )

Get the device name.

Returns: the current value of m_name

Definition at line 402 of file zaberStage.hpp.

◆ name() [2/2]

template<class parentT >

int MagAOX::app::zaberStage< parentT >::name ( const std::string & n )

Set the device name.

Returns: 0 on success; -1 on error

Parameters

[in] n the new device name

Definition at line 408 of file zaberStage.hpp.

◆ onPowerOff()

template<class parentT >

int MagAOX::app::zaberStage< parentT >::onPowerOff ( )

Clear all state so that when the system is powered back on we get the correct new state.

< The status of the last command sent. true = OK, false = RJ (rejected)

< Current status. Either 'I' for IDLE or 'B' for BUSY. Intializes to 'U' for UNKOWN.

< The driver temperature, in C.

Definition at line 1715 of file zaberStage.hpp.

◆ park()

template<class parentT >

int MagAOX::app::zaberStage< parentT >::park ( z_port port )

Park the stage.

Parameters

[in] port the port with which to communicate

Definition at line 1101 of file zaberStage.hpp.

References MagAOX::app::MagAOXApp< true >::log().

◆ parked()

template<class parentT >

int MagAOX::app::zaberStage< parentT >::parked ( )

Get the parked status.

Returns: the current value of m_parked

Definition at line 478 of file zaberStage.hpp.

◆ parseWarnings()

template<class parentT >

int MagAOX::app::zaberStage< parentT >::parseWarnings ( std::string & response )

Parse the warning response from the device.

Sends each warning flag to processWarning.

Returns: 0 on success; -1 on error

Parameters

[in] response the response from the warnings query

Definition at line 1470 of file zaberStage.hpp.

References MagAOX::app::MagAOXApp< true >::log().

Referenced by libXWCTest::zaberLowLevelTest::SCENARIO(), and libXWCTest::zaberLowLevelTest::SCENARIO().

◆ processWarning()

template<class parentT >

int MagAOX::app::zaberStage< parentT >::processWarning ( std::string & warn )

Process a single warning from the device, setting the appropriate flag.

Warnings are two ASCII characeters, e.g. "WR".

Returns: 0 if the warning is processed, including if it's not recognized.; -1 on an error, currently not possible.

Parameters

[in] warn the two-character warning flag

Definition at line 1202 of file zaberStage.hpp.

References MagAOX::app::MagAOXApp< true >::log(), flatlogs::logPrio::LOG_EMERGENCY, and flatlogs::logPrio::LOG_WARNING.

◆ rawPos()

template<class parentT >

long MagAOX::app::zaberStage< parentT >::rawPos ( )

Get the current raw position, in counts.

Returns: the current value of m_rawPos

Definition at line 496 of file zaberStage.hpp.

◆ readStateFile()

template<class parentT >

int MagAOX::app::zaberStage< parentT >::readStateFile ( std::ifstream & fin )

Parameters

[in] fin an open ofstream to write to

Definition at line 1768 of file zaberStage.hpp.

References MagAOX::app::MagAOXApp< true >::log().

◆ sendCommand() [1/2]

template<class parentT >

int MagAOX::app::zaberStage< parentT >::sendCommand	(	std::string &	response,
		z_port	port,
		const std::string &	command
	)

Send a command and get the response.

Parameters

[out]	response	the response received from the stage
[in]	port	the port with which to communicate
[in]	command	the command to send

Definition at line 723 of file zaberStage.hpp.

References MagAOX::app::MagAOXApp< true >::log(), Z_ERROR_TIMEOUT, Z_SUCCESS, za_decode(), za_receive(), and za_send().

◆ sendCommand() [2/2]

template<class parentT >

int MagAOX::app::zaberStage< parentT >::sendCommand	(	z_port	port,
		const std::string &	command
	)

Send a command for which no response is expected.

Parameters

[in]	port	the port with which to communicate
[in]	command	the command to send

Definition at line 963 of file zaberStage.hpp.

References MagAOX::app::MagAOXApp< true >::log().

◆ serial() [1/2]

template<class parentT >

std::string MagAOX::app::zaberStage< parentT >::serial ( )

Get the device serial number.

Returns: the current value of m_serial

Definition at line 415 of file zaberStage.hpp.

◆ serial() [2/2]

template<class parentT >

int MagAOX::app::zaberStage< parentT >::serial ( const std::string & s )

Set the device serial.

Returns: 0 on success; -1 on error

Parameters

[in] s the new device serial

Definition at line 421 of file zaberStage.hpp.

◆ stop()

template<class parentT >

int MagAOX::app::zaberStage< parentT >::stop ( z_port port )

Stop the stage.

Definition at line 1045 of file zaberStage.hpp.

References MagAOX::app::MagAOXApp< true >::log().

◆ temp()

template<class parentT >

float MagAOX::app::zaberStage< parentT >::temp ( )

Get the temperature, in C.

Returns: the current value of m_temp

Definition at line 520 of file zaberStage.hpp.

◆ tgtPos()

template<class parentT >

long MagAOX::app::zaberStage< parentT >::tgtPos ( )

Get the current tgt position, in counts.

Returns: the current value of m_tgtPos

Definition at line 502 of file zaberStage.hpp.

◆ unpark()

template<class parentT >

int MagAOX::app::zaberStage< parentT >::unpark ( z_port port )

Unpark the stage.

Parameters

[in] port the port with which to communicate

Definition at line 1121 of file zaberStage.hpp.

References MagAOX::app::MagAOXApp< true >::log().

◆ unsetWarnings()

template<class parentT >

int MagAOX::app::zaberStage< parentT >::unsetWarnings ( )

Sets all warning flags to false.

This is not the same as clearing warnings on the device, this is just used for bookkeeping.

Returns: 0 on success (always)

Definition at line 1173 of file zaberStage.hpp.

◆ updatePos()

template<class parentT >

int MagAOX::app::zaberStage< parentT >::updatePos ( z_port port )

Update the position of the stage.

Parameters

[in] port the port with which to communicate

Definition at line 927 of file zaberStage.hpp.

References MagAOX::app::MagAOXApp< true >::log().

◆ updateTemp()

template<class parentT >

int MagAOX::app::zaberStage< parentT >::updateTemp ( z_port port )

Update the stage temperature.

Parameters

[in] port the port with which to communicate

Definition at line 945 of file zaberStage.hpp.

References MagAOX::app::MagAOXApp< true >::log().

◆ warn()

template<class parentT >

bool MagAOX::app::zaberStage< parentT >::warn ( )

Get the status of the warning flag.

Returns: the current value of m_warn

Definition at line 514 of file zaberStage.hpp.

◆ warnFB()

template<class parentT >

bool MagAOX::app::zaberStage< parentT >::warnFB ( )

Definition at line 556 of file zaberStage.hpp.

Referenced by libXWCTest::zaberLowLevelTest::SCENARIO().

◆ warnFD()

template<class parentT >

bool MagAOX::app::zaberStage< parentT >::warnFD ( )

Definition at line 532 of file zaberStage.hpp.

Referenced by libXWCTest::zaberLowLevelTest::SCENARIO().

◆ warnFE()

template<class parentT >

bool MagAOX::app::zaberStage< parentT >::warnFE ( )

Definition at line 568 of file zaberStage.hpp.

Referenced by libXWCTest::zaberLowLevelTest::SCENARIO().

◆ warnFP()

template<class parentT >

bool MagAOX::app::zaberStage< parentT >::warnFP ( )

Definition at line 562 of file zaberStage.hpp.

Referenced by libXWCTest::zaberLowLevelTest::SCENARIO().

◆ warnFQ()

template<class parentT >

bool MagAOX::app::zaberStage< parentT >::warnFQ ( )

Definition at line 538 of file zaberStage.hpp.

Referenced by libXWCTest::zaberLowLevelTest::SCENARIO().

◆ warnFS()

template<class parentT >

bool MagAOX::app::zaberStage< parentT >::warnFS ( )

Definition at line 544 of file zaberStage.hpp.

Referenced by libXWCTest::zaberLowLevelTest::SCENARIO().

◆ warnFT()

template<class parentT >

bool MagAOX::app::zaberStage< parentT >::warnFT ( )

Definition at line 550 of file zaberStage.hpp.

Referenced by libXWCTest::zaberLowLevelTest::SCENARIO().

◆ warningState()

template<class parentT >

bool MagAOX::app::zaberStage< parentT >::warningState ( )

Get the warning state.

Returns: the true if any warning flags are set.

Definition at line 526 of file zaberStage.hpp.

Referenced by libXWCTest::zaberLowLevelTest::SCENARIO().

◆ warnNC()

template<class parentT >

bool MagAOX::app::zaberStage< parentT >::warnNC ( )

Definition at line 616 of file zaberStage.hpp.

Referenced by libXWCTest::zaberLowLevelTest::SCENARIO().

◆ warnND()

template<class parentT >

bool MagAOX::app::zaberStage< parentT >::warnND ( )

Definition at line 628 of file zaberStage.hpp.

Referenced by libXWCTest::zaberLowLevelTest::SCENARIO().

◆ warnNI()

template<class parentT >

bool MagAOX::app::zaberStage< parentT >::warnNI ( )

Definition at line 622 of file zaberStage.hpp.

Referenced by libXWCTest::zaberLowLevelTest::SCENARIO().

◆ warnNJ()

template<class parentT >

bool MagAOX::app::zaberStage< parentT >::warnNJ ( )

Definition at line 640 of file zaberStage.hpp.

Referenced by libXWCTest::zaberLowLevelTest::SCENARIO().

◆ warnNU()

template<class parentT >

bool MagAOX::app::zaberStage< parentT >::warnNU ( )

Definition at line 634 of file zaberStage.hpp.

Referenced by libXWCTest::zaberLowLevelTest::SCENARIO().

◆ warnUNK()

template<class parentT >

bool MagAOX::app::zaberStage< parentT >::warnUNK ( )

Definition at line 646 of file zaberStage.hpp.

Referenced by libXWCTest::zaberLowLevelTest::SCENARIO().

◆ warnWH()

template<class parentT >

bool MagAOX::app::zaberStage< parentT >::warnWH ( )

Definition at line 574 of file zaberStage.hpp.

Referenced by libXWCTest::zaberLowLevelTest::SCENARIO().

◆ warnWL()

template<class parentT >

bool MagAOX::app::zaberStage< parentT >::warnWL ( )

Definition at line 580 of file zaberStage.hpp.

Referenced by libXWCTest::zaberLowLevelTest::SCENARIO().

◆ warnWM()

template<class parentT >

bool MagAOX::app::zaberStage< parentT >::warnWM ( )

Definition at line 604 of file zaberStage.hpp.

Referenced by libXWCTest::zaberLowLevelTest::SCENARIO().

◆ warnWP()

template<class parentT >

bool MagAOX::app::zaberStage< parentT >::warnWP ( )

Definition at line 586 of file zaberStage.hpp.

Referenced by libXWCTest::zaberLowLevelTest::SCENARIO().

◆ warnWR()

template<class parentT >

bool MagAOX::app::zaberStage< parentT >::warnWR ( )

Definition at line 610 of file zaberStage.hpp.

Referenced by libXWCTest::zaberLowLevelTest::SCENARIO().

◆ warnWT()

template<class parentT >

bool MagAOX::app::zaberStage< parentT >::warnWT ( )

Definition at line 598 of file zaberStage.hpp.

Referenced by libXWCTest::zaberLowLevelTest::SCENARIO().

◆ warnWV()

template<class parentT >

bool MagAOX::app::zaberStage< parentT >::warnWV ( )

Definition at line 592 of file zaberStage.hpp.

Referenced by libXWCTest::zaberLowLevelTest::SCENARIO().

◆ writeStateFile()

template<class parentT >

int MagAOX::app::zaberStage< parentT >::writeStateFile ( std::ofstream & fout )

Parameters

[in] fout an open ofstream to write to

Definition at line 1734 of file zaberStage.hpp.

References MagAOX::app::MagAOXApp< true >::log().

Member Data Documentation

◆ m_axisNumber

template<class parentT >

int MagAOX::app::zaberStage< parentT >::m_axisNumber { 0 }

protected

The axis number at the address (normally 0 in MagAO-X)

Definition at line 37 of file zaberStage.hpp.

◆ m_commandStatus

template<class parentT >

bool MagAOX::app::zaberStage< parentT >::m_commandStatus { true }

protected

The status of the last command sent. true = OK, false = RJ (rejected)

Definition at line 39 of file zaberStage.hpp.

◆ m_deviceAddress

template<class parentT >

int MagAOX::app::zaberStage< parentT >::m_deviceAddress { -1 }

protected

The device's address, a.k.a. its order in the chain.

Definition at line 35 of file zaberStage.hpp.

◆ m_deviceStatus

template<class parentT >

char MagAOX::app::zaberStage< parentT >::m_deviceStatus

protected

Initial value:

{

'U' }

Current status. Either 'I' for IDLE or 'B' for BUSY. Intializes to 'U' for UNKOWN.

Definition at line 41 of file zaberStage.hpp.

◆ m_homing

template<class parentT >

bool MagAOX::app::zaberStage< parentT >::m_homing { false }

protected

Definition at line 44 of file zaberStage.hpp.

◆ m_knobEnabled

template<class parentT >

bool MagAOX::app::zaberStage< parentT >::m_knobEnabled { false }

protected

Definition at line 58 of file zaberStage.hpp.

◆ m_lastHomed

template<class parentT >

timespec MagAOX::app::zaberStage< parentT >::m_lastHomed { 0, 0 }

protected

Time stamp of the last time the stage was homed.

Definition at line 46 of file zaberStage.hpp.

◆ m_ledEnabled

template<class parentT >

bool MagAOX::app::zaberStage< parentT >::m_ledEnabled { false }

protected

Definition at line 60 of file zaberStage.hpp.

◆ m_maxPos

template<class parentT >

long MagAOX::app::zaberStage< parentT >::m_maxPos

protected

The max position allowed for the device, set by config. Will be set to no larger m_maxPosHW.

Definition at line 54 of file zaberStage.hpp.

◆ m_name

template<class parentT >

std::string MagAOX::app::zaberStage< parentT >::m_name

protected

The stage's name.

Definition at line 31 of file zaberStage.hpp.

◆ m_parent

template<class parentT >

parentT* MagAOX::app::zaberStage< parentT >::m_parent { nullptr }

protected

Definition at line 29 of file zaberStage.hpp.

Referenced by MagAOX::app::zaberStage< parentT >::zaberStage().

◆ m_parked

template<class parentT >

bool MagAOX::app::zaberStage< parentT >::m_parked { false }

protected

Definition at line 48 of file zaberStage.hpp.

◆ m_rawPos

template<class parentT >

long MagAOX::app::zaberStage< parentT >::m_rawPos

protected

The raw position reported by the device, in microsteps.

Definition at line 50 of file zaberStage.hpp.

◆ m_serial

template<class parentT >

std::string MagAOX::app::zaberStage< parentT >::m_serial

protected

The stage's serial number.

Definition at line 33 of file zaberStage.hpp.

◆ m_temp

template<class parentT >

float MagAOX::app::zaberStage< parentT >::m_temp { -999 }

protected

The driver temperature, in C.

Definition at line 56 of file zaberStage.hpp.

◆ m_tgtPos

template<class parentT >

long MagAOX::app::zaberStage< parentT >::m_tgtPos { 0 }

protected

The tgt position last sent to the device, in microsteps.

Definition at line 52 of file zaberStage.hpp.

◆ m_warn

template<class parentT >

bool MagAOX::app::zaberStage< parentT >::m_warn { false }

protected

Definition at line 62 of file zaberStage.hpp.

◆ m_warnFB

template<class parentT >

bool MagAOX::app::zaberStage< parentT >::m_warnFB { false }

protected

Definition at line 72 of file zaberStage.hpp.

◆ m_warnFBreported

template<class parentT >

bool MagAOX::app::zaberStage< parentT >::m_warnFBreported { false }

protected

Definition at line 73 of file zaberStage.hpp.

◆ m_warnFD

template<class parentT >

bool MagAOX::app::zaberStage< parentT >::m_warnFD { false }

protected

Definition at line 64 of file zaberStage.hpp.

◆ m_warnFDreported

template<class parentT >

bool MagAOX::app::zaberStage< parentT >::m_warnFDreported { false }

protected

Definition at line 65 of file zaberStage.hpp.

◆ m_warnFE

template<class parentT >

bool MagAOX::app::zaberStage< parentT >::m_warnFE { false }

protected

Definition at line 76 of file zaberStage.hpp.

◆ m_warnFEreported

template<class parentT >

bool MagAOX::app::zaberStage< parentT >::m_warnFEreported { false }

protected

Definition at line 77 of file zaberStage.hpp.

◆ m_warnFP

template<class parentT >

bool MagAOX::app::zaberStage< parentT >::m_warnFP { false }

protected

Definition at line 74 of file zaberStage.hpp.

◆ m_warnFPreported

template<class parentT >

bool MagAOX::app::zaberStage< parentT >::m_warnFPreported { false }

protected

Definition at line 75 of file zaberStage.hpp.

◆ m_warnFQ

template<class parentT >

bool MagAOX::app::zaberStage< parentT >::m_warnFQ { false }

protected

Definition at line 66 of file zaberStage.hpp.

◆ m_warnFQreported

template<class parentT >

bool MagAOX::app::zaberStage< parentT >::m_warnFQreported { false }

protected

Definition at line 67 of file zaberStage.hpp.

◆ m_warnFS

template<class parentT >

bool MagAOX::app::zaberStage< parentT >::m_warnFS { false }

protected

Definition at line 68 of file zaberStage.hpp.

◆ m_warnFSreported

template<class parentT >

bool MagAOX::app::zaberStage< parentT >::m_warnFSreported { false }

protected

Definition at line 69 of file zaberStage.hpp.

◆ m_warnFT

template<class parentT >

bool MagAOX::app::zaberStage< parentT >::m_warnFT { false }

protected

Definition at line 70 of file zaberStage.hpp.

◆ m_warnFTreported

template<class parentT >

bool MagAOX::app::zaberStage< parentT >::m_warnFTreported { false }

protected

Definition at line 71 of file zaberStage.hpp.

◆ m_warnNC

template<class parentT >

bool MagAOX::app::zaberStage< parentT >::m_warnNC { false }

protected

Definition at line 92 of file zaberStage.hpp.

◆ m_warnNCreported

template<class parentT >

bool MagAOX::app::zaberStage< parentT >::m_warnNCreported { false }

protected

Definition at line 93 of file zaberStage.hpp.

◆ m_warnND

template<class parentT >

bool MagAOX::app::zaberStage< parentT >::m_warnND { false }

protected

Definition at line 96 of file zaberStage.hpp.

◆ m_warnNDreported

template<class parentT >

bool MagAOX::app::zaberStage< parentT >::m_warnNDreported { false }

protected

Definition at line 97 of file zaberStage.hpp.

◆ m_warnNI

template<class parentT >

bool MagAOX::app::zaberStage< parentT >::m_warnNI { false }

protected

Definition at line 94 of file zaberStage.hpp.

◆ m_warnNIreported

template<class parentT >

bool MagAOX::app::zaberStage< parentT >::m_warnNIreported { false }

protected

Definition at line 95 of file zaberStage.hpp.

◆ m_warnNJ

template<class parentT >

bool MagAOX::app::zaberStage< parentT >::m_warnNJ { false }

protected

Definition at line 100 of file zaberStage.hpp.

◆ m_warnNJreported

template<class parentT >

bool MagAOX::app::zaberStage< parentT >::m_warnNJreported { false }

protected

Definition at line 101 of file zaberStage.hpp.

◆ m_warnNU

template<class parentT >

bool MagAOX::app::zaberStage< parentT >::m_warnNU { false }

protected

Definition at line 98 of file zaberStage.hpp.

◆ m_warnNUreported

template<class parentT >

bool MagAOX::app::zaberStage< parentT >::m_warnNUreported { false }

protected

Definition at line 99 of file zaberStage.hpp.

◆ m_warnUNK

template<class parentT >

bool MagAOX::app::zaberStage< parentT >::m_warnUNK { false }

protected

Definition at line 102 of file zaberStage.hpp.

◆ m_warnWH

template<class parentT >

bool MagAOX::app::zaberStage< parentT >::m_warnWH { false }

protected

Definition at line 78 of file zaberStage.hpp.

◆ m_warnWHreported

template<class parentT >

bool MagAOX::app::zaberStage< parentT >::m_warnWHreported { false }

protected

Definition at line 79 of file zaberStage.hpp.

◆ m_warnWL

template<class parentT >

bool MagAOX::app::zaberStage< parentT >::m_warnWL { false }

protected

Definition at line 80 of file zaberStage.hpp.

◆ m_warnWLreported

template<class parentT >

bool MagAOX::app::zaberStage< parentT >::m_warnWLreported { false }

protected

Definition at line 81 of file zaberStage.hpp.

◆ m_warnWM

template<class parentT >

bool MagAOX::app::zaberStage< parentT >::m_warnWM { false }

protected

Definition at line 88 of file zaberStage.hpp.

◆ m_warnWMreported

template<class parentT >

bool MagAOX::app::zaberStage< parentT >::m_warnWMreported { false }

protected

Definition at line 89 of file zaberStage.hpp.

◆ m_warnWP

template<class parentT >

bool MagAOX::app::zaberStage< parentT >::m_warnWP { false }

protected

Definition at line 82 of file zaberStage.hpp.

◆ m_warnWPreported

template<class parentT >

bool MagAOX::app::zaberStage< parentT >::m_warnWPreported { false }

protected

Definition at line 83 of file zaberStage.hpp.

◆ m_warnWR

template<class parentT >

bool MagAOX::app::zaberStage< parentT >::m_warnWR { false }

protected

Definition at line 90 of file zaberStage.hpp.

◆ m_warnWRreported

template<class parentT >

bool MagAOX::app::zaberStage< parentT >::m_warnWRreported { false }

protected

Definition at line 91 of file zaberStage.hpp.

◆ m_warnWT

template<class parentT >

bool MagAOX::app::zaberStage< parentT >::m_warnWT { false }

protected

Definition at line 86 of file zaberStage.hpp.

◆ m_warnWTreported

template<class parentT >

bool MagAOX::app::zaberStage< parentT >::m_warnWTreported { false }

protected

Definition at line 87 of file zaberStage.hpp.

◆ m_warnWV

template<class parentT >

bool MagAOX::app::zaberStage< parentT >::m_warnWV { false }

protected

Definition at line 84 of file zaberStage.hpp.

◆ m_warnWVreported

template<class parentT >

bool MagAOX::app::zaberStage< parentT >::m_warnWVreported { false }

protected

Definition at line 85 of file zaberStage.hpp.

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

apps/zaberLowLevel/zaberStage.hpp

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ zaberStage() [1/2]

◆ zaberStage() [2/2]

Member Function Documentation

◆ axisNumber() [1/2]

◆ axisNumber() [2/2]

◆ commandStatus()

◆ deviceAddress() [1/2]

◆ deviceAddress() [2/2]

◆ deviceStatus()

◆ enableKnob()

◆ enableLED()

◆ estop()

◆ getKnob()

◆ getLED()

◆ getMaxPos()

◆ getParked()

◆ getResponse() [1/2]

◆ getResponse() [2/2]

◆ getValue()

◆ getWarnings()

◆ home()

◆ homing()

◆ isCommandReply()

◆ knobEnabled()

◆ lastHomed()

◆ ledEnabled()

◆ maxPos()

◆ moveAbs()

◆ name() [1/2]

◆ name() [2/2]

◆ onPowerOff()

◆ park()

◆ parked()

◆ parseWarnings()

◆ processWarning()

◆ rawPos()

◆ readStateFile()

◆ sendCommand() [1/2]

◆ sendCommand() [2/2]

◆ serial() [1/2]

◆ serial() [2/2]

◆ stop()

◆ temp()

◆ tgtPos()

◆ unpark()

◆ unsetWarnings()

◆ updatePos()

◆ updateTemp()

◆ warn()

◆ warnFB()

◆ warnFD()

◆ warnFE()

◆ warnFP()

◆ warnFQ()

◆ warnFS()

◆ warnFT()

◆ warningState()

◆ warnNC()

◆ warnND()

◆ warnNI()

◆ warnNJ()

◆ warnNU()

◆ warnUNK()

◆ warnWH()

◆ warnWL()

◆ warnWM()

◆ warnWP()

◆ warnWR()

◆ warnWT()

◆ warnWV()

◆ writeStateFile()

Member Data Documentation

◆ m_axisNumber

◆ m_commandStatus

◆ m_deviceAddress

◆ m_deviceStatus