FWEventItemsManager Class Reference

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

Inheritance diagram for FWEventItemsManager:

Public Types
typedef std::vector< FWEventItem * >::const_iterator	const_iterator

Public Member Functions
FWEventItem *	add (const FWPhysicsObjectDesc &iItem, const FWConfiguration *pbConf=nullptr, bool doSetEvent=true)
void	addTo (FWConfiguration &) const override
const_iterator	begin () const
	NOTE: iterator is allowed to return a null object for items that have been removed. More...
void	clearItems ()
const_iterator	end () const
const FWEventItem *	find (const std::string &iName) const
	FWEventItemsManager (FWModelChangeManager *)
	FWEventItemsManager (const FWEventItemsManager &)=delete
void	newEvent (const edm::EventBase *iEvent)
const FWEventItemsManager &	operator= (const FWEventItemsManager &)=delete
void	setContext (fireworks::Context *)
void	setFrom (const FWConfiguration &) override
	~FWEventItemsManager () override
Public Member Functions inherited from FWConfigurable
	FWConfigurable ()
	FWConfigurable (const FWConfigurable &)=delete
const FWConfigurable &	operator= (const FWConfigurable &)=delete
virtual	~FWConfigurable ()

Public Attributes
sigc::signal< void()>	goingToClearItems_
sigc::signal< void(FWEventItem *)>	newItem_
sigc::signal< void(const FWEventItem *)>	removingItem_

Private Member Functions
void	removeItem (const FWEventItem *)

Private Attributes
std::shared_ptr< FWItemAccessorFactory >	m_accessorFactory
FWModelChangeManager *	m_changeManager
fireworks::Context *	m_context
const edm::EventBase *	m_event
std::vector< FWEventItem * >	m_items

Detailed Description

Description: Manages multiple FWEventItems

Usage: <usage>

Definition at line 44 of file FWEventItemsManager.h.

Member Typedef Documentation

const_iterator

typedef std::vector<FWEventItem*>::const_iterator FWEventItemsManager::const_iterator

Definition at line 50 of file FWEventItemsManager.h.

Constructor & Destructor Documentation

FWEventItemsManager() [1/2]

FWEventItemsManager::FWEventItemsManager

(

FWModelChangeManager *

iManager

)

Definition at line 41 of file FWEventItemsManager.cc.

    : m_changeManager(iManager), m_context(nullptr), m_event(nullptr), m_accessorFactory(new FWItemAccessorFactory()) {}

~FWEventItemsManager()

FWEventItemsManager::~FWEventItemsManager ( )

override

FWEventItemsManager has ownership of the items it contains.

Note that because of the way we keep track of removed items, m_items[i] could actually be 0 for indices corresponding to removed items.

Definition at line 55 of file FWEventItemsManager.cc.

References MillePedeFileConverter_cfg::e, mps_fire::i, and m_items.

                                          {
  for (size_t i = 0, e = m_items.size(); i != e; ++i)
    delete m_items[i];

  m_items.clear();
}

FWEventItemsManager() [2/2]

FWEventItemsManager::FWEventItemsManager ( const FWEventItemsManager &  )

delete

Member Function Documentation

add()

FWEventItem * FWEventItemsManager::add	(	const FWPhysicsObjectDesc &	iItem,
		const FWConfiguration *	pbConf = nullptr,
		bool	doSetEvent = true
	)

Definition at line 77 of file FWEventItemsManager.cc.

References FWColorManager::colorHasIndex(), fireworks::Context::colorManager(), fwLog, FWColorManager::getDefaultStartColorIndex(), fwlog::kWarning, m_accessorFactory, m_changeManager, m_context, m_event, m_items, newItem_, removeItem(), and groupFilesInBlocks::temp.

Referenced by FWGUIEventDataAdder::addNewItem(), counter.Counter::register(), SequenceTypes._TaskBase::remove(), SequenceTypes._TaskBase::replace(), and setFrom().

                                                                                                                   {
  FWPhysicsObjectDesc temp(iItem);

  if (!m_context->colorManager()->colorHasIndex(temp.displayProperties().color())) {
    FWDisplayProperties prop(temp.displayProperties());
    fwLog(fwlog::kWarning) << Form(
        "FWEventItemsManager::add(const FWPhysicsObjectDesc& iItem), color index  not valid. Set Color idex to %d\n",
        FWColorManager::getDefaultStartColorIndex());
    prop.setColor(FWColorManager::getDefaultStartColorIndex());
    temp.setDisplayProperties(prop);
  }

  m_items.push_back(new FWEventItem(m_context, m_items.size(), m_accessorFactory->accessorFor(temp.type()), temp, pbc));
  newItem_(m_items.back());
  m_items.back()->goingToBeDestroyed_.connect(std::bind(&FWEventItemsManager::removeItem, this, std::placeholders::_1));
  if (doSetEvent && m_event) {
    FWChangeSentry sentry(*m_changeManager);
    m_items.back()->setEvent(m_event);
  }
  return m_items.back();
}

