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.
void	push_back (const std::vector< void * > &flows)
	Sets a flow to the flow set pool.
size_t	PoolSize () const noexcept
	Gets the size of the flow set pool.
void	Reserve (int flowSets) noexcept
	Reserve flow sets in the flow set pool.
auto	CBegin () const noexcept
	Iterator access.
auto	Begin () noexcept
	Iterator access.
auto	cbegin () const noexcept
	Iterator access.
auto	begin () noexcept
	Iterator access.
auto	begin () const noexcept
	Iterator access.
auto	CEnd () const noexcept
	Iterator access.
auto	End () noexcept
	Iterator access.
auto	cend () const noexcept
	Iterator access.
auto	end () noexcept
	Iterator access.
auto	end () const noexcept
	Iterator access.
auto	CRBegin () const noexcept
	Iterator access.
auto	RBegin () noexcept
	Iterator access.
auto	crbegin () const noexcept
	Iterator access.
auto	rbegin () noexcept
	Iterator access.
auto	CREnd () const noexcept
	Iterator access.
auto	REnd () const noexcept
	Iterator access.
auto	crend () const noexcept
	Iterator access.
auto	rend () noexcept
	Iterator access.

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

Detailed Description

FlowSetPool class to set external buffers as set of flows.

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

Does	not throw any exception.

begin() [1/2]

auto begin ( ) const

inlinenoexcept

Iterator access.

Returns

An iterator for read access.

Exceptions

Does	not throw any exception.

begin() [2/2]

auto begin ( )

inlinenoexcept

Iterator access.

Returns

An iterator for read/write access.

Exceptions

Does	not throw any exception.

CBegin()

auto CBegin ( ) const

inlinenoexcept

Iterator access.

Returns

An iterator for read only access.

Exceptions

Does	not throw any exception.

cbegin()

auto cbegin ( ) const

inlinenoexcept

Iterator access.

Returns

An iterator for read only access.

Exceptions

Does	not throw any exception.

CEnd()

auto CEnd ( ) const

inlinenoexcept

Iterator access.

Returns

An iterator for read only access.

Exceptions

Does	not throw any exception.

cend()

auto cend ( ) const

inlinenoexcept

Iterator access.

Returns

An iterator for read only access.

Exceptions

Does	not throw any exception.

CRBegin()

auto CRBegin ( ) const

inlinenoexcept

Iterator access.

Returns

A reverse iterator for read only access.

Exceptions

Does	not throw any exception.

crbegin()

auto crbegin ( ) const

inlinenoexcept

Iterator access.

Returns

A reverse iterator for read only access.

Exceptions

Does	not throw any exception.

Create()

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

inlinestatic

Creates a new flow set pool.

Parameters

[in]

flowInfos

Flow 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

Does	not throw any exception.

crend()

auto crend ( ) const

inlinenoexcept

Iterator access.

Returns

A reverse iterator for read only access.

Exceptions

Does	not throw any exception.

End()

auto End ( )

inlinenoexcept

Iterator access.

Returns

An iterator for read/write access.

Exceptions

Does	not throw any exception.

end() [1/2]

auto end ( ) const

inlinenoexcept

Iterator access.

Returns

An iterator for read access.

Exceptions

Does	not throw any exception.

end() [2/2]

auto end ( )

inlinenoexcept

Iterator access.

Returns

An iterator for read/write access.

Exceptions

Does	not 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]

flows

Vector of flows which make up a single flow set entry.

Exceptions

Any	exception 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]

flowBuffers

Vector of flow buffers which make up a single flow set.

Exceptions

Any	exception derived from std::exception including CvbException.

RBegin()

auto RBegin ( )

inlinenoexcept

Iterator access.

Returns

A reverse iterator for read/write access.

Exceptions

Does	not throw any exception.

rbegin()

auto rbegin ( )

inlinenoexcept

Iterator access.

Returns

A reverse iterator for read/write access.

Exceptions

Does	not throw any exception.

REnd()

auto REnd ( ) const

inlinenoexcept

Iterator access.

Returns

A reverse iterator for read/write access.

Exceptions

Does	not throw any exception.

rend()

auto rend ( )

inlinenoexcept

Iterator access.

Returns

A reverse iterator for read/write access.

Exceptions

Does	not throw any exception.

Reserve()

void Reserve ( int flowSets )

inlinenoexcept

Reserve flow sets in the flow set pool.

Parameters

[in]

flowSets

Number of flow sets to reserve.

Exceptions

Does	not throw any exception.