Interface yaml_interface_mod::yaml_get¶

ClassList > yaml_interface_mod > 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.

Public Functions¶

Type	Name
subroutine	yaml_get_integer_generic (type(yaml_node_t), intent(in) node, character(len=), intent(in) key, integer, intent(out) value, integer, intent(out), optional rc, integer, intent(in), optional default_value) Generic integer getter with optional default and return code.*
subroutine	yaml_get_logical_generic (type(yaml_node_t), intent(in) node, character(len=), intent(in) key, logical, intent(out) value, integer, intent(out), optional rc, logical, intent(in), optional default_value) Generic logical getter with optional default and return code.*
subroutine	yaml_get_real_dp_generic (type(yaml_node_t), intent(in) node, character(len=), intent(in) key, real(kind=real64), intent(out) value, integer, intent(out), optional rc, real(kind=real64), intent(in), optional default_value) Generic double precision real getter.*
subroutine	yaml_get_real_sp_generic (type(yaml_node_t), intent(in) node, character(len=), intent(in) key, real(kind=real32), intent(out) value, integer, intent(out), optional rc, real(kind=real32), intent(in), optional default_value) Generic single precision real getter.*
subroutine	yaml_get_string_generic (type(yaml_node_t), intent(in) node, character(len=), intent(in) key, character(len=), intent(out) value, integer, intent(out), optional rc, character(len=), intent(in), optional default_value) Generic string getter with optional default and return code.*

Public Functions Documentation¶

function yaml_get_integer_generic¶

Generic integer getter with optional default and return code.

subroutine yaml_interface_mod::yaml_get::yaml_get_integer_generic (
    type( yaml_node_t ), intent(in) node,
    character(len=*), intent(in) key,
    integer, intent(out) value,
    integer, intent(out), optional rc,
    integer, intent(in), optional default_value
)

function yaml_get_logical_generic¶

Generic logical getter with optional default and return code.

subroutine yaml_interface_mod::yaml_get::yaml_get_logical_generic (
    type( yaml_node_t ), intent(in) node,
    character(len=*), intent(in) key,
    logical, intent(out) value,
    integer, intent(out), optional rc,
    logical, intent(in), optional default_value
)

function yaml_get_real_dp_generic¶

Generic double precision real getter.

subroutine yaml_interface_mod::yaml_get::yaml_get_real_dp_generic (
    type( yaml_node_t ), intent(in) node,
    character(len=*), intent(in) key,
    real(kind=real64), intent(out) value,
    integer, intent(out), optional rc,
    real(kind=real64), intent(in), optional default_value
)

function yaml_get_real_sp_generic¶

Generic single precision real getter.

subroutine yaml_interface_mod::yaml_get::yaml_get_real_sp_generic (
    type( yaml_node_t ), intent(in) node,
    character(len=*), intent(in) key,
    real(kind=real32), intent(out) value,
    integer, intent(out), optional rc,
    real(kind=real32), intent(in), optional default_value
)

function yaml_get_string_generic¶

Generic string getter with optional default and return code.

subroutine yaml_interface_mod::yaml_get::yaml_get_string_generic (
    type( yaml_node_t ), intent(in) node,
    character(len=*), intent(in) key,
    character(len=*), intent(out) value,
    integer, intent(out), optional rc,
    character(len=*), intent(in), optional default_value
)

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