JetMomentMap Class Reference

#include <JetMomentMap.h>

Inheritance diagram for JetMomentMap:

Collaboration diagram for JetMomentMap:

Public Types
typedef JetMoment::float_t	float_t
typedef JetMoment::tag_t	tag_t
typedef JetMoment::MomentData	data_t
typedef JetMapBase< data_t >	base_t
typedef base_t::map_t	map_t
typedef base_t::record_t	record_t
typedef size_t	key_t
	Publish key type.

Public Member Functions
	JetMomentMap ()
virtual	~JetMomentMap ()
virtual bool	setMoment (size_t jetIndex, size_t keyIndex, float_t moment)
virtual bool	setMoment (size_t jetIndex, size_t keyIndex, float_t moment) const
virtual bool	getMoment (size_t jetIndex, size_t keyIndex, float_t &moment) const
virtual float_t	getMoment (size_t jetIndex, size_t keyIndex) const
void	access () const
virtual bool	addRecord (size_t jetIndex) const
	Add a record.
virtual const record_t *	getRecord (size_t jetIndex) const
	get the full record for a given jet
virtual void	assignRecord (size_t jetIndex, record_t *rec) const
	assign a given record to a given jet
virtual void	addData (size_t jetIndex, size_t keyIndex, const data_t &data) const
	Add data.
virtual bool	retrieveData (size_t jetIndex, size_t keyIndex, data_t &data) const
	Retrieve data.
virtual const data_t &	accessData (size_t jetIndex, size_t keyIndex) const
virtual size_t	numberOfMoments (size_t jetIndex) const
virtual void	clear ()
SG::OwnershipPolicy	ownPolicy ()

Protected Member Functions
virtual void	removeRecord (size_t jetIndex) const
	remove a record
virtual void	transferRecord (const JetMapBase< JetMoment::MomentData > *fromMap, size_t oldIndex, size_t newIndex) const
	transfer a record from an other map
map_t &	map ()

Protected Attributes
map_t	m_store
	Store last valid record index.
SG::OwnershipPolicy	m_ownPolicy

Static Protected Attributes
static const data_t	m_nullData
	Null data reference.

Friends
class	JetCollection

Detailed Description

Author

Peter Loch loch@.nosp@m.phys.nosp@m.ics.a.nosp@m.rizo.nosp@m.na.ed.nosp@m.u

Rolf Seuster Rolf..nosp@m.Seus.nosp@m.ter@c.nosp@m.ern..nosp@m.ch

Michel Lefebvre lefeb.nosp@m.vre@.nosp@m.uvic..nosp@m.ca

Date

June 29, 2006

DEPRECIATED. Jets now store moment internally

Keyed store for jet moments. The key is the pointer to the Jet, and the data is a JetMomentStore.

Definition at line 20 of file JetMomentMap.h.

Member Typedef Documentation

base_t

typedef JetMapBase<data_t> JetMomentMap::base_t

Definition at line 30 of file JetMomentMap.h.

data_t

typedef JetMoment::MomentData JetMomentMap::data_t

Definition at line 29 of file JetMomentMap.h.

float_t

typedef JetMoment::float_t JetMomentMap::float_t

Definition at line 27 of file JetMomentMap.h.

key_t

typedef size_t JetMapBase< JetMoment::MomentData >::key_t

inherited

Publish key type.

Definition at line 50 of file JetMapBase.h.

map_t

typedef base_t::map_t JetMomentMap::map_t

Definition at line 31 of file JetMomentMap.h.

record_t

typedef base_t::record_t JetMomentMap::record_t

Definition at line 32 of file JetMomentMap.h.

tag_t

typedef JetMoment::tag_t JetMomentMap::tag_t

Definition at line 28 of file JetMomentMap.h.

Constructor & Destructor Documentation

JetMomentMap()

JetMomentMap::JetMomentMap

(

)

Definition at line 9 of file JetMomentMap.cxx.

                           : base_t()
{ 
}

~JetMomentMap()

JetMomentMap::~JetMomentMap ( )

virtualdefault

Member Function Documentation

access()

void JetMomentMap::access ( ) const

inline

Definition at line 45 of file JetMomentMap.h.

{ };

accessData()

virtual const data_t & JetMapBase< JetMoment::MomentData >::accessData ( size_t jetIndex, size_t keyIndex ) const

virtualinherited

addData()

virtual void JetMapBase< JetMoment::MomentData >::addData ( size_t jetIndex, size_t keyIndex, const data_t & data ) const

virtualinherited

Add data.

This method adds data to an existing record.

Parameters

jetIndex	index of the record in the store
keyIndex	index of the data in the record
data	reference to non-mdoifiable data to be stored in record

Note that this method will overwrite any previously stored data at the (jetIndex,keyIndex) position.

addRecord()

virtual bool JetMapBase< JetMoment::MomentData >::addRecord ( size_t jetIndex ) const

