openPMD::PatchRecord Class Reference

Inheritance diagram for openPMD::PatchRecord:

Public Member Functions
PatchRecord &	setUnitDimension (std::map< UnitDimension, double > const &)
Public Member Functions inherited from openPMD::BaseRecord< PatchRecordComponent >
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)
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
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.
auto	insert (InputIt first, InputIt last) -> void
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)
void	insert (InputIt first, InputIt last)
void	insert (std::initializer_list< value_type > ilist)
auto	insert (InputIt first, InputIt last) -> void
void	swap (BaseRecord &other) noexcept
bool	contains (key_type const &key) const
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.
Public Member Functions inherited from openPMD::Container< PatchRecordComponent >
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[])
Public Member Functions inherited from openPMD::PatchRecordComponent
	PatchRecordComponent (BaseRecord< PatchRecordComponent > const &)
	Avoid object slicing when using a Record as a scalar Record Component.
PatchRecordComponent &	setUnitSI (double)
uint8_t	getDimensionality () const
Extent	getExtent () const
template<typename T>
std::shared_ptr< T >	load ()
template<typename T>
void	load (std::shared_ptr< T >)
template<typename T>
void	load (std::shared_ptr< T[]>)
template<typename T>
void	loadRaw (T *)
template<typename T>
void	store (uint64_t idx, T)
template<typename T>
void	store (T)
Public Member Functions inherited from openPMD::RecordComponent
	RecordComponent (BaseRecord< RecordComponent > const &)
	Avoid object slicing when using a Record as a scalar Record Component.
RecordComponent &	setUnitSI (double)
RecordComponent &	resetDataset (Dataset)
	Declare the dataset's type and extent.
uint8_t	getDimensionality () const
Extent	getExtent () const
template<typename T>
RecordComponent &	makeConstant (T)
	Create a dataset with regular extent and constant value.
template<typename T>
RecordComponent &	makeEmpty (uint8_t dimensions)
	Create a dataset with zero extent in each dimension.
RecordComponent &	makeEmpty (Datatype dt, uint8_t dimensions)
	Non-template overload of RecordComponent::makeEmpty().
bool	empty () const
	Returns true if this is an empty record component.
template<typename T>
std::shared_ptr< T >	loadChunk (Offset={0u}, Extent={-1u})
	Load and allocate a chunk of data.
shared_ptr_dataset_types	loadChunkVariant (Offset={0u}, Extent={-1u})
	std::variant-based version of allocating loadChunk<T>(Offset, Extent)
template<typename T>
void	loadChunk (std::shared_ptr< T > data, Offset offset, Extent extent)
	Load a chunk of data into pre-allocated memory.
template<typename T>
void	loadChunk (std::shared_ptr< T[]> data, Offset offset, Extent extent)
	Load a chunk of data into pre-allocated memory, array version.
template<typename T>
void	loadChunkRaw (T *data, Offset offset, Extent extent)
	Load a chunk of data into pre-allocated memory, raw pointer version.
template<typename T>
void	storeChunk (std::shared_ptr< T > data, Offset offset, Extent extent)
	Store a chunk of data from a chunk of memory.
template<typename T>
void	storeChunk (std::shared_ptr< T[]> data, Offset offset, Extent extent)
	Store a chunk of data from a chunk of memory, array version.
template<typename T>
void	storeChunk (UniquePtrWithLambda< T > data, Offset offset, Extent extent)
	Store a chunk of data from a chunk of memory, unique pointer version.
template<typename T, typename Del>
void	storeChunk (std::unique_ptr< T, Del > data, Offset offset, Extent extent)
	Store a chunk of data from a chunk of memory, unique pointer version.
template<typename T>
void	storeChunkRaw (T const *data, Offset offset, Extent extent)
	Store a chunk of data from a chunk of memory, raw pointer version.
