In This Package:

UpdateManagerSvc::Item Class Reference

Used internally by UpdateManagerSvc to handle the dependency network. More...

Collaboration diagram for UpdateManagerSvc::Item:

[legend]List of all members.

Public Types
typedef std::pair< BasePtrSetter *, void * >	UserPtrType
	Type for the list of user's pointers for the condition.
typedef std::vector< Item * >	ItemList
	Type used for the collections of items.
typedef std::pair< Item *, BaseObjectMemberFunction * >	ParentItem
	Type used as pointer to an item that is using this one, a parent.
typedef std::vector< ParentItem >	ParentList
	Type for the list of parents.
typedef std::list< UserPtrType >	UserPtrList
	Type for the list of user's pointers for the condition.
typedef std::vector< MembFunc >	MembFuncList
	Type for the list of the registered member functions.
Public Member Functions
	Item (const std::string &objPath, ValidDataObject *overrideObj=NULL)
	Constructor for an item representing an object in the data store.
	Item (const std::string &objPath, UserPtrType dest, ValidDataObject *overrideObj=NULL)
	Constructor for an item representing an object in the data store.
	Item (BaseObjectMemberFunction *mf, const std::string tsRoot)
	Constructor for an item representing a generic object.
	~Item ()
	Destructor.
bool	isValid (const Gaudi::Time &when)
void	resetIOV ()
void	invalidate ()
void	changeValidity (const Gaudi::Time &new_since, const Gaudi::Time &new_until)
void	purge (MsgStream *log=NULL)
StatusCode	setUserPointers (DataObject *pObj, bool force=false)
StatusCode	setPointers (DataObject *pObj, bool force=false)
StatusCode	update (IDataProviderSvc *dp, const Gaudi::Time &when, MsgStream *log=NULL)
	Main method. Used to update the object and all the used ones.
bool	match (void *p) const
	Tells if this item represents the given pointer.
bool	match (const std::string &p, bool is_path_to_db=false) const
	Tells if this item represents object identified by the given pointer.
bool	isHead () const
	Tells if the item does not have parents.
bool	isTail () const
	Tells if the item does not have parents.
MembFuncList::iterator	find (BaseObjectMemberFunction *mf)
	Finds the MembFunc object containing the given member function.
void	addParent (Item *parent, BaseObjectMemberFunction *parentMF)
	Adds a (item,member_function) pair to the list of parents.
BaseObjectMemberFunction *	addChild (BaseObjectMemberFunction *thisMF, Item *child)
	Adds a child item to the given member function.
Public Attributes
Gaudi::Time	since
	Time points delimiting the interval of validity of the item (intersection of the intervals of validity of the member functions).
Gaudi::Time	until
ParentList	parents
	Item parents: the (item,member_function) pairs that depend on this item.
ItemList	children
	List of all the children: the items on which this item depend (used for fast accessing).
std::string	path
	Path to the object, inside the data store, represented by the item.
std::string	db_path
	Path of the persistent version of the object inside the Conditions DataBase.
ValidDataObject *	vdo
	Pointer to the ValidDataObject interface of the represented object.
void *	ptr
	Void pointer to the represented object, obtained via dynamic_cast (used to unically identify the item).
ValidDataObject *	override
	Pointer to the object used to override the object retrieved from the data provider.
MembFuncList	memFuncs
	List of the registered member functions.
bool	updateLock
	Flag used to prevent infinite loops when updating.
UserPtrList	user_dest_ptrs
	List op setters for user's pointers.
Classes
struct	MembFunc
	Used inside Item to identify a registered member function. More...

---

Detailed Description

Used internally by UpdateManagerSvc to handle the dependency network.

Author:

Marco Clemencic

Date:

2005-04-26

Definition at line 128 of file UpdateManagerSvc.h.

---

Member Typedef Documentation

typedef std::pair<BasePtrSetter*,void*> UpdateManagerSvc::Item::UserPtrType

Type for the list of user's pointers for the condition.

Definition at line 130 of file UpdateManagerSvc.h.

typedef std::vector<Item*> UpdateManagerSvc::Item::ItemList

Type used for the collections of items.

Definition at line 172 of file UpdateManagerSvc.h.

typedef std::pair<Item*,BaseObjectMemberFunction*> UpdateManagerSvc::Item::ParentItem

Type used as pointer to an item that is using this one, a parent.

Definition at line 174 of file UpdateManagerSvc.h.

typedef std::vector<ParentItem> UpdateManagerSvc::Item::ParentList

Type for the list of parents.

Definition at line 176 of file UpdateManagerSvc.h.

typedef std::list<UserPtrType> UpdateManagerSvc::Item::UserPtrList

Type for the list of user's pointers for the condition.

Definition at line 178 of file UpdateManagerSvc.h.

typedef std::vector<MembFunc> UpdateManagerSvc::Item::MembFuncList

Type for the list of the registered member functions.

Definition at line 209 of file UpdateManagerSvc.h.

---

Constructor & Destructor Documentation

UpdateManagerSvc::Item::Item	(	const std::string &	objPath,
		ValidDataObject *	overrideObj = NULL
	)			[inline]

Constructor for an item representing an object in the data store.

Definition at line 135 of file UpdateManagerSvc.h.

UpdateManagerSvc::Item::Item	(	const std::string &	objPath,
		UserPtrType	dest,
		ValidDataObject *	overrideObj = NULL
	)			[inline]

Constructor for an item representing an object in the data store.

Definition at line 141 of file UpdateManagerSvc.h.

UpdateManagerSvc::Item::Item	(	BaseObjectMemberFunction *	mf,
		const std::string	tsRoot
	)			[inline]

Constructor for an item representing a generic object.

Definition at line 150 of file UpdateManagerSvc.h.

UpdateManagerSvc::Item::~Item

(

)

Destructor.

Definition at line 22 of file UpdateManagerSvc_Item.cpp.

                            {
  for (MembFuncList::const_iterator mi = memFuncs.begin();
       mi != memFuncs.end(); ++mi) {
    delete mi->mf;
    delete mi->items;
  }
  // I'm the owner of the list of user's pointer setters: delete them!
  for (UserPtrList::iterator pi = user_dest_ptrs.begin();
       pi != user_dest_ptrs.end(); ++pi){
    delete pi->first;
  }
}

---

Member Function Documentation

bool UpdateManagerSvc::Item::isValid

(

const Gaudi::Time &

when

)

[inline]

Definition at line 211 of file UpdateManagerSvc.h.

void UpdateManagerSvc::Item::resetIOV

(

)

[inline]

Definition at line 214 of file UpdateManagerSvc.h.

void UpdateManagerSvc::Item::invalidate

(

)

[inline]

Definition at line 216 of file UpdateManagerSvc.h.

void UpdateManagerSvc::Item::changeValidity	(	const Gaudi::Time &	new_since,
		const Gaudi::Time &	new_until
	)			[inline]

Definition at line 224 of file UpdateManagerSvc.h.

void UpdateManagerSvc::Item::purge

(

MsgStream *

log = NULL

)

Definition at line 214 of file UpdateManagerSvc_Item.cpp.

                                               {
  if ( ! path.empty() ) {
    if (log) (*log) << MSG::DEBUG << "Purging " << path << endmsg;
    // Clean up pointers
    const bool force = true;
    setPointers(NULL,force).ignore();
  } else {
    if (log) (*log) << MSG::DEBUG << "Purging object at " << ptr << endmsg;
  }
  
  // I'm not sure I need this
  // invalidate();
  // or just this
  since = 1;
  until = 0;
}

StatusCode UpdateManagerSvc::Item::setUserPointers	(	DataObject *	pObj,
		bool	force = false
	)			[inline]

Definition at line 277 of file UpdateManagerSvc.h.

StatusCode UpdateManagerSvc::Item::setPointers	(	DataObject *	pObj,
		bool	force = false
	)			[inline]

Definition at line 292 of file UpdateManagerSvc.h.

StatusCode UpdateManagerSvc::Item::update	(	IDataProviderSvc *	dp,
		const Gaudi::Time &	when,
		MsgStream *	log = NULL
	)

Main method. Used to update the object and all the used ones.

Definition at line 37 of file UpdateManagerSvc_Item.cpp.

                                                                                                 {
  if (log){
    (*log) << MSG::DEBUG << "Updating (Item* " << this << ") " << ptr << " ---BEGIN---";
    if (!path.empty()) (*log) << " " << path;
    (*log) << endmsg;
    (*log) << MSG::VERBOSE << "    initial validity: " << since << " -> " << until << endmsg;
  }
  if (updateLock) {
    if (log) (*log) << MSG::VERBOSE << "Update lock found: break loop" << endmsg;
    return StatusCode::SUCCESS;
  }
  // check validity
  if (isValid(when)) {
    if (log) (*log) << MSG::VERBOSE << "Item valid, not need to update" << endmsg;
    return StatusCode::SUCCESS;
  }
  // prepare for update
  updateLock = true;
  resetIOV();
  StatusCode sc;
  // start real update
  if (ptr == NULL && vdo == NULL && !path.empty()) { // I do not have a VDO ptr (or a void*) but a path: load it

    if (log) (*log) << MSG::DEBUG << "Retrieve object " << path << " from data provider" << endmsg;

    DataObject  *pObj;
    sc = dp->retrieveObject(path,pObj);

    if (!sc.isSuccess()){
      if (log) (*log) << MSG::ERROR << "Retrieve from data provider failed!" << endmsg;
      return sc;
    }

    // Check if the requested condition is in the override list.
    if ( override ) {
      // yes, it is!
      // First I check if I can update in place the object
      ValidDataObject * vdo = dynamic_cast<ValidDataObject *>(pObj);
      if (vdo) { // Good, we can update in place
        vdo->update(*override);
        Condition * cond = dynamic_cast<Condition *>(pObj);
        if (cond) { // A condition needs to be initialized too
          sc = cond->initialize();
          if ( !sc.isSuccess() ) {
            if (log) (*log) << MSG::ERROR
                            << "Unable to initialize overridden condition at "
                            << path << endmsg;
            return sc;
          }
        }
        // to avoid memory leaks, I have to delete the overriding object
        delete override;
        //override->release();
        override = NULL;
      } else { // I cannot update the object, so I replace it.
        //   let's unregister the original object
        sc = dp->unregisterObject(pObj);
        if ( !sc.isSuccess() ) {
          if (log) (*log) << MSG::ERROR << "Unable to unregister object at " << path << endmsg;
          return sc;
        }
        //   and delete it
        pObj->release();
        //   Now I can register the user specified one
        pObj = override;
        sc = dp->registerObject(path,pObj);
        if ( !sc.isSuccess() ) {
          if (log) (*log) << MSG::ERROR << "Unable to register override object to " << path << endmsg;
          return sc;
        }
        // I do not need to delete the overriding object because now it belongs to the T.S.
      }
    }
    
    // Set also internal pointers
    sc = setPointers(pObj);
    if ( !sc.isSuccess() ) {
      if (log) (*log) << MSG::ERROR << "Failure setting the pointers for object at " << path << endmsg;
      return sc;
    }
    
    // try to get the path to CondDB folder
    IOpaqueAddress *pAddr = pObj->registry()->address();
    if (pAddr != NULL) {
      if (pAddr->svcType() == CONDDB_StorageType) {
        // it comes from the cond db, so I can find its path
        db_path = pAddr->par()[0];
      }
    }
  } else {
    if (vdo != NULL && !vdo->isValid(when)){ // I have a VDO ptr and the object is not valid
      if (log) (*log) << MSG::DEBUG << "Update object " << path << " from data provider" << endmsg;
      sc = vdo->update(); // only if I didn't load it
      if ( !sc.isSuccess() ) {
        if (log) (*log) << MSG::ERROR << "Update from data provider failed!" << endmsg;
        return sc;
      }
    }
  }
  if (vdo != NULL) { // it is a valid data object and should be up-to-date: align validity
    // no check because it shouldn't be necessary
    since = vdo->validSince();
    until = vdo->validTill();
  }
  // object internal data are up-to-date, now check what it depends on
  if (log) (*log) << MSG::VERBOSE << "Enter dependencies update loop" << endmsg;
  for (MembFuncList::iterator mfIt = memFuncs.begin(); mfIt != memFuncs.end(); ++mfIt){
    if (!mfIt->isValid(when)) { // only if one the children of the member function need an update
      size_t n = mfIt - memFuncs.begin();
      if (log) (*log) << MSG::VERBOSE << "Loop over dependencies of m.f. " << n << endmsg;
      mfIt->resetIOV();
      for (ItemList::iterator itemIt = mfIt->items->begin(); itemIt != mfIt->items->end(); ++itemIt){
        sc = (*itemIt)->update(dp,when,log);
        if (!sc.isSuccess()) return sc;
        // child item updated, update mf's IOV
        if (mfIt->since < (*itemIt)->since) mfIt->since = (*itemIt)->since;
        if (mfIt->until > (*itemIt)->until) mfIt->until = (*itemIt)->until;
      }
      if (log) (*log) << MSG::VERBOSE << "Call m.f. " << n << endmsg;
      sc = (*(mfIt->mf))();
      if (!sc.isSuccess()){
        if (log) (*log) << MSG::DEBUG << "m.f. " << n << " returned a failure" << endmsg;
        return sc;
      }
    }
    // update the overall validity even if the M.F. was not called
    if (since < mfIt->since) since = mfIt->since;
    if (until > mfIt->until) until = mfIt->until;
  }
  updateLock = false;
  //std::cout << "UMS:      final validity: " << since << " -> " << until << std::endl;
  //std::cout << "UMS: Updating (Item* " << this << ") " << ptr << " ---END---" << std::endl;
  if (log){
    (*log) << MSG::VERBOSE << "    final validity: " << since << " -> " << until << endmsg;
    (*log) << MSG::DEBUG << "Updating (Item* " << this << ") " << ptr << " ---END---";
    if (!path.empty()) (*log) << " " << path;
    (*log) << endmsg;
  }
  sc = StatusCode::SUCCESS;  
  return sc;
}

bool UpdateManagerSvc::Item::match

(

void *

p

)

const [inline]

Tells if this item represents the given pointer.

Definition at line 304 of file UpdateManagerSvc.h.

bool UpdateManagerSvc::Item::match	(	const std::string &	p,
		bool	is_path_to_db = false
	)			const [inline]

Tells if this item represents object identified by the given pointer.

Definition at line 307 of file UpdateManagerSvc.h.

bool UpdateManagerSvc::Item::isHead

(

)

const [inline]

Tells if the item does not have parents.

Definition at line 312 of file UpdateManagerSvc.h.

bool UpdateManagerSvc::Item::isTail

(

)

const [inline]

Tells if the item does not have parents.

Definition at line 314 of file UpdateManagerSvc.h.

MembFuncList::iterator UpdateManagerSvc::Item::find

(

BaseObjectMemberFunction *

mf

)

[inline]

Finds the MembFunc object containing the given member function.

Definition at line 316 of file UpdateManagerSvc.h.

void UpdateManagerSvc::Item::addParent	(	Item *	parent,
		BaseObjectMemberFunction *	parentMF
	)			[inline]

Adds a (item,member_function) pair to the list of parents.

Definition at line 324 of file UpdateManagerSvc.h.

BaseObjectMemberFunction * UpdateManagerSvc::Item::addChild	(	BaseObjectMemberFunction *	thisMF,
		Item *	child
	)

Adds a child item to the given member function.

Return a pointer to the actual member function if an equivalent one was already registered.

Definition at line 181 of file UpdateManagerSvc_Item.cpp.

                                                                                                       {
  MembFuncList::iterator mfIt = find(thisMF);
  if (mfIt == memFuncs.end()) {
    mfIt = memFuncs.insert(mfIt,MembFunc(thisMF));
  } else {
    if (mfIt->mf != thisMF)
      delete thisMF;
  }
  if (std::find(mfIt->items->begin(),mfIt->items->end(),child) == mfIt->items->end()){
    // it is a new child (not in current m.f. list)
    mfIt->items->push_back(child);

    // intersect M.F. validity with the new child
    if (mfIt->since < child->since) mfIt->since = child->since;
    if (mfIt->until > child->until) mfIt->until = child->until;

    // add the new child to the list of childs if not already included
    if (std::find(children.begin(),children.end(),child) == children.end()){
      children.push_back(child);
    }
    
    // intersect the item validity with the one of the member function
    if (since < mfIt->since) since = mfIt->since;
    if (until > mfIt->until) until = mfIt->until;

  }
  // return the real pointer since thisMF can be deleted
  return mfIt->mf;
}

---

Member Data Documentation

Gaudi::Time UpdateManagerSvc::Item::since

Time points delimiting the interval of validity of the item (intersection of the intervals of validity of the member functions).

Definition at line 250 of file UpdateManagerSvc.h.

Gaudi::Time UpdateManagerSvc::Item::until

Definition at line 250 of file UpdateManagerSvc.h.

ParentList UpdateManagerSvc::Item::parents

Item parents: the (item,member_function) pairs that depend on this item.

Definition at line 253 of file UpdateManagerSvc.h.

ItemList UpdateManagerSvc::Item::children

List of all the children: the items on which this item depend (used for fast accessing).

Definition at line 256 of file UpdateManagerSvc.h.

std::string UpdateManagerSvc::Item::path

Path to the object, inside the data store, represented by the item.

Definition at line 259 of file UpdateManagerSvc.h.

std::string UpdateManagerSvc::Item::db_path

Path of the persistent version of the object inside the Conditions DataBase.

Definition at line 261 of file UpdateManagerSvc.h.

ValidDataObject* UpdateManagerSvc::Item::vdo

Pointer to the ValidDataObject interface of the represented object.

Definition at line 263 of file UpdateManagerSvc.h.

void* UpdateManagerSvc::Item::ptr

Void pointer to the represented object, obtained via dynamic_cast (used to unically identify the item).

Definition at line 265 of file UpdateManagerSvc.h.

ValidDataObject* UpdateManagerSvc::Item::override

Pointer to the object used to override the object retrieved from the data provider.

Definition at line 267 of file UpdateManagerSvc.h.

MembFuncList UpdateManagerSvc::Item::memFuncs

List of the registered member functions.

Definition at line 269 of file UpdateManagerSvc.h.

bool UpdateManagerSvc::Item::updateLock

Flag used to prevent infinite loops when updating.

Definition at line 272 of file UpdateManagerSvc.h.

UserPtrList UpdateManagerSvc::Item::user_dest_ptrs

List op setters for user's pointers.

Definition at line 275 of file UpdateManagerSvc.h.

---

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

• /home/dayabay/installs/trunk_2011_04_11_opt/NuWa-trunk/lhcb/Det/DetDescSvc/src/UpdateManagerSvc.h
• /home/dayabay/installs/trunk_2011_04_11_opt/NuWa-trunk/lhcb/Det/DetDescSvc/src/UpdateManagerSvc_Item.cpp

---