FWModelChangeManager Class Reference

#include <Fireworks/Core/interface/FWModelChangeManager.h>

Public Member Functions
void	beginChanges ()
void	changed (const FWModelId &)
void	changed (const FWEventItem *)
void	endChanges ()
	FWModelChangeManager ()
	FWModelChangeManager (const FWModelChangeManager &)=delete
void	itemsGoingToBeClearedSlot (void)
void	newItemSlot (FWEventItem *)
const FWModelChangeManager &	operator= (const FWModelChangeManager &)=delete
virtual	~FWModelChangeManager ()

Public Attributes
sigc::signal< void()>	changeSignalsAreComing_
sigc::signal< void()>	changeSignalsAreDone_

Private Attributes
std::vector< FWModelIds >	m_changes
std::vector< FWModelChangeSignal >	m_changeSignals
unsigned int	m_depth
std::set< const FWEventItem * >	m_itemChanges
std::vector< FWItemChangeSignal >	m_itemChangeSignals

Detailed Description

Description: Manages propagating announcements of changes to Models to any interested party

Usage: <usage>

Definition at line 33 of file FWModelChangeManager.h.

Constructor & Destructor Documentation

FWModelChangeManager() [1/2]

FWModelChangeManager::FWModelChangeManager

(

)

Definition at line 35 of file FWModelChangeManager.cc.

: m_depth(0) {}

~FWModelChangeManager()

FWModelChangeManager::~FWModelChangeManager ( )

virtual

Definition at line 42 of file FWModelChangeManager.cc.

{}

FWModelChangeManager() [2/2]

FWModelChangeManager::FWModelChangeManager ( const FWModelChangeManager &  )

delete

Member Function Documentation

beginChanges()

void FWModelChangeManager::beginChanges

(

)

Definition at line 59 of file FWModelChangeManager.cc.

References m_depth.

Referenced by FWChangeSentry::FWChangeSentry().

{ ++m_depth; }

changed() [1/2]

void FWModelChangeManager::changed

(

const FWModelId &

iID

)

Definition at line 61 of file FWModelChangeManager.cc.

References cms::cuda::assert(), FWEventItem::id(), FWModelId::item(), and m_changes.

Referenced by FWEventItem::destroy(), FWEventItem::handleChange(), FWEventItem::proxyConfigChanged(), FWEventItem::resetColor(), FWEventItem::runFilter(), FWEventItem::select(), FWEventItem::setDefaultDisplayProperties(), FWEventItem::setDisplayProperties(), FWEventItem::toggleSelect(), and FWEventItem::unselect().

                                                       {
  FWChangeSentry sentry(*this);
  assert(iID.item());
  assert(iID.item()->id() < m_changes.size());
  m_changes[iID.item()->id()].insert(iID);
}

changed() [2/2]

void FWModelChangeManager::changed

(

const FWEventItem *

iItem

)

Definition at line 68 of file FWModelChangeManager.cc.

References cms::cuda::assert(), FWEventItem::id(), m_changes, and m_itemChanges.

                                                           {
  FWChangeSentry sentry(*this);
  assert(nullptr != iItem);
  m_itemChanges.insert(iItem);
  //remove any pending changes on models owned by this item
  assert(iItem->id() < m_changes.size());
  m_changes[iItem->id()].clear();
}

endChanges()

void FWModelChangeManager::endChanges

(

)

Definition at line 83 of file FWModelChangeManager.cc.

References cms::cuda::assert(), DMR_cfg::cerr, changeSignalsAreComing_, cppFunctionSkipper::exception, beamvalidation::exit(), fwLog, B2GTnPMonitor_cfi::item, fwlog::kError, m_changes, m_depth, m_itemChanges, sendChangeSignalsAreDone(), and cms::Exception::what().

