RegridderSpecRouteHandleMap Derived Type

type, public :: RegridderSpecRouteHandleMap

Inherits

Help

Inherited by

Help

Constructor

public interface RegridderSpecRouteHandleMap

private function m_new_map_empty() result(m)

Arguments
None
Return Value type(RegridderSpecRouteHandleMap)

private function m_new_map_from_pair_array(pairs) result(m)

Arguments

Type	Intent	Optional	Attributes		Name
type(pair),	intent(in)			::	pairs(:)

Return Value type(RegridderSpecRouteHandleMap)

Type-Bound Procedures

procedure, public :: at => m_at

private function m_at(this, key) result(res)

Arguments

Type	Intent	Optional	Attributes		Name
class(RegridderSpecRouteHandleMap),	intent(in),		target	::	this
type(RegridderSpec),	intent(in)			::	key

Return Value type(ESMF_RouteHandle), pointer

procedure, public :: begin => m_begin

private function m_begin(this) result(iter)

Arguments

Type	Intent	Optional	Attributes		Name
class(RegridderSpecRouteHandleMap),	intent(in),		target	::	this

Return Value type(RegridderSpecRouteHandleMapIterator)

procedure, public :: clear => m_clear

private subroutine m_clear(this)

Arguments

Type	Intent	Optional	Attributes		Name
class(RegridderSpecRouteHandleMap),	intent(inout)			::	this

procedure, public :: count => m_count

private function m_count(this, key) result(count)

Arguments

Type	Intent	Optional	Attributes		Name
class(RegridderSpecRouteHandleMap),	intent(in)			::	this
type(RegridderSpec),	intent(in)			::	key

Return Value integer(kind=SIZE_KIND)

procedure, public :: deepCopy => m_deepCopy

private subroutine m_deepCopy(this, original)

Arguments

Type	Intent	Optional	Attributes		Name
class(RegridderSpecRouteHandleMap),	intent(out)			::	this
class(RegridderSpecRouteHandleMap),	intent(in)			::	original

procedure, public :: empty => m_empty

private function m_empty(this) result(isEmpty)

Arguments

Type	Intent	Optional	Attributes		Name
class(RegridderSpecRouteHandleMap),	intent(in)			::	this

Return Value logical

procedure, public :: end => m_end

private function m_end(this) result(iter)

Arguments

Type	Intent	Optional	Attributes		Name
class(RegridderSpecRouteHandleMap),	intent(in),		target	::	this

Return Value type(RegridderSpecRouteHandleMapIterator)

generic, public :: erase => erase_one

private subroutine m_erase_one(this, iter)

Arguments

Type	Intent	Optional	Attributes		Name
class(RegridderSpecRouteHandleMap),	intent(inout)			::	this
type(RegridderSpecRouteHandleMapIterator),	intent(inout)			::	iter

procedure, public :: erase_one => m_erase_one

private subroutine m_erase_one(this, iter)

Arguments

Type	Intent	Optional	Attributes		Name
class(RegridderSpecRouteHandleMap),	intent(inout)			::	this
type(RegridderSpecRouteHandleMapIterator),	intent(inout)			::	iter

procedure, public :: find => m_find

private function m_find(this, key) result(iter)

Arguments

Type	Intent	Optional	Attributes		Name
class(RegridderSpecRouteHandleMap),	intent(in),		target	::	this
type(RegridderSpec),	intent(in)			::	key

Return Value type(RegridderSpecRouteHandleMapIterator)

procedure, public :: get => m_get

private function m_get(this, key, value) result(res)

Arguments

Type	Intent	Optional	Attributes		Name
class(RegridderSpecRouteHandleMap),	intent(in),		target	::	this
type(RegridderSpec)				::	key
type(ESMF_RouteHandle),	intent(out),		pointer	::	value

Return Value logical

generic, public :: insert => insert_key_value

private subroutine m_insert_key_value(this, key, value)

Arguments

Type	Intent	Optional	Attributes		Name
class(RegridderSpecRouteHandleMap),	intent(inout)			::	this
type(RegridderSpec),	intent(in)			::	key
type(ESMF_RouteHandle),	intent(in)			::	value

generic, public :: insert => insert_pair

private subroutine m_insert_pair(this, p)

Arguments

Type	Intent	Optional	Attributes		Name
class(RegridderSpecRouteHandleMap),	intent(inout)			::	this
type(pair),	intent(in)			::	p

procedure, public :: insert_key_value => m_insert_key_value

private subroutine m_insert_key_value(this, key, value)

Arguments

Type	Intent	Optional	Attributes		Name
class(RegridderSpecRouteHandleMap),	intent(inout)			::	this
type(RegridderSpec),	intent(in)			::	key
type(ESMF_RouteHandle),	intent(in)			::	value

procedure, public :: insert_pair => m_insert_pair

private subroutine m_insert_pair(this, p)

Arguments

Type	Intent	Optional	Attributes		Name
class(RegridderSpecRouteHandleMap),	intent(inout)			::	this
type(pair),	intent(in)			::	p

procedure, public, nopass :: max_size => m_max_size

private function m_max_size() result(max_size)

Arguments
None
Return Value integer(kind=SIZE_KIND)

procedure, public :: of => m_of

private function m_of(this, key) result(res)

Arguments

Type	Intent	Optional	Attributes		Name
class(RegridderSpecRouteHandleMap),	intent(inout),		target	::	this
type(RegridderSpec),	intent(in)			::	key

Return Value type(ESMF_RouteHandle), pointer

procedure, public :: set => m_set

private subroutine m_set(this, key, value)

Arguments

Type	Intent	Optional	Attributes		Name
class(RegridderSpecRouteHandleMap),	intent(inout)			::	this
type(RegridderSpec),	intent(in)			::	key
type(ESMF_RouteHandle),	intent(in)			::	value

procedure, public :: size => m_size

private function m_size(this) result(size)

Arguments

Type	Intent	Optional	Attributes		Name
class(RegridderSpecRouteHandleMap),	intent(in)			::	this

Return Value integer(kind=SIZE_kind)