bsltf_alloctesttype

Detailed Description

Outline

• Purpose
• Classes
• Description
  • Salient Attributes
  • Non-salient Attributes
  • Usage
    • Example 1: Printing the Supported Traits

Purpose

Provide a class for testing that allocates with bsl::allocator.

Classes

• bsltf::AllocTestType: allocating test class

See also

bsltf_templatetestfacility

Description

This component provides a single, unconstrained (value-semantic) attribute class, AllocTestType, that uses a bsl::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.

Salient Attributes

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

• data: representation of the object's value

Non-salient Attributes

Name                Type              Default
------------------  ----------------  ------------------
allocator           bsl::allocator<>  bsl::allocator<>{}

• allocator: allocator used by the object

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.