openPMD-api
Public Member Functions | Static Public Member Functions | Public Attributes | List of all members
openPMD::Parameter< Operation::CREATE_DATASET > Struct Reference
Inheritance diagram for openPMD::Parameter< Operation::CREATE_DATASET >:
Inheritance graph
[legend]
Collaboration diagram for openPMD::Parameter< Operation::CREATE_DATASET >:
Collaboration graph
[legend]

Public Member Functions

 Parameter (Parameter &&)=default
 
 Parameter (Parameter const &)=default
 
Parameteroperator= (Parameter &&)=default
 
Parameteroperator= (Parameter const &)=default
 
std::unique_ptr< AbstractParameterto_heap () &&override
 

Static Public Member Functions

template<typename TracingJSON >
static void warnUnusedParameters (TracingJSON &, std::string const &currentBackendName, std::string const &warningMessage)
 Warn about unused JSON paramters. More...
 
template<>
void warnUnusedParameters (json::TracingJSON &config, std::string const &currentBackendName, std::string const &warningMessage)
 

Public Attributes

std::string name = ""
 
Extent extent = {}
 
Datatype dtype = Datatype::UNDEFINED
 
std::string options = "{}"
 
std::optional< size_t > joinedDimension
 

Additional Inherited Members

- Protected Member Functions inherited from openPMD::AbstractParameter
 AbstractParameter (const AbstractParameter &)=default
 
AbstractParameteroperator= (const AbstractParameter &)=default
 
 AbstractParameter (AbstractParameter &&)=default
 
AbstractParameteroperator= (AbstractParameter &&)=default
 

Member Function Documentation

◆ warnUnusedParameters()

template<typename TracingJSON >
static void openPMD::Parameter< Operation::CREATE_DATASET >::warnUnusedParameters ( TracingJSON &  ,
std::string const &  currentBackendName,
std::string const &  warningMessage 
)
static

Warn about unused JSON paramters.

Template parameter so we don't have to include the JSON lib here. This function is useful for the createDataset() methods in, IOHandlerImpl's, so putting that here is the simplest way to make it available for them.


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