CHROMA
Public Member Functions | Private Member Functions | Private Attributes | List of all members
Chroma::CreateStoutGaugeState< P, Q > Class Template Reference

Create a stout gauge connection state. More...

#include <stout_gaugestate.h>

Inheritance diagram for Chroma::CreateStoutGaugeState< P, Q >:
Chroma::CreateGaugeState< P, Q > Chroma::CreateState< P, Q >

Public Member Functions

 CreateStoutGaugeState (Handle< GaugeBC< P, Q > > gbc_, const StoutFermStateParams &p_)
 Full constructor. More...
 
 ~CreateStoutGaugeState ()
 Destructor. More...
 
StoutGaugeState< P, Q > * operator() (const Q &q) const
 Construct a ConnectState. More...
 
const GaugeBC< P, Q > & getBC () const
 Return the gauge BC object for this state. More...
 
- Public Member Functions inherited from Chroma::CreateGaugeState< P, Q >
virtual ~CreateGaugeState ()
 Virtual destructor to help with cleanup;. More...
 
- Public Member Functions inherited from Chroma::CreateState< P, Q >
virtual ~CreateState ()
 Virtual destructor to help with cleanup;. More...
 

Private Member Functions

 CreateStoutGaugeState ()
 
void operator= (const CreateStoutGaugeState &)
 

Private Attributes

Handle< GaugeBC< P, Q > > gbc
 
StoutFermStateParams params
 

Detailed Description

template<typename P, typename Q>
class Chroma::CreateStoutGaugeState< P, Q >

Create a stout gauge connection state.

This is a factory class for producing a connection state

Definition at line 177 of file stout_gaugestate.h.

Constructor & Destructor Documentation

◆ CreateStoutGaugeState() [1/2]

template<typename P , typename Q >
Chroma::CreateStoutGaugeState< P, Q >::CreateStoutGaugeState ( Handle< GaugeBC< P, Q > >  gbc_,
const StoutFermStateParams p_ 
)
inline

Full constructor.

Definition at line 181 of file stout_gaugestate.h.

◆ ~CreateStoutGaugeState()

template<typename P , typename Q >
Chroma::CreateStoutGaugeState< P, Q >::~CreateStoutGaugeState ( )
inline

Destructor.

Definition at line 185 of file stout_gaugestate.h.

◆ CreateStoutGaugeState() [2/2]

template<typename P , typename Q >
Chroma::CreateStoutGaugeState< P, Q >::CreateStoutGaugeState ( )
inlineprivate

Definition at line 197 of file stout_gaugestate.h.

Member Function Documentation

◆ getBC()

template<typename P , typename Q >
const GaugeBC<P,Q>& Chroma::CreateStoutGaugeState< P, Q >::getBC ( ) const
inlinevirtual

Return the gauge BC object for this state.

Implements Chroma::CreateGaugeState< P, Q >.

Definition at line 194 of file stout_gaugestate.h.

References Chroma::CreateStoutGaugeState< P, Q >::gbc.

◆ operator()()

template<typename P , typename Q >
StoutGaugeState<P,Q>* Chroma::CreateStoutGaugeState< P, Q >::operator() ( const Q q) const
inlinevirtual

◆ operator=()

template<typename P , typename Q >
void Chroma::CreateStoutGaugeState< P, Q >::operator= ( const CreateStoutGaugeState< P, Q > &  )
inlineprivate

Definition at line 198 of file stout_gaugestate.h.

Member Data Documentation

◆ gbc

template<typename P , typename Q >
Handle< GaugeBC<P,Q> > Chroma::CreateStoutGaugeState< P, Q >::gbc
private

◆ params

template<typename P , typename Q >
StoutFermStateParams Chroma::CreateStoutGaugeState< P, Q >::params
private

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