the_environment::join Interface Reference

An alias for the the_environment::food_resources_collapse_global_object() method for joining food resources into a single global food resource out of the global array the_environment::global_habitats_available. See the_environment::unjoin() for how to unjoin an array of food resources back into an array. More...

Collaboration diagram for the_environment::join:

Public Member Functions
type(food_resource) function	food_resources_collapse_global_object (reindex, label)
	Join food resources into a single global food resource out of the global array the_environment::global_habitats_available. See the_environment::unjoin() for how to unjoin an array of food resources back into an array. The joined resource can then go into the perception system. The properties of the component resources are retained in the collapsed resource. More...

Detailed Description

An alias for the the_environment::food_resources_collapse_global_object() method for joining food resources into a single global food resource out of the global array the_environment::global_habitats_available. See the_environment::unjoin() for how to unjoin an array of food resources back into an array.

Definition at line 767 of file m_env.f90.

Member Function/Subroutine Documentation

food_resources_collapse_global_object()

type(food_resource) function the_environment::join::food_resources_collapse_global_object	(	logical, intent(in), optional	reindex,
		character(len=*), intent(in), optional	label
	)

Join food resources into a single global food resource out of the global array the_environment::global_habitats_available. See the_environment::unjoin() for how to unjoin an array of food resources back into an array. The joined resource can then go into the perception system. The properties of the component resources are retained in the collapsed resource.

Note

This procedure is intended to use a short interface name join, see the_environment::join().

A similar procedure using a list of input component resources is implemented in the_environment::food_resources_collapse().

Parameters

[in]	reindex	reindex logical flag to reindex the joined resource (TRUE) upon joining. The default is no reindexing.
[in]	label	label Label for the joined food resource, if absent set to 'tmp_object'.

Returns

A collapsed food resource joining the input array.

Definition at line 7914 of file m_env.f90.

---

The documentation for this interface was generated from the following file:

• m_env.f90