Namespace yaml_interface_mod¶

Namespace List > yaml_interface_mod

Classes¶

Type	Name
interface	yaml_get Generic interface for getting values from YAML This allows uniform syntax: call yaml_get(node, key, value, rc) for any supported data type.
interface	yaml_get_array Generic interface for getting arrays from YAML This allows uniform syntax: call yaml_get_array(node, key, values, rc) for any supported array type.
interface	yaml_set Generic interface for setting values in YAML This allows uniform syntax: call yaml_set(node, key, value, rc) for any supported data type.

Public Functions¶

Type	Name
subroutine, public	safe_yaml_get_integer (type(yaml_node_t), intent(in) yaml_root, character(len=), intent(in) key, integer, intent(out) value, integer, intent(out) rc) Safe YAML integer reader Reads value as string first, then converts to avoid yaml-cpp conversion errors.*
subroutine, public	safe_yaml_get_logical (type(yaml_node_t), intent(in) yaml_root, character(len=), intent(in) key, logical, intent(out) value, integer, intent(out) rc) Safe YAML logical reader Reads value as string first, then converts to avoid yaml-cpp conversion errors.*
subroutine, public	safe_yaml_get_real (type(yaml_node_t), intent(in) yaml_root, character(len=), intent(in) key, real(fp), intent(out) value, integer, intent(out) rc) Safe YAML real number reader Reads value as string first, then converts to avoid yaml-cpp conversion errors.*
subroutine, public	yaml_destroy_node (type(yaml_node_t), intent(inout) node) Destroy YAML node.
logical function, public	yaml_get_all_keys (type(yaml_node_t), intent(in) node, character(len=), dimension(:), intent(out) keys, integer, intent(out) actual_count) Get all keys from a YAML map.*
logical function, public	yaml_get_integer (type(yaml_node_t), intent(in) node, character(len=), intent(in) key, integer, intent(out) value) Get integer value.*
logical function, public	yaml_get_integer_array (type(yaml_node_t), intent(in) node, character(len=), intent(in) key, integer, dimension(:), intent(out) values, integer, intent(out) actual_size) Get integer array.*
logical function, public	yaml_get_logical (type(yaml_node_t), intent(in) node, character(len=), intent(in) key, logical, intent(out) value) Get logical value.*
logical function, public	yaml_get_real (type(yaml_node_t), intent(in) node, character(len=), intent(in) key, real(fp), intent(out) value) Get real value.*
logical function, public	yaml_get_real_array (type(yaml_node_t), intent(in) node, character(len=), intent(in) key, real(fp), dimension(:), intent(out) values, integer, intent(out) actual_size) Get real array.*
integer function, public	yaml_get_size (type(yaml_node_t), intent(in) node) Get size of node.
logical function, public	yaml_get_string (type(yaml_node_t), intent(in) node, character(len=), intent(in) key, character(len=), intent(out) value) Get string value.
logical function, public	yaml_get_string_array (type(yaml_node_t), intent(in) node, character(len=), intent(in) key, character(len=), dimension(:), intent(out) values, integer, intent(out) actual_size) Get string array.
logical function, public	yaml_has_key (type(yaml_node_t), intent(in) node, character(len=), intent(in) key) Check if key exists.*
logical function, public	yaml_is_map (type(yaml_node_t), intent(in) node) Check if node is map.
logical function, public	yaml_is_sequence (type(yaml_node_t), intent(in) node) Check if node is sequence.
type(yaml_node_t) function, public	yaml_load_file (character(len=), intent(in) filename) Load YAML from file.*
type(yaml_node_t) function, public	yaml_load_string (character(len=), intent(in) yaml_string) Load YAML from string.*
logical function, public	yaml_save_file (type(yaml_node_t), intent(in) node, character(len=), intent(in) filename) Save YAML to file.*
type(yaml_node_t) function, public	yaml_sequence_to_map (type(yaml_node_t), intent(in) node)
logical function, public	yaml_set_integer (type(yaml_node_t), intent(in) node, character(len=), intent(in) key, integer, intent(in) value) Set integer value.*
logical function, public	yaml_set_logical (type(yaml_node_t), intent(in) node, character(len=), intent(in) key, logical, intent(in) value) Set logical value.*
logical function, public	yaml_set_real (type(yaml_node_t), intent(in) node, character(len=), intent(in) key, real(fp), intent(in) value) Set real value.*
logical function, public	yaml_set_string (type(yaml_node_t), intent(in) node, character(len=), intent(in) key, character(len=), intent(in) value) Set string value.

Public Functions Documentation¶

function safe_yaml_get_integer¶

Safe YAML integer reader Reads value as string first, then converts to avoid yaml-cpp conversion errors.

subroutine, public yaml_interface_mod::safe_yaml_get_integer (
    type( yaml_node_t ), intent(in) yaml_root,
    character(len=*), intent(in) key,
    integer, intent(out) value,
    integer, intent(out) rc
)

function safe_yaml_get_logical¶

Safe YAML logical reader Reads value as string first, then converts to avoid yaml-cpp conversion errors.

subroutine, public yaml_interface_mod::safe_yaml_get_logical (
    type( yaml_node_t ), intent(in) yaml_root,
    character(len=*), intent(in) key,
    logical, intent(out) value,
    integer, intent(out) rc
)

