from::param::param_table< ParamType > Class Template Reference

An interface to a param table of one of the predefined types. More...

#include <param_table.hpp>

Public Types
using	paramdef_type = typename ParamType::paramdef_type
	The paramdefs this param type uses.
using	iterator = param_iterator< paramdef_type >
	Param iterator type.
using	reverse_iterator = std::reverse_iterator< iterator >
	Reverse order param iterator type.
using	const_iterator = param_const_iterator< paramdef_type >
	Param const iterator type.
using	const_reverse_iterator = std::reverse_iterator< const_iterator >
	Reverse order param const iterator type.

Public Member Functions
std::pair< paramdef_type &, bool >	operator[] (row_index_type row) const noexcept
	Get a param row from this param table by its row index.
iterator	begin () noexcept
	Get the iterator to the first param row in the table.
iterator	end () noexcept
	Get the iterator after the last param row in the table.
const_iterator	begin () const noexcept
	Get the iterator to the first param row in the table.
const_iterator	end () const noexcept
	Get the iterator after the last param row in the table.
const_iterator	cbegin () const noexcept
	Get the const iterator to the first param row in the table.
const_iterator	cend () const noexcept
	Get the const iterator after the last param row in the table.
reverse_iterator	rbegin () noexcept
	Get the reverse iterator to the last param row in the table.
reverse_iterator	rend () noexcept
	Get the reverse iterator before the first param row in the table.
const_reverse_iterator	rbegin () const noexcept
	Get the reverse iterator to the last param row in the table.
const_reverse_iterator	rend () const noexcept
	Get the reverse iterator before the first param row in the table.
const_reverse_iterator	crbegin () const noexcept
	Get the reverse iterator to the last param row in the table.
const_reverse_iterator	crend () const noexcept
	Get the reverse iterator before the first param row in the table.

Static Public Attributes
static constexpr param_index	index = ParamType::index
	The param index of this param table.

Detailed Description

template<typename ParamType>
class from::param::param_table< ParamType >

An interface to a param table of one of the predefined types.

Template Parameters

ParamType

one of the predefined param types

Member Function Documentation

begin() [1/2]

template<typename ParamType >

const_iterator from::param::param_table< ParamType >::begin ( ) const

inlinenoexcept

Get the iterator to the first param row in the table.

If the table has not been yet initialized, returns a default constructed iterator.

Returns

const_iterator an iterator to the first param row or a default constructed iterator

begin() [2/2]

template<typename ParamType >

iterator from::param::param_table< ParamType >::begin ( )

inlinenoexcept

Get the iterator to the first param row in the table.

If the table has not been yet initialized, returns a default constructed iterator.

Returns

iterator an iterator to the first param row or a default constructed iterator

cbegin()

template<typename ParamType >

const_iterator from::param::param_table< ParamType >::cbegin ( ) const

inlinenoexcept

Get the const iterator to the first param row in the table.

If the table has not been yet initialized, returns a default constructed iterator.

Returns

const_iterator an iterator to the first param row or a default constructed iterator

cend()

template<typename ParamType >

const_iterator from::param::param_table< ParamType >::cend ( ) const

inlinenoexcept

Get the const iterator after the last param row in the table.

If the table has not been yet initialized, returns a default constructed iterator.

Returns

const iterator an iterator past the end of the param table or a default constructed iterator

crbegin()

template<typename ParamType >

const_reverse_iterator from::param::param_table< ParamType >::crbegin ( ) const

inlinenoexcept

Get the reverse iterator to the last param row in the table.

If the table has not been yet initialized, returns a default constructed iterator.

Returns

const_reverse_iterator an iterator to the last param row or a default constructed iterator

crend()

template<typename ParamType >

const_reverse_iterator from::param::param_table< ParamType >::crend ( ) const

inlinenoexcept

Get the reverse iterator before the first param row in the table.

If the table has not been yet initialized, returns a default constructed iterator.

Returns

const_reverse_iterator an iterator before the start of the param table or a default constructed iterator

end() [1/2]

template<typename ParamType >

const_iterator from::param::param_table< ParamType >::end ( ) const

inlinenoexcept

Get the iterator after the last param row in the table.

If the table has not been yet initialized, returns a default constructed iterator.

Returns

const_iterator an iterator past the end of the param table or a default constructed iterator

end() [2/2]

template<typename ParamType >

iterator from::param::param_table< ParamType >::end ( )

inlinenoexcept

Get the iterator after the last param row in the table.

If the table has not been yet initialized, returns a default constructed iterator.

Returns

iterator an iterator past the end of the param table or a default constructed iterator

operator[]()

template<typename ParamType >

std::pair< paramdef_type &, bool > from::param::param_table< ParamType >::operator[] ( row_index_type  row ) const

inlinenoexcept

Get a param row from this param table by its row index.

Performs a binary search on the param table to find a matching param row index and returns the row on success. If the desired param row does not exist, returns a default-initialized param row instead.

The bool in the param row/bool pair indicates whether the row exists.

Example:

auto [row, row_exists] =
   from::param::EquipParamAccessory[5020]; 

Parameters

row	The row id.

Returns

std::pair<paramdef_type&, bool>

rbegin() [1/2]

template<typename ParamType >

const_reverse_iterator from::param::param_table< ParamType >::rbegin ( ) const

inlinenoexcept

Get the reverse iterator to the last param row in the table.

If the table has not been yet initialized, returns a default constructed iterator.

Returns

const_reverse_iterator an iterator to the last param row or a default constructed iterator

rbegin() [2/2]

template<typename ParamType >

reverse_iterator from::param::param_table< ParamType >::rbegin ( )

inlinenoexcept

Get the reverse iterator to the last param row in the table.

If the table has not been yet initialized, returns a default constructed iterator.

Returns

reverse_iterator an iterator to the last param row or a default constructed iterator

rend() [1/2]

template<typename ParamType >

const_reverse_iterator from::param::param_table< ParamType >::rend ( ) const

inlinenoexcept

Get the reverse iterator before the first param row in the table.

If the table has not been yet initialized, returns a default constructed iterator.

Returns

const_reverse_iterator an iterator before the start of the param table or a default constructed iterator

rend() [2/2]

template<typename ParamType >

reverse_iterator from::param::param_table< ParamType >::rend ( )

inlinenoexcept

Get the reverse iterator before the first param row in the table.

If the table has not been yet initialized, returns a default constructed iterator.

Returns

reverse_iterator an iterator before the start of the param table or a default constructed iterator

---

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

• include/param/param_table.hpp