Public Member Functions | |
UcdFlags (const bool write_preamble=false) | |
void | parse_parameters (const ParameterHandler &prm) |
unsigned int | memory_consumption () const |
Static Public Member Functions | |
static void | declare_parameters (ParameterHandler &prm) |
Public Attributes | |
bool | write_preamble |
Flags controlling the details of output in UCD format for AVS Express.
DataOutBase::UcdFlags::UcdFlags | ( | const bool | write_preamble = false |
) |
Constructor.
static void DataOutBase::UcdFlags::declare_parameters | ( | ParameterHandler & | prm | ) | [static] |
Declare all flags with name and type as offered by this class, for use in input files.
void DataOutBase::UcdFlags::parse_parameters | ( | const ParameterHandler & | prm | ) |
Read the parameters declared in declare_parameters
and set the flags for this output format accordingly.
The flags thus obtained overwrite all previous contents of this object.
Determine an estimate for the memory consumption (in bytes) of this object. Since sometimes the size of objects can not be determined exactly (for example: what is the memory consumption of an STL std::map
type with a certain number of elements?), this is only an estimate. however often quite close to the true value.
Write a comment at the beginning of the file stating the date of creation and some other data. While this is supported by the UCD format and AVS Express, some other programs get confused by this, so the default is to not write a preamble. However, a preamble can be written using this flag.
Default: false
.