so_5::state_t::state_path_t Class Reference

Helper class for simplify iteration on state's path. More...

#include <state.hpp>

Public Member Functions
	state_path_t (const state_t &state) noexcept
	Initializing constructor.
	state_path_t (const state_path_t &)=delete
state_path_t &	operator= (const state_path_t &)=delete
	state_path_t (state_path_t &&)=delete
state_path_t &	operator= (state_path_t &&)=delete
state_t::path_t::const_iterator	begin () const noexcept
	Get iterator for the very first item of the path.
state_t::path_t::const_iterator	end () const noexcept
	Get the past-the-end iterator for the path.

Private Attributes
state_t::path_t	m_path
	Path for the state.
state_t::path_t::const_iterator	m_past_the_end_it

Detailed Description

Helper class for simplify iteration on state's path.

Usage example:

state_t::state_path_t path{ *m_current_state_ptr };
for( const state_t * st : path )
{
  ... // use of `st`
}

Attention

This class is not Copyable, nor Moveable.

Since

v.5.8.5

Definition at line 1840 of file state.hpp.

Constructor & Destructor Documentation

state_path_t() [1/3]

so_5::state_t::state_path_t::state_path_t ( const state_t & state )

inlineexplicitnoexcept

Initializing constructor.

Definition at line 1853 of file state.hpp.

state_path_t() [2/3]

so_5::state_t::state_path_t::state_path_t ( const state_path_t & )

delete

state_path_t() [3/3]

so_5::state_t::state_path_t::state_path_t ( state_path_t && )

delete

Member Function Documentation

begin()

state_t::path_t::const_iterator so_5::state_t::state_path_t::begin ( ) const

inlinenodiscardnoexcept

Get iterator for the very first item of the path.

Definition at line 1873 of file state.hpp.

end()

state_t::path_t::const_iterator so_5::state_t::state_path_t::end ( ) const

inlinenodiscardnoexcept

Get the past-the-end iterator for the path.

Definition at line 1881 of file state.hpp.

operator=() [1/2]

state_path_t & so_5::state_t::state_path_t::operator= ( const state_path_t & )

delete

operator=() [2/2]

state_path_t & so_5::state_t::state_path_t::operator= ( state_path_t && )

delete

Member Data Documentation

m_past_the_end_it

state_t::path_t::const_iterator so_5::state_t::state_path_t::m_past_the_end_it

private

Past-the-end iterator for the m_path.

Will be calculated in the constructor and won't be changed after that.

Definition at line 1849 of file state.hpp.

m_path

state_t::path_t so_5::state_t::state_path_t::m_path

private

Path for the state.

Definition at line 1843 of file state.hpp.

---

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

• state.hpp