vitrio::image_location_grouping::group Class Reference

The locations of one file in an image_location_grouping. More...

#include <vitrio/image_location_grouping.hpp>

Public Member Functions
const std::string &	get_key () const noexcept
	Get the key of the file.
bool	is_whole () const noexcept
	Check whether any location addresses the file as a whole.
span< const std::size_t >	get_indices () const noexcept
	Get the stack indices of the locations of the file.

Friends
class	image_location_grouping

Detailed Description

The locations of one file in an image_location_grouping.

A group refers to storage owned by its grouping, so it can be used only while the grouping is alive and has not been assigned to.

Member Function Documentation

get_indices()

span< const std::size_t > vitrio::image_location_grouping::group::get_indices ( ) const

noexcept

Get the stack indices of the locations of the file.

Returns

span<const std::size_t> The indices, in ascending order and without repeats. Empty if the file is addressed as a whole.

get_key()

const std::string & vitrio::image_location_grouping::group::get_key ( ) const

noexcept

Get the key of the file.

Returns

const std::string& The key.

is_whole()

bool vitrio::image_location_grouping::group::is_whole ( ) const

noexcept

Check whether any location addresses the file as a whole.

Returns

true At least one location of the file has no stack index.

false All locations of the file have a stack index.

---

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

• vitrio/image_location_grouping.hpp