FieldListAccessor Class Reference

#include <field_set.hh>

Collaboration diagram for FieldListAccessor:

Public Member Functions
	FieldListAccessor ()
	Default constructor. More...
	FieldListAccessor (std::vector< FieldCommon * > field_list, unsigned int field_idx)
	Constructor. More...
void	inc ()
	Iterates to next Field. More...
unsigned int	field_idx () const
	Getter for field_idx_. More...
unsigned int	field_component_idx () const
	Getter for field_component_idx_. More...
FieldCommon *	field () const
	Returns pointer to actual field held by accessor. More...
bool	operator== (const FieldListAccessor &other)
	Comparison of accessors. More...
bool	operator!= (const FieldListAccessor &other) const
FieldCommon *	operator-> () const
	Dereference operator simplify access to actual field held by accessor. More...

Private Attributes
std::vector< FieldCommon * >	field_list_
	List of FieldCommon objects (combine Fields and MultiFields. More...
unsigned int	field_idx_
	Index of actual Field in field_list. More...
unsigned int	field_component_idx_
	Index of subfield in MultiField (fo fields hold only value 0 that is not used) More...

Detailed Description

Accessor to vector of Fields holds in FieldSet.

Class holds position to vector and allows iterate through all instances of Field class and all components (SubFields) of MultiFields.

Base methods:

• inc() - increment to next Field instance: Field - iterates to next item in field list MultiFields - iterates to next component of MultiField or if actual position is last component jumps to next item in field list
• operator ->() - returns pointer to actual Field.

Definition at line 62 of file field_set.hh.

Constructor & Destructor Documentation

FieldListAccessor() [1/2]

FieldListAccessor::FieldListAccessor ( )

inline

Default constructor.

Definition at line 65 of file field_set.hh.

FieldListAccessor() [2/2]

FieldListAccessor::FieldListAccessor ( std::vector< FieldCommon * >  field_list, unsigned int  field_idx  )

inline

Constructor.

Definition at line 69 of file field_set.hh.

Member Function Documentation

field()

FieldCommon* FieldListAccessor::field ( ) const

inline

Returns pointer to actual field held by accessor.

Definition at line 96 of file field_set.hh.

field_component_idx()

unsigned int FieldListAccessor::field_component_idx ( ) const

inline

Getter for field_component_idx_.

Definition at line 91 of file field_set.hh.

field_idx()

unsigned int FieldListAccessor::field_idx ( ) const

inline

Getter for field_idx_.

Definition at line 86 of file field_set.hh.

inc()

void FieldListAccessor::inc ( )

inline

Iterates to next Field.

Definition at line 73 of file field_set.hh.

operator!=()

bool FieldListAccessor::operator!= ( const FieldListAccessor &  other ) const

inline

Definition at line 108 of file field_set.hh.

operator->()

FieldCommon* FieldListAccessor::operator-> ( ) const

inline

Dereference operator simplify access to actual field held by accessor.

Definition at line 113 of file field_set.hh.

operator==()

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

inline

Comparison of accessors.

Definition at line 104 of file field_set.hh.

Member Data Documentation

field_component_idx_

unsigned int FieldListAccessor::field_component_idx_

private

Index of subfield in MultiField (fo fields hold only value 0 that is not used)

Definition at line 123 of file field_set.hh.

field_idx_

unsigned int FieldListAccessor::field_idx_

private

Index of actual Field in field_list.

Definition at line 122 of file field_set.hh.

field_list_

std::vector<FieldCommon *> FieldListAccessor::field_list_

private

List of FieldCommon objects (combine Fields and MultiFields.

Definition at line 121 of file field_set.hh.

---

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

• /home/runner/work/flow123d/flow123d/src/fields/field_set.hh