Create a gauge connection state. More...
#include <create_state.h>
Public Member Functions | |
| virtual | ~CreateGaugeState () |
| Virtual destructor to help with cleanup;. More... | |
| virtual GaugeState< P, Q > * | operator() (const Q &q) const =0 |
| Construct a ConnectState. More... | |
| virtual const GaugeBC< P, Q > & | getBC () const =0 |
| Return the gauge BC object for this state. More... | |
 Public Member Functions inherited from Chroma::CreateState< P, Q > | |
| virtual | ~CreateState () |
| Virtual destructor to help with cleanup;. More... | |
Detailed Description
template<typename P, typename Q>
class Chroma::CreateGaugeState< P, Q >
Create a gauge connection state.
This is a factory class for producing a connection state
Definition at line 46 of file create_state.h.
Constructor & Destructor Documentation
◆ ~CreateGaugeState()
|
inlinevirtual |
Virtual destructor to help with cleanup;.
Definition at line 50 of file create_state.h.
Member Function Documentation
◆ getBC()
|
pure virtual |
Return the gauge BC object for this state.
The user will supply the BC in a derived class
Implements Chroma::CreateState< P, Q >.
Implemented in Chroma::CreateStoutGaugeState< P, Q >, Chroma::CreateSimpleGaugeState< P, Q >, and Chroma::CreatePeriodicGaugeState< P, Q >.
◆ operator()()
|
pure virtual |
Construct a ConnectState.
Implements Chroma::CreateState< P, Q >.
Implemented in Chroma::CreateStoutGaugeState< P, Q >, Chroma::CreateSimpleGaugeState< P, Q >, and Chroma::CreatePeriodicGaugeState< P, Q >.
The documentation for this class was generated from the following file:
