Tools.h++ Class Reference

Conventions
All Rogue Wave class names start with the letters RW, as in RWCollectable, with the bold font
emphasizing the class name rather than the prefix. In some cases, we may refer to an instance of
a class by an English name; for example, "the string" instead of "the RWCString instance." We
do this to make it easier to read when the meaning should be clear from context, but we use the
longer form if there is a possible ambiguity.
All function names begin with a lower case letter, with the first letter of subsequent words
capitalized. Function names attempt to accurately describe what a function does. For example,
RWCString::toLower() changes all uppercase letters in itself to lowercase. Underline characters
and abbreviations are not generally used in function names.
Function names, examples, operating system commands, mathematical symbols and code
fragments are shown in a courier font, as in <rw/stream.h> . Vertical ellipses are used in code
examples to indicate that some part of the code is missing.
Throughout this documentation, there are frequent references to "self." This should be read as
"*this".
Inheritance Notation
Each class that inherits from another class (or other classes) includes an illustration that shows
the inheritance hierarchy. For example, the following illustration indicates that class A inherits
from class B:
When a class inherits from more than one class, or there are multiple levels of inheritance, all of
the inheritance relationships are shown. For example, the following illustration indicates that A
inherits from class B and from class C, which inherits from class D.
The notation system used in the inheritance hierarchies is based on the Object Modeling
Technique (OMT) developed by Rumbaugh and others.
Member Functions
Within their general categories, member functions for each class are listed alphabetically.
Member functions fall into three general types:
Functions that are unique to a class. The complete documentation for these functions is
presented in the class where they occur. An example is balance(), a member of the class
1.