group_id¶

Syntax¶

group_id(group_name)
group_id(unique_group_id)

Parameters¶

group_name: A valid group name.
unique_group_name: Expression that evaluates to a valid unique group ID.

Returns¶

Returns the ID of a group agent, or, if the agent is not a member of the given group, or the argument is not a valid group ID, or if the group does not have an group agent, returns 0.

Description¶

The first form returns the ID the group agent for the executing agent's group. Returns 0 if the agent is not a member of the given group, or if the group does not have a group agent.

The second form returns the ID the group agent for the group whose unique group_id is provided. Returns 0 if the argument is not the ID of a group, or if the group does not have a group agent.

Note

All group agents have IDs , 0, so the value of 0 indicates a missing repsonse.

Examples¶

Suppose the model declares that each school has a group agent.

place School {
      has_group_agent = 1
}

The following would return the ID of the group agent for the student's specific school.

my_school_group_agent = group_id(School)