TwiceAsNice  2019-02-18
Public Member Functions | Private Attributes | List of all members
boost::cb_details::capacity_control< Size > Struct Template Reference

Capacity controller of the space optimized circular buffer. More...

#include <details.hpp>

Collaboration diagram for boost::cb_details::capacity_control< Size >:
Collaboration graph

Public Member Functions

 capacity_control (Size capacity, Size min_capacity=0)
 Constructor. More...
 
Size capacity () const
 Get the capacity of the space optimized circular buffer. More...
 
Size min_capacity () const
 Get the minimal capacity of the space optimized circular buffer. More...
 
 operator Size () const
 Size operator - returns the capacity of the space optimized circular buffer. More...
 

Private Attributes

Size m_capacity
 The capacity of the space optimized circular buffer. More...
 
Size m_min_capacity
 The lowest guaranteed capacity of the adapted circular buffer. More...
 

Detailed Description

template<class Size>
struct boost::cb_details::capacity_control< Size >

Capacity controller of the space optimized circular buffer.

Constructor & Destructor Documentation

◆ capacity_control()

template<class Size>
boost::cb_details::capacity_control< Size >::capacity_control ( Size  capacity,
Size  min_capacity = 0 
)
inline

Constructor.

Member Function Documentation

◆ capacity()

template<class Size>
Size boost::cb_details::capacity_control< Size >::capacity ( ) const
inline

Get the capacity of the space optimized circular buffer.

◆ min_capacity()

template<class Size>
Size boost::cb_details::capacity_control< Size >::min_capacity ( ) const
inline

Get the minimal capacity of the space optimized circular buffer.

◆ operator Size()

template<class Size>
boost::cb_details::capacity_control< Size >::operator Size ( ) const
inline

Size operator - returns the capacity of the space optimized circular buffer.

Member Data Documentation

◆ m_capacity

template<class Size>
Size boost::cb_details::capacity_control< Size >::m_capacity
private

The capacity of the space optimized circular buffer.

◆ m_min_capacity

template<class Size>
Size boost::cb_details::capacity_control< Size >::m_min_capacity
private

The lowest guaranteed capacity of the adapted circular buffer.


The documentation for this struct was generated from the following file: