oaCMObjectRefTbl Class Reference


Public Methods

 oaCMObjectRefTbl (oaCMDatabaseRef::SPtr database)
 ~oaCMObjectRefTbl ()
oaCMObjectRef::SPtr find (void *obj) const
void onPassivate (oaCMObjectRef::SPtr ref)
void onActivate (oaCMObjectRef::SPtr ref)
oaCMDatabaseRef::SPtr getDatabase () const
ObjectRefConstIter begin () const
ObjectRefConstIter end () const
void cleanup (oaTimeStamp timeStamp)

Public Types

typedef std::list< oaCMObjectRef * >::const_iterator ObjectRefConstIter
typedef std::list< oaCMObjectRef * >::iterator ObjectRefIter

Friends

class oaCMObjectIDRef
class oaCMObjectStateRef

Detailed Description

The oaCMObjectRefTbl class contains contains all the reference objects for a change set.

Member Typedef Documentation

typedef std::list<oaCMObjectRef*>::const_iterator oaCMObjectRefTbl::ObjectRefConstIter
 

typedef std::list<oaCMObjectRef*>::iterator oaCMObjectRefTbl::ObjectRefIter
 

Constructor & Destructor Documentation

oaCMObjectRefTbl::oaCMObjectRefTbl (  oaCMDatabaseRef::SPtr    database ) 
 

This function is the oaCMObjectRefTbl constructor.

Parameters:
database A smart pointer to the database reference.

oaCMObjectRefTbl::~oaCMObjectRefTbl (    ) 
 

This is the oaCMObjectRefTbl destructor.

Member Function Documentation

CMObjectRefMapConstIter oaCMObjectRefTbl::begin (    )  const
 

This function returns a constant iterator that points to the first oaCMObjectRef in the table.

void oaCMObjectRefTbl::cleanup (  oaTimeStamp    timeStamp ) 
 

This function removes the references that are older than timeStamp.

Parameters:
timeStamp The timestamp indicating when to begin the clean-up.

CMObjectRefMapConstIter oaCMObjectRefTbl::end (    )  const
 

This function returns a constant iterator that points to the last oaCMObjectRef in the table.

oaCMObjectRef::SPtr oaCMObjectRefTbl::find (  void *    obj )  const
 

This function returns a smart pointer to the oaCMObjectRef for the specified object.

Parameters:
obj A pointer to the object for which to find the oaCMObjectRef.

oaCMDatabaseRef::SPtr oaCMObjectRefTbl::getDatabase (    )  const
 

This function returns a smart pointer to the database for this oaCMObjectRef.

void oaCMObjectRefTbl::onActivate (  oaCMObjectRef::SPtr    ref ) 
 

This function is called when the specified reference ref is activated.

Parameters:
ref The oaCMObjectRef to activate.

void oaCMObjectRefTbl::onPassivate (  oaCMObjectRef::SPtr    ref ) 
 

This function is called when the specified reference ref is passivated.

Parameters:
ref The oaCMObjectRef to passivate.

Friends And Related Function Documentation

friend class oaCMObjectIDRef [friend]
 

friend class oaCMObjectStateRef [friend]
 

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

Return to top of page




Copyright © 2002 - 2010 Cadence Design Systems, Inc.
All Rights Reserved.