Scroom::Utils::Detail::ProgressStore Class Reference

#include <progressinterfacehelpers.hh>

Inheritance diagram for Scroom::Utils::Detail::ProgressStore:

Collaboration diagram for Scroom::Utils::Detail::ProgressStore:

Public Types
using	Ptr = boost::shared_ptr< ProgressStore >
Public Types inherited from ProgressInterface
using	Ptr = boost::shared_ptr< ProgressInterface >
using	WeakPtr = boost::weak_ptr< ProgressInterface >

Public Member Functions
void	init (ProgressInterface::Ptr const &i)
Public Member Functions inherited from Scroom::Utils::ProgressInterfaceFromProgressStateInterface
void	setIdle () override
void	setWaiting (double progress=0.0) override
void	setWorking (double progress) override
void	setFinished () override

Static Public Member Functions
static Ptr	create ()

Protected Member Functions
void	setProgress (State s, double progress=0.0) override
Protected Member Functions inherited from Scroom::Utils::ProgressStateInterface
virtual void	setProgress (State s, double progress=0.0)=0

Private Member Functions
	ProgressStore ()=default

Private Attributes
State	state {IDLE}
double	progress {0.0}

Additional Inherited Members
Protected Types inherited from Scroom::Utils::ProgressStateInterface
enum	State { IDLE, WAITING, WORKING, FINISHED }
using	Ptr = boost::shared_ptr< ProgressStateInterface >
using	WeakPtr = boost::weak_ptr< ProgressStateInterface >

Member Typedef Documentation

Ptr

using Scroom::Utils::Detail::ProgressStore::Ptr = boost::shared_ptr<ProgressStore>

Constructor & Destructor Documentation

ProgressStore()

Scroom::Utils::Detail::ProgressStore::ProgressStore ( )

privatedefault

Referenced by create().

Here is the caller graph for this function:

Member Function Documentation

create()

ProgressStore::Ptr Scroom::Utils::Detail::ProgressStore::create ( )

static

{ return Ptr(new ProgressStore()); }

Referenced by Scroom::Utils::ProgressInterfaceBroadcaster::ProgressInterfaceBroadcaster().

Here is the call graph for this function:

Here is the caller graph for this function:

init()

void Scroom::Utils::Detail::ProgressStore::init

(

ProgressInterface::Ptr const &

i

)

    {
      switch(state)
      {
      case IDLE:
        i->setIdle();
        break;
      case WAITING:
        i->setWaiting(progress);
        break;
      case WORKING:
        i->setWorking(progress);
        break;
      case FINISHED:
        i->setFinished();
        break;
      }
    }

setProgress()

void Scroom::Utils::Detail::ProgressStore::setProgress ( State  s, double  progress = 0.0  )

overrideprotected

    {
      state    = s;
      progress = p;
    }

Member Data Documentation

progress

double Scroom::Utils::Detail::ProgressStore::progress {0.0}

private

Referenced by init(), and setProgress().

state

State Scroom::Utils::Detail::ProgressStore::state {IDLE}

private

Referenced by init(), and setProgress().

---

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

• inc/scroom/progressinterfacehelpers.hh
• libs/util/src/progressinterfacehelpers.cc