TBTK
Need a break? Support the development by playing Polarity Puzzles
TBTK::PropertyExtractor::PropertyExtractor::Information Class Reference

#include <PropertyExtractor.h>

Public Member Functions

 Information ()
 
void setSpinIndex (int spinIndex)
 
int getSpinIndex () const
 

Detailed Description

Info class that is able to pass the most common parameters between calculate-functions and the corresponding callbacks. Calculations requiring more advanced features should override this class and perform a type cast in the callbacks.

Constructor & Destructor Documentation

◆ Information()

TBTK::PropertyExtractor::PropertyExtractor::Information::Information ( )

Member Function Documentation

◆ getSpinIndex()

int TBTK::PropertyExtractor::PropertyExtractor::Information::getSpinIndex ( ) const
inline

Get the subindex for the spin index.

Returns
The spin index. Returns -1 if no spin-index has been set.

◆ setSpinIndex()

void TBTK::PropertyExtractor::PropertyExtractor::Information::setSpinIndex ( int  spinIndex)
inline

Set the subindex for the spin index.

Parameters
spinIndexThe subindex that is the spin index.

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