openPMD-api
|
Root level of the openPMD hierarchy. More...
#include <Series.hpp>
Classes | |
struct | ParsedInput |
Public Member Functions | |
Series (std::string const &filepath, Access at, MPI_Comm comm, std::string const &options="{}") | |
Series (std::string const &filepath, Access at, std::string const &options="{}") | |
std::string | openPMD () const |
Series & | setOpenPMD (std::string const &openPMD) |
Set the version of the enforced openPMD standard. More... | |
uint32_t | openPMDextension () const |
Series & | setOpenPMDextension (uint32_t openPMDextension) |
Set a 32-bit mask of applied extensions to the openPMD standard. More... | |
std::string | basePath () const |
Series & | setBasePath (std::string const &basePath) |
Set the common prefix for all data sets and sub-groups of a specific iteration. More... | |
std::string | meshesPath () const |
Series & | setMeshesPath (std::string const &meshesPath) |
Set the path to mesh records, relative(!) to basePath . More... | |
std::string | particlesPath () const |
Series & | setParticlesPath (std::string const &particlesPath) |
Set the path to groups for each particle species, relative(!) to basePath . More... | |
std::string | author () const |
Series & | setAuthor (std::string const &author) |
Indicate the author and contact for the information in the file. More... | |
std::string | software () const |
Series & | setSoftware (std::string const &newName, std::string const &newVersion=std::string("unspecified")) |
Indicate the software/code/simulation that created the file. More... | |
std::string | softwareVersion () const |
Series & | setSoftwareVersion (std::string const &softwareVersion) |
Indicate the version of the software/code/simulation that created the file. More... | |
std::string | date () const |
Series & | setDate (std::string const &date) |
Indicate the date of creation. More... | |
std::string | softwareDependencies () const |
Series & | setSoftwareDependencies (std::string const &newSoftwareDependencies) |
Indicate dependencies of software that were used to create the file. More... | |
std::string | machine () const |
Series & | setMachine (std::string const &newMachine) |
Indicate the machine or relevant hardware that created the file. More... | |
IterationEncoding | iterationEncoding () const |
Series & | setIterationEncoding (IterationEncoding iterationEncoding) |
Set the encoding style for multiple iterations in this series. More... | |
std::string | iterationFormat () const |
Series & | setIterationFormat (std::string const &iterationFormat) |
Set a pattern describing how to access single iterations in the raw file. More... | |
std::string | name () const |
Series & | setName (std::string const &name) |
Set the pattern for file names. More... | |
std::string | backend () const |
The currently used backend. More... | |
void | flush () |
Execute all required remaining IO operations to write or read data. | |
ReadIterations | readIterations () |
Entry point to the reading end of the streaming API. More... | |
WriteIterations | writeIterations () |
Entry point to the writing end of the streaming API. More... | |
Public Member Functions inherited from openPMD::Attributable | |
Attributable (Attributable const &) | |
Attributable (Attributable &&)=delete | |
Attributable & | operator= (Attributable const &) |
Attributable & | operator= (Attributable &&)=delete |
Attribute | getAttribute (std::string const &key) const |
Retrieve value of Attribute stored with provided key. More... | |
bool | deleteAttribute (std::string const &key) |
Remove Attribute of provided value both logically and physically. More... | |
std::vector< std::string > | attributes () const |
List all currently stored Attributes' keys. More... | |
size_t | numAttributes () const |
Count all currently stored Attributes. More... | |
bool | containsAttribute (std::string const &key) const |
Check whether am Attribute with a given key exists. More... | |
std::string | comment () const |
Retrieve a user-supplied comment associated with the object. More... | |
Attributable & | setComment (std::string const &comment) |
Populate Attribute corresponding to a comment with the user-supplied comment. More... | |
template<typename T > | |
bool | setAttribute (std::string const &key, T const &value) |
Populate Attribute of provided name with provided value. More... | |
bool | setAttribute (std::string const &key, char const value[]) |
Public Attributes | |
Container< Iteration, uint64_t > | iterations |
Friends | |
class | Iteration |
class | SeriesIterator |
Additional Inherited Members | |
Protected Member Functions inherited from openPMD::Attributable | |
void | flushAttributes () |
void | readAttributes () |
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. More... | |
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. More... | |
bool & | dirty () const |
bool & | written () const |
Protected Attributes inherited from openPMD::Attributable | |
std::shared_ptr< Writable > | m_writable |
AbstractFilePosition * | abstractFilePosition |
AbstractIOHandler * | IOHandler |
Writable * | parent |
Root level of the openPMD hierarchy.
Entry point and common link between all iterations of particle and mesh data.
std::string openPMD::Series::author | ( | ) | const |
no_such_attribute_error | If optional attribute is not present. |
std::string openPMD::Series::backend | ( | ) | const |
The currently used backend.
std::string openPMD::Series::basePath | ( | ) | const |
std::string openPMD::Series::date | ( | ) | const |
no_such_attribute_error | If optional attribute is not present. |
IterationEncoding openPMD::Series::iterationEncoding | ( | ) | const |
std::string openPMD::Series::iterationFormat | ( | ) | const |
std::string openPMD::Series::machine | ( | ) | const |
no_such_attribute_error | If optional attribute is not present. |
std::string openPMD::Series::meshesPath | ( | ) | const |
no_such_attribute_error | If optional attribute is not present. |
basePath
. std::string openPMD::Series::name | ( | ) | const |
std::string openPMD::Series::openPMD | ( | ) | const |
uint32_t openPMD::Series::openPMDextension | ( | ) | const |
std::string openPMD::Series::particlesPath | ( | ) | const |
no_such_attribute_error | If optional attribute is not present. |
basePath
. ReadIterations openPMD::Series::readIterations | ( | ) |
Entry point to the reading end of the streaming API.
Creates and returns an instance of the ReadIterations class which can be used for iterating over the openPMD iterations in a C++11-style for loop. Look for the ReadIterations class for further documentation.
Series & openPMD::Series::setAuthor | ( | std::string const & | author | ) |
Indicate the author and contact for the information in the file.
author | String indicating author and contact for the information in the file. |
Series & openPMD::Series::setBasePath | ( | std::string const & | basePath | ) |
Set the common prefix for all data sets and sub-groups of a specific iteration.
basePath | String of the common prefix for all data sets and sub-groups of a specific iteration. |
Series & openPMD::Series::setDate | ( | std::string const & | date | ) |
Indicate the date of creation.
date | String indicating the date of creation. |
Series & openPMD::Series::setIterationEncoding | ( | IterationEncoding | iterationEncoding | ) |
Set the encoding style for multiple iterations in this series.
iterationEncoding | Desired encoding style for multiple iterations in this series. |
Series & openPMD::Series::setIterationFormat | ( | std::string const & | iterationFormat | ) |
Set a pattern describing how to access single iterations in the raw file.
iterationFormat | String with the iteration regex %T defining either the series of files (fileBased) or the series of groups within a single file (groupBased) that allows to extract the iteration from it. For fileBased formats the iteration must be included in the file name. The format depends on the selected iterationEncoding method. |
Series & openPMD::Series::setMachine | ( | std::string const & | newMachine | ) |
Indicate the machine or relevant hardware that created the file.
newMachine | String indicating the machine or relevant hardware that created the file (semicolon-separated list if needed).. |
Series & openPMD::Series::setMeshesPath | ( | std::string const & | meshesPath | ) |
Set the path to mesh records, relative(!) to basePath
.
meshesPath | String of the path to mesh records, relative(!) to basePath . |
Series & openPMD::Series::setName | ( | std::string const & | name | ) |
Set the pattern for file names.
name | String of the pattern for file names. Must include iteration regex %T for fileBased data. |
Series & openPMD::Series::setOpenPMD | ( | std::string const & | openPMD | ) |
Set the version of the enforced openPMD standard.
Series & openPMD::Series::setOpenPMDextension | ( | uint32_t | openPMDextension | ) |
Set a 32-bit mask of applied extensions to the openPMD standard.
openPMDextension | Unsigned 32-bit integer used as a bit-mask of applied extensions. |
Series & openPMD::Series::setParticlesPath | ( | std::string const & | particlesPath | ) |
Set the path to groups for each particle species, relative(!) to basePath
.
particlesPath | String of the path to groups for each particle species, relative(!) to basePath . |
Series & openPMD::Series::setSoftware | ( | std::string const & | newName, |
std::string const & | newVersion = std::string("unspecified") |
||
) |
Indicate the software/code/simulation that created the file.
newName | String indicating the software/code/simulation that created the file. |
newVersion | String indicating the version of the software/code/simulation that created the file. |
Series & openPMD::Series::setSoftwareDependencies | ( | std::string const & | newSoftwareDependencies | ) |
Indicate dependencies of software that were used to create the file.
newSoftwareDependencies | String indicating dependencies of software that were used to create the file (semicolon-separated list if needed). |
Series & openPMD::Series::setSoftwareVersion | ( | std::string const & | softwareVersion | ) |
Indicate the version of the software/code/simulation that created the file.
softwareVersion | String indicating the version of the software/code/simulation that created the file. |
std::string openPMD::Series::software | ( | ) | const |
no_such_attribute_error | If optional attribute is not present. |
std::string openPMD::Series::softwareDependencies | ( | ) | const |
no_such_attribute_error | If optional attribute is not present. |
std::string openPMD::Series::softwareVersion | ( | ) | const |
no_such_attribute_error | If optional attribute is not present. |
WriteIterations openPMD::Series::writeIterations | ( | ) |
Entry point to the writing end of the streaming API.
Creates and returns an instance of the WriteIterations class which is a restricted container of iterations which takes care of streaming semantics. The created object is stored as member of the Series object, hence this method may be called as many times as a user wishes. Look for the WriteIterations class for further documentation.