ObservePointAccessor Class Reference

Point accessor allow iterate over local Observe points. More...

#include <observe.hh>

Collaboration diagram for ObservePointAccessor:

Public Member Functions
	ObservePointAccessor ()
	Default invalid accessor. More...
	ObservePointAccessor (const Observe *observe, unsigned int loc_idx)
unsigned int	local_idx () const
	Return local index to point. More...
unsigned int	global_idx () const
	Return global index to point. More...
const ObservePoint	observe_point () const
	Return ElementAccessor to element of loc_ele_idx_. More...
unsigned int	loc_point_time_index () const
	Return local index in data cache (combination of local point index and index of stored time) More...
bool	is_valid () const
	Check validity of accessor (see default constructor) More...
void	inc ()
	Iterates to next local point. More...
bool	operator== (const ObservePointAccessor &other)
	Comparison of accessors. More...

Protected Attributes
const Observe *	observe_
	Pointer to the Observe owning the point. More...
unsigned int	loc_point_idx_
	Index into Observe::point_4_loc_ array. More...

Detailed Description

Point accessor allow iterate over local Observe points.

Iterator is defined by:

• Observe object
• local index of observe point (iterated value)

Definition at line 372 of file observe.hh.

Constructor & Destructor Documentation

ObservePointAccessor() [1/2]

ObservePointAccessor::ObservePointAccessor ( )

inline

Default invalid accessor.

Definition at line 375 of file observe.hh.

ObservePointAccessor() [2/2]

ObservePointAccessor::ObservePointAccessor ( const Observe *  observe, unsigned int  loc_idx  )

inline

Observe point accessor.

Definition at line 382 of file observe.hh.

Member Function Documentation

global_idx()

unsigned int ObservePointAccessor::global_idx ( ) const

inline

Return global index to point.

Definition at line 392 of file observe.hh.

Here is the caller graph for this function:

inc()

void ObservePointAccessor::inc ( )

inline

Iterates to next local point.

Definition at line 412 of file observe.hh.

is_valid()

bool ObservePointAccessor::is_valid ( ) const

inline

Check validity of accessor (see default constructor)

Definition at line 407 of file observe.hh.

loc_point_time_index()

unsigned int ObservePointAccessor::loc_point_time_index ( ) const

inline

Return local index in data cache (combination of local point index and index of stored time)

Definition at line 402 of file observe.hh.

Here is the caller graph for this function:

local_idx()

unsigned int ObservePointAccessor::local_idx ( ) const

inline

Return local index to point.

Definition at line 387 of file observe.hh.

observe_point()

const ObservePoint ObservePointAccessor::observe_point ( ) const

inline

Return ElementAccessor to element of loc_ele_idx_.

Definition at line 397 of file observe.hh.

operator==()

bool ObservePointAccessor::operator== ( const ObservePointAccessor &  other )

inline

Comparison of accessors.

Definition at line 417 of file observe.hh.

Member Data Documentation

loc_point_idx_

unsigned int ObservePointAccessor::loc_point_idx_

protected

Index into Observe::point_4_loc_ array.

Definition at line 425 of file observe.hh.

observe_

const Observe* ObservePointAccessor::observe_

protected

Pointer to the Observe owning the point.

Definition at line 423 of file observe.hh.

---

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

• /home/runner/work/flow123d/flow123d/src/io/observe.hh