addTo()

void FWEventItemsManager::addTo ( FWConfiguration &  iTo ) const

overridevirtual

Implements FWConfigurable.

Definition at line 143 of file FWEventItemsManager.cc.

References FWConfiguration::addKeyValue(), cms::cuda::assert(), fireworks::Context::colorManager(), DTskim_cfg::dataType, kColor(), kFalse(), kFilterExpression(), kIsVisible(), kLayer(), kModuleLabel(), kProcessName(), kProductInstanceLabel(), kPurpose(), kTransparency(), kTrue(), kType(), m_context, and m_items.

                                                          {
  FWColorManager* cm = m_context->colorManager();
  assert(nullptr != cm);
  for (std::vector<FWEventItem*>::const_iterator it = m_items.begin(); it != m_items.end(); ++it) {
    if (!*it)
      continue;
    FWConfiguration conf(6);
    edm::TypeWithDict dataType((*((*it)->type()->GetTypeInfo())));
    assert(dataType != edm::TypeWithDict());

    conf.addKeyValue(kType, FWConfiguration(dataType.name()));
    conf.addKeyValue(kModuleLabel, FWConfiguration((*it)->moduleLabel()));
    conf.addKeyValue(kProductInstanceLabel, FWConfiguration((*it)->productInstanceLabel()));
    conf.addKeyValue(kProcessName, FWConfiguration((*it)->processName()));
    conf.addKeyValue(kFilterExpression, FWConfiguration((*it)->filterExpression()));
    {
      std::ostringstream os;
      os << (*it)->defaultDisplayProperties().color();
      conf.addKeyValue(kColor, FWConfiguration(os.str()));
    }
    conf.addKeyValue(kIsVisible, FWConfiguration((*it)->defaultDisplayProperties().isVisible() ? kTrue : kFalse));
    {
      std::ostringstream os;
      os << (*it)->layer();
      conf.addKeyValue(kLayer, FWConfiguration(os.str()));
    }
    conf.addKeyValue(kPurpose, (*it)->purpose());
    {
      std::ostringstream os;
      os << static_cast<int>((*it)->defaultDisplayProperties().transparency());
      conf.addKeyValue(kTransparency, FWConfiguration(os.str()));
    }

    FWConfiguration pbTmp;
    (*it)->getConfig()->addTo(pbTmp);
    conf.addKeyValue("PBConfig", pbTmp, true);

    iTo.addKeyValue((*it)->name(), conf, true);
  }
}

begin()

FWEventItemsManager::const_iterator FWEventItemsManager::begin

(

void

)

const

NOTE: iterator is allowed to return a null object for items that have been removed.

Definition at line 299 of file FWEventItemsManager.cc.

References m_items.

Referenced by FWGUIEventDataAdder::addNewItem(), FWEventItem::isInBack(), FWEventItem::isInFront(), FWEventItem::moveToBack(), FWEventItem::moveToFront(), CmsShowCommon::permuteColors(), CmsShowCommon::randomizeColors(), FWFileEntry::runFilter(), CmsShowCommon::setPalette(), and CmsShowMain::setupDataHandling().

{ return m_items.begin(); }

clearItems()

void FWEventItemsManager::clearItems

(

void

)

Clear all the items in the model.

Notice that a previous implementation was setting all the items to 0, I guess to track accessing delete items.

Definition at line 117 of file FWEventItemsManager.cc.

References MillePedeFileConverter_cfg::e, goingToClearItems_, mps_fire::i, B2GTnPMonitor_cfi::item, and m_items.

Referenced by FWPartialConfigLoadGUI::Load(), and setFrom().

                                         {
  for (size_t i = 0, e = m_items.size(); i != e; ++i) {
    FWEventItem* item = m_items[i];
    if (item) {
      item->destroy();
    }
    m_items[i] = nullptr;
  }
  goingToClearItems_();

  m_items.clear();
}

end()

FWEventItemsManager::const_iterator FWEventItemsManager::end

(

void

)

const

