votca 2025.1-dev
 
Loading...
Searching...
No Matches
Public Member Functions | Private Member Functions | Private Attributes | List of all members
votca::xtp::QMState Class Reference

Identifier for QMstates. Strings like S1 are converted into enum +zero indexed int. More...

#include <qmstate.h>

Collaboration diagram for votca::xtp::QMState:
Collaboration graph
[legend]

Public Member Functions

 QMState (const QMStateType::statetype &type, Index index, bool transition)
 
 QMState (const QMStateType &type, Index index, bool transition)
 
 QMState ()
 
 QMState (const std::string &statestring)
 
void FromString (const std::string &statestring)
 
std::string ToString () const
 
std::string ToLongString () const
 
const QMStateType & Type () const
 
bool isTransition () const
 
Index StateIdx () const
 
bool operator== (const QMState &rhs) const
 
bool operator!= (const QMState &rhs) const
 

Private Member Functions

Index DetermineIndex (const std::string &statestring)
 
QMStateType DetermineType (const std::string &statestring)
 

Private Attributes

QMStateType type_
 
Index index_
 
bool transition_
 

Detailed Description

Identifier for QMstates. Strings like S1 are converted into enum +zero indexed int.

Definition at line 132 of file qmstate.h.

Constructor & Destructor Documentation

◆ QMState() [1/4]

votca::xtp::QMState::QMState ( const QMStateType::statetype & type,
Index index,
bool transition )
inline

Definition at line 135 of file qmstate.h.

◆ QMState() [2/4]

votca::xtp::QMState::QMState ( const QMStateType & type,
Index index,
bool transition )
inline

Definition at line 139 of file qmstate.h.

◆ QMState() [3/4]

votca::xtp::QMState::QMState ( )
inline

Definition at line 143 of file qmstate.h.

◆ QMState() [4/4]

votca::xtp::QMState::QMState ( const std::string & statestring)
inline

Definition at line 144 of file qmstate.h.

Member Function Documentation

◆ DetermineIndex()

Index votca::xtp::QMState::DetermineIndex ( const std::string & statestring)
private

Definition at line 161 of file qmstate.cc.

◆ DetermineType()

QMStateType votca::xtp::QMState::DetermineType ( const std::string & statestring)
private

Definition at line 188 of file qmstate.cc.

◆ FromString()

void votca::xtp::QMState::FromString ( const std::string & statestring)

Definition at line 203 of file qmstate.cc.

◆ isTransition()

bool votca::xtp::QMState::isTransition ( ) const
inline

Definition at line 153 of file qmstate.h.

◆ operator!=()

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

Definition at line 160 of file qmstate.h.

◆ operator==()

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

Definition at line 156 of file qmstate.h.

◆ StateIdx()

Index votca::xtp::QMState::StateIdx ( ) const
inline

Definition at line 154 of file qmstate.h.

◆ ToLongString()

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

Definition at line 130 of file qmstate.cc.

◆ ToString()

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

Definition at line 146 of file qmstate.cc.

◆ Type()

const QMStateType & votca::xtp::QMState::Type ( ) const
inline

Definition at line 151 of file qmstate.h.

Member Data Documentation

◆ index_

Index votca::xtp::QMState::index_
private

Definition at line 169 of file qmstate.h.

◆ transition_

bool votca::xtp::QMState::transition_
private

Definition at line 171 of file qmstate.h.

◆ type_

QMStateType votca::xtp::QMState::type_
private

Definition at line 167 of file qmstate.h.

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