oaCMObjectStateTbl Class Reference


Public Methods

 oaCMObjectStateTbl ()
 ~oaCMObjectStateTbl ()
ObjectStateEntryConstIter begin () const
ObjectStateEntryConstIter end () const
void cleanup (oaTimeStamp timeStamp)

Public Types

typedef std::list< oaCMObjectStateEntry * >::const_iterator ObjectStateEntryConstIter
typedef std::list< oaCMObjectStateEntry * >::iterator ObjectStateEntryIter

Friends

class oaCMObjectStateEntry

Detailed Description

The oaCMObjectStateTbl class contains a collection of object-state entry objects for a change set. (Object state refers to an OpenAccess object that is identified by a compound state rather than a unique identifier.)

The oaCMObjectStateTbl does not support look up. Rather, it provides a mechanism for object state consolidation.


Member Typedef Documentation

typedef std::list<oaCMObjectStateEntry*>::const_iterator oaCMObjectStateTbl::ObjectStateEntryConstIter
 

typedef std::list<oaCMObjectStateEntry*>::iterator oaCMObjectStateTbl::ObjectStateEntryIter
 


Constructor & Destructor Documentation

oaCMObjectStateTbl::oaCMObjectStateTbl  
 

This is the default oaCMObjectStateTbl constructor.

oaCMObjectStateTbl::~oaCMObjectStateTbl  
 

This function deletes this table object.


Member Function Documentation

CMObjectStateTblConstIter oaCMObjectStateTbl::begin   const
 

This function returns a constant iterator that points to the first object-state entry in the table.

void oaCMObjectStateTbl::cleanup oaTimeStamp    timeStamp
 

This function removes out-of-date state entries contained in this table.

Parameters:
timeStamp The timestamp indicating the point at which to begin the clean up.

CMObjectStateTblConstIter oaCMObjectStateTbl::end   const
 

This function returns a constant iterator that points to the last object-state entry in the table.


Friends And Related Function Documentation

friend class oaCMObjectStateEntry [friend]
 


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

Return to top of page