Component bsltf_alloctesttype [Package bsltf]

Provide a class for testing that allocates with bslma::Allocator. More...

Namespaces
namespace	bslma
namespace	bsltf

---

Detailed Description

Outline

• Purpose
• Classes
• Description
  • Attributes
  • Usage
    • Example 1: Printing the Supported Traits

Purpose:

Provide a class for testing that allocates with bslma::Allocator.

Classes:

bsltf::AllocTestType

allocating test class

See also:

Component bsltf_templatetestfacility

Description:

This component provides a single, unconstrained (value-semantic) attribute class, AllocTestType, that uses a bslma::Allocator to supply memory and defines the type trait bslma::UsesBslmaAllocator. Furthermore, this class is not bitwise-moveable, and will assert on destruction if it has been moved. This class is primarily provided to facilitate testing of templates by defining a simple type representative of user-defined types having an allocator.

Attributes:

  Name                Type         Default
  ------------------  -----------  -------
  data                int          0

• data: representation of the object's value

Usage:

This section illustrates intended use of this component.

Example 1: Printing the Supported Traits:

Suppose we wanted to print the supported traits of this test type.

First, we create a function template printTypeTraits with a parameterized TYPE:

  template <class TYPE>
  void printTypeTraits()
      // Prints the traits of the parameterized 'TYPE' to the console.
  {
      if (bslma::UsesBslmaAllocator<TYPE>::value) {
          printf("Type defines bslma::UsesBslmaAllocator.\n");
      }
      else {
          printf(
              "Type does not define bslma::UsesBslmaAllocator.\n");
      }

      if (bslmf::IsBitwiseMoveable<TYPE>::value) {
          printf("Type defines bslmf::IsBitwiseMoveable.\n");
      }
      else {
          printf("Type does not define bslmf::IsBitwiseMoveable.\n");
      }
  }

Now, we invoke the printTypeTraits function template using AllocTestType as the parameterized TYPE:

  printTypeTraits<AllocTestType>();

Finally, we observe the console output:

  Type defines bslma::UsesBslmaAllocator.
  Type does not define bslmf::IsBitwiseMoveable.