FWEventItem Class Reference

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

Classes
struct	ModelInfo

Public Member Functions
FWModelChangeManager *	changeManager () const
FWColorManager *	colorManager () const
const fireworks::Context &	context () const
const void *	data (const std::type_info &) const
const FWDisplayProperties &	defaultDisplayProperties () const
void	destroy () const
const std::string &	errorMessage () const
	returns error string if there was a problem this event More...
const std::string &	filterExpression () const
	FWEventItem (fireworks::Context *iContext, unsigned int iItemId, boost::shared_ptr< FWItemAccessorBase > iAccessor, const FWPhysicsObjectDesc &iDesc, const FWConfiguration *pbConf=0)
template<class T >
void	get (const T *&oData) const
FWProxyBuilderConfiguration *	getConfig () const
const edm::EventBase *	getEvent () const
const FWGeometry *	getGeom () const
void	getPrimaryData () const
bool	hasError () const
	returns true if failed to get data for this event More...
bool	hasEvent () const
bool	haveInterestingValue () const
unsigned int	id () const
bool	isCollection () const
bool	isInBack () const
	returns true if item is behind all other items More...
bool	isInFront () const
	returns true if item is in front of all other items More...
bool	itemIsSelected () const
int	layer () const
const void *	modelData (int iIndex) const
ModelInfo	modelInfo (int iIndex) const
const std::string &	modelInterestingValueAsString (int iIndex) const
std::string	modelName (int iIndex) const
const TClass *	modelType () const
const std::string &	moduleLabel () const
void	moveToBack ()
void	moveToFront ()
void	moveToLayer (int layer)
const std::string &	name () const
const std::string &	processName () const
const std::string &	productInstanceLabel () const
void	proxyConfigChanged ()
const std::string &	purpose () const
void	resetColor ()
void	select (int iIndex) const
FWSelectionManager *	selectionManager () const
void	selectItem ()
void	setData (const edm::ObjectWithDict &) const
void	setDefaultDisplayProperties (const FWDisplayProperties &)
void	setDisplayProperties (int iIndex, const FWDisplayProperties &) const
void	setEvent (const edm::EventBase *iEvent)
void	setFilterExpression (const std::string &)
void	setLabels (const std::string &iModule, const std::string &iProductInstance, const std::string &iProcess)
void	setName (const std::string &iName)
size_t	size () const
void	toggleSelect (int iIndex) const
void	toggleSelectItem ()
const TClass *	type () const
void	unselect (int iIndex) const
void	unselectItem ()
const FWItemValueGetter &	valueGetter () const
	one value from the model which is normally used for the popup More...
virtual	~FWEventItem ()

Static Public Member Functions
static int	maxLayerValue ()
static int	minLayerValue ()

Public Attributes
FWModelChangeSignal	changed_
FWItemChangeSignal	defaultDisplayPropertiesChanged_
FWItemChangeSignal	filterChanged_
FWItemChangeSignal	goingToBeDestroyed_
FWItemChangeSignal	itemChanged_
FWItemChangeSignal	preItemChanged_

Private Member Functions
void	handleChange ()
void	runFilter ()

Private Attributes
boost::shared_ptr < FWItemAccessorBase >	m_accessor
const fireworks::Context *	m_context
FWDisplayProperties	m_displayProperties
std::string	m_errorMessage
const edm::EventBase *	m_event
FWModelFilter	m_filter
unsigned int	m_id
FWItemValueGetter	m_interestingValueGetter
bool	m_isSelected
std::vector< ModelInfo >	m_itemInfos
int	m_layer
std::string	m_moduleLabel
std::string	m_name
Color_t	m_origColor
bool	m_printedErrorThisEvent
std::string	m_processName
std::string	m_productInstanceLabel
FWProxyBuilderConfiguration *	m_proxyBuilderConfig
std::string	m_purpose
const TClass *	m_type
edm::TypeWithDict	m_wrapperType

Detailed Description

Description: Stand in for a top level item in an Event

Usage: <usage>

Definition at line 56 of file FWEventItem.h.

Constructor & Destructor Documentation

FWEventItem::FWEventItem	(	fireworks::Context *	iContext,
		unsigned int	iItemId,
		boost::shared_ptr< FWItemAccessorBase >	iAccessor,
		const FWPhysicsObjectDesc &	iDesc,
		const FWConfiguration *	pbConf = 0
	)

Definition at line 52 of file FWEventItem.cc.

FWEventItem::~FWEventItem ( )

virtual

Definition at line 101 of file FWEventItem.cc.

Member Function Documentation

FWModelChangeManager* FWEventItem::changeManager ( ) const

inline

Definition at line 132 of file FWEventItem.h.

Referenced by FWFromSliceSelector::changeManager(), FWHistSliceSelector::doSelect(), FWHFTowerSliceSelector::doSelect(), FWHistSliceSelector::doUnselect(), FWHFTowerSliceSelector::doUnselect(), and FWModelExpressionSelector::select().

FWColorManager* FWEventItem::colorManager ( ) const

inline

Definition at line 139 of file FWEventItem.h.

const fireworks::Context& FWEventItem::context ( ) const

inline

Definition at line 128 of file FWEventItem.h.

Referenced by FWCaloDataProxyBuilderBase::build(), and FWDetailViewBase::context().

const void * FWEventItem::data

(

const std::type_info &

iInfo

)

const

Definition at line 394 of file FWEventItem.cc.

const FWDisplayProperties & FWEventItem::defaultDisplayProperties

(

)

const

Definition at line 453 of file FWEventItem.cc.

Referenced by FWInteractionList::added(), FWBeamSpotProxyBuilder::build(), FWPFClusterRPZProxyBuilder::build(), fireworks::makeRhoPhiSuperCluster(), and FWPFClusterRPZProxyBuilder::sharedBuild().

void FWEventItem::destroy

(

)

const

Definition at line 610 of file FWEventItem.cc.

const std::string & FWEventItem::errorMessage

(

)

const

returns error string if there was a problem this event

Definition at line 674 of file FWEventItem.cc.

const std::string & FWEventItem::filterExpression

(

)

const

Definition at line 604 of file FWEventItem.cc.

template<class T >

void FWEventItem::get ( const T *&  oData ) const

inline

Definition at line 85 of file FWEventItem.h.

Referenced by Options.Options::__getitem__(), FWPRCaloTowerProxyBuilder::build(), FWME0DigiProxyBuilder::build(), FWPCaloHitProxyBuilder::build(), FWSiPixelClusterDetProxyBuilder::build(), FWSiStripClusterProxyBuilder::build(), FWCSCStripDigiProxyBuilder::build(), FWSiStripDigiProxyBuilder::build(), FWRPCDigiProxyBuilder::build(), FWCSCWireDigiProxyBuilder::build(), FWSiPixelDigiProxyBuilder::build(), FWSiPixelClusterProxyBuilder::build(), FWPFCandidateTowerProxyBuilder::build(), FWCaloTowerProxyBuilderBase::build(), FWPFTauProxyBuilder::buildViewType(), FWCaloTauProxyBuilder::buildViewType(), FWDTDigiProxyBuilder::buildViewType(), FWHFTowerSliceSelector::doSelect(), FWHFTowerSliceSelector::doUnselect(), FWPFCandidateTowerSliceSelector::getItemEntryEtaPhi(), and FWCaloTowerSliceSelector::getItemEntryEtaPhi().

FWProxyBuilderConfiguration* FWEventItem::getConfig ( ) const

inline

Definition at line 170 of file FWEventItem.h.

Referenced by FWMuonRhoPhiProxyBuilder::build(), FWGenParticleLegoProxyBuilder::build(), FWMuonProxyBuilder::build(), FWTrackProxyBuilder::build(), FWGenParticleLegoProxyBuilder::setItem(), FWMuonRhoPhiProxyBuilder::setItem(), FWTrackingParticleProxyBuilder::setItem(), FWMuonProxyBuilder::setItem(), FWCandidateProxyBuilder::setItem(), and FWTrackProxyBuilder::setItem().

const edm::EventBase* FWEventItem::getEvent ( ) const

inline

Definition at line 148 of file FWEventItem.h.

const FWGeometry * FWEventItem::getGeom

(

)

const

Definition at line 683 of file FWEventItem.cc.

Referenced by FWPRCaloTowerProxyBuilder::build(), FWCaloClusterProxyBuilder::build(), FWTrackTrackingRecHitProxyBuilder::build(), FWME0DigiProxyBuilder::build(), FWPCaloHitProxyBuilder::build(), FWSiPixelClusterDetProxyBuilder::build(), FWSiStripClusterProxyBuilder::build(), FWTracksModulesProxyBuilder::build(), FWCSCRecHitProxyBuilder::build(), FWSiStripDigiProxyBuilder::build(), FWCSCStripDigiProxyBuilder::build(), FWRPCDigiProxyBuilder::build(), FWCSCWireDigiProxyBuilder::build(), FWCSCSegmentProxyBuilder::build(), FWSiPixelDigiProxyBuilder::build(), FWSiPixelClusterProxyBuilder::build(), FWPFEcalRecHitRPProxyBuilder::build(), FWTrajectorySeedProxyBuilder::build(), FWPFEcalRecHitLegoProxyBuilder::build(), FWPSimHitProxyBuilder::buildViewType(), FWRPCRecHitProxyBuilder::buildViewType(), FWPhotonProxyBuilder::buildViewType(), FWGEMRecHitProxyBuilder::buildViewType(), FWDTSegmentProxyBuilder::buildViewType(), FWDTDigiProxyBuilder::buildViewType(), and FWHFTowerSliceSelector::findBinFromId().

void FWEventItem::getPrimaryData

(

)

const

Definition at line 445 of file FWEventItem.cc.

void FWEventItem::handleChange ( )

private

Definition at line 380 of file FWEventItem.cc.

bool FWEventItem::hasError

(

void

)

const

returns true if failed to get data for this event

Definition at line 669 of file FWEventItem.cc.

bool FWEventItem::hasEvent ( ) const

inline

Definition at line 143 of file FWEventItem.h.

bool FWEventItem::haveInterestingValue

(

)

const

Definition at line 589 of file FWEventItem.cc.

Referenced by FWInteractionList::added(), and FWInteractionList::itemChanged().

unsigned int FWEventItem::id

(

void

)

const

Unique ID for the item. This number starts at 0 and increments by one for each new item.

Definition at line 496 of file FWEventItem.cc.

Referenced by FWSelectionManager::itemChanged(), FWSelectionManager::select(), and FWSelectionManager::unselect().

bool FWEventItem::isCollection

(

)

const

Definition at line 557 of file FWEventItem.cc.

bool FWEventItem::isInBack

(

)

const

returns true if item is behind all other items

Definition at line 480 of file FWEventItem.cc.

bool FWEventItem::isInFront

(

)

const

returns true if item is in front of all other items

Definition at line 465 of file FWEventItem.cc.

bool FWEventItem::itemIsSelected

(

)

const

Definition at line 663 of file FWEventItem.cc.

int FWEventItem::layer

(

)

const

objects with a larger layer number are drawn on top of objects with a lower number

Definition at line 459 of file FWEventItem.cc.

int FWEventItem::maxLayerValue ( )

static

Definition at line 43 of file FWEventItem.cc.

int FWEventItem::minLayerValue ( )

static

Definition at line 38 of file FWEventItem.cc.

const void * FWEventItem::modelData

(

int

iIndex

)

const

Definition at line 569 of file FWEventItem.cc.

Referenced by FWDetailViewBase::build(), FWSimpleProxyBuilder::build(), FWSimpleProxyBuilder::buildViewType(), FWCandidateTowerProxyBuilder::fillCaloData(), FWCandidateTowerSliceSelector::getItemEntryEtaPhi(), FWViewContextMenuHandlerGL::select(), FWModelExpressionSelector::select(), and FWSimpleProxyBuilder::visibilityModelChanges().

FWEventItem::ModelInfo FWEventItem::modelInfo

(

int

iIndex

)

const

Definition at line 537 of file FWEventItem.cc.

Referenced by FWPRCaloTowerProxyBuilder::build(), FWPCaloHitProxyBuilder::build(), FWPFEcalRecHitRPProxyBuilder::build(), FWSimpleProxyBuilder::build(), FWPFEcalClusterRPZProxyBuilder::build(), FWPFHcalClusterRPZProxyBuilder::build(), FWSimpleProxyBuilder::buildViewType(), FWFromSliceSelector::clear(), FWHistSliceSelector::doSelect(), FWHFTowerSliceSelector::doSelect(), FWModelIdFromEveSelector::doSelect(), FWHistSliceSelector::doUnselect(), FWHFTowerSliceSelector::doUnselect(), FWModelIdFromEveSelector::doUnselect(), FWCandidateTowerProxyBuilder::fillCaloData(), FWPFCandidateTowerProxyBuilder::fillCaloData(), FWCaloTowerProxyBuilderBase::fillCaloData(), FWInteractionList::itemChanged(), FWBeamSpotProxyBuilder::localModelChanges(), FWPFCandidatesLegoProxyBuilder::localModelChanges(), FWCandidateLegoProxyBuilder::localModelChanges(), FWPFPatJetLegoProxyBuilder< T >::localModelChanges(), FWPFClusterLegoProxyBuilder::localModelChanges(), FWPFEcalRecHitLegoProxyBuilder::localModelChanges(), FWInteractionList::modelChanges(), FWDigitSetProxyBuilder::modelChanges(), FWModelExpressionSelector::select(), FWCollectionSummaryModelCellRenderer::setData(), FWSecondarySelectableSelector::syncSelection(), and FWSimpleProxyBuilder::visibilityModelChanges().

const std::string & FWEventItem::modelInterestingValueAsString

(

int

iIndex

)

const

Definition at line 596 of file FWEventItem.cc.

Referenced by FWInteractionList::added(), FWDigitSetProxyBuilder::getTooltip(), and FWInteractionList::itemChanged().

std::string FWEventItem::modelName

(

int

iIndex

)

const

Definition at line 576 of file FWEventItem.cc.

Referenced by FWInteractionList::added(), FWInteractionList::itemChanged(), and FWCollectionSummaryModelCellRenderer::setData().

const TClass * FWEventItem::modelType

(

)

const

Definition at line 563 of file FWEventItem.cc.

Referenced by FWSimpleProxyHelper::itemChanged(), and FWModelExpressionSelector::select().

const std::string & FWEventItem::moduleLabel

(

)

const

Definition at line 520 of file FWEventItem.cc.

void FWEventItem::moveToBack

(

)

Definition at line 335 of file FWEventItem.cc.

void FWEventItem::moveToFront

(

)

change layering

Definition at line 312 of file FWEventItem.cc.

void FWEventItem::moveToLayer

(

int

layer

)

Definition at line 358 of file FWEventItem.cc.

const std::string & FWEventItem::name

(

void

)

const

Definition at line 502 of file FWEventItem.cc.

Referenced by FWDigitSetProxyBuilder::getTooltip(), VIDSelectorBase.VIDSelectorBase::initialize(), FWViewManagerManager::registerEventItem(), and FWViewManagerManager::removeEventItem().

const std::string & FWEventItem::processName

(

)

const

Definition at line 531 of file FWEventItem.cc.

const std::string & FWEventItem::productInstanceLabel

(

)

const

Definition at line 525 of file FWEventItem.cc.

void FWEventItem::proxyConfigChanged

(

)

Definition at line 370 of file FWEventItem.cc.

Referenced by FWProxyBuilderConfiguration::assertParam().

const std::string & FWEventItem::purpose

(

)

const

Since the same C++ type can be used for multiple purposes, this string disambiguates them.

Definition at line 514 of file FWEventItem.cc.

void FWEventItem::resetColor

(

)

Definition at line 687 of file FWEventItem.cc.

void FWEventItem::runFilter ( )

private

Definition at line 209 of file FWEventItem.cc.

void FWEventItem::select

(

int

iIndex

)

const

Definition at line 252 of file FWEventItem.cc.

Referenced by FWHistSliceSelector::doSelect(), FWHFTowerSliceSelector::doSelect(), Vispa.Views.AbstractView.AbstractView::restoreSelection(), FWModelExpressionSelector::select(), FWModelId::select(), and FWSecondarySelectableSelector::syncSelection().

FWSelectionManager* FWEventItem::selectionManager ( ) const

inline

Definition at line 135 of file FWEventItem.h.

void FWEventItem::selectItem

(

)

Select the item (i.e. container) itself

Definition at line 634 of file FWEventItem.cc.

void FWEventItem::setData

(

const edm::ObjectWithDict &

iData

)

const

Definition at line 432 of file FWEventItem.cc.

void FWEventItem::setDefaultDisplayProperties

(

const FWDisplayProperties &

iProp

)

This is the place where not only display properties are changed, but which is also responsible to notify the FWModelChangeManager about the change. If you've just added some property, you have a nice GUI for it and still nothing works, this is probably the place where you want to look.

Definition at line 157 of file FWEventItem.cc.

void FWEventItem::setDisplayProperties	(	int	iIndex,
		const FWDisplayProperties &	iProps
	)		const

Definition at line 278 of file FWEventItem.cc.

Referenced by FWModelExpressionSelector::select().

void FWEventItem::setEvent

(

const edm::EventBase *

iEvent

)

Definition at line 122 of file FWEventItem.cc.

void FWEventItem::setFilterExpression

(

const std::string &

iExpression

)

Throws an FWExpresionException if there is a problem with the expression

Definition at line 201 of file FWEventItem.cc.

void FWEventItem::setLabels	(	const std::string &	iModule,
		const std::string &	iProductInstance,
		const std::string &	iProcess
	)

Definition at line 132 of file FWEventItem.cc.

void FWEventItem::setName

(

const std::string &

iName

)

Definition at line 145 of file FWEventItem.cc.

size_t FWEventItem::size

(

void

)

const

Definition at line 550 of file FWEventItem.cc.

Referenced by FWPFEcalRecHitRPProxyBuilder::build(), FWSimpleProxyBuilder::build(), FWPFEcalRecHitLegoProxyBuilder::build(), FWSimpleProxyBuilder::buildViewType(), FWFromSliceSelector::clear(), FWHistSliceSelector::doSelect(), FWHistSliceSelector::doUnselect(), FWCandidateTowerProxyBuilder::fillCaloData(), FWInteractionList::itemChanged(), FWInteractionList::modelChanges(), FWConversionProxyBuilder::requestCommon(), FWModelExpressionSelector::select(), and FWSecondarySelectableSelector::syncSelection().

void FWEventItem::toggleSelect

(

int

iIndex

)

const

Definition at line 266 of file FWEventItem.cc.

Referenced by FWModelId::toggleSelect().

void FWEventItem::toggleSelectItem

(

)

Definition at line 652 of file FWEventItem.cc.

const TClass * FWEventItem::type

(

)

const

Definition at line 508 of file FWEventItem.cc.

void FWEventItem::unselect

(

int

iIndex

)

const

Definition at line 241 of file FWEventItem.cc.

Referenced by FWFromSliceSelector::clear(), FWHistSliceSelector::doUnselect(), FWHFTowerSliceSelector::doUnselect(), FWSecondarySelectableSelector::syncSelection(), and FWModelId::unselect().

void FWEventItem::unselectItem

(

)

Definition at line 643 of file FWEventItem.cc.

const FWItemValueGetter& FWEventItem::valueGetter ( ) const

inline

one value from the model which is normally used for the popup

Definition at line 119 of file FWEventItem.h.

Referenced by FWViewContextMenuHandlerGL::select().

Member Data Documentation

FWModelChangeSignal FWEventItem::changed_

mutable

connect to this signal if you want to know when models held by the item change

Definition at line 200 of file FWEventItem.h.

FWItemChangeSignal FWEventItem::defaultDisplayPropertiesChanged_

mutable

connect to this signal if you want to know that the default display properties of the item have changed. This is only useful if you are displaying these properties and not just the underlying models.

Definition at line 212 of file FWEventItem.h.

FWItemChangeSignal FWEventItem::filterChanged_

mutable

connect to this signal if you want to know that the filter being applied to the item was changed.

Definition at line 215 of file FWEventItem.h.

FWItemChangeSignal FWEventItem::goingToBeDestroyed_

mutable

connect to this signal if you need to know that this item is going to be destroyed.

Definition at line 219 of file FWEventItem.h.

Referenced by FWViewManagerManager::registerEventItem().

FWItemChangeSignal FWEventItem::itemChanged_

mutable

connect to this signal if you want to know when the data underlying the item changes

Definition at line 203 of file FWEventItem.h.

boost::shared_ptr<FWItemAccessorBase> FWEventItem::m_accessor

private

Definition at line 234 of file FWEventItem.h.

const fireworks::Context* FWEventItem::m_context

private

Definition at line 229 of file FWEventItem.h.

FWDisplayProperties FWEventItem::m_displayProperties

private

Definition at line 235 of file FWEventItem.h.

std::string FWEventItem::m_errorMessage

mutableprivate

Definition at line 249 of file FWEventItem.h.

const edm::EventBase* FWEventItem::m_event

private

Definition at line 243 of file FWEventItem.h.

FWModelFilter FWEventItem::m_filter

private

Definition at line 247 of file FWEventItem.h.

unsigned int FWEventItem::m_id

private

Definition at line 230 of file FWEventItem.h.

FWItemValueGetter FWEventItem::m_interestingValueGetter

private

Definition at line 245 of file FWEventItem.h.

bool FWEventItem::m_isSelected

private

Definition at line 251 of file FWEventItem.h.

std::vector<ModelInfo> FWEventItem::m_itemInfos

mutableprivate

Definition at line 237 of file FWEventItem.h.

int FWEventItem::m_layer

private

Definition at line 236 of file FWEventItem.h.

std::string FWEventItem::m_moduleLabel

private

Definition at line 240 of file FWEventItem.h.

std::string FWEventItem::m_name

private

Definition at line 231 of file FWEventItem.h.

Color_t FWEventItem::m_origColor

private

Definition at line 252 of file FWEventItem.h.

bool FWEventItem::m_printedErrorThisEvent

mutableprivate

Definition at line 248 of file FWEventItem.h.

std::string FWEventItem::m_processName

private

Definition at line 242 of file FWEventItem.h.

std::string FWEventItem::m_productInstanceLabel

private

Definition at line 241 of file FWEventItem.h.

FWProxyBuilderConfiguration* FWEventItem::m_proxyBuilderConfig

private

Definition at line 254 of file FWEventItem.h.

std::string FWEventItem::m_purpose

private

Definition at line 233 of file FWEventItem.h.

const TClass* FWEventItem::m_type

private

Definition at line 232 of file FWEventItem.h.

edm::TypeWithDict FWEventItem::m_wrapperType

private

Definition at line 244 of file FWEventItem.h.

FWItemChangeSignal FWEventItem::preItemChanged_

mutable

connect to this signal if you want to know immediately when the data underlying the item changes only intended to be used by the FWSelectionManager

Definition at line 208 of file FWEventItem.h.

Referenced by FWSelectionManager::select().