votca 2024.2-dev
Loading...
Searching...
No Matches
votca::xtp::QMStateType Class Reference

#include <qmstate.h>

Public Types

enum  statetype {
  Electron = 0 , Hole = 1 , Singlet = 2 , Triplet = 3 ,
  Gstate = 4 , PQPstate , DQPstate , KSstate ,
  LMOstate
}
 

Public Member Functions

 QMStateType (const statetype &type)
 
 QMStateType ()
 
 QMStateType (const std::string &s)
 
statetype Type () const
 
void FromString (const std::string &statetypestring)
 
std::string ToString () const
 
std::string ToLongString () const
 
bool operator== (const QMStateType &rhs) const
 
bool operator!= (const QMStateType &rhs) const
 
bool operator== (const QMStateType::statetype &rhs) const
 
bool operator!= (const QMStateType::statetype &rhs) const
 
bool isExciton () const
 
bool isKMCState () const
 
bool isSingleParticleState () const
 
bool isGWState () const
 
bool isKSState () const
 
bool isPQPState () const
 

Private Attributes

statetype type_
 

Detailed Description

Definition at line 33 of file qmstate.h.

Member Enumeration Documentation

◆ statetype

Enumerator
Electron 
Hole 
Singlet 
Triplet 
Gstate 
PQPstate 
DQPstate 
KSstate 
LMOstate 

Definition at line 35 of file qmstate.h.

Constructor & Destructor Documentation

◆ QMStateType() [1/3]

votca::xtp::QMStateType::QMStateType ( const statetype & type)
inline

Definition at line 47 of file qmstate.h.

◆ QMStateType() [2/3]

votca::xtp::QMStateType::QMStateType ( )
inline

Definition at line 48 of file qmstate.h.

◆ QMStateType() [3/3]

votca::xtp::QMStateType::QMStateType ( const std::string & s)
inline

Definition at line 49 of file qmstate.h.

Member Function Documentation

◆ FromString()

void votca::xtp::QMStateType::FromString ( const std::string & statetypestring)

Definition at line 103 of file qmstate.cc.

◆ isExciton()

bool votca::xtp::QMStateType::isExciton ( ) const
inline

Definition at line 71 of file qmstate.h.

◆ isGWState()

bool votca::xtp::QMStateType::isGWState ( ) const
inline

Definition at line 85 of file qmstate.h.

◆ isKMCState()

bool votca::xtp::QMStateType::isKMCState ( ) const
inline

Definition at line 75 of file qmstate.h.

◆ isKSState()

bool votca::xtp::QMStateType::isKSState ( ) const
inline

Definition at line 89 of file qmstate.h.

◆ isPQPState()

bool votca::xtp::QMStateType::isPQPState ( ) const
inline

Definition at line 91 of file qmstate.h.

◆ isSingleParticleState()

bool votca::xtp::QMStateType::isSingleParticleState ( ) const
inline

Definition at line 80 of file qmstate.h.

◆ operator!=() [1/2]

bool votca::xtp::QMStateType::operator!= ( const QMStateType & rhs) const
inline

Definition at line 61 of file qmstate.h.

◆ operator!=() [2/2]

bool votca::xtp::QMStateType::operator!= ( const QMStateType::statetype & rhs) const
inline

Definition at line 67 of file qmstate.h.

◆ operator==() [1/2]

bool votca::xtp::QMStateType::operator== ( const QMStateType & rhs) const
inline

Definition at line 59 of file qmstate.h.

◆ operator==() [2/2]

bool votca::xtp::QMStateType::operator== ( const QMStateType::statetype & rhs) const
inline

Definition at line 63 of file qmstate.h.

◆ ToLongString()

std::string votca::xtp::QMStateType::ToLongString ( ) const

Definition at line 69 of file qmstate.cc.

◆ ToString()

std::string votca::xtp::QMStateType::ToString ( ) const

Definition at line 35 of file qmstate.cc.

◆ Type()

statetype votca::xtp::QMStateType::Type ( ) const
inline

Definition at line 51 of file qmstate.h.

Member Data Documentation

◆ type_

statetype votca::xtp::QMStateType::type_
private

Definition at line 94 of file qmstate.h.


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