openPMD-api
Public Member Functions | List of all members
openPMD::Parameter< Operation > Struct Template Reference

Typesafe description of all required arguments for a specified Operation. More...

#include <IOTask.hpp>

Inheritance diagram for openPMD::Parameter< Operation >:
Inheritance graph
[legend]
Collaboration diagram for openPMD::Parameter< Operation >:
Collaboration graph
[legend]

Public Member Functions

 Parameter (Parameter const &)=delete
 
 Parameter (Parameter &&)=delete
 
- Public Member Functions inherited from openPMD::AbstractParameter
virtual std::unique_ptr< AbstractParameterto_heap () &&=0
 

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. More...
 
- Static Public Attributes inherited from openPMD::AbstractParameter
constexpr static 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
 
AbstractParameteroperator= (const AbstractParameter &)=default
 
 AbstractParameter (AbstractParameter &&)=default
 
AbstractParameteroperator= (AbstractParameter &&)=default
 

Detailed Description

template<Operation>
struct openPMD::Parameter< Operation >

Typesafe description of all required arguments for a specified Operation.

Note
Input operations (i.e. ones that transfer data from persistent files to logical representations in openPMD-api) use shared pointers to indicate shared ownership of the resource. The pointer will only be valid after the Operation has completed.
Template Parameters
OperationType of Operation to be executed.

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