RTI Connext Traditional C++ API  Version 5.2.3
 All Classes Functions Variables Typedefs Enumerations Enumerator Groups Pages
Conventions

This section describes the conventions used in the API documentation.

Unsupported Features

[Not supported (optional)] This note means that the optional feature from the DDS specification is not supported in the current release.

API Naming Conventions

Structure & Class Names

RTI Data Distribution Service 4 makes a distinction between value types and interface types. Value types are types such as primitives, enumerations, strings, and structures whose identity and equality are determined solely by explicit state. Interface types are those abstract opaque data types that conceptually have an identity apart from their explicit state. Examples include all of the DDSEntity subtypes, the DDSCondition subtypes, and DDSWaitSet. Instances of value types are frequently transitory and are declared on the stack. Instances of interface types typically have longer lifecycles, are accessible by pointer only, and may be managed by a factory object.

Value and interface types are distinguished by their names: value types have names beginning with "DDS_" (i.e. with an underscore); interface types have names beginning with "DDS" (i.e. with no underscore). Another way to think of it: C-style types – structures, enumerations, etc. – have names beginning with "DDS_"; C++ classes have names beginning with "DDS."

API Documentation Terms

In the API documentation, the term module refers to a logical grouping of documentation and elements in the API.

At this time, typedefs that occur in the API, such as DDS_ReturnCode_t do not show up in the compound list or indices. This is a known limitation in the generated HTML.

Stereotypes

Commonly used stereotypes in the API documentation include the following.

Extensions

Experimental

Types

Method Parameters


RTI Connext Traditional C++ API Version 5.2.3 Copyright © Wed Apr 27 2016 Real-Time Innovations, Inc