Definition at line 300 of file FWEventItemsManager.cc.

References m_items.

Referenced by FWGUIEventDataAdder::addNewItem(), Types.LuminosityBlockRange::cppID(), Types.EventRange::cppID(), FWEventItem::isInBack(), FWEventItem::isInFront(), FWEventItem::moveToBack(), FWEventItem::moveToFront(), CmsShowCommon::permuteColors(), CmsShowCommon::randomizeColors(), FWFileEntry::runFilter(), CmsShowCommon::setPalette(), and CmsShowMain::setupDataHandling().

{ return m_items.end(); }

find()

const FWEventItem * FWEventItemsManager::find

(

const std::string &

iName

)

const

Look up an item by name.

Definition at line 304 of file FWEventItemsManager.cc.

References MillePedeFileConverter_cfg::e, mps_fire::i, B2GTnPMonitor_cfi::item, and m_items.

Referenced by FWGUIEventDataAdder::addNewItem().

                                                                         {
  for (size_t i = 0, e = m_items.size(); i != e; ++i) {
    const FWEventItem* item = m_items[i];
    if (item && item->name() == iName)
      return item;
  }
  return nullptr;
}

newEvent()

void FWEventItemsManager::newEvent

(

const edm::EventBase *

iEvent

)

Prepare to handle a new event by associating all the items to watch it.

Definition at line 102 of file FWEventItemsManager.cc.

References MillePedeFileConverter_cfg::e, mps_fire::i, iEvent, B2GTnPMonitor_cfi::item, m_changeManager, m_event, and m_items.

                                                             {
  FWChangeSentry sentry(*m_changeManager);
  m_event = iEvent;
  for (size_t i = 0, e = m_items.size(); i != e; ++i) {
    FWEventItem* item = m_items[i];
    if (item)
      item->setEvent(iEvent);
  }
}

operator=()

const FWEventItemsManager& FWEventItemsManager::operator= ( const FWEventItemsManager &  )

delete

removeItem()

void FWEventItemsManager::removeItem ( const FWEventItem *  iItem )

private

Remove one item.

Notice that rather than erasing the item from the list, it is preferred to set it to zero, I guess to catch accesses to remove items and to avoid having to recalculate the current selection.

GE: I think this is a broken way of handling removal of objects. The object should be properly deleted and the current selection should be updated accordingly.

Definition at line 288 of file FWEventItemsManager.cc.

References cms::cuda::assert(), FWEventItem::id(), m_items, and removingItem_.

Referenced by add().

                                                             {
  assert(iItem->id() < m_items.size());
  removingItem_(iItem);
  m_items[iItem->id()] = nullptr;
}

setContext()

void FWEventItemsManager::setContext

(

fireworks::Context *

iContext

)

Definition at line 294 of file FWEventItemsManager.cc.

References m_context.

Referenced by CmsShowMain::CmsShowMain(), and FWFFLooper::FWFFLooper().

{ m_context = iContext; }

setFrom()

void FWEventItemsManager::setFrom ( const FWConfiguration &  iFrom )

overridevirtual

This is responsible for resetting the status of items from configuration

Implements FWConfigurable.

Definition at line 186 of file FWEventItemsManager.cc.

