Testvs19::ListSectionsFlow< T > Class Template Reference

List of physical objects under study. More...

#include <Testvs19_ListSectionsFlow.hpp>

Inheritance diagram for Testvs19::ListSectionsFlow< T >:

Public Types
using	listIter = std::vector<T>::iterator
	Aliases.
using	clistIter = std::vector<T>::const_iterator
using	size_type = std::vector<T>::size_type
using	value_type = std::iter_value_t<listIter>

Public Member Functions
listIter	begin ()
	helpers to iterate (begin to end)
listIter	end ()
clistIter	cbegin () const
clistIter	cend () const
void	flush () override final
	empty the list
void	putInFront (const T aData) override final
	add element in the fron
void	append (const T aData) override final
	add an element at the end
void	delFromFront () override final
	delete elemenmt starting beginning
const T &	getFirst () const override final
	return first element in the list
T &	getFirst () override final
const T &	getLast () const override final
	return last element in the list
T &	getLast () override final
bool	isEmpty () const override final
	check if list conatains element
size_type	size () const
	number of elements in the list
void	reserve (size_t aCapacity) noexcept
	allocate memory to store data
void	shrinkToFit () noexcept
	shrink list to fit size
bool	isAllSectionsUnitWidth () const noexcept
	check if all sections are unit width
bool	isAllSectionsFrictionLess () const noexcept
	check if all sections are frictionless
bool	isAllSectionsFlatBottom () const noexcept
	check if all sections have flat bottom

Private Attributes
std::vector< T >	m_listPhysObj

Friends
class	ListSectionsIterator< T >
	friend class ListSectionsIterator

Detailed Description

template<typename T>
class Testvs19::ListSectionsFlow< T >

List of physical objects under study.

Template Parameters

T	physical object

Member Typedef Documentation

clistIter

template<typename T>

using Testvs19::ListSectionsFlow< T >::clistIter = std::vector<T>::const_iterator

listIter

template<typename T>

using Testvs19::ListSectionsFlow< T >::listIter = std::vector<T>::iterator

Aliases.

size_type

template<typename T>

using Testvs19::ListSectionsFlow< T >::size_type = std::vector<T>::size_type

value_type

template<typename T>

using Testvs19::ListSectionsFlow< T >::value_type = std::iter_value_t<listIter>

Member Function Documentation

append()

template<typename T>

void Testvs19::ListSectionsFlow< T >::append ( const T aData )

inlinefinaloverride

add an element at the end

Parameters

aData

element to sdd

begin()

template<typename T>

listIter Testvs19::ListSectionsFlow< T >::begin ( )

inline

helpers to iterate (begin to end)

Returns

cbegin()

template<typename T>

clistIter Testvs19::ListSectionsFlow< T >::cbegin ( ) const

inline

cend()

template<typename T>

clistIter Testvs19::ListSectionsFlow< T >::cend ( ) const

inline

delFromFront()

template<typename T>

void Testvs19::ListSectionsFlow< T >::delFromFront ( )

inlinefinaloverride

delete elemenmt starting beginning

end()

template<typename T>

listIter Testvs19::ListSectionsFlow< T >::end ( )

inline

flush()

template<typename T>

void Testvs19::ListSectionsFlow< T >::flush ( )

inlinefinaloverride

empty the list

getFirst() [1/2]

template<typename T>

const T & Testvs19::ListSectionsFlow< T >::getFirst ( ) const

inlinefinaloverride

return first element in the list

Returns

first data

getFirst() [2/2]

template<typename T>

T & Testvs19::ListSectionsFlow< T >::getFirst ( )

inlinefinaloverride

getLast() [1/2]

template<typename T>

const T & Testvs19::ListSectionsFlow< T >::getLast ( ) const

inlinefinaloverride

return last element in the list

Returns

last data

getLast() [2/2]

template<typename T>

T & Testvs19::ListSectionsFlow< T >::getLast ( )

inlinefinaloverride

isAllSectionsFlatBottom()

template<typename T>

bool Testvs19::ListSectionsFlow< T >::isAllSectionsFlatBottom ( ) const

inlinenoexcept

check if all sections have flat bottom

Returns

true/false

isAllSectionsFrictionLess()

template<typename T>

bool Testvs19::ListSectionsFlow< T >::isAllSectionsFrictionLess ( ) const

inlinenoexcept

check if all sections are frictionless

Returns

true/false

isAllSectionsUnitWidth()

template<typename T>

bool Testvs19::ListSectionsFlow< T >::isAllSectionsUnitWidth ( ) const

inlinenoexcept

check if all sections are unit width

Returns

true/false

isEmpty()

template<typename T>

bool Testvs19::ListSectionsFlow< T >::isEmpty ( ) const

inlinenodiscardfinaloverride

check if list conatains element

Returns

true/false

putInFront()

template<typename T>

void Testvs19::ListSectionsFlow< T >::putInFront ( const T aData )

inlinefinaloverride

add element in the fron

Parameters

aData

element to add

reserve()

template<typename T>

void Testvs19::ListSectionsFlow< T >::reserve ( size_t aCapacity )

inlinenoexcept

allocate memory to store data

Parameters

aCapacity

number element

shrinkToFit()

template<typename T>

void Testvs19::ListSectionsFlow< T >::shrinkToFit ( )

inlinenoexcept

shrink list to fit size

size()

template<typename T>

size_type Testvs19::ListSectionsFlow< T >::size ( ) const

inline

number of elements in the list

Returns

number of elements

Friends And Related Symbol Documentation

ListSectionsIterator< T >

template<typename T>

friend class ListSectionsIterator< T >

friend

friend class ListSectionsIterator

Member Data Documentation

m_listPhysObj

template<typename T>

std::vector<T> Testvs19::ListSectionsFlow< T >::m_listPhysObj

private

---

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

• DamBreakSimulator/Nov_VS2019/PhysicsAlgorithm/Testvs19_ListSectionsFlow.hpp