get_group_agents¶
Syntax¶
Parameters¶
<group_name>- A valid group name.
Returns¶
Retrieves the list of group agents for sites of the given group_name.
Description¶
Returns the list of group agent ids for the given group. If the group is a place, returns the list in the order in which individual sites of that place are generated.
Examples¶
Suppose the user defines a new Place called Pharmacy and generates two pharmacies, as per the following code.
place Pharmacy {
has_group_agent = 1
site = 942003001, 40.451164, -79.999803, 230.1
site = 942003002, 40.626449, -79.723195, 240.5
}
Then get_group_agents(Pharmacy) returns the agent IDs of the group agents for the two Pharmacy sites generated above.