API
Public Member Functions | List of all members
MagAOX::app::tmcCon< parentT > Class Template Reference

Local derivation of tmcController to implement MagAO-X logging. More...

#include <kcubeCtrl.hpp>

Inheritance diagram for MagAOX::app::tmcCon< parentT >:
Inheritance graph
Collaboration diagram for MagAOX::app::tmcCon< parentT >:
Collaboration graph

Public Member Functions

virtual void ftdiErrmsg (const std::string &src, const std::string &msg, int rv, const std::string &file, int line)
 Print a message to MagAO-X logs describing an error from an \libftdi1 function. More...
 
virtual void otherErrmsg (const std::string &src, const std::string &msg, const std::string &file, int line)
 Print a message to MagAO-X logs describing an error. More...
 

Detailed Description

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

Local derivation of tmcController to implement MagAO-X logging.

Definition at line 35 of file kcubeCtrl.hpp.

Member Function Documentation

◆ ftdiErrmsg()

template<class parentT >
virtual void MagAOX::app::tmcCon< parentT >::ftdiErrmsg ( const std::string &  src,
const std::string &  msg,
int  rv,
const std::string &  file,
int  line 
)
inlinevirtual

Print a message to MagAO-X logs describing an error from an \libftdi1 function.

Intended to be overriden in a derived class to provide custom error messaging.

Parameters
[in]srcThe source of the error (the tmcController function)
[in]msgThe message describing the error
[in]rvThe return value of the \libftdi1 function
[in]fileThe file name of this file
[in]lineThe line number at which the error was recorded

Definition at line 42 of file kcubeCtrl.hpp.

◆ otherErrmsg()

template<class parentT >
virtual void MagAOX::app::tmcCon< parentT >::otherErrmsg ( const std::string &  src,
const std::string &  msg,
const std::string &  file,
int  line 
)
inlinevirtual

Print a message to MagAO-X logs describing an error.

Intended to be overriden in a derived class to provide custom error messaging.

Parameters
[in]srcThe source of the error (the tmcController function)
[in]msgThe message describing the error
[in]fileThe file name of this file
[in]lineThe line number at which the error was recorded

Definition at line 58 of file kcubeCtrl.hpp.

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