Simbody
3.7
|
This header provides declarations of the user-visible portion of the PIMPLHandle template classes that are used in the SimTK Core to implement the PIMPL (private implementation) design pattern. More...
Go to the source code of this file.
Classes | |
class | SimTK::PIMPLHandle< HANDLE, IMPL, PTR > |
This class provides some infrastructure useful in making SimTK Private Implementation (PIMPL) classes. More... | |
class | SimTK::PIMPLImplementation< HANDLE, IMPL > |
This class provides some infrastructure useful in creating PIMPL Implementation classes (the ones referred to by Handles). More... | |
Namespaces | |
SimTK | |
This is the top-level SimTK namespace into which all SimTK names are placed to avoid collision with other symbols. | |
Macros | |
#define | SimTK_INSERT_DERIVED_HANDLE_DECLARATIONS(DERIVED, DERIVED_IMPL, PARENT) |
#define | SimTK_INSERT_DERIVED_HANDLE_DEFINITIONS(DERIVED, DERIVED_IMPL, PARENT) |
Functions | |
template<class H , class IMPL , bool PTR> | |
std::ostream & | SimTK::operator<< (std::ostream &o, const PIMPLHandle< H, IMPL, PTR > &h) |
This header provides declarations of the user-visible portion of the PIMPLHandle template classes that are used in the SimTK Core to implement the PIMPL (private implementation) design pattern.
The definitions associated with these template method declarations are separated into the companion header file PrivateImplementation_Defs.h with the intent that those definitions will be visible only in library-side code where they need to be instantiated. The definition header file is available for end users as part of the SimTK Core installation, but is not automatically included with SimTKcomon.h as this file is.
SimTK Core client-side headers include this declarations file in order to define the various client side Handle classes, but SimTK Core client-side code never includes the definitions; that is done exclusively in private, library-side code.
#define SimTK_INSERT_DERIVED_HANDLE_DECLARATIONS | ( | DERIVED, | |
DERIVED_IMPL, | |||
PARENT | |||
) |
#define SimTK_INSERT_DERIVED_HANDLE_DEFINITIONS | ( | DERIVED, | |
DERIVED_IMPL, | |||
PARENT | |||
) |