Home|News

When Design Matters

CoreLinux++

CoreLinux Consortium

CoreLinux++ Home News Download Project Summary Public surveys Report a Defect Goals What are we Why are we What is our Intent What is not our Intent Developer's Corner C++ Coding Standards Developer's guide Draft Papers FAQ Functional Requirements OO Coding Standards Process Details CL Classes Reference CLFW Classes Reference CVS repository Patch manager Bibliography Open Publication License Adds On Contacts Forums Mailing Lists

Iterator Class Report Generated at: Fri, Jan 28, 2000 17:52:17 TABLE OF CONTENTS REPORT BODY Class report Data package Developer class Client class Component View package corelinux package Iterator class Exception class AssociativeIterator class CoreLinuxAssociativeIterator class CoreLinuxIterator class InvalidIteratorException class IteratorBoundsException class IteratorException class Model dictionary SUMMARY REPORT BODY Class report package Data class Developer Stereotype:   <<actor>> Documentation: Developer extends the abstract Iterator pattern for a particular implementation. class Client Stereotype:   <<actor>> Documentation: The Client is the user of a Iterator implementation. package Data::Component View package Data::corelinux abstract class Iterator < ElementType > Documentation: Iterator provides a way to access the elements of an collection object sequentially without exposing its underlying representation. Operations: public   Iterator ( [Unnamed] : void ) Stereotype:   <<constructor>> Documentation: Default Constructor public   Iterator ( aIterator : IteratorCref ) Stereotype:   <<constructor>> Documentation: Copy constructor public   ~Iterator ( [Unnamed] : void ) Stereotype:   <<destructor>> Documentation: Destructor public   IteratorRef  operator= ( aIterator : IteratorCref ) Stereotype:   <<operator>> Documentation: Assignment operator public   bool  operator== ( anIterator : IteratorCref ) Stereotype:   <<operator>> Constraints:  {query} Documentation: Equality operator, returns true if the iterator instances are the same. public abstract  void  setNext ( [Unnamed] : void ) Stereotype:   <<setter>> Documentation: Sets the Iterator to point to the next element in the collection. public abstract  void  setLast ( [Unnamed] : void ) Stereotype:   <<setter>> Documentation: Sets the iterator to point to the last element in the collection. public abstract  ElementType  getElement ( [Unnamed] : void ) Stereotype:   <<getter>> Constraints:  {query} Documentation: Gets the element that is currently pointed to by the iterator implementation. Enforces IteratorBoundsException public abstract  void  setFirst ( [Unnamed] : void ) Stereotype:   <<setter>> Documentation: Sets the Iterator to point to the first element. public abstract  bool  isValid ( [Unnamed] : void ) Stereotype:   <<getter>> Constraints:  {query} Documentation: Returns true if current position of iteration points to a valid entry. public abstract  void  setPrevious ( [Unnamed] : void ) Stereotype:   <<setter>> Documentation: Sets the iterator to point to the element prior to the current position. class Exception Documentation: CoreLinux base Exception class. abstract class AssociativeIterator < KeyType, ElementType > Superclasses: Data::corelinux::Iterator Documentation: AssociativeIterator is an Iterator for classes that have a key to the element type. Operations: public   AssociativeIterator ( [Unnamed] : void ) Stereotype:   <<constructor>> Documentation: Default Constructor public   AssociativeIterator ( aIterator : AssociativeIterator ) Stereotype:   <<constructor>> Documentation: Copy constructor public   ~AssociativeIterator ( [Unnamed] : void ) Stereotype:   <<destructor>> Documentation: Destructor public   AssociativeIterator  operator= ( aIterator : AssociativeIterator ) Stereotype:   <<operator>> Documentation: Assignment operator public   bool  operator== ( anIterator : IteratorCref ) Stereotype:   <<operator>> Constraints:  {query} Documentation: Equality operator, returns true if the iterator instances are the same. public abstract  KeyType  getKey ( [Unnamed] : void ) Stereotype:   <<getter>> Constraints:  {query} Documentation: Returns the Key that is at the current position class CoreLinuxAssociativeIterator < Traverser, KeyType, ElementType > Superclasses: Data::corelinux::AssociativeIterator Documentation: CoreLinuxAssocaitiveIterator is a parameterized iterator that works with the knowledge of the STL associative collections. Attributes: protected   theBegin  :  Traverser Documentation: Points to the begining element of the collection. protected   theEnd  :  Traverser Documentation: Points to the end of the collection. protected   theCurrent  :  Traverser Documentation: The current location of the Iterator Operations: public   CoreLinuxAssociativeIterator ( aBegin : Traverser,  aEnd : Traverser ) Stereotype:   <<constructor>> Documentation: Default Constructor takes the STL iterators begin and end as arguments. public   CoreLinuxAssociativeIterator ( [Unnamed] : void ) Stereotype:   <<constructor>> Documentation: Default constructor with no arguments throws InvalidIteratorException. public   CoreLinuxAssociativeIterator ( aIterator : CoreLinuxAssociativeIteratorCref ) Stereotype:   <<constructor>> Documentation: Copy constructor copies the relevent traversal information public   ~CoreLinuxAssociativeIterator ( [Unnamed] : void ) Stereotype:   <<destructor>> Documentation: Destructor public   void  setFirst ( [Unnamed] : void ) Stereotype:   <<setter>> Documentation: Sets theCurrent to theBegin public   void  setNext ( [Unnamed] : void ) Stereotype:   <<setter>> Documentation: Sets theCurrent to the next element. May throw IteratorBoundsException. public   void  setLast ( [Unnamed] : void ) Stereotype:   <<setter>> Documentation: Sets the iterator to the last element. public   ElementType  getElement ( [Unnamed] : void ) Stereotype:   <<getter>> Constraints:  {query} Documentation: Retrieves the element pointed to by theCurrent public   CoreLinuxAssociativeIterator  operator= ( aIterator : CoreLinuxAssociativeIterator ) Stereotype:   <<operator>> Documentation: Assignment operator public   bool  operator== ( aIterator : CoreLinuxAssociativeIterator ) Stereotype:   <<operator>> Constraints:  {query} Documentation: Returns true if the iterator instances point to the same collection. public   bool  isValid ( [Unnamed] : void ) Stereotype:   <<getter>> Constraints:  {query} Documentation: Implementation of testing that the current position contains a valid entry. public   void  setPrevious ( [Unnamed] : void ) Stereotype:   <<setter>> Documentation: Sets theCurrent to previous unless it already is equal to theBegin, otherwise an exception is thrown. public   KeyType  getKey ( [Unnamed] : void ) Stereotype:   <<getter>> Constraints:  {query} Documentation: Returns the Key that is at the current position class CoreLinuxIterator < Traverser, ElementType > Superclasses: Data::corelinux::Iterator Documentation: CoreLinuxIterator is a parameterized iterator that works with the knowledge of the STL non-associative collections. Attributes: protected   theBegin  :  Traverser Documentation: Points to the begining element of the collection. protected   theEnd  :  Traverser Documentation: Points to the end of the collection. protected   theCurrent  :  Traverser Documentation: The current location of the Iterator Operations: public   CoreLinuxIterator ( aBegin : Traverser,  aEnd : Traverser ) Stereotype:   <<constructor>> Documentation: Default Constructor takes the STL iterators begin and end as arguments. public   CoreLinuxIterator ( [Unnamed] : void ) Stereotype:   <<constructor>> Documentation: Default constructor with no arguments throws InvalidIteratorException. public   CoreLinuxIterator ( aIterator : CoreLinuxIteratorCref ) Stereotype:   <<constructor>> Documentation: Copy constructor copies the relevent traversal information public   ~CoreLinuxIterator ( [Unnamed] : void ) Stereotype:   <<destructor>> Documentation: Destructor public   void  setFirst ( [Unnamed] : void ) Stereotype:   <<setter>> Documentation: Sets theCurrent to theBegin public   void  setNext ( [Unnamed] : void ) Stereotype:   <<setter>> Documentation: Sets theCurrent to the next element. May throw IteratorBoundsException. public   void  setLast ( [Unnamed] : void ) Stereotype:   <<setter>> Documentation: Sets the iterator to the last element. public   ElementType  getElement ( [Unnamed] : void ) Stereotype:   <<getter>> Constraints:  {query} Documentation: Retrieves the element pointed to by theCurrent public   CoreLinuxIteratorRef  operator= ( aIterator : CoreLinuxIteratorCref ) Stereotype:   <<operator>> Documentation: Assignment operator public   bool  operator== ( aIterator : CoreLinuxIteratorCref ) Stereotype:   <<operator>> Constraints:  {query} Documentation: Returns true if the iterator instances point to the same collection. public   bool  isValid ( [Unnamed] : void ) Stereotype:   <<getter>> Constraints:  {query} Documentation: Implementation of testing that the current position contains a valid entry. public   void  setPrevious ( [Unnamed] : void ) Stereotype:   <<setter>> Documentation: Sets theCurrent to previous unless it already is equal to theBegin, otherwise an exception is thrown. class InvalidIteratorException Superclasses: Data::corelinux::IteratorException Documentation: Indicates that the iterator is not initialized to point to a valid collection. class IteratorBoundsException Superclasses: Data::corelinux::IteratorException Documentation: IteratorBoundsException indicates that a particular operation would cause the iterator to refer to an invalid element. class IteratorException Superclasses: Data::corelinux::Exception Documentation: IteratorException type Model dictionary I   A   C   D   E   G   I   O   S   T   ~    I Iterator operation from class corelinux.Iterator Default Constructor Iterator operation from class corelinux.Iterator Copy constructor A AssociativeIterator class from package corelinux AssociativeIterator is an Iterator for classes that have a key to the element type. AssociativeIterator operation from class corelinux.AssociativeIterator Default Constructor AssociativeIterator operation from class corelinux.AssociativeIterator Copy constructor C Client class The Client is the user of a Iterator implementation. Component View package corelinux package CoreLinuxAssociativeIterator class from package corelinux CoreLinuxAssocaitiveIterator is a parameterized iterator that works with the knowledge of the STL associative collections. CoreLinuxAssociativeIterator operation from class corelinux.CoreLinuxAssociativeIterator Default Constructor takes the STL iterators begin and end as arguments. CoreLinuxAssociativeIterator operation from class corelinux.CoreLinuxAssociativeIterator Default constructor with no arguments throws InvalidIteratorException. CoreLinuxAssociativeIterator operation from class corelinux.CoreLinuxAssociativeIterator Copy constructor copies the relevent traversal information CoreLinuxIterator class from package corelinux CoreLinuxIterator is a parameterized iterator that works with the knowledge of the STL non-associative collections. CoreLinuxIterator operation from class corelinux.CoreLinuxIterator Default Constructor takes the STL iterators begin and end as arguments. CoreLinuxIterator operation from class corelinux.CoreLinuxIterator Default constructor with no arguments throws InvalidIteratorException. CoreLinuxIterator operation from class corelinux.CoreLinuxIterator Copy constructor copies the relevent traversal information D Data package Developer class Developer extends the abstract Iterator pattern for a particular implementation. E Exception class from package corelinux CoreLinux base Exception class. G getElement operation from class corelinux.CoreLinuxAssociativeIterator Retrieves the element pointed to by theCurrent getElement operation from class corelinux.Iterator Gets the element that is currently pointed to by the iterator implementation. Enforces IteratorBoundsException getElement operation from class corelinux.CoreLinuxIterator Retrieves the element pointed to by theCurrent getKey operation from class corelinux.AssociativeIterator Returns the Key that is at the current position getKey operation from class corelinux.CoreLinuxAssociativeIterator Returns the Key that is at the current position I InvalidIteratorException class from package corelinux Indicates that the iterator is not initialized to point to a valid collection. isValid operation from class corelinux.CoreLinuxAssociativeIterator Implementation of testing that the current position contains a valid entry. isValid operation from class corelinux.CoreLinuxIterator Implementation of testing that the current position contains a valid entry. isValid operation from class corelinux.Iterator Returns true if current position of iteration points to a valid entry. Iterator class from package corelinux Iterator provides a way to access the elements of an collection object sequentially without exposing its underlying representation. IteratorBoundsException class from package corelinux IteratorBoundsException indicates that a particular operation would cause the iterator to refer to an invalid element. IteratorException class from package corelinux IteratorException type O operator= operation from class corelinux.CoreLinuxAssociativeIterator Assignment operator operator= operation from class corelinux.CoreLinuxIterator Assignment operator operator= operation from class corelinux.AssociativeIterator Assignment operator operator= operation from class corelinux.Iterator Assignment operator operator== operation from class corelinux.CoreLinuxAssociativeIterator Returns true if the iterator instances point to the same collection. operator== operation from class corelinux.AssociativeIterator Equality operator, returns true if the iterator instances are the same. operator== operation from class corelinux.CoreLinuxIterator Returns true if the iterator instances point to the same collection. operator== operation from class corelinux.Iterator Equality operator, returns true if the iterator instances are the same. S setFirst operation from class corelinux.Iterator Sets the Iterator to point to the first element. setFirst operation from class corelinux.CoreLinuxIterator Sets theCurrent to theBegin setFirst operation from class corelinux.CoreLinuxAssociativeIterator Sets theCurrent to theBegin setLast operation from class corelinux.Iterator Sets the iterator to point to the last element in the collection. setLast operation from class corelinux.CoreLinuxIterator Sets the iterator to the last element. setLast operation from class corelinux.CoreLinuxAssociativeIterator Sets the iterator to the last element. setNext operation from class corelinux.CoreLinuxIterator Sets theCurrent to the next element. May throw IteratorBoundsException. setNext operation from class corelinux.Iterator Sets the Iterator to point to the next element in the collection. setNext operation from class corelinux.CoreLinuxAssociativeIterator Sets theCurrent to the next element. May throw IteratorBoundsException. setPrevious operation from class corelinux.CoreLinuxAssociativeIterator Sets theCurrent to previous unless it already is equal to theBegin, otherwise an exception is thrown. setPrevious operation from class corelinux.CoreLinuxIterator Sets theCurrent to previous unless it already is equal to theBegin, otherwise an exception is thrown. setPrevious operation from class corelinux.Iterator Sets the iterator to point to the element prior to the current position. T theBegin attribute from class corelinux.CoreLinuxIterator Points to the begining element of the collection. theBegin attribute from class corelinux.CoreLinuxAssociativeIterator Points to the begining element of the collection. theCurrent attribute from class corelinux.CoreLinuxAssociativeIterator The current location of the Iterator theCurrent attribute from class corelinux.CoreLinuxIterator The current location of the Iterator theEnd attribute from class corelinux.CoreLinuxAssociativeIterator Points to the end of the collection. theEnd attribute from class corelinux.CoreLinuxIterator Points to the end of the collection. ~ ~AssociativeIterator operation from class corelinux.AssociativeIterator Destructor ~Iterator operation from class corelinux.Iterator Destructor ~CoreLinuxIterator operation from class corelinux.CoreLinuxIterator Destructor ~CoreLinuxAssociativeIterator operation from class corelinux.CoreLinuxAssociativeIterator Destructor SUMMARY Total packages reported:     3 Total classes reported:      10 Total attributes reported:      6 Total operations reported:      42 Copyright © 1999, 2000 by CoreLinux Consortium This material may be distributed only subject to the terms and conditions set forth in the Open Publication License

Contacts - contact the webmaster News [06/03/01] libclfw++ 0.2.8 [05/12/01] libclfll++ 0.1.1 [04/28/01] libclfw++ 0.2.7 [04/15/01] libcorelinux++ 0.4.32 Powered / Hosted by SourceForge.net Contributor NoMagic, inc. thanks Gary! Cool OO Sites cetus corba omg patterns

Made with xemacs / php

Comments to webmaster