template<typename T_ContiguousContainer>
std::enable_if_t< auxiliary::IsContiguousContainer_v< T_ContiguousContainer > >	storeChunk (T_ContiguousContainer &data, Offset offset={0u}, Extent extent={-1u})
	Store a chunk of data from a contiguous container.
template<typename T, typename F>
DynamicMemoryView< T >	storeChunk (Offset offset, Extent extent, F &&createBuffer)
	Overload of storeChunk() that lets the openPMD API allocate a buffer.
template<typename T>
DynamicMemoryView< T >	storeChunk (Offset, Extent)
	Overload of span-based storeChunk() that uses operator new() to create a buffer.
template<typename Visitor, typename... Args>
auto	visit (Args &&...args) -> decltype(Visitor::template call< char >(std::declval< RecordComponent & >(), std::forward< Args >(args)...))
	Run a template functor on the type of the record component, similar to std::visit().
Public Member Functions inherited from openPMD::BaseRecordComponent
	BaseRecordComponent (BaseRecordComponent const &other)
	BaseRecordComponent (BaseRecordComponent &&other)
BaseRecordComponent &	operator= (BaseRecordComponent const &other)
BaseRecordComponent &	operator= (BaseRecordComponent &&other)
double	unitSI () const
BaseRecordComponent &	resetDatatype (Datatype)
Datatype	getDatatype () const
bool	constant () const
	Returns true if this is a constant record component.
std::optional< size_t >	joinedDimension () const
ChunkTable	availableChunks ()
	Get data chunks that are available to be loaded from the backend.

Friends
class	Container< PatchRecord >
class	ParticleSpecies
class	ParticlePatches

Additional Inherited Members
Public Types inherited from openPMD::BaseRecord< PatchRecordComponent >
using	T_RecordComponent
using	T_Container
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 Types inherited from openPMD::Container< PatchRecordComponent >
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 Types inherited from openPMD::RecordComponent
enum class	Allocation { USER , API , AUTO }
using	shared_ptr_dataset_types
Static Public Attributes inherited from openPMD::RecordComponent
static constexpr char const *const	SCALAR = "\vScalar"
Protected Types inherited from openPMD::Container< PatchRecordComponent >
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 Types inherited from openPMD::RecordComponent
using	Data_t = internal::RecordComponentData
Protected Types inherited from openPMD::BaseRecordComponent
using	Data_t = internal::BaseRecordComponentData
Protected Member Functions inherited from openPMD::BaseRecord< PatchRecordComponent >
void	setData (std::shared_ptr< Data_t > data)
void	readBase ()
void	setData (std::shared_ptr< Data_t > data)
void	readBase ()
Protected Member Functions inherited from openPMD::Container< PatchRecordComponent >
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 * >
Protected Member Functions inherited from openPMD::PatchRecordComponent
	PatchRecordComponent (NoInit)
Protected Member Functions inherited from openPMD::RecordComponent
void	flush (std::string const &, internal::FlushParams const &)
void	read (bool require_unit_si)
	RecordComponent (NoInit)
Data_t const &	get () const
Data_t &	get ()
std::shared_ptr< Data_t >	getShared ()
void	setData (std::shared_ptr< internal::RecordComponentData > data)
void	readBase (bool require_unit_si)
template<typename T>
void	verifyChunk (Offset const &, Extent const &) const
void	verifyChunk (Datatype, Offset const &, Extent const &) const
Protected Member Functions inherited from openPMD::BaseRecordComponent
Data_t const &	get () const
Data_t &	get ()
void	setData (std::shared_ptr< Data_t > data)
bool	datasetDefined () const
	BaseRecordComponent (NoInit)
Protected Attributes inherited from openPMD::Container< PatchRecordComponent >
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
Protected Attributes inherited from openPMD::RecordComponent
std::shared_ptr< Data_t >	m_recordComponentData
Protected Attributes inherited from openPMD::BaseRecordComponent
std::shared_ptr< Data_t >	m_baseRecordComponentData

---

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

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