oaCMStringTbl Class Reference


Public Methods

 oaCMStringTbl ()
 ~oaCMStringTbl ()
StringEntryConstIter begin () const
StringEntryConstIter end () const
oaCMStringEntry::SPtr find (const oaString &str) const
void cleanup (oaTimeStamp timeStamp)

Public Types

typedef std::map< std::string, oaCMStringEntry * >::const_iterator StringEntryConstIter
typedef std::map< std::string, oaCMStringEntry * >::iterator StringEntryIter

Friends

class oaCMStringEntry

Detailed Description

The oaCMStringTbl class contains a collection of string entry objects that are used in change sets. The oaCMStringTbl supports look-up by string.


Member Typedef Documentation

typedef std::map<std::string, oaCMStringEntry*>::const_iterator oaCMStringTbl::StringEntryConstIter
 

typedef std::map<std::string, oaCMStringEntry*>::iterator oaCMStringTbl::StringEntryIter
 


Constructor & Destructor Documentation

oaCMStringTbl::oaCMStringTbl  
 

This is the oaCMStringTbl constructor.

oaCMStringTbl::~oaCMStringTbl  
 

This function deletes this table object.


Member Function Documentation

ConstIter oaCMStringTbl::begin   const
 

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

void oaCMStringTbl::cleanup oaTimeStamp    timeStamp
 

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

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

ConstIter oaCMStringTbl::end   const
 

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

oaCMStringEntry::SPtr oaCMStringTbl::find const oaString &    str const
 

This function returns a smart pointer to the oaCMStringEntry for str.

Parameters:
str The string for which to return the oaCMStringEntry smart pointer.


Friends And Related Function Documentation

friend class oaCMStringEntry [friend]
 


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

Return to top of page