Public Member Functions | Public Attributes | List of all members
openPMD::AttributableInterface::MyPath Struct Reference

String serialization to describe an Attributable. More...

#include <Attributable.hpp>

Collaboration diagram for openPMD::AttributableInterface::MyPath:
Collaboration graph

Public Member Functions

std::string filePath () const
 Reconstructs a path that can be passed to a Series constructor.

Public Attributes

std::string directory
std::string seriesName
 e.g., samples/git-samples/
std::string seriesExtension
 e.g., dataT
std::vector< std::string > group
 e.g., .bp, .h5, .json, ... More...

Detailed Description

String serialization to describe an Attributable.

This object contains the Series data path as well as the openPMD object names to find an Attributable. This can be used to re-open a Series and re-constructing an Attributable, e.g. on a remote context/node.

Member Data Documentation

◆ group

std::vector< std::string > openPMD::AttributableInterface::MyPath::group

e.g., .bp, .h5, .json, ...

A vector of openPMD object names

Indicates where this Attributable may be found within its Series. Prefixed by the accessed object, e.g., "iterations", "100", "meshes", "E", "x" Notice that RecordComponent::SCALAR is included in this list, too.

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