Metall: metall::anonymous_object_attr_accessor< _offset_type, _size_type > Class Template Reference

Metall v0.28

A persistent memory allocator for data-centric analytics

#include </home/runner/work/metall/metall/include/metall/object_attribute_accessor.hpp>

Public Types
using	size_type = typename object_directory_type::size_type

using	name_type = typename object_directory_type::name_type

using	offset_type = typename object_directory_type::offset_type

using	length_type = typename object_directory_type::length_type

using	description_type = typename object_directory_type::description_type

using	const_iterator = typename object_directory_type::const_iterator

Public Member Functions
	anonymous_object_attr_accessor () noexcept=default

	anonymous_object_attr_accessor (const std::string &object_attribute_file_path) noexcept

	anonymous_object_attr_accessor (const anonymous_object_attr_accessor &other) noexcept

	anonymous_object_attr_accessor (anonymous_object_attr_accessor &&) noexcept=default

anonymous_object_attr_accessor &	operator= (const anonymous_object_attr_accessor &other) noexcept

anonymous_object_attr_accessor &	operator= (anonymous_object_attr_accessor &&) noexcept=default

bool	good () const noexcept
	Returns if the internal state is good. More...

size_type	num_objects () const noexcept
	Returns the number of objects in the directory. More...

const_iterator	begin () const noexcept
	Returns a const iterator that points the beginning of stored object attribute. More...

const_iterator	end () const noexcept
	Returns a const iterator that points the end of stored object attribute. More...

bool	set_description (const_iterator position, const description_type &description) noexcept
	Sets an description. An existing one is overwrite. More...

Detailed Description

template<typename _offset_type, typename _size_type>
class metall::anonymous_object_attr_accessor< _offset_type, _size_type >

Template Parameters

_offset_type
_size_type

Member Typedef Documentation

◆ size_type

template<typename _offset_type , typename _size_type >

using metall::anonymous_object_attr_accessor< _offset_type, _size_type >::size_type = typename object_directory_type::size_type

◆ name_type

template<typename _offset_type , typename _size_type >

using metall::anonymous_object_attr_accessor< _offset_type, _size_type >::name_type = typename object_directory_type::name_type

◆ offset_type

template<typename _offset_type , typename _size_type >

using metall::anonymous_object_attr_accessor< _offset_type, _size_type >::offset_type = typename object_directory_type::offset_type

◆ length_type

template<typename _offset_type , typename _size_type >

using metall::anonymous_object_attr_accessor< _offset_type, _size_type >::length_type = typename object_directory_type::length_type

◆ description_type

template<typename _offset_type , typename _size_type >

using metall::anonymous_object_attr_accessor< _offset_type, _size_type >::description_type = typename object_directory_type::description_type

◆ const_iterator

template<typename _offset_type , typename _size_type >

using metall::anonymous_object_attr_accessor< _offset_type, _size_type >::const_iterator = typename object_directory_type::const_iterator

Constructor & Destructor Documentation

◆ anonymous_object_attr_accessor() [1/4]

template<typename _offset_type , typename _size_type >

metall::anonymous_object_attr_accessor< _offset_type, _size_type >::anonymous_object_attr_accessor ( )

defaultnoexcept

◆ anonymous_object_attr_accessor() [2/4]

template<typename _offset_type , typename _size_type >

metall::anonymous_object_attr_accessor< _offset_type, _size_type >::anonymous_object_attr_accessor ( const std::string & object_attribute_file_path )

inlineexplicitnoexcept

◆ anonymous_object_attr_accessor() [3/4]

template<typename _offset_type , typename _size_type >

metall::anonymous_object_attr_accessor< _offset_type, _size_type >::anonymous_object_attr_accessor ( const anonymous_object_attr_accessor< _offset_type, _size_type > & other )

inlinenoexcept

◆ anonymous_object_attr_accessor() [4/4]

template<typename _offset_type , typename _size_type >

metall::anonymous_object_attr_accessor< _offset_type, _size_type >::anonymous_object_attr_accessor ( anonymous_object_attr_accessor< _offset_type, _size_type > && )

defaultnoexcept

Member Function Documentation

◆ operator=() [1/2]

template<typename _offset_type , typename _size_type >

anonymous_object_attr_accessor& metall::anonymous_object_attr_accessor< _offset_type, _size_type >::operator= ( const anonymous_object_attr_accessor< _offset_type, _size_type > & other )

inlinenoexcept

◆ operator=() [2/2]

template<typename _offset_type , typename _size_type >

anonymous_object_attr_accessor& metall::anonymous_object_attr_accessor< _offset_type, _size_type >::operator= ( anonymous_object_attr_accessor< _offset_type, _size_type > && )

defaultnoexcept

◆ good()

template<typename _offset_type , typename _size_type >

bool metall::anonymous_object_attr_accessor< _offset_type, _size_type >::good ( ) const

inlinenoexcept

Returns if the internal state is good.

Returns: Returns true if good; otherwise, false.

◆ num_objects()

template<typename _offset_type , typename _size_type >

size_type metall::anonymous_object_attr_accessor< _offset_type, _size_type >::num_objects ( ) const

inlinenoexcept

Returns the number of objects in the directory.

Returns: Returns the number of objects in the directory.

◆ begin()

template<typename _offset_type , typename _size_type >

const_iterator metall::anonymous_object_attr_accessor< _offset_type, _size_type >::begin ( ) const

inlinenoexcept

Returns a const iterator that points the beginning of stored object attribute.

Returns: Returns a const iterator that points the beginning of stored object attribute.

◆ end()

template<typename _offset_type , typename _size_type >

const_iterator metall::anonymous_object_attr_accessor< _offset_type, _size_type >::end ( ) const

inlinenoexcept

Returns a const iterator that points the end of stored object attribute.

Returns: Returns a const iterator that points the end of stored object attribute.

◆ set_description()

template<typename _offset_type , typename _size_type >

bool metall::anonymous_object_attr_accessor< _offset_type, _size_type >::set_description	(	const_iterator	position,
		const description_type &	description
	)

inlinenoexcept

Sets an description. An existing one is overwrite.

Parameters

position	An iterator to an object.
description	A description string in description_type.

Returns: Returns true if a description is set (stored) successfully. Otherwise, false.

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

/home/runner/work/metall/metall/include/metall/object_attribute_accessor.hpp