YAML_data

YAML_data#

#include <YAML_data.h>
Brief description

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 reference this class#

Copy the following pieces of RST/Markdown code to cite this element in other parts of the sphinx documentation (there is a copy button on the top-right when hovering the code block):

:ref:`YAML\_data <class-yaml-data>`

[YAML\_data](#class-yaml-data)

Detailed description#

List of Public Methods#

Complete Member Function Documentation#

add_attribute#

Definition
void YAML_data::add_attribute(const std::string &attr)
Brief description
Detailed description
How to reference this method:

Copy the following pieces of RST/Markdown code to cite this element in other parts of the sphinx documentation (there is a copy button on the top-right when hovering the code block):

:ref:`void YAML_data::add_attribute(const std::string &attr) <yaml-data-public-void-yaml-data-add-attribute-const-std-string-ref-attr>`

[void YAML_data::add_attribute(const std::string &attr)](#yaml-data-public-void-yaml-data-add-attribute-const-std-string-ref-attr)

get_attributes#

Definition
const std::vector<std::string> & YAML_data::get_attributes() const
Brief description
Detailed description
How to reference this method:

Copy the following pieces of RST/Markdown code to cite this element in other parts of the sphinx documentation (there is a copy button on the top-right when hovering the code block):

:ref:`const std::vector<std::string> & YAML_data::get_attributes() const <yaml-data-public-const-std-vector-std-string-ref-yaml-data-get-attributes-const>`

[const std::vector<std::string> & YAML_data::get_attributes() const](#yaml-data-public-const-std-vector-std-string-ref-yaml-data-get-attributes-const)

get_conditions#

Definition
const std::string & YAML_data::get_conditions() const
Brief description
Detailed description
How to reference this method:

Copy the following pieces of RST/Markdown code to cite this element in other parts of the sphinx documentation (there is a copy button on the top-right when hovering the code block):

:ref:`const std::string & YAML_data::get_conditions() const <yaml-data-public-const-std-string-ref-yaml-data-get-conditions-const>`

[const std::string & YAML_data::get_conditions() const](#yaml-data-public-const-std-string-ref-yaml-data-get-conditions-const)

get_dims#

Definition
int YAML_data::get_dims() const
Brief description
Detailed description
How to reference this method:

Copy the following pieces of RST/Markdown code to cite this element in other parts of the sphinx documentation (there is a copy button on the top-right when hovering the code block):

:ref:`int YAML_data::get_dims() const <yaml-data-public-int-yaml-data-get-dims-const>`

[int YAML_data::get_dims() const](#yaml-data-public-int-yaml-data-get-dims-const)

get_hdf_name#

Definition
const std::string & YAML_data::get_hdf_name() const
Brief description
Detailed description
How to reference this method:

Copy the following pieces of RST/Markdown code to cite this element in other parts of the sphinx documentation (there is a copy button on the top-right when hovering the code block):

:ref:`const std::string & YAML_data::get_hdf_name() const <yaml-data-public-const-std-string-ref-yaml-data-get-hdf-name-const>`

[const std::string & YAML_data::get_hdf_name() const](#yaml-data-public-const-std-string-ref-yaml-data-get-hdf-name-const)

get_name#

Definition
const std::string & YAML_data::get_name() const
Brief description
Detailed description
How to reference this method:

Copy the following pieces of RST/Markdown code to cite this element in other parts of the sphinx documentation (there is a copy button on the top-right when hovering the code block):

:ref:`const std::string & YAML_data::get_name() const <yaml-data-public-const-std-string-ref-yaml-data-get-name-const>`

[const std::string & YAML_data::get_name() const](#yaml-data-public-const-std-string-ref-yaml-data-get-name-const)

get_type#

Definition
const std::string & YAML_data::get_type() const
Brief description
Detailed description
How to reference this method:

Copy the following pieces of RST/Markdown code to cite this element in other parts of the sphinx documentation (there is a copy button on the top-right when hovering the code block):

:ref:`const std::string & YAML_data::get_type() const <yaml-data-public-const-std-string-ref-yaml-data-get-type-const>`

[const std::string & YAML_data::get_type() const](#yaml-data-public-const-std-string-ref-yaml-data-get-type-const)

is_dataset#

Definition
bool YAML_data::is_dataset() const
Brief description
Detailed description
How to reference this method:

Copy the following pieces of RST/Markdown code to cite this element in other parts of the sphinx documentation (there is a copy button on the top-right when hovering the code block):

:ref:`bool YAML_data::is_dataset() const <yaml-data-public-bool-yaml-data-is-dataset-const>`

[bool YAML_data::is_dataset() const](#yaml-data-public-bool-yaml-data-is-dataset-const)

is_local#

Definition
bool YAML_data::is_local() const
Brief description
Detailed description
How to reference this method:

Copy the following pieces of RST/Markdown code to cite this element in other parts of the sphinx documentation (there is a copy button on the top-right when hovering the code block):

:ref:`bool YAML_data::is_local() const <yaml-data-public-bool-yaml-data-is-local-const>`

[bool YAML_data::is_local() const](#yaml-data-public-bool-yaml-data-is-local-const)

save_field_type#

Definition
bool YAML_data::save_field_type() const
Brief description
Detailed description
How to reference this method:

Copy the following pieces of RST/Markdown code to cite this element in other parts of the sphinx documentation (there is a copy button on the top-right when hovering the code block):

:ref:`bool YAML_data::save_field_type() const <yaml-data-public-bool-yaml-data-save-field-type-const>`

[bool YAML_data::save_field_type() const](#yaml-data-public-bool-yaml-data-save-field-type-const)

set_conditions#

Definition
void YAML_data::set_conditions(const std::string &cond)
Brief description
Detailed description
Referenced By
How to reference this method:

Copy the following pieces of RST/Markdown code to cite this element in other parts of the sphinx documentation (there is a copy button on the top-right when hovering the code block):

:ref:`void YAML_data::set_conditions(const std::string &cond) <yaml-data-public-void-yaml-data-set-conditions-const-std-string-ref-cond>`

[void YAML_data::set_conditions(const std::string &cond)](#yaml-data-public-void-yaml-data-set-conditions-const-std-string-ref-cond)

set_dataset#

Definition
void YAML_data::set_dataset(bool d)
Brief description
Detailed description
How to reference this method:

Copy the following pieces of RST/Markdown code to cite this element in other parts of the sphinx documentation (there is a copy button on the top-right when hovering the code block):

:ref:`void YAML_data::set_dataset(bool d) <yaml-data-public-void-yaml-data-set-dataset-bool-d>`

[void YAML_data::set_dataset(bool d)](#yaml-data-public-void-yaml-data-set-dataset-bool-d)

set_hdf_name#

Definition
void YAML_data::set_hdf_name(const std::string &n)
Brief description
Detailed description
How to reference this method:

Copy the following pieces of RST/Markdown code to cite this element in other parts of the sphinx documentation (there is a copy button on the top-right when hovering the code block):

:ref:`void YAML_data::set_hdf_name(const std::string &n) <yaml-data-public-void-yaml-data-set-hdf-name-const-std-string-ref-n>`

[void YAML_data::set_hdf_name(const std::string &n)](#yaml-data-public-void-yaml-data-set-hdf-name-const-std-string-ref-n)

set_local#

Definition
void YAML_data::set_local(bool l)
Brief description
Detailed description
Referenced By
How to reference this method:

Copy the following pieces of RST/Markdown code to cite this element in other parts of the sphinx documentation (there is a copy button on the top-right when hovering the code block):

:ref:`void YAML_data::set_local(bool l) <yaml-data-public-void-yaml-data-set-local-bool-l>`

[void YAML_data::set_local(bool l)](#yaml-data-public-void-yaml-data-set-local-bool-l)

set_save_field_type#

Definition
void YAML_data::set_save_field_type(bool b)
Brief description
Detailed description
Referenced By
How to reference this method:

Copy the following pieces of RST/Markdown code to cite this element in other parts of the sphinx documentation (there is a copy button on the top-right when hovering the code block):

:ref:`void YAML_data::set_save_field_type(bool b) <yaml-data-public-void-yaml-data-set-save-field-type-bool-b>`

[void YAML_data::set_save_field_type(bool b)](#yaml-data-public-void-yaml-data-set-save-field-type-bool-b)

YAML_data#

Definition
YAML_data::YAML_data()
Brief description
Detailed description
How to reference this method:

Copy the following pieces of RST/Markdown code to cite this element in other parts of the sphinx documentation (there is a copy button on the top-right when hovering the code block):

:ref:`YAML_data::YAML_data() <yaml-data-public-yaml-data-yaml-data>`

[YAML_data::YAML_data()](#yaml-data-public-yaml-data-yaml-data)

YAML_data#

Definition
YAML_data::YAML_data(const std::string &name, const std::string &type)
Brief description
Detailed description
How to reference this method:

Copy the following pieces of RST/Markdown code to cite this element in other parts of the sphinx documentation (there is a copy button on the top-right when hovering the code block):

:ref:`YAML_data::YAML_data(const std::string &name, const std::string &type) <yaml-data-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)](#yaml-data-public-yaml-data-yaml-data-const-std-string-ref-name-const-std-string-ref-type)

YAML_data#

Definition
YAML_data::YAML_data(const std::string &name, const std::string &type, int nb_dim)
Brief description
Detailed description
How to reference this method:

Copy the following pieces of RST/Markdown code to cite this element in other parts of the sphinx documentation (there is a copy button on the top-right when hovering the code block):

:ref:`YAML_data::YAML_data(const std::string &name, const std::string &type, int nb_dim) <yaml-data-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)](#yaml-data-public-yaml-data-yaml-data-const-std-string-ref-name-const-std-string-ref-type-int-nb-dim)

YAML_data#

Definition
YAML_data::YAML_data(const std::string &name, const std::string &type, int nb_dim, bool loc)
Brief description
Detailed description
How to reference this method:

Copy the following pieces of RST/Markdown code to cite this element in other parts of the sphinx documentation (there is a copy button on the top-right when hovering the code block):

:ref:`YAML_data::YAML_data(const std::string &name, const std::string &type, int nb_dim, bool loc) <yaml-data-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)](#yaml-data-public-yaml-data-yaml-data-const-std-string-ref-name-const-std-string-ref-type-int-nb-dim-bool-loc)

YAML_data#

Definition
YAML_data::YAML_data(const std::string &name, const std::string &type, int nb_dim, bool loc, bool is_ds)
Brief description
Detailed description
How to reference this method:

Copy the following pieces of RST/Markdown code to cite this element in other parts of the sphinx documentation (there is a copy button on the top-right when hovering the code block):

:ref:`YAML_data::YAML_data(const std::string &name, const std::string &type, int nb_dim, bool loc, bool is_ds) <yaml-data-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)](#yaml-data-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_
Contents