Public Member Functions | Static Public Member Functions | List of all members
FlowSetPool Class Reference

FlowSetPool class to set external buffers as set of flows. More...

#include <cvb/driver/flow_set_pool.hpp>

Public Member Functions

 FlowSetPool (const std::vector< FlowInfo > &flowInfos, ProtectedTag) noexcept
 Flow set pool constructor.
 
virtual void PushBack (const std::vector< void * > &flowBuffers)
 Sets a flow to the flow set pool. More...
 
void push_back (const std::vector< void * > &flows)
 Sets a flow to the flow set pool. More...
 
size_t PoolSize () const noexcept
 Gets the size of the flow set pool. More...
 
void Reserve (int flowSets) noexcept
 Reserve flow sets in the flow set pool. More...
 
auto CBegin () const noexcept
 Iterator access. More...
 
auto Begin () noexcept
 Iterator access. More...
 
auto cbegin () const noexcept
 Iterator access. More...
 
auto begin () noexcept
 Iterator access. More...
 
auto CEnd () const noexcept
 Iterator access. More...
 
auto End () noexcept
 Iterator access. More...
 
auto cend () const noexcept
 Iterator access. More...
 
auto end () noexcept
 Iterator access. More...
 
auto CRBegin () const noexcept
 Iterator access. More...
 
auto RBegin () noexcept
 Iterator access. More...
 
auto crbegin () const noexcept
 Iterator access. More...
 
auto rbegin () noexcept
 Iterator access. More...
 
auto CREnd () const noexcept
 Iterator access. More...
 
auto REnd () const noexcept
 Iterator access. More...
 
auto crend () const noexcept
 Iterator access. More...
 
auto rend () noexcept
 Iterator access. More...
 

Static Public Member Functions

static FlowSetPoolPtr Create (const std::vector< FlowInfo > &flowInfos)
 Creates a new flow set pool. More...
 

Detailed Description

FlowSetPool class to set external buffers as set of flows.

Member Function Documentation

◆ Begin()

auto Begin ( )
inlinenoexcept

Iterator access.

Returns
An iterator for read/write access.
Exceptions
Doesnot throw any exception.

◆ begin()

auto begin ( )
inlinenoexcept

Iterator access.

Returns
An iterator for read/write access.
Exceptions
Doesnot throw any exception.

◆ CBegin()

auto CBegin ( ) const
inlinenoexcept

Iterator access.

Returns
An iterator for read only access.
Exceptions
Doesnot throw any exception.

◆ cbegin()

auto cbegin ( ) const
inlinenoexcept

Iterator access.

Returns
An iterator for read only access.
Exceptions
Doesnot throw any exception.

◆ CEnd()

auto CEnd ( ) const
inlinenoexcept

Iterator access.

Returns
An iterator for read only access.
Exceptions
Doesnot throw any exception.

◆ cend()

auto cend ( ) const
inlinenoexcept

Iterator access.

Returns
An iterator for read only access.
Exceptions
Doesnot throw any exception.

◆ CRBegin()

auto CRBegin ( ) const
inlinenoexcept

Iterator access.

Returns
A reverse iterator for read only access.
Exceptions
Doesnot throw any exception.

◆ crbegin()

auto crbegin ( ) const
inlinenoexcept

Iterator access.

Returns
A reverse iterator for read only access.
Exceptions
Doesnot throw any exception.

◆ Create()

static FlowSetPoolPtr Create ( const std::vector< FlowInfo > &  flowInfos)
inlinestatic

Creates a new flow set pool.

Parameters
[in]flowInfosFlow infos for creating flow set pool.
Returns
Shared pointer to newly created flow set pool.

◆ CREnd()

auto CREnd ( ) const
inlinenoexcept

Iterator access.

Returns
A reverse iterator for read only access.
Exceptions
Doesnot throw any exception.

◆ crend()

auto crend ( ) const
inlinenoexcept

Iterator access.

Returns
A reverse iterator for read only access.
Exceptions
Doesnot throw any exception.

◆ End()

auto End ( )
inlinenoexcept

Iterator access.

Returns
An iterator for read/write access.
Exceptions
Doesnot throw any exception.

◆ end()

auto end ( )
inlinenoexcept

Iterator access.

Returns
An iterator for read/write access.
Exceptions
Doesnot throw any exception.

◆ PoolSize()

size_t PoolSize ( ) const
inlinenoexcept

Gets the size of the flow set pool.

Returns
Size of the flow set pool

◆ push_back()

void push_back ( const std::vector< void * > &  flows)
inline

Sets a flow to the flow set pool.

Note
This method is for convenience only and calls PushBack().
Parameters
[in]flowsVector of flows which make up a single flow set entry.
Exceptions
Anyexception derived from std::exception including CvbException.

◆ PushBack()

virtual void PushBack ( const std::vector< void * > &  flowBuffers)
inlinevirtual

Sets a flow to the flow set pool.

Parameters
[in]flowBuffersVector of flow buffers which make up a single flow set.
Exceptions
Anyexception derived from std::exception including CvbException.

◆ RBegin()

auto RBegin ( )
inlinenoexcept

Iterator access.

Returns
A reverse iterator for read/write access.
Exceptions
Doesnot throw any exception.

◆ rbegin()

auto rbegin ( )
inlinenoexcept

Iterator access.

Returns
A reverse iterator for read/write access.
Exceptions
Doesnot throw any exception.

◆ REnd()

auto REnd ( ) const
inlinenoexcept

Iterator access.

Returns
A reverse iterator for read/write access.
Exceptions
Doesnot throw any exception.

◆ rend()

auto rend ( )
inlinenoexcept

Iterator access.

Returns
A reverse iterator for read/write access.
Exceptions
Doesnot throw any exception.

◆ Reserve()

void Reserve ( int  flowSets)
inlinenoexcept

Reserve flow sets in the flow set pool.

Parameters
[in]flowSetsNumber of flow sets to reserve.
Exceptions
Doesnot throw any exception.