Scroom::Utils::ProgressInterfaceBroadcaster Class Reference

#include <progressinterfacehelpers.hh>

Inheritance diagram for Scroom::Utils::ProgressInterfaceBroadcaster:

Collaboration diagram for Scroom::Utils::ProgressInterfaceBroadcaster:

Classes
class	Unsubscriber

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

Public Member Functions
Stuff	subscribe (ProgressInterface::Ptr const &child)
void	setIdle () override
void	setWaiting (double progress=0.0) override
void	setWorking (double progress) override
void	setFinished () override
Public Member Functions inherited from Scroom::Utils::Base
	Base ()=default
	Base (const Base &)=delete
	Base (Base &&)=delete
Base &	operator= (const Base &)=delete
Base &	operator= (Base &&)=delete
virtual	~Base ()=default
template<typename R >
boost::shared_ptr< R >	shared_from_this ()
template<typename R >
boost::shared_ptr< R const >	shared_from_this () const

Static Public Member Functions
static Ptr	create ()

Private Member Functions
	ProgressInterfaceBroadcaster ()
void	unsubscribe (ProgressInterface::Ptr const &child)

Private Attributes
boost::mutex	mut
std::set< ProgressInterface::Ptr >	children
Detail::ProgressStore::Ptr	store

Friends
class	Unsubscriber

Member Typedef Documentation

Ptr

using Scroom::Utils::ProgressInterfaceBroadcaster::Ptr = boost::shared_ptr<ProgressInterfaceBroadcaster>

Constructor & Destructor Documentation

ProgressInterfaceBroadcaster()

Scroom::Utils::ProgressInterfaceBroadcaster::ProgressInterfaceBroadcaster ( )

private

  {
    store = Detail::ProgressStore::create();
    children.insert(store);
  }

Referenced by create().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Function Documentation

create()

ProgressInterfaceBroadcaster::Ptr Scroom::Utils::ProgressInterfaceBroadcaster::create ( )

static

{ return Ptr(new ProgressInterfaceBroadcaster()); }

Referenced by BOOST_AUTO_TEST_CASE().

Here is the call graph for this function:

Here is the caller graph for this function:

setFinished()

void Scroom::Utils::ProgressInterfaceBroadcaster::setFinished ( )

overridevirtual

Implements ProgressInterface.

  {
    boost::mutex::scoped_lock const lock(mut);
    for(ProgressInterface::Ptr const& child: children)
    {
      child->setFinished();
    }
  }

setIdle()

void Scroom::Utils::ProgressInterfaceBroadcaster::setIdle ( )

overridevirtual

Implements ProgressInterface.

  {
    boost::mutex::scoped_lock const lock(mut);
    for(ProgressInterface::Ptr const& child: children)
    {
      child->setIdle();
    }
  }

setWaiting()

void Scroom::Utils::ProgressInterfaceBroadcaster::setWaiting ( double  progress = 0.0 )

overridevirtual

Implements ProgressInterface.

  {
    boost::mutex::scoped_lock const lock(mut);
    for(ProgressInterface::Ptr const& child: children)
    {
      child->setWaiting(progress);
    }
  }

setWorking()

void Scroom::Utils::ProgressInterfaceBroadcaster::setWorking ( double  progress )

overridevirtual

Implements ProgressInterface.

  {
    boost::mutex::scoped_lock const lock(mut);
    for(ProgressInterface::Ptr const& child: children)
    {
      child->setWorking(progress);
    }
  }

subscribe()

Stuff Scroom::Utils::ProgressInterfaceBroadcaster::subscribe

(

ProgressInterface::Ptr const &

child

)

  {
    boost::mutex::scoped_lock const lock(mut);
    store->init(child);
    children.insert(child);
    return Unsubscriber::create(shared_from_this<ProgressInterfaceBroadcaster>(), child);
  }

Here is the call graph for this function:

unsubscribe()

void Scroom::Utils::ProgressInterfaceBroadcaster::unsubscribe ( ProgressInterface::Ptr const &  child )

private

  {
    boost::mutex::scoped_lock const lock(mut);
    children.erase(child);
  }

Friends And Related Function Documentation

Unsubscriber

friend class Unsubscriber

friend

Member Data Documentation

children

std::set<ProgressInterface::Ptr> Scroom::Utils::ProgressInterfaceBroadcaster::children

private

Referenced by ProgressInterfaceBroadcaster(), setFinished(), setIdle(), setWaiting(), setWorking(), subscribe(), and unsubscribe().

mut

boost::mutex Scroom::Utils::ProgressInterfaceBroadcaster::mut

private

Referenced by Scroom::Utils::ProgressInterfaceMultiplexer::ChildData::clearFinished(), setFinished(), setIdle(), Scroom::Utils::ProgressInterfaceMultiplexer::ChildData::setProgress(), setWaiting(), setWorking(), subscribe(), and unsubscribe().

store

Detail::ProgressStore::Ptr Scroom::Utils::ProgressInterfaceBroadcaster::store

private

Referenced by ProgressInterfaceBroadcaster(), and subscribe().

---

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

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