References add(), FWConfiguration::addKeyValue(), cms::cuda::assert(), clearItems(), fireworks::Context::colorManager(), submitPVResolutionJobs::desc, Calorimetry_cff::dp, FWConfiguration::keyValues(), kTrue(), nano_mu_digi_cff::layer, m_changeManager, m_context, m_event, HerwigMaxPtPartonFilter_cfi::moduleLabel, Skims_PA_cff::name, FWColorManager::oldColorToIndex(), SimL1EmulatorRepack_CalouGT_cff::processName, hgcalPlots::purpose, edm::second(), AlCaHLTBitMon_QueryRunRegistry::string, FWConfiguration::valueForKey(), and FWConfiguration::version().

                                                              {
  FWColorManager* cm = m_context->colorManager();
  assert(nullptr != cm);

  clearItems();
  const FWConfiguration::KeyValues* keyValues = iFrom.keyValues();

  if (keyValues == nullptr)
    return;

  std::vector<FWEventItem*> newItems;
  newItems.reserve(keyValues->size());

  for (FWConfiguration::KeyValues::const_iterator it = keyValues->begin(); it != keyValues->end(); ++it) {
    const std::string& name = it->first;
    const FWConfiguration& conf = it->second;
    const FWConfiguration::KeyValues* keyValues = conf.keyValues();
    assert(nullptr != keyValues);
    const std::string& type = (*keyValues)[0].second.value();
    const std::string& moduleLabel = (*keyValues)[1].second.value();
    const std::string& productInstanceLabel = (*keyValues)[2].second.value();
    const std::string& processName = (*keyValues)[3].second.value();
    const std::string& filterExpression = (*keyValues)[4].second.value();
    const std::string& sColor = (*keyValues)[5].second.value();
    const bool isVisible = (*keyValues)[6].second.value() == kTrue;

    unsigned int colorIndex;
    if (conf.version() < 5) {
      std::istringstream is(sColor);
      Color_t color;
      is >> color;
      colorIndex = cm->oldColorToIndex(color, conf.version());
    } else {
      // In version 4 we assume:
      //   fireworks colors start at ROOT index 1000
      //   geometry  colors start at ROOT index 1100
      // We save them as such -- no conversions needed.
      std::istringstream is(sColor);
      is >> colorIndex;
    }

    int transparency = 0;

    // Read transparency from file. We don't care about checking errors
    // because strtol returns 0 in that case.
    if (conf.version() > 3)
      transparency = strtol((*keyValues)[9].second.value().c_str(), nullptr, 10);

    FWDisplayProperties dp(colorIndex, isVisible, transparency);

    unsigned int layer = strtol((*keyValues)[7].second.value().c_str(), nullptr, 10);

    //For older configs assume name is the same as purpose
    std::string purpose(name);
    if (conf.version() > 1)
      purpose = (*keyValues)[8].second.value();

    FWConfiguration* proxyConfig =
        (FWConfiguration*)conf.valueForKey("PBConfig") ? new FWConfiguration(*conf.valueForKey("PBConfig")) : nullptr;

    // beckward compatibilty for obsolete proxy builders
    if (conf.version() < 6) {
      assert(proxyConfig == nullptr);
      if (purpose == "VerticesWithTracks") {
        purpose = "Vertices";
        proxyConfig = new FWConfiguration();
        FWConfiguration vTmp;
        vTmp.addKeyValue("Draw Tracks", FWConfiguration("1"));
        proxyConfig->addKeyValue("Var", vTmp, true);
      }
    }

    FWPhysicsObjectDesc desc(name,
                             TClass::GetClass(type.c_str()),
                             purpose,
                             dp,
                             moduleLabel,
                             productInstanceLabel,
                             processName,
                             filterExpression,
                             layer);

    newItems.push_back(add(desc, proxyConfig, false));
  }

  if (m_event) {
    FWChangeSentry sentry(*m_changeManager);
    for (auto ip : newItems)
      ip->setEvent(m_event);
  }
}

Member Data Documentation

goingToClearItems_

sigc::signal<void()> FWEventItemsManager::goingToClearItems_

Definition at line 75 of file FWEventItemsManager.h.

Referenced by clearItems(), FWSummaryManager::FWSummaryManager(), and CmsShowMainBase::setupViewManagers().

m_accessorFactory

std::shared_ptr<FWItemAccessorFactory> FWEventItemsManager::m_accessorFactory

private

Definition at line 90 of file FWEventItemsManager.h.

Referenced by add().

m_changeManager

FWModelChangeManager* FWEventItemsManager::m_changeManager

private

Definition at line 86 of file FWEventItemsManager.h.

Referenced by add(), newEvent(), and setFrom().

m_context

fireworks::Context* FWEventItemsManager::m_context

private

Definition at line 87 of file FWEventItemsManager.h.

Referenced by add(), addTo(), setContext(), and setFrom().

m_event

const edm::EventBase* FWEventItemsManager::m_event

private

Definition at line 89 of file FWEventItemsManager.h.

Referenced by add(), newEvent(), and setFrom().

m_items

std::vector<FWEventItem*> FWEventItemsManager::m_items

private

Definition at line 85 of file FWEventItemsManager.h.

Referenced by add(), addTo(), begin(), clearItems(), end(), find(), newEvent(), removeItem(), and ~FWEventItemsManager().

newItem_

sigc::signal<void(FWEventItem*)> FWEventItemsManager::newItem_

Definition at line 73 of file FWEventItemsManager.h.

Referenced by add(), FWGUIManager::FWGUIManager(), FWSummaryManager::FWSummaryManager(), and FWFileEntry::openFile().

removingItem_

sigc::signal<void(const FWEventItem*)> FWEventItemsManager::removingItem_

Definition at line 74 of file FWEventItemsManager.h.

Referenced by removeItem().