1.1 Content
This reference is presented as an alphabetical listing of the classes provided by Rogue Wave® HydraExpress.
The entry for each class includes a brief description, an illustration showing its inheritance hierarchy, and a synopsis indicating the header file(s) associated with the class. The synopsis also shows a declaration and definition of a class object, and any type definitions that are used.
Rogue Wave officially supports only publicly documented APIs. In some packages, APIs may exist that are not documented, or APIs may contain undocumented methods; these are internal APIs that may change and behave unexpectedly, and are not meant to be used directly by customers.
Member functions for each class are listed alphabetically. Member functions fall into three general types:
Methods that are unique to a class. The complete documentation for these methods is presented in the class where they occur.
Methods that are inherited from a base class without being redefined. The complete documentation for these methods is presented in the defining base class.
Methods that are redefined in a derived class. These are usually virtual methods. The documentation for these methods links to the base class, but may also describe the redefinitions and extensions relevant to the derived class.
1.1.1 Code Conventions
All HydraExpress library classes are in the namespace rwsf and therefore start with rwsf::, as in rwsf::MessageHandler.
In some cases, we may refer to an instance of a class by an English name; for example, "the message handler" instead of "the rwsf::MessageHandler 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 any 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, rwsf::MessageHandler::invoke() invokes the message handler. Underline characters and abbreviations are not generally used in function names.
Throughout the documentation, there are occassional references to self, which should be understood to mean *this.
© Copyright Rogue Wave Software, Inc. All Rights Reserved. All Rights Reserved. Rogue Wave is a registered trademark of Rogue Wave Software, Inc. in the United States and other countries. HydraExpress is a trademark of Rogue Wave Software, Inc. All other trademarks are the property of their respective owners.
Contact Rogue Wave about documentation or support issues.