openPMD-api
 
Loading...
Searching...
No Matches
Public Member Functions | Friends | List of all members
openPMD::ParticlePatches Class Reference
Inheritance diagram for openPMD::ParticlePatches:
openPMD::Container< PatchRecord > openPMD::Attributable

Public Member Functions

size_t numPatches () const
 
- Public Member Functions inherited from openPMD::Container< PatchRecord >
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[])
 

Friends

class ParticleSpecies
 
class Container< ParticlePatches >
 
class Container< PatchRecord >
 

Additional Inherited Members

- Public Types inherited from openPMD::Container< PatchRecord >
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
 
- Protected Types inherited from openPMD::Container< PatchRecord >
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 Member Functions inherited from openPMD::Container< PatchRecord >
void setData (std::shared_ptr< ContainerData > containerData)
 
InternalContainer const & container () const
 
InternalContainer & container ()
 
void clear_unchecked ()
 
virtual void flush (std::string const &path, internal::FlushParams const &flushParams)
 
 Container (NoInit)
 
void setData (std::shared_ptr< ContainerData > containerData)
 
InternalContainer const & container () const
 
InternalContainer & container ()
 
void clear_unchecked ()
 
virtual void flush (std::string const &path, internal::FlushParams const &flushParams)
 
 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 Attributes inherited from openPMD::Container< PatchRecord >
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
 
The documentation for this class was generated from the following files: