votca 2024-dev
Loading...
Searching...
No Matches
Public Member Functions | Protected Attributes | List of all members
votca::xtp::QMThread Class Reference

#include <qmthread.h>

Inheritance diagram for votca::xtp::QMThread:
Inheritance graph
[legend]
Collaboration diagram for votca::xtp::QMThread:
Collaboration graph
[legend]

Public Member Functions

 QMThread ()=default
 
 QMThread (bool maverick)
 
 ~QMThread () override=default
 
Index getId () const
 
void setId (Index id)
 
bool isMaverick () const
 
LoggergetLogger ()
 
void Run (void) override
 Run() executes the actual code.
 
- Public Member Functions inherited from votca::tools::Thread
 Thread ()
 
virtual ~Thread ()
 
void Start ()
 Starts and runs a thread.
 
void WaitDone ()
 WaitDone() will not exit until thread ends computation.
 
bool IsFinished () const
 Checks to see if the thread is done.
 

Protected Attributes

Index id_
 
std::stringstream ss_
 
bool maverick_ = false
 
Logger logger_
 

Additional Inherited Members

virtual void Run (void)=0
 Run() executes the actual code.
 

Detailed Description

Definition at line 45 of file qmthread.h.

Constructor & Destructor Documentation

◆ QMThread() [1/2]

votca::xtp::QMThread::QMThread ( )
default

◆ QMThread() [2/2]

votca::xtp::QMThread::QMThread ( bool  maverick)
inline

Definition at line 48 of file qmthread.h.

◆ ~QMThread()

votca::xtp::QMThread::~QMThread ( )
overridedefault

Member Function Documentation

◆ getId()

Index votca::xtp::QMThread::getId ( ) const
inline

Definition at line 51 of file qmthread.h.

◆ getLogger()

Logger & votca::xtp::QMThread::getLogger ( )
inline

Definition at line 55 of file qmthread.h.

◆ isMaverick()

bool votca::xtp::QMThread::isMaverick ( ) const
inline

Definition at line 53 of file qmthread.h.

◆ Run()

void votca::xtp::QMThread::Run ( void  )
inlineoverridevirtual

Run() executes the actual code.

It is left blank here and must be overloaded, for the thread to do any work. This method should never be called by the user, it is called internally by the Start method.

Implements votca::tools::Thread.

Definition at line 56 of file qmthread.h.

◆ setId()

void votca::xtp::QMThread::setId ( Index  id)
inline

Definition at line 52 of file qmthread.h.

Member Data Documentation

◆ id_

Index votca::xtp::QMThread::id_
protected

Definition at line 59 of file qmthread.h.

◆ logger_

Logger votca::xtp::QMThread::logger_
protected

Definition at line 62 of file qmthread.h.

◆ maverick_

bool votca::xtp::QMThread::maverick_ = false
protected

Definition at line 61 of file qmthread.h.

◆ ss_

std::stringstream votca::xtp::QMThread::ss_
protected

Definition at line 60 of file qmthread.h.


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