All Rogue Wave C++ class names start with the letters RW, as in RWURL. In some cases, an instance of a class is referred to by an English name; for example, "the agent" instead of "the RWIAgent." 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 possible ambiguity.
All function names begin with a lower case letter, with the first letter of subsequent words capitalized. Function names describe what a function does. For example, newsGroup(void) returns the specified news group portion of the URL, if applicable. 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. Ellipses are used in code examples to indicate that some part of the code is missing.
Throughout the documentation, there are frequent references to "self," which should be understood to mean *this.
Inheritance hierarchies for derived classes are displayed at the top of each class entry. The notation system is the standard Unified Modeling Language (UML); see any UML guide for information. The class interaction diagrams have their own symbol keys. In the class reference section, the following conventions are used.
A
 B |
A
 B |
A
 B |
A
 B |
|
A inherits from B |
A contains B |
A references B |
A creates B |
When a class inherits from more than one class, or there are multiple levels of inheritance, all of its inheritance relationships are shown. For example, the following illustration indicates that class A inherits from class B and from class C, which inherits from class D.
B
A
C
D
The notation system used in the Class Reference is based on the Object Modeling Technique (OMT) developed by Rumbaugh and others. The notation is similar to the notation used in Design Patterns by Gamma, Helm, Johnson, and Vlissides.
©Copyright 2000, Rogue Wave Software, Inc.
Contact Rogue Wave about documentation or support issues.