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

Create a simple gauge connection state. More...

#include <simple_gaugestate.h>

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

Public Member Functions

 CreateSimpleGaugeState (Handle< GaugeBC< P, Q > > gbc_)
 Full constructor. More...
 
 ~CreateSimpleGaugeState ()
 Destructor. More...
 
SimpleGaugeState< 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

 CreateSimpleGaugeState ()
 
void operator= (const CreateSimpleGaugeState &)
 

Private Attributes

Handle< GaugeBC< P, Q > > gbc
 

Detailed Description

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

Create a simple gauge connection state.

This is a factory class for producing a connection state

Definition at line 69 of file simple_gaugestate.h.

Constructor & Destructor Documentation

◆ CreateSimpleGaugeState() [1/2]

template<typename P , typename Q >
Chroma::CreateSimpleGaugeState< P, Q >::CreateSimpleGaugeState ( Handle< GaugeBC< P, Q > >  gbc_)
inline

Full constructor.

Definition at line 73 of file simple_gaugestate.h.

◆ ~CreateSimpleGaugeState()

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

Destructor.

Definition at line 76 of file simple_gaugestate.h.

◆ CreateSimpleGaugeState() [2/2]

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

Definition at line 88 of file simple_gaugestate.h.

Member Function Documentation

◆ getBC()

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

Return the gauge BC object for this state.

Implements Chroma::CreateGaugeState< P, Q >.

Definition at line 85 of file simple_gaugestate.h.

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

◆ operator()()

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

Construct a ConnectState.

Implements Chroma::CreateGaugeState< P, Q >.

Definition at line 79 of file simple_gaugestate.h.

References Chroma::CreateSimpleGaugeState< P, Q >::gbc, and q.

◆ operator=()

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

Definition at line 89 of file simple_gaugestate.h.

Member Data Documentation

◆ gbc

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

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