Naming Conventions
Rogue Wave HydraExpress class names and types are typically referenced with the namespace qualification
rwsf::. Template parameter values for templatized classes appear in angle brackets
< > like this:
rwsf::Enumeration<T>. Formal template parameters appear in text only when they are important to the discussion, so you may occasionally see this:
rwsf::Enumeration<T>, but generally it is simply
rwsf::Enumeration.
All member function names start with a lower case letter, but subsequent words are capitalized. In most class and function names, words are fully spelled out, for example:
| A class name |
getContext() | A function name |
In our manuals, we sometimes refer to an instance of a class generically; for example, the “servlet class” instead of “
rwsf::Servlet class.” We do this for readability when the meaning should be clear from context. If there is possible ambiguity, however, we use the actual class name.
Throughout the documentation, references to “self” mean *this.