Base class for any type of record (e.g. More...

#include <BaseRecord.hpp>

Inheritance diagram for openPMD::BaseRecord< T_elem >:

Public Types
using	T_RecordComponent = T_elem

using	T_Container = Container<T_elem>

using	key_type = typename Container<T_elem>::key_type

using	mapped_type = typename Container<T_elem>::mapped_type

using	value_type = typename Container<T_elem>::value_type

using	size_type = typename Container<T_elem>::size_type

using	difference_type = typename Container<T_elem>::difference_type

using	allocator_type = typename Container<T_elem>::allocator_type

using	reference = typename Container<T_elem>::reference

using	const_reference = typename Container<T_elem>::const_reference

using	pointer = typename Container<T_elem>::pointer

using	const_pointer = typename Container<T_elem>::const_pointer

using	iterator

using	const_iterator

using	reverse_iterator

using	const_reverse_iterator

Public Types inherited from openPMD::Container< T_elem >
using	key_type

using	mapped_type

using	value_type

using	size_type

using	difference_type

using	allocator_type

using	reference

using	const_reference

using	pointer

using	const_pointer

using	iterator

using	const_iterator

using	reverse_iterator

using	const_reverse_iterator

using	key_type

using	mapped_type

using	value_type

using	size_type

using	difference_type

using	allocator_type

using	reference

using	const_reference

using	pointer

using	const_pointer

using	iterator

using	const_iterator

using	reverse_iterator

using	const_reverse_iterator

Public Member Functions
iterator	begin ()

const_iterator	begin () const

const_iterator	cbegin () const

iterator	end ()

const_iterator	end () const

const_iterator	cend () const

reverse_iterator	rbegin ()

const_reverse_iterator	rbegin () const

const_reverse_iterator	crbegin () const

reverse_iterator	rend ()

const_reverse_iterator	rend () const

const_reverse_iterator	crend () const

mapped_type &	operator[] (key_type const &key)

mapped_type &	operator[] (key_type &&key)

mapped_type &	at (key_type const &key)

mapped_type const &	at (key_type const &key) const

size_type	erase (key_type const &key)

iterator	erase (iterator res)

bool	empty () const noexcept

iterator	find (key_type const &key)

const_iterator	find (key_type const &key) const

size_type	count (key_type const &key) const

size_type	size () const

void	clear ()

std::pair< iterator, bool >	insert (value_type const &value)

std::pair< iterator, bool >	insert (value_type &&value)

iterator	insert (const_iterator hint, value_type const &value)

iterator	insert (const_iterator hint, value_type &&value)

template<class InputIt>
void	insert (InputIt first, InputIt last)

void	insert (std::initializer_list< value_type > ilist)

void	swap (BaseRecord &other) noexcept

bool	contains (key_type const &key) const

template<class... Args>
auto	emplace (Args &&...args) -> std::pair< iterator, bool >

unit_representations::AsArray	unitDimension () const
	Return the physical dimension (quantity) of a record.

void	setDatasetDefined (BaseRecordComponent::Data_t &data) override

bool	scalar () const
	Returns true if this record only contains a single component.

template<typename InputIt>
auto	insert (InputIt first, InputIt last) -> void

Public Member Functions inherited from openPMD::Container< T_elem >
iterator	begin () noexcept

const_iterator	begin () const noexcept

const_iterator	cbegin () const noexcept

iterator	end () noexcept

const_iterator	end () const noexcept

const_iterator	cend () const noexcept

reverse_iterator	rbegin () noexcept

const_reverse_iterator	rbegin () const noexcept

const_reverse_iterator	crbegin () const noexcept

reverse_iterator	rend () noexcept

const_reverse_iterator	rend () const noexcept

const_reverse_iterator	crend () const noexcept

bool	empty () const noexcept

size_type	size () const noexcept

void	clear ()
	Remove all objects from the container and (if written) from disk.

std::pair< iterator, bool >	insert (value_type const &value)

std::pair< iterator, bool >	insert (value_type &&value)

iterator	insert (const_iterator hint, value_type const &value)

iterator	insert (const_iterator hint, value_type &&value)

void	insert (InputIt first, InputIt last)

void	insert (std::initializer_list< value_type > ilist)

void	swap (Container &other)

mapped_type &	at (key_type const &key)

mapped_type const &	at (key_type const &key) const

mapped_type &	operator[] (key_type const &key)
	Access the value that is mapped to a key equivalent to key, creating it if such key does not exist already.

mapped_type &	operator[] (key_type &&key)
	Access the value that is mapped to a key equivalent to key, creating it if such key does not exist already.

iterator	find (key_type const &key)

const_iterator	find (key_type const &key) const

size_type	count (key_type const &key) const
	This returns either 1 if the key is found in the container of 0 if not.

bool	contains (key_type const &key) const
	Checks if there is an element with a key equivalent to an exiting key in the container.

size_type	erase (key_type const &key)
	Remove a single element from the container and (if written) from disk.

iterator	erase (iterator res)

auto	emplace (Args &&...args) -> decltype(InternalContainer().emplace(std::forward< Args >(args)...))

	Container (Container const &other)

	Container (Container &&other) noexcept

Container &	operator= (Container const &other)

Container &	operator= (Container &&other) noexcept

iterator	begin () noexcept

const_iterator	begin () const noexcept

const_iterator	cbegin () const noexcept

iterator	end () noexcept

const_iterator	end () const noexcept

const_iterator	cend () const noexcept

reverse_iterator	rbegin () noexcept

const_reverse_iterator	rbegin () const noexcept

const_reverse_iterator	crbegin () const noexcept

reverse_iterator	rend () noexcept

const_reverse_iterator	rend () const noexcept

const_reverse_iterator	crend () const noexcept

bool	empty () const noexcept

size_type	size () const noexcept

void	clear ()
	Remove all objects from the container and (if written) from disk.

std::pair< iterator, bool >	insert (value_type const &value)

std::pair< iterator, bool >	insert (value_type &&value)

iterator	insert (const_iterator hint, value_type const &value)

iterator	insert (const_iterator hint, value_type &&value)

void	insert (InputIt first, InputIt last)

void	insert (std::initializer_list< value_type > ilist)

void	swap (Container &other)

mapped_type &	at (key_type const &key)

mapped_type const &	at (key_type const &key) const

mapped_type &	operator[] (key_type const &key)
	Access the value that is mapped to a key equivalent to key, creating it if such key does not exist already.

mapped_type &	operator[] (key_type &&key)
	Access the value that is mapped to a key equivalent to key, creating it if such key does not exist already.

iterator	find (key_type const &key)

const_iterator	find (key_type const &key) const

size_type	count (key_type const &key) const
	This returns either 1 if the key is found in the container of 0 if not.

bool	contains (key_type const &key) const
	Checks if there is an element with a key equivalent to an exiting key in the container.

size_type	erase (key_type const &key)
	Remove a single element from the container and (if written) from disk.

iterator	erase (iterator res)

auto	emplace (Args &&...args) -> decltype(InternalContainer().emplace(std::forward< Args >(args)...))

	Container (Container const &other)

	Container (Container &&other) noexcept

Container &	operator= (Container const &other)

Container &	operator= (Container &&other) noexcept

Public Member Functions inherited from openPMD::Attributable
	Attributable (NoInit) noexcept

Attribute	getAttribute (std::string const &key) const
	Retrieve value of Attribute stored with provided key.

bool	deleteAttribute (std::string const &key)
	Remove Attribute of provided value both logically and physically.

std::vector< std::string >	attributes () const
	List all currently stored Attributes' keys.

size_t	numAttributes () const
	Count all currently stored Attributes.

bool	containsAttribute (std::string const &key) const
	Check whether am Attribute with a given key exists.

std::string	comment () const
	Retrieve a user-supplied comment associated with the object.

Attributable &	setComment (std::string const &comment)
	Populate Attribute corresponding to a comment with the user-supplied comment.

void	seriesFlush (std::string backendConfig="{}")
	Flush the corresponding Series object.

void	iterationFlush (std::string backendConfig="{}")
	Flush the containing Iteration.

MyPath	myPath () const
	The path to this object within its containing Series.

void	touch ()
	Sets the object dirty to make internal procedures think it has been modified.

OpenpmdStandard	openPMDStandard () const

template<typename T>
bool	setAttribute (std::string const &key, T value)
	Populate Attribute of provided name with provided value.

bool	setAttribute (std::string const &key, char const value[])

Protected Member Functions
void	setData (std::shared_ptr< Data_t > data)

void	readBase ()

Protected Member Functions inherited from openPMD::Container< T_elem >
void	setData (std::shared_ptr< ContainerData > containerData)

InternalContainer const &	container () const

InternalContainer &	container ()

void	clear_unchecked ()

	Container (NoInit)

void	setData (std::shared_ptr< ContainerData > containerData)

InternalContainer const &	container () const

InternalContainer &	container ()

void	clear_unchecked ()

	Container (NoInit)

Protected Member Functions inherited from openPMD::Attributable
Series	retrieveSeries () const

template<bool flush_entire_series>
void	seriesFlush_impl (internal::FlushParams const &)

void	flushAttributes (internal::FlushParams const &)

void	readAttributes (ReadMode)

template<typename T>
T	readFloatingpoint (std::string const &key) const
	Retrieve the value of a floating point Attribute of user-defined precision with ensured type-safety.

template<typename T>
std::vector< T >	readVectorFloatingpoint (std::string const &key) const
	Retrieve a vector of values of a floating point Attributes of user-defined precision with ensured type-safety.

AbstractIOHandler *	IOHandler ()

AbstractIOHandler const *	IOHandler () const

Writable *&	parent ()

Writable const *	parent () const

Writable &	writable ()

Writable const &	writable () const

void	setData (std::shared_ptr< internal::AttributableData > attri)

internal::SharedAttributableData &	get ()

internal::SharedAttributableData const &	get () const

bool	dirty () const

bool	dirtyRecursive () const
	O(1).

void	setDirty (bool dirty_in)

void	setDirtyRecursive (bool dirty_in)

bool	written () const

void	setWritten (bool val, EnqueueAsynchronously)

auto	containingIteration () const -> std::pair< std::optional< internal::IterationData const * >, internal::SeriesData const * >
	Returns the corresponding Iteration.

auto	containingIteration () -> std::pair< std::optional< internal::IterationData * >, internal::SeriesData * >

Friends
class	Iteration

class	ParticleSpecies

class	PatchRecord

class	Record

class	Mesh

template<typename, typename>
class	internal::BaseRecordData

template<typename, typename, typename>
class	internal::ScalarIterator

template<typename T>
T &	internal::makeOwning (T &self, Series)

Additional Inherited Members
Protected Types inherited from openPMD::Container< T_elem >
using	ContainerData

using	InternalContainer

using	ContainerData

using	InternalContainer

Protected Types inherited from openPMD::Attributable
enum	ReadMode { IgnoreExisting , OverrideExisting , FullyReread }

enum class	EnqueueAsynchronously : bool { Yes , No }

using	Data_t = internal::AttributableData

Protected Attributes inherited from openPMD::Container< T_elem >
std::shared_ptr< ContainerData >	m_containerData

std::shared_ptr< ContainerData >	m_containerData

Protected Attributes inherited from openPMD::Attributable
std::shared_ptr< Data_t >	m_attri

Detailed Description

template<typename T_elem>
class openPMD::BaseRecord< T_elem >

Base class for any type of record (e.g.

mesh or particle record).

If the record is a vector record, the single components are accessed via the container interface (base class 1). If the record is a scalar record, it directly acts as a record component (base class 2) and the Container API needs not be used.

Template Parameters

T_elem

Member Typedef Documentation

◆ const_iterator

template<typename T_elem>

using openPMD::BaseRecord< T_elem >::const_iterator

Initial value:

 internal::ScalarIterator<
        T_Self const,
        Data_t const,
        typename T_Container::InternalContainer::const_iterator>

◆ const_reverse_iterator

template<typename T_elem>

using openPMD::BaseRecord< T_elem >::const_reverse_iterator

Initial value:

 internal::ScalarIterator<
        T_Self const,
        Data_t const,
        typename T_Container::InternalContainer::const_reverse_iterator>

◆ iterator

template<typename T_elem>

using openPMD::BaseRecord< T_elem >::iterator

Initial value:

 internal::ScalarIterator<
        T_Self,
        Data_t,
        typename T_Container::InternalContainer::iterator>

◆ reverse_iterator

template<typename T_elem>

using openPMD::BaseRecord< T_elem >::reverse_iterator

Initial value:

 internal::ScalarIterator<
        T_Self,
        Data_t,
        typename T_Container::InternalContainer::reverse_iterator>

Member Function Documentation

◆ scalar()

template<typename T_elem>

bool openPMD::BaseRecord< T_elem >::scalar ( ) const

inline

Returns true if this record only contains a single component.

Returns: true if a record with only a single component

◆ unitDimension()

template<typename T_elem>

unit_representations::AsArray openPMD::BaseRecord< T_elem >::unitDimension ( ) const

inline

Return the physical dimension (quantity) of a record.

Todo: add also, as soon as added in Container:

Annotating the physical dimension of a record allows us to read data sets with arbitrary names and understand their purpose simply by dimensional analysis. The dimensional base quantities in openPMD are in order: length (L), mass (M), time (T), electric current (I), thermodynamic temperature (theta), amount of substance (N), luminous intensity (J) after the international system of quantities (ISQ).

See also: https://en.wikipedia.org/wiki/Dimensional_analysis; https://en.wikipedia.org/wiki/International_System_of_Quantities#Base_quantities; https://github.com/openPMD/openPMD-standard/blob/1.1.0/STANDARD.md#required-for-each-record

Returns: powers of the 7 base measures in the order specified above

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

/tmp/tmp.NhLRcLhrNZ/openPMD-api/include/openPMD/backend/BaseRecord.hpp
/tmp/tmp.NhLRcLhrNZ/openPMD-api/src/backend/BaseRecord.cpp

Public Types

Public Member Functions

Protected Member Functions

Friends

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ const_iterator

◆ const_reverse_iterator

◆ iterator

◆ reverse_iterator

Member Function Documentation

◆ scalar()

◆ unitDimension()