openPMD-api
Static Public Member Functions | Static Public Attributes | List of all members
openPMD::detail::VariableDefiner Struct Reference

Static Public Member Functions

template<typename T >
static void call (adios2::IO &IO, std::string const &name, std::vector< ADIOS2IOHandlerImpl::ParameterizedOperator > const &compressions, adios2::Dims const &shape=adios2::Dims(), adios2::Dims const &start=adios2::Dims(), adios2::Dims const &count=adios2::Dims(), bool const constantDims=false)
 Define a Variable of type T within the passed IO. More...
 

Static Public Attributes

static constexpr char const * errorMsg = "ADIOS2: defineVariable()"
 

Member Function Documentation

◆ call()

template<typename T >
void openPMD::detail::VariableDefiner::call ( adios2::IO &  IO,
std::string const &  name,
std::vector< ADIOS2IOHandlerImpl::ParameterizedOperator > const &  compressions,
adios2::Dims const &  shape = adios2::Dims(),
adios2::Dims const &  start = adios2::Dims(),
adios2::Dims const &  count = adios2::Dims(),
bool const  constantDims = false 
)
static

Define a Variable of type T within the passed IO.

Parameters
IOThe adios2::IO object within which to define the variable. The variable can later be retrieved from the IO using the passed name.
nameAs in adios2::IO::DefineVariable
compressionsADIOS2 operators, including an arbitrary number of parameters, to be added to the variable upon definition.
shapeAs in adios2::IO::DefineVariable
startAs in adios2::IO::DefineVariable
countAs in adios2::IO::DefineVariable
constantDimsAs in adios2::IO::DefineVariable

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