iflClassList(3)

NAME
     iflClassList - class inheritance chain

INHERITS FROM
     This is a base class

HEADER FILE
     #include <ifl/iflClassList.h>

CLASS DESCRIPTION
     iflClassList is used to statically create a class inheritance chain; it's
     not setup to deal with multiple inheritance, just the "primary" base
     class.

   Usage
     Put the iflClassListDeclare macro in the public section of a class
     declaration derived from a base class and the iflClassListImplementBase
     or iflClassListImplementDerived macro in the implementation file. These
     macros will declare and implement the methods described below, thus
     allowing the class hierarchy to be interrogated.

     Refer to <il/ilLink.h> and <il/ilImage.h> for examples of the use of
     these macros.

   Public methods added
     The folling public methods are added to the invoking class by the
     iflClassListImplementXXX macros:

     getClassName()

          virtual char* getClassName(int parentIdx=0)


          This method specifies the name of the class for this object
          instantiantion (or of the nearest ancestor class that registers
          itself using this macro.) The optional parentIdx argument allows the
          name of one of the parent classes to be returned, the values
          specifies how may levels of the class hierarchy to traverse.

     getClassId()

           virtual iflClassId getClassId()


          This method returns the class ID for this object instantiantion.

     derivesFrom()

          virtual int derivesFrom(iflClassId classID)
          This method returns TRUE if this object instantiantion derives from
          the class indicated by classID.  This classID is formed using the
          iflClassID macro defined in ilTypes.h; e.g. "iflClassID(ilImage)"

   Protected methods added
     The following protected method is added to the invoking class by the
     iflClassListImplementXXX macros:

     getDefaultDescription()

          virtual char* getDefaultDescription()


          This method returns the default description for this object
          instantiantion. This is the string supplied in the
          iflClassListImplement* macros.

CLASS MEMBER FUNCTION SUMMARY
     Class lookup methods

          int find(iflClassId classID)
          char* find(int parentIdx)


FUNCTION DESCRIPTIONS
     find()

          char* find(int parentIdx)
          int find(iflClassId classID)


          This first version returns the name of the class, parentIdx levels
          up in the class list.  The second versions returns TRUE if classID
          is found in the class list.