oaLibDefListMem Class Reference

Inheritance diagram for oaLibDefListMem:

oaSessionObject oaObject oaLibDef oaLibDefListRef


Public Methods

oaLibDefListgetList () const
void moveAfter (oaLibDefListMem *member)
void moveToFirst ()
void moveToLast ()
void destroy ()

Detailed Description

oaLibDefListMem is a base class that represents a member in a oaLibDefList. It has two derived classes: oaLibDef, which represents a library definition, and oaLibDefListRef, which represents a reference to another lib def list.

For a sample user routine that gets and iterates through all the oaLibDefListMems in an oaLibDefList passed to the routine in order to process all the library definitions found in the user's library definition file hierarchy, see oaLibDefList::getMembers.


Member Function Documentation

void oaLibDefListMem::destroy  
 

This function destroys this oaLibDefListMem object.

oaLibDefList * oaLibDefListMem::getList   const
 

This function returns the oaLibDefList which contains this member object.

void oaLibDefListMem::moveAfter oaLibDefListMem *    member
 

This function moves this oaLibDefListMem object after the specified member in the owning oaLibDefList.

Parameters:
member input parameter - The list member that this object will be moved after.
Exceptions:
oacInvalidLibDefListMemMove 

void oaLibDefListMem::moveToFirst  
 

This function moves this oaLibDefListMem object to the first position in the owning oaLibDefList.

void oaLibDefListMem::moveToLast  
 

This function moves this oaLibDefListMem object to the last position in the owning oaLibDefList.


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

Return to top of page