dbpp::ListSectionsFlow Class Reference

List of cross-section flow (itereable) More...

#include <dbpp_ListSectionsFlow.h>

Public Types
using	vec_sizetype = std::vector<SectionFlow>::size_type
	Aliases.
using	vec_valtype = std::vector<SectionFlow>::value_type
using	vec_iter = std::vector<SectionFlow>::iterator
using	vec_citer = std::vector<SectionFlow>::const_iterator
using	vec_riter = std::reverse_iterator<vec_iter>
using	vec_rciter = std::reverse_iterator<vec_citer>

Public Member Functions
vec_iter	begin ()
vec_iter	end ()
vec_riter	rbegin ()
vec_riter	rend ()
vec_citer	cbegin () const
vec_citer	cend () const
vec_rciter	crbegin () const
vec_rciter	crend () const
void	push_back (const SectionFlow &aSectF)
void	push_back (SectionFlow &&aSectF)
bool	contains (SectionFlow aSectF2Find)
void	clear ()
	Empty list.
SectionFlow &	operator[] (vec_sizetype aIdx)
const SectionFlow &	operator[] (vec_sizetype aIdx) const
bool	isEmpty () const noexcept
vec_sizetype	size () const noexcept
void	shrink2Fit ()
std::vector< SectionFlow >	getList () const noexcept
const SectionFlow &	front () const
const SectionFlow &	back () const
void	reserve (vec_sizetype aSize)
bool	isFrictionLess () const
bool	isFlatBed () const
bool	isUnitWidth () const
std::map< unsigned, float64 >	getSectionsManning () const
std::map< unsigned, float64 >	getSectionsBathymetry () const
std::map< unsigned, double >	getSectionsWaterLevel () const

Private Attributes
std::vector< SectionFlow >	m_listSectionsFlow

Detailed Description

List of cross-section flow (itereable)

Member Typedef Documentation

vec_citer

using dbpp::ListSectionsFlow::vec_citer = std::vector<SectionFlow>::const_iterator

vec_iter

using dbpp::ListSectionsFlow::vec_iter = std::vector<SectionFlow>::iterator

vec_rciter

using dbpp::ListSectionsFlow::vec_rciter = std::reverse_iterator<vec_citer>

vec_riter

using dbpp::ListSectionsFlow::vec_riter = std::reverse_iterator<vec_iter>

vec_sizetype

using dbpp::ListSectionsFlow::vec_sizetype = std::vector<SectionFlow>::size_type

Aliases.

vec_valtype

using dbpp::ListSectionsFlow::vec_valtype = std::vector<SectionFlow>::value_type

Member Function Documentation

back()

const SectionFlow & dbpp::ListSectionsFlow::back ( ) const

inline

Returns

begin()

vec_iter dbpp::ListSectionsFlow::begin ( )

inline

cbegin()

vec_citer dbpp::ListSectionsFlow::cbegin ( ) const

inline

cend()

vec_citer dbpp::ListSectionsFlow::cend ( ) const

inline

clear()

void dbpp::ListSectionsFlow::clear ( )

inline

Empty list.

contains()

bool dbpp::ListSectionsFlow::contains ( SectionFlow aSectF2Find )

inline

Parameters

aSectF2Find

Returns

crbegin()

vec_rciter dbpp::ListSectionsFlow::crbegin ( ) const

inline

crend()

vec_rciter dbpp::ListSectionsFlow::crend ( ) const

inline

end()

vec_iter dbpp::ListSectionsFlow::end ( )

inline

front()

const SectionFlow & dbpp::ListSectionsFlow::front ( ) const

inline

Returns

getList()

std::vector< SectionFlow > dbpp::ListSectionsFlow::getList ( ) const

inlinenoexcept

Returns

getSectionsBathymetry()

std::map< unsigned, float64 > dbpp::ListSectionsFlow::getSectionsBathymetry ( ) const

inline

Returns

getSectionsManning()

std::map< unsigned, float64 > dbpp::ListSectionsFlow::getSectionsManning ( ) const

inline

Returns

getSectionsWaterLevel()

std::map< unsigned, double > dbpp::ListSectionsFlow::getSectionsWaterLevel ( ) const

inline

Returns

isEmpty()

bool dbpp::ListSectionsFlow::isEmpty ( ) const

inlinenodiscardnoexcept

Returns

isFlatBed()

bool dbpp::ListSectionsFlow::isFlatBed ( ) const

inline

return if all sections are flat bed

isFrictionLess()

bool dbpp::ListSectionsFlow::isFrictionLess ( ) const

inline

return if all sections are frictionless

isUnitWidth()

bool dbpp::ListSectionsFlow::isUnitWidth ( ) const

inline

returns f all sections are unit width

operator[]() [1/2]

SectionFlow & dbpp::ListSectionsFlow::operator[] ( vec_sizetype aIdx )

inline

operator[]() [2/2]

const SectionFlow & dbpp::ListSectionsFlow::operator[] ( vec_sizetype aIdx ) const

inline

push_back() [1/2]

void dbpp::ListSectionsFlow::push_back ( const SectionFlow & aSectF )

inline

pass by pointer since we want a reference semantic we are not using the boost concept pointer container or even the smart pointer (shared pointer C++11) ??

push_back() [2/2]

void dbpp::ListSectionsFlow::push_back ( SectionFlow && aSectF )

inline

Parameters

aSectF

rbegin()

vec_riter dbpp::ListSectionsFlow::rbegin ( )

inline

rend()

vec_riter dbpp::ListSectionsFlow::rend ( )

inline

reserve()

void dbpp::ListSectionsFlow::reserve ( vec_sizetype aSize )

inline

Parameters

aSize

shrink2Fit()

void dbpp::ListSectionsFlow::shrink2Fit ( )

inline

size()

vec_sizetype dbpp::ListSectionsFlow::size ( ) const

inlinenoexcept

Returns

Member Data Documentation

m_listSectionsFlow

std::vector<SectionFlow> dbpp::ListSectionsFlow::m_listSectionsFlow

private

---

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

• DamBreakSimulator/Nov_VS2019/dbpp_ListSectionsFlow.h