An input/output capable device. More...

#include <ioDevice.hpp>

Inheritance diagram for MagAOX::app::dev::ioDevice:

Collaboration diagram for MagAOX::app::dev::ioDevice:

Public Member Functions
int	setupConfig (mx::app::appConfigurator &config)
	Setup an application configurator for the device section. More...

int	loadConfig (mx::app::appConfigurator &config)
	Load the device section from an application configurator. More...

int	appStartup ()
	Perform application startup steps specific to an ioDevice. More...

int	appLogic ()
	Perform application logic steps specific to an ioDevice during the main event loop. More...

Public Attributes
unsigned	m_readTimeout {1000}
	The read timeout [msec]. More...

unsigned	m_writeTimeout {1000}
	The write timeout [msec]. More...

Detailed Description

An input/output capable device.

Standardizes read and write timeout configuration.

Definition at line 26 of file ioDevice.hpp.

Member Function Documentation

◆ appLogic()

int MagAOX::app::dev::ioDevice::appLogic ( )

Perform application logic steps specific to an ioDevice during the main event loop.

This is currently an empty function which always returns 0. Could be ignored, but for future changes it is recommended to include a call to this in derivedT::appLogic().

Returns: 0 on success; -1 on error

Definition at line 41 of file ioDevice.cpp.

◆ appStartup()

int MagAOX::app::dev::ioDevice::appStartup ( )

Perform application startup steps specific to an ioDevice.

This is currently an empty function which always returns 0. Could be ignored, but for future changes it is recommended to include a call to this in derivedT::appStartup().

Returns: 0 on success; -1 on error

Definition at line 36 of file ioDevice.cpp.

Referenced by MagAOX::app::tcsInterface::appStartup().

◆ loadConfig()

int MagAOX::app::dev::ioDevice::loadConfig ( mx::app::appConfigurator & config )

Load the device section from an application configurator.

Returns: 0 on success; -1 on error (nothing implemented yet)

Parameters

[in] config an application configuration from which to load values

Definition at line 28 of file ioDevice.cpp.

Referenced by MagAOX::app::picoMotorCtrl::loadConfig(), MagAOX::app::smc100ccCtrl::loadConfig(), MagAOX::app::trippLitePDU::loadConfig(), MagAOX::app::dev::edtCamera< derivedT >::loadConfig(), MagAOX::app::flipperCtrl::loadConfigImpl(), MagAOX::app::pi335Ctrl::loadConfigImpl(), MagAOX::app::rhusbMon::loadConfigImpl(), and MagAOX::app::tcsInterface::loadConfigImpl().

◆ setupConfig()

int MagAOX::app::dev::ioDevice::setupConfig ( mx::app::appConfigurator & config )

Setup an application configurator for the device section.

Returns: 0 on success.; -1 on error (nothing implemented yet)

Parameters

[in] config an application configuration to setup

Definition at line 20 of file ioDevice.cpp.

Referenced by MagAOX::app::flipperCtrl::setupConfig(), MagAOX::app::pi335Ctrl::setupConfig(), MagAOX::app::picoMotorCtrl::setupConfig(), MagAOX::app::rhusbMon::setupConfig(), MagAOX::app::smc100ccCtrl::setupConfig(), MagAOX::app::tcsInterface::setupConfig(), MagAOX::app::trippLitePDU::setupConfig(), and MagAOX::app::dev::edtCamera< derivedT >::setupConfig().

Member Data Documentation

◆ m_readTimeout

unsigned MagAOX::app::dev::ioDevice::m_readTimeout {1000}

The read timeout [msec].

Definition at line 28 of file ioDevice.hpp.

Referenced by MagAOX::app::rhusbMon::rhusbMon(), MagAOX::app::tcsInterface::acquireFromGuider(), MagAOX::app::picoMotorCtrl::appLogic(), MagAOX::app::trippLitePDU::devPostLogin(), MagAOX::app::trippLitePDU::devStatus(), MagAOX::app::pi335Ctrl::finishInit(), MagAOX::app::pi335Ctrl::getCom(), MagAOX::app::smc100ccCtrl::getCtrlState(), MagAOX::app::smc100ccCtrl::getLastError(), MagAOX::app::tcsInterface::getMagTelStatus(), MagAOX::app::flipperCtrl::getPos(), MagAOX::app::smc100ccCtrl::getPosition(), MagAOX::app::pi335Ctrl::initDM(), loadConfig(), MagAOX::app::rhusbMon::readProbe(), MagAOX::app::tcsInterface::sendFoffload(), MagAOX::app::tcsInterface::sendPyrNudge(), MagAOX::app::tcsInterface::sendTToffload(), MagAOX::app::pi335Ctrl::testConnection(), MagAOX::app::smc100ccCtrl::testConnection(), MagAOX::app::trippLitePDU::turnOutletOff(), and MagAOX::app::trippLitePDU::turnOutletOn().

◆ m_writeTimeout

unsigned MagAOX::app::dev::ioDevice::m_writeTimeout {1000}

The write timeout [msec].

Definition at line 29 of file ioDevice.hpp.

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

libMagAOX/app/dev/ioDevice.hpp
libMagAOX/app/dev/ioDevice.cpp

Public Member Functions

Public Attributes