Scroom::Utils::ProgressInterfaceMultiplexer::ChildData Class Reference

Inheritance diagram for Scroom::Utils::ProgressInterfaceMultiplexer::ChildData:

Collaboration diagram for Scroom::Utils::ProgressInterfaceMultiplexer::ChildData:

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

Public Member Functions
void	clearFinished ()
void	setProgress (State s, double progress=0.0) override

Static Public Member Functions
static Ptr	create ()

Public Attributes
boost::mutex	mut
ProgressStateInterface::State	state {ProgressStateInterface::IDLE}
double	progress {0.0}

Private Member Functions
	ChildData ()=default

Member Typedef Documentation

Ptr

using Scroom::Utils::ProgressInterfaceMultiplexer::ChildData::Ptr = boost::shared_ptr<ChildData>

Constructor & Destructor Documentation

ChildData()

Scroom::Utils::ProgressInterfaceMultiplexer::ChildData::ChildData ( )

privatedefault

Member Function Documentation

clearFinished()

void Scroom::Utils::ProgressInterfaceMultiplexer::ChildData::clearFinished

(

)

  {
    boost::mutex::scoped_lock const l(mut);
    if(state == FINISHED)
    {
      state    = IDLE;
      progress = 0.0;
    }
  }

create()

ProgressInterfaceMultiplexer::ChildData::Ptr Scroom::Utils::ProgressInterfaceMultiplexer::ChildData::create ( )

static

{ return Ptr(new ChildData()); }

Referenced by Scroom::Utils::ProgressInterfaceMultiplexer::createProgressInterface().

Here is the caller graph for this function:

setProgress()

void Scroom::Utils::ProgressInterfaceMultiplexer::ChildData::setProgress ( State  s, double  progress = 0.0  )

overridevirtual

Implements Scroom::Utils::ProgressStateInterface.

  {
    boost::mutex::scoped_lock const l(mut);
    state    = state_;
    progress = progress_;
  }

Member Data Documentation

mut

boost::mutex Scroom::Utils::ProgressInterfaceMultiplexer::ChildData::mut

progress

double Scroom::Utils::ProgressInterfaceMultiplexer::ChildData::progress {0.0}

state

ProgressStateInterface::State Scroom::Utils::ProgressInterfaceMultiplexer::ChildData::state {ProgressStateInterface::IDLE}

---

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

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