nml_string_key_t Derived Type

type, public, extends(nml_key_t) :: nml_string_key_t

String key. Deferred-len char pointer associates with a fixed-len target and assumes its length; parsing errors if the parsed value is LONGER than len(tgt) (no silent truncation).


Inherits

type~~nml_string_key_t~~InheritsGraph type~nml_string_key_t nml_string_key_t type~nml_key_t nml_key_t type~nml_string_key_t->type~nml_key_t

Inherited by

type~~nml_string_key_t~~InheritedByGraph type~nml_string_key_t nml_string_key_t type~nml_enum_key_t nml_enum_key_t type~nml_enum_key_t->type~nml_string_key_t

Components

Type Visibility Attributes Name Initial
character(len=:), public, allocatable :: dead_reason

Unallocated/empty = live. Non-empty = this knob is registered (accepted, type/range-validated) but does NOT reach any ocean-path behaviour – e.g. &vcoord_nml zstar_stretching is captured on cfg but never copied onto ocean_state%vcoord (rdb_ocean_vcoord.F90:179,182). Carried into the JSON emitter (render_json) so a generated caller-side layer can warn on assignment instead of presenting a dead knob as live.
character(len=:), public, allocatable :: default
character(len=:), public, allocatable :: doc

Human-readable description (FORD-style synthesis doc).
logical, public :: found = .false.

Parse-state: set true when the key is seen in the file.
character(len=:), public, allocatable :: name

Key name (matched case-insensitively).
logical, public :: required = .false.

If true, the key must appear whenever its group appears.
character(len=:), public, pointer :: tgt => null()
character(len=:), public, allocatable :: units

Optional units string, default ‘’.

Type-Bound Procedures

procedure, public :: default_string => string_default_string

  • private function string_default_string(this) result(str)

    Arguments

    Type IntentOptional Attributes Name
    class(nml_string_key_t), intent(in) :: this

    Return Value character(len=:), allocatable

procedure, public :: is_default => string_is_default

  • private function string_is_default(this) result(yes)

    Arguments

    Type IntentOptional Attributes Name
    class(nml_string_key_t), intent(in) :: this

    Return Value logical

procedure, public :: parse_tokens => string_parse

  • private subroutine string_parse(this, values, err_msg)

    Arguments

    Type IntentOptional Attributes Name
    class(nml_string_key_t), intent(inout) :: this
    character(len=*), intent(in) :: values(:)
    character(len=:), intent(out), allocatable :: err_msg

procedure, public :: value_string => string_value_string

  • private function string_value_string(this) result(str)

    Arguments

    Type IntentOptional Attributes Name
    class(nml_string_key_t), intent(in) :: this

    Return Value character(len=:), allocatable

Source Code

   type, extends(nml_key_t) :: nml_string_key_t
      !! String key.  Deferred-len char pointer associates with a
      !! fixed-len target and assumes its length; parsing errors if the
      !! parsed value is LONGER than len(tgt) (no silent truncation).
      character(len=:), pointer :: tgt => null()
      character(len=:), allocatable :: default
   contains
      procedure :: parse_tokens => string_parse
      procedure :: value_string => string_value_string
      procedure :: default_string => string_default_string
      procedure :: is_default => string_is_default
   end type nml_string_key_t