function safe_yaml_get_real¶

Safe YAML real number reader Reads value as string first, then converts to avoid yaml-cpp conversion errors.

subroutine, public yaml_interface_mod::safe_yaml_get_real (
    type( yaml_node_t ), intent(in) yaml_root,
    character(len=*), intent(in) key,
    real(fp), intent(out) value,
    integer, intent(out) rc
)

function yaml_destroy_node¶

Destroy YAML node.

subroutine, public yaml_interface_mod::yaml_destroy_node (
    type( yaml_node_t ), intent(inout) node
)

function yaml_get_all_keys¶

Get all keys from a YAML map.

logical function, public yaml_interface_mod::yaml_get_all_keys (
    type( yaml_node_t ), intent(in) node,
    character(len=*), dimension(:), intent(out) keys,
    integer, intent(out) actual_count
)

function yaml_get_integer¶

Get integer value.

logical function, public yaml_interface_mod::yaml_get_integer (
    type( yaml_node_t ), intent(in) node,
    character(len=*), intent(in) key,
    integer, intent(out) value
)

function yaml_get_integer_array¶

Get integer array.

logical function, public yaml_interface_mod::yaml_get_integer_array (
    type( yaml_node_t ), intent(in) node,
    character(len=*), intent(in) key,
    integer, dimension(:), intent(out) values,
    integer, intent(out) actual_size
)

function yaml_get_logical¶

Get logical value.

logical function, public yaml_interface_mod::yaml_get_logical (
    type( yaml_node_t ), intent(in) node,
    character(len=*), intent(in) key,
    logical, intent(out) value
)

function yaml_get_real¶

Get real value.

logical function, public yaml_interface_mod::yaml_get_real (
    type( yaml_node_t ), intent(in) node,
    character(len=*), intent(in) key,
    real(fp), intent(out) value
)

function yaml_get_real_array¶

Get real array.

logical function, public yaml_interface_mod::yaml_get_real_array (
    type( yaml_node_t ), intent(in) node,
    character(len=*), intent(in) key,
    real(fp), dimension(:), intent(out) values,
    integer, intent(out) actual_size
)

function yaml_get_size¶

Get size of node.

integer function, public yaml_interface_mod::yaml_get_size (
    type( yaml_node_t ), intent(in) node
)

function yaml_get_string¶

Get string value.

logical function, public yaml_interface_mod::yaml_get_string (
    type( yaml_node_t ), intent(in) node,
    character(len=*), intent(in) key,
    character(len=*), intent(out) value
)

function yaml_get_string_array¶

Get string array.

logical function, public yaml_interface_mod::yaml_get_string_array (
    type( yaml_node_t ), intent(in) node,
    character(len=*), intent(in) key,
    character(len=*), dimension(:), intent(out) values,
    integer, intent(out) actual_size
)

function yaml_has_key¶

Check if key exists.

logical function, public yaml_interface_mod::yaml_has_key (
    type( yaml_node_t ), intent(in) node,
    character(len=*), intent(in) key
)

function yaml_is_map¶

Check if node is map.

logical function, public yaml_interface_mod::yaml_is_map (
    type( yaml_node_t ), intent(in) node
)

function yaml_is_sequence¶

Check if node is sequence.

logical function, public yaml_interface_mod::yaml_is_sequence (
    type( yaml_node_t ), intent(in) node
)

function yaml_load_file¶

Load YAML from file.

type( yaml_node_t ) function, public yaml_interface_mod::yaml_load_file (
    character(len=*), intent(in) filename
)

function yaml_load_string¶

Load YAML from string.

type( yaml_node_t ) function, public yaml_interface_mod::yaml_load_string (
    character(len=*), intent(in) yaml_string
)

function yaml_save_file¶

Save YAML to file.

logical function, public yaml_interface_mod::yaml_save_file (
    type( yaml_node_t ), intent(in) node,
    character(len=*), intent(in) filename
)

function yaml_sequence_to_map¶

type( yaml_node_t ) function, public yaml_interface_mod::yaml_sequence_to_map (
    type( yaml_node_t ), intent(in) node
)

function yaml_set_integer¶

Set integer value.

logical function, public yaml_interface_mod::yaml_set_integer (
    type( yaml_node_t ), intent(in) node,
    character(len=*), intent(in) key,
    integer, intent(in) value
)

function yaml_set_logical¶

Set logical value.

logical function, public yaml_interface_mod::yaml_set_logical (
    type( yaml_node_t ), intent(in) node,
    character(len=*), intent(in) key,
    logical, intent(in) value
)

function yaml_set_real¶

Set real value.

logical function, public yaml_interface_mod::yaml_set_real (
    type( yaml_node_t ), intent(in) node,
    character(len=*), intent(in) key,
    real(fp), intent(in) value
)

function yaml_set_string¶

Set string value.

logical function, public yaml_interface_mod::yaml_set_string (
    type( yaml_node_t ), intent(in) node,
    character(len=*), intent(in) key,
    character(len=*), intent(in) value
)

The documentation for this class was generated from the following file src/external/yaml_interface/yaml_interface_mod.F90