Referenced by FWChangeSentry::~FWChangeSentry().

                                      {
  assert(m_depth != 0);
  //makes sure that 'changeSignalsAreDone is called if changeSignalsAreComing_ is sent
  bool guard(false);
  if (0 == --m_depth) {
    unsigned int index = 0;
    for (std::set<const FWEventItem*>::iterator itChanges = m_itemChanges.begin(); itChanges != m_itemChanges.end();
         ++itChanges, ++index) {
      if (!guard) {
        // std::shared_ptr<FWModelChangeManager> done(this, &sendChangeSignalsAreDone);
        guard = true;
        changeSignalsAreComing_();
      }
      try {
        const FWEventItem* item = (*itChanges);
        item->itemChanged_.emit(item);
      } catch (const cms::Exception& iE) {
        fwLog(fwlog::kError) << (*itChanges)->name() << " had the failure in process FWItemChanged signals\n"
                             << iE.what() << std::endl;
      } catch (const std::bad_alloc& iE) {
        std::cerr << "Ran out of memory while processing " << (*itChanges)->name() << std::endl;
        exit(1);
      } catch (const std::exception& iE) {
        fwLog(fwlog::kError) << (*itChanges)->name() << " had the failure in process FWItemChanged signals (2) \n"
                             << iE.what() << std::endl;
      }
    }
    m_itemChanges.clear();

    for (size_t ci = 0, ce = m_changes.size(), si = 0; ci != ce; ++ci, ++si) {
      FWModelIds& changes = m_changes[ci];
      if (not changes.empty()) {
        if (!guard) {
          // std::shared_ptr<FWModelChangeManager> done(this, &sendChangeSignalsAreDone);
          guard = true;
          changeSignalsAreComing_();
          try {
            const FWEventItem* item = changes.begin()->item();
            item->changed_.emit(changes);
          } catch (const cms::Exception& iE) {
            fwLog(fwlog::kError) << changes.begin()->item()->name()
                                 << " had the failure in process FWModelChangeSignals\n"
                                 << iE.what() << "\n";
          } catch (const std::bad_alloc& iE) {
            // GE: if we run out of memory why do we assume that we will be able to print?
            fwLog(fwlog::kError) << "Ran out of memory while processing " << changes.begin()->item()->name() << "\n";
            exit(1);
          } catch (const std::exception& iE) {
            fwLog(fwlog::kError) << changes.begin()->item()->name()
                                 << " had the failure in process FWModelChangeSignals (2)\n"
                                 << iE.what() << "\n";
          }
        }
      }
      changes.clear();
    }
  }

  if (guard)
    sendChangeSignalsAreDone(this);
}

itemsGoingToBeClearedSlot()

void FWModelChangeManager::itemsGoingToBeClearedSlot

(

void

)

Whenever all the items are removed from the FWItemsManager clean also the associated vectors here.

Definition at line 160 of file FWModelChangeManager.cc.

References m_changes, m_changeSignals, m_itemChanges, and m_itemChangeSignals.

Referenced by FWSummaryManager::FWSummaryManager().

                                                         {
  m_changes.clear();
  m_changeSignals.clear();

  m_itemChangeSignals.clear();
  m_itemChanges.clear();
}

newItemSlot()

void FWModelChangeManager::newItemSlot

(

FWEventItem *

iItem

)

Definition at line 145 of file FWModelChangeManager.cc.

References cms::cuda::assert(), FWEventItem::changed_, FWEventItem::id(), FWEventItem::itemChanged_, m_changes, m_changeSignals, and m_itemChangeSignals.

Referenced by CmsShowMainBase::setup().

                                                         {
  assert(nullptr != iItem);
  assert(iItem->id() == m_changes.size());
  assert(iItem->id() == m_changeSignals.size());
  m_changes.push_back(FWModelIds());
  m_changeSignals.push_back(FWModelChangeSignal());
  m_itemChangeSignals.push_back(FWItemChangeSignal());
  //propagate our signal to the item
  m_changeSignals.back().connect(iItem->changed_);
  m_itemChangeSignals.back().connect(iItem->itemChanged_);
}

operator=()

const FWModelChangeManager& FWModelChangeManager::operator= ( const FWModelChangeManager &  )

delete

Member Data Documentation

changeSignalsAreComing_

sigc::signal<void()> FWModelChangeManager::changeSignalsAreComing_

Definition at line 49 of file FWModelChangeManager.h.

Referenced by endChanges(), and FWViewManagerBase::setChangeManager().

changeSignalsAreDone_

sigc::signal<void()> FWModelChangeManager::changeSignalsAreDone_

Definition at line 50 of file FWModelChangeManager.h.

Referenced by FWSelectionManager::FWSelectionManager(), FWSummaryManager::FWSummaryManager(), sendChangeSignalsAreDone(), and FWViewManagerBase::setChangeManager().

m_changes

std::vector<FWModelIds> FWModelChangeManager::m_changes

private

Definition at line 62 of file FWModelChangeManager.h.

Referenced by changed(), endChanges(), itemsGoingToBeClearedSlot(), and newItemSlot().

m_changeSignals

std::vector<FWModelChangeSignal> FWModelChangeManager::m_changeSignals

private

Definition at line 64 of file FWModelChangeManager.h.

Referenced by itemsGoingToBeClearedSlot(), and newItemSlot().

m_depth

unsigned int FWModelChangeManager::m_depth

private

Definition at line 61 of file FWModelChangeManager.h.

Referenced by beginChanges(), and endChanges().

m_itemChanges

std::set<const FWEventItem*> FWModelChangeManager::m_itemChanges

private

Definition at line 63 of file FWModelChangeManager.h.

Referenced by changed(), endChanges(), and itemsGoingToBeClearedSlot().

m_itemChangeSignals

std::vector<FWItemChangeSignal> FWModelChangeManager::m_itemChangeSignals

private

Definition at line 65 of file FWModelChangeManager.h.

Referenced by itemsGoingToBeClearedSlot(), and newItemSlot().