YAML_data#

#include <YAML_data.h>

classe YAML_data : collection of all needed information for data to save/restore in order to write the YAML file used to initialize PDI

How to cite this class in this doc#

:ref:`YAML\_data <class-yaml-data>`
[YAML\_data](#class-yaml-data)

Detailed description#

List of Public Methods#

Complete Member Function Documentation#

add_attribute
void YAML_data::add_attribute(const std::string &attr)
How to cite in this doc:
:ref:`void YAML_data::add_attribute(const std::string &attr) <public-void-yaml-data-add-attribute-const-std-string-ref-attr>`
[void YAML_data::add_attribute(const std::string &attr)](#public-void-yaml-data-add-attribute-const-std-string-ref-attr)
get_attributes
const std::vector<std::string> & YAML_data::get_attributes() const
How to cite in this doc:
:ref:`const std::vector<std::string> & YAML_data::get_attributes() const <public-const-std-vector-std-string-ref-yaml-data-get-attributes-const>`
[const std::vector<std::string> & YAML_data::get_attributes() const](#public-const-std-vector-std-string-ref-yaml-data-get-attributes-const)
get_conditions
const std::string & YAML_data::get_conditions() const
How to cite in this doc:
:ref:`const std::string & YAML_data::get_conditions() const <public-const-std-string-ref-yaml-data-get-conditions-const>`
[const std::string & YAML_data::get_conditions() const](#public-const-std-string-ref-yaml-data-get-conditions-const)
get_dims
int YAML_data::get_dims() const
How to cite in this doc:
:ref:`int YAML_data::get_dims() const <public-int-yaml-data-get-dims-const>`
[int YAML_data::get_dims() const](#public-int-yaml-data-get-dims-const)
get_hdf_name
const std::string & YAML_data::get_hdf_name() const
How to cite in this doc:
:ref:`const std::string & YAML_data::get_hdf_name() const <public-const-std-string-ref-yaml-data-get-hdf-name-const>`
[const std::string & YAML_data::get_hdf_name() const](#public-const-std-string-ref-yaml-data-get-hdf-name-const)
get_name
const std::string & YAML_data::get_name() const
How to cite in this doc:
:ref:`const std::string & YAML_data::get_name() const <public-const-std-string-ref-yaml-data-get-name-const>`
[const std::string & YAML_data::get_name() const](#public-const-std-string-ref-yaml-data-get-name-const)
get_type
const std::string & YAML_data::get_type() const
How to cite in this doc:
:ref:`const std::string & YAML_data::get_type() const <public-const-std-string-ref-yaml-data-get-type-const>`
[const std::string & YAML_data::get_type() const](#public-const-std-string-ref-yaml-data-get-type-const)
is_dataset
bool YAML_data::is_dataset() const
How to cite in this doc:
:ref:`bool YAML_data::is_dataset() const <public-bool-yaml-data-is-dataset-const>`
[bool YAML_data::is_dataset() const](#public-bool-yaml-data-is-dataset-const)
is_local
bool YAML_data::is_local() const
How to cite in this doc:
:ref:`bool YAML_data::is_local() const <public-bool-yaml-data-is-local-const>`
[bool YAML_data::is_local() const](#public-bool-yaml-data-is-local-const)
save_field_type
bool YAML_data::save_field_type() const
How to cite in this doc:
:ref:`bool YAML_data::save_field_type() const <public-bool-yaml-data-save-field-type-const>`
[bool YAML_data::save_field_type() const](#public-bool-yaml-data-save-field-type-const)
set_conditions
void YAML_data::set_conditions(const std::string &cond)
Referenced By
How to cite in this doc:
:ref:`void YAML_data::set_conditions(const std::string &cond) <public-void-yaml-data-set-conditions-const-std-string-ref-cond>`
[void YAML_data::set_conditions(const std::string &cond)](#public-void-yaml-data-set-conditions-const-std-string-ref-cond)
set_dataset
void YAML_data::set_dataset(bool d)
How to cite in this doc:
:ref:`void YAML_data::set_dataset(bool d) <public-void-yaml-data-set-dataset-bool-d>`
[void YAML_data::set_dataset(bool d)](#public-void-yaml-data-set-dataset-bool-d)
set_hdf_name
void YAML_data::set_hdf_name(const std::string &n)
How to cite in this doc:
:ref:`void YAML_data::set_hdf_name(const std::string &n) <public-void-yaml-data-set-hdf-name-const-std-string-ref-n>`
[void YAML_data::set_hdf_name(const std::string &n)](#public-void-yaml-data-set-hdf-name-const-std-string-ref-n)
set_local
void YAML_data::set_local(bool l)
Referenced By
How to cite in this doc:
:ref:`void YAML_data::set_local(bool l) <public-void-yaml-data-set-local-bool-l>`
[void YAML_data::set_local(bool l)](#public-void-yaml-data-set-local-bool-l)
set_save_field_type
void YAML_data::set_save_field_type(bool b)
Referenced By
How to cite in this doc:
:ref:`void YAML_data::set_save_field_type(bool b) <public-void-yaml-data-set-save-field-type-bool-b>`
[void YAML_data::set_save_field_type(bool b)](#public-void-yaml-data-set-save-field-type-bool-b)
YAML_data
YAML_data::YAML_data()
How to cite in this doc:
:ref:`YAML_data::YAML_data() <public-yaml-data-yaml-data>`
[YAML_data::YAML_data()](#public-yaml-data-yaml-data)
YAML_data
YAML_data::YAML_data(const std::string &name, const std::string &type)
How to cite in this doc:
:ref:`YAML_data::YAML_data(const std::string &name, const std::string &type) <public-yaml-data-yaml-data-const-std-string-ref-name-const-std-string-ref-type>`
[YAML_data::YAML_data(const std::string &name, const std::string &type)](#public-yaml-data-yaml-data-const-std-string-ref-name-const-std-string-ref-type)
YAML_data
YAML_data::YAML_data(const std::string &name, const std::string &type, int nb_dim)
How to cite in this doc:
:ref:`YAML_data::YAML_data(const std::string &name, const std::string &type, int nb_dim) <public-yaml-data-yaml-data-const-std-string-ref-name-const-std-string-ref-type-int-nb-dim>`
[YAML_data::YAML_data(const std::string &name, const std::string &type, int nb_dim)](#public-yaml-data-yaml-data-const-std-string-ref-name-const-std-string-ref-type-int-nb-dim)
YAML_data
YAML_data::YAML_data(const std::string &name, const std::string &type, int nb_dim, bool loc)
How to cite in this doc:
:ref:`YAML_data::YAML_data(const std::string &name, const std::string &type, int nb_dim, bool loc) <public-yaml-data-yaml-data-const-std-string-ref-name-const-std-string-ref-type-int-nb-dim-bool-loc>`
[YAML_data::YAML_data(const std::string &name, const std::string &type, int nb_dim, bool loc)](#public-yaml-data-yaml-data-const-std-string-ref-name-const-std-string-ref-type-int-nb-dim-bool-loc)
YAML_data
YAML_data::YAML_data(const std::string &name, const std::string &type, int nb_dim, bool loc, bool is_ds)
How to cite in this doc:
:ref:`YAML_data::YAML_data(const std::string &name, const std::string &type, int nb_dim, bool loc, bool is_ds) <public-yaml-data-yaml-data-const-std-string-ref-name-const-std-string-ref-type-int-nb-dim-bool-loc-bool-is-ds>`
[YAML_data::YAML_data(const std::string &name, const std::string &type, int nb_dim, bool loc, bool is_ds)](#public-yaml-data-yaml-data-const-std-string-ref-name-const-std-string-ref-type-int-nb-dim-bool-loc-bool-is-ds)

Attributes Documentation#

attributes_ (private)
std::vector<std::string> YAML_data::attributes_
conditions_ (private)
std::string YAML_data::conditions_
dimension_ (private)
int YAML_data::dimension_
hdf_name_ (private)
std::string YAML_data::hdf_name_
is_dataset_ (private)
bool YAML_data::is_dataset_ = true
local_ (private)
bool YAML_data::local_ = true
name_ (private)
std::string YAML_data::name_
save_field_type_ (private)
bool YAML_data::save_field_type_ = false
type_ (private)
std::string YAML_data::type_