openPMD::Parameter< Operation::ADVANCE > Struct Reference

Inheritance diagram for openPMD::Parameter< Operation::ADVANCE >:

Classes
struct	StepSelection

Public Member Functions
	Parameter (Parameter &&)=default
	Parameter (Parameter const &)=default
Parameter &	operator= (Parameter &&)=default
Parameter &	operator= (Parameter const &)=default
std::unique_ptr< AbstractParameter >	to_heap () &&override
	Parameter (Parameter const &)=delete
	Parameter (Parameter &&)=delete

Public Attributes
std::variant< AdvanceMode, StepSelection >	mode
	AdvanceMode: Is one of BeginStep/EndStep.
bool	isThisStepMandatory = false
std::shared_ptr< AdvanceStatus >	status

Additional Inherited Members
Static Public Member Functions inherited from openPMD::AbstractParameter
template<typename TracingJSON>
static void	warnUnusedParameters (TracingJSON &, std::string const &currentBackendName, std::string const &warningMessage)
	Warn about unused JSON paramters.
Static Public Attributes inherited from openPMD::AbstractParameter
static constexpr I_dont_want_to_use_joined_dimensions_t	I_dont_want_to_use_joined_dimensions {}
Protected Member Functions inherited from openPMD::AbstractParameter
	AbstractParameter (const AbstractParameter &)=default
AbstractParameter &	operator= (const AbstractParameter &)=default
	AbstractParameter (AbstractParameter &&)=default
AbstractParameter &	operator= (AbstractParameter &&)=default

Member Function Documentation

to_heap()

std::unique_ptr< AbstractParameter > openPMD::Parameter< Operation::ADVANCE >::to_heap ( ) &&

inlineoverridevirtual

Implements openPMD::AbstractParameter.

Member Data Documentation

mode

std::variant<AdvanceMode, StepSelection> openPMD::Parameter< Operation::ADVANCE >::mode

AdvanceMode: Is one of BeginStep/EndStep.

Used during writing and in linear read mode to step sequentially through steps. StepSelection: Used in random-access read mode, jump to the specified step. Can be nullopt in order to reset the backend to read step-agnostically, e.g. for reading global datasets such as /rankTable.

status

std::shared_ptr<AdvanceStatus> openPMD::Parameter< Operation::ADVANCE >::status

Initial value:

=
        std::make_shared<AdvanceStatus>(AdvanceStatus::OK)

---

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

• /tmp/tmp.NhLRcLhrNZ/openPMD-api/include/openPMD/IO/IOTask.hpp