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

Create a stout ferm connection state. More...

#include <stout_fermstate_w.h>

Inheritance diagram for Chroma::CreateStoutFermState< T, P, Q >:
Chroma::CreateFermState< T, P, Q > Chroma::CreateState< P, Q >

Public Member Functions

 CreateStoutFermState (Handle< FermBC< T, P, Q > > fbc_, const StoutFermStateParams &p_)
 Full constructor. More...
 
 ~CreateStoutFermState ()
 Destructor. More...
 
StoutFermState< T, P, Q > * operator() (const Q &q) const
 Construct a ConnectState. More...
 
const FermBC< T, P, Q > & getBC () const
 Return the ferm BC object for this state. More...
 
Handle< FermBC< T, P, Q > > getFermBC () const
 Return the ferm BC object for this state. More...
 
- Public Member Functions inherited from Chroma::CreateFermState< T, P, Q >
virtual ~CreateFermState ()
 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

 CreateStoutFermState ()
 
void operator= (const CreateStoutFermState &)
 

Private Attributes

Handle< FermBC< T, P, Q > > fbc
 
StoutFermStateParams params
 

Detailed Description

template<typename T, typename P, typename Q>
class Chroma::CreateStoutFermState< T, P, Q >

Create a stout ferm connection state.

This is a factory class for producing a connection state

Definition at line 201 of file stout_fermstate_w.h.

Constructor & Destructor Documentation

◆ CreateStoutFermState() [1/2]

template<typename T , typename P , typename Q >
Chroma::CreateStoutFermState< T, P, Q >::CreateStoutFermState ( Handle< FermBC< T, P, Q > >  fbc_,
const StoutFermStateParams p_ 
)
inline

Full constructor.

Definition at line 207 of file stout_fermstate_w.h.

◆ ~CreateStoutFermState()

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

Destructor.

Definition at line 212 of file stout_fermstate_w.h.

◆ CreateStoutFermState() [2/2]

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

Definition at line 227 of file stout_fermstate_w.h.

Member Function Documentation

◆ getBC()

template<typename T , typename P , typename Q >
const FermBC<T,P,Q>& Chroma::CreateStoutFermState< T, P, Q >::getBC ( ) const
inlinevirtual

Return the ferm BC object for this state.

Implements Chroma::CreateFermState< T, P, Q >.

Definition at line 221 of file stout_fermstate_w.h.

References Chroma::CreateStoutFermState< T, P, Q >::fbc.

◆ getFermBC()

template<typename T , typename P , typename Q >
Handle< FermBC<T,P,Q> > Chroma::CreateStoutFermState< T, P, Q >::getFermBC ( ) const
inlinevirtual

Return the ferm BC object for this state.

Implements Chroma::CreateFermState< T, P, Q >.

Definition at line 224 of file stout_fermstate_w.h.

References Chroma::CreateStoutFermState< T, P, Q >::fbc.

◆ operator()()

template<typename T , typename P , typename Q >
StoutFermState<T,P,Q>* Chroma::CreateStoutFermState< T, P, Q >::operator() ( const Q q) const
inlinevirtual

◆ operator=()

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

Definition at line 228 of file stout_fermstate_w.h.

Member Data Documentation

◆ fbc

template<typename T , typename P , typename Q >
Handle< FermBC<T,P,Q> > Chroma::CreateStoutFermState< T, P, Q >::fbc
private

◆ params

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

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