virtualinherited

Add a record.

This method adds a record to the store and returns the index of this record to the client. The returned value is false if the record already existed

Parameters

JetIndex

reference to modifiable index, will contain the last index in the store.

assignRecord()

virtual void JetMapBase< JetMoment::MomentData >::assignRecord ( size_t jetIndex, record_t * rec ) const

virtualinherited

assign a given record to a given jet

The map will 'own' the given record : it will delete it when destructed. If a record already exist at jetIndex, it will be deleted.

Parameters

jetIndex	index of the record in the store
rec	pointer to the record to store.

clear()

virtual void JetMapBase< JetMoment::MomentData >::clear ( )

virtualinherited

getMoment() [1/2]

JetMomentMap::float_t JetMomentMap::getMoment ( size_t jetIndex, size_t keyIndex ) const

virtual

Definition at line 44 of file JetMomentMap.cxx.

{
  data_t ds(JetMoment::invalidMoment(),false);
  return this->retrieveData(jetIndex,keyIndex,ds) && ds.tag()
    ? ds.moment() : JetMoment::invalidMoment(); 
}

getMoment() [2/2]

bool JetMomentMap::getMoment ( size_t jetIndex, size_t keyIndex, float_t & moment ) const

virtual

Definition at line 34 of file JetMomentMap.cxx.

{
  data_t ds(JetMoment::invalidMoment(),false);
  if ( !this->retrieveData(jetIndex,keyIndex,ds) ) return false;
  // successfully retrieved
  moment = ds.moment();
  return ds.tag();
}

getRecord()

virtual const record_t * JetMapBase< JetMoment::MomentData >::getRecord ( size_t jetIndex ) const

virtualinherited

get the full record for a given jet

map()

map_t & JetMapBase< JetMoment::MomentData >::map ( )

protectedinherited

numberOfMoments()

virtual size_t JetMapBase< JetMoment::MomentData >::numberOfMoments ( size_t jetIndex ) const

virtualinherited

ownPolicy()

SG::OwnershipPolicy JetMapBase< JetMoment::MomentData >::ownPolicy ( )

inlineinherited

Definition at line 127 of file JetMapBase.h.

{return m_ownPolicy;};

removeRecord()

virtual void JetMapBase< JetMoment::MomentData >::removeRecord ( size_t jetIndex ) const

protectedvirtualinherited

remove a record

Destroy the record associated to an entry.

Parameters

jetIndex

identifier of the record to remove

retrieveData()

virtual bool JetMapBase< JetMoment::MomentData >::retrieveData ( size_t jetIndex, size_t keyIndex, data_t & data ) const

virtualinherited

Retrieve data.

Retrieves data by index pair and stores result in client supplied variable. Returns false if index pair (jetIndex,keyIndex) refers to non-existing entry, i.e. at least one of (jetIndex,keyIndex) is out of range.

Parameters

jetIndex	index of record in store
keyIndex	index of data in record
data	reference to modifiable variable storing retrieved data

Note that in case of an invalid index pair the original value of data is not changed.

setMoment() [1/2]

bool JetMomentMap::setMoment ( size_t jetIndex, size_t keyIndex, float_t moment )

virtual

Definition at line 18 of file JetMomentMap.cxx.

{
  data_t ds(moment,true);
  this->addData(jetIndex,keyIndex,ds);
  return true;
}

setMoment() [2/2]

bool JetMomentMap::setMoment ( size_t jetIndex, size_t keyIndex, float_t moment ) const

virtual

Definition at line 26 of file JetMomentMap.cxx.

{
  data_t ds(moment,true);
  this->addData(jetIndex,keyIndex,ds);
  return true;
}

transferRecord()

virtual void JetMapBase< JetMoment::MomentData >::transferRecord ( const JetMapBase< JetMoment::MomentData > * fromMap, size_t oldIndex, size_t newIndex ) const

protectedvirtualinherited

transfer a record from an other map

Parameters

fromMap	pointer to the other map
oldIndex	identifier of the record in the other map
newIndex	the identifier in this map

Friends And Related Symbol Documentation

JetCollection

friend class JetCollection

friend

Definition at line 25 of file JetMomentMap.h.

Member Data Documentation

m_nullData

const data_t JetMapBase< JetMoment::MomentData >::m_nullData

staticprotectedinherited

Null data reference.

Definition at line 162 of file JetMapBase.h.

m_ownPolicy

SG::OwnershipPolicy JetMapBase< JetMoment::MomentData >::m_ownPolicy

protectedinherited

Definition at line 166 of file JetMapBase.h.

m_store

map_t JetMapBase< JetMoment::MomentData >::m_store

mutableprotectedinherited

Store last valid record index.

Data store

Definition at line 160 of file JetMapBase.h.

---

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

• JetMomentMap.h
• JetMomentMap.cxx