ISequence Class Template Reference

Inheritance diagram for ISequence:

Public Methods
virtual oa::oaUInt4	count ()=0
virtual void	insert (const T &objIn)=0
virtual void	append (const T &objIn)=0
virtual void	remove ()=0
virtual void	replace (const T &objIn)=0

---

Detailed Description

template<class T, const Guid * SeqId, const Guid * IterId>
class ISequence< T, SeqId, IterId >

This is a templated abstract class that extends the functionality found on IIter to add the ability to modify the underlying collection. These functions all operate relative to the current element. The partial specialization of ISequence is purely an optimization so that sequences of pointers (such as interface pointers, which likely represent the bulk of usage) are passed in as Type * rather than const Type *&. The template considerations work identically to those for IIter.

---

Member Function Documentation

template<class T, const Guid * SeqId, const Guid * IterId> void ISequence< T, SeqId, IterId >::append (  const T &    objIn )  [pure virtual]

This function adds an element after the current element. Parameters: objIn  A reference to a variable representing the value of the element to append.

template<class T, const Guid * SeqId, const Guid * IterId> uint32 ISequence< T, SeqId, IterId >::count (    )  [pure virtual]

This function returns the total count of elements in this collection.

template<class T, const Guid * SeqId, const Guid * IterId> void ISequence< T, SeqId, IterId >::insert (  const T &    objIn )  [pure virtual]

This function adds an element before the current element. Parameters: objIn  A reference to a variable representing the value of the element to insert.

template<class T, const Guid * SeqId, const Guid * IterId> void ISequence< T, SeqId, IterId >::remove (    )  [pure virtual]

This function removes the current element from the collection and sets the current element to the previous element so that calling next has the effect of going to the element that would have been next if remove had not been called.

template<class T, const Guid * SeqId, const Guid * IterId> void ISequence< T, SeqId, IterId >::replace (  const T &    objIn )  [pure virtual]

The replace function replaces the current element with the element passed in. Parameters: objIn  A reference to a variable representing the value of the element that will replace the current one.

---

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

• oaCommonIBase.h
• oaCommonIBase.inl
• oaCommonIBase.dox

Return to top of page

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