#include <model.h>

Inheritance diagram for fpmas::api::model::Agent:

[legend]

Public Member Functions
virtual GroupId	groupId () const =0

virtual std::vector< GroupId >	groupIds () const =0

virtual void	setGroupId (GroupId id)=0

virtual void	addGroupId (GroupId id)=0

virtual void	removeGroupId (GroupId id)=0

virtual AgentGroup *	group ()=0

virtual const AgentGroup *	group () const =0

virtual std::vector< AgentGroup * >	groups ()=0

virtual std::vector< const AgentGroup * >	groups () const =0

virtual void	setGroup (AgentGroup *group)=0

virtual void	addGroup (AgentGroup *group)=0

virtual void	removeGroup (AgentGroup *group)=0

virtual void	setGroupPos (api::model::GroupId gid, std::list< Agent * >::iterator pos)=0

virtual std::list< Agent * >::iterator	getGroupPos (api::model::GroupId gid) const =0

virtual TypeId	typeId () const =0

virtual Agent *	copy () const =0

virtual void	copyAssign (Agent *agent)=0

virtual void	moveAssign (Agent *agent)=0

virtual AgentNode *	node ()=0

virtual const AgentNode *	node () const =0

virtual void	setNode (AgentNode *node)=0

virtual Model *	model ()=0

virtual const Model *	model () const =0

virtual void	setModel (Model *model)=0

virtual AgentTask *	task ()=0

virtual const AgentTask *	task () const =0

virtual void	setTask (AgentTask *task)=0

virtual AgentTask *	task (GroupId id)=0

virtual const AgentTask *	task (GroupId id) const =0

virtual void	setTask (GroupId id, AgentTask *task)=0

virtual const std::unordered_map< GroupId, AgentTask * > &	tasks ()=0

virtual void	act ()=0

Detailed Description

Generic Agent API.

Agents in a simulation are assumed to take advantage of polymorphism : a single type is used to store Agents in an api::graph::DistributedGraph (more precisely, AgentPtr is used), but pointed Agents might have different types and implement different the act() functions to produce different behaviors.

Member Function Documentation

◆ groupId()

virtual GroupId fpmas::api::model::Agent::groupId ( ) const

pure virtual

Deprecated:: Returns the ID of the AgentGroup to which this Agent belong.

This method is deprecated and will be removed in a next release. Use groupIds() instead.

Returns: group id

Implemented in fpmas::model::detail::AgentBase< api::model::Cell, GraphCell, GraphCellBase< GraphCell, GraphCell > >, fpmas::model::detail::AgentBase< api::model::Cell, GraphCellType, GraphCellBase< GraphCellType, GraphCellType > >, fpmas::model::detail::AgentBase< api::model::GridAgent< model::GridCell >, AgentType, SpatialAgentBase< api::model::GridAgent< model::GridCell >, AgentType, model::GridCell, GridAgent< AgentType, model::GridCell, AgentType > > >, fpmas::model::detail::AgentBase< api::model::GridCell, GridCell, GridCellBase< GridCell, GridCell > >, fpmas::model::detail::AgentBase< api::model::GridCell, GridCellType, GridCellBase< GridCellType, GridCellType > >, and fpmas::model::detail::AgentBase< api::model::SpatialAgent< api::model::Cell >, AgentType, SpatialAgentBase< api::model::SpatialAgent< api::model::Cell >, AgentType, api::model::Cell, AgentType > >.

◆ groupIds()

virtual std::vector< GroupId > fpmas::api::model::Agent::groupIds ( ) const

pure virtual

Returns ids of AgentGroups to which the Agent belong.

Returns: list of group ids

Implemented in fpmas::model::detail::AgentBase< api::model::Cell, GraphCell, GraphCellBase< GraphCell, GraphCell > >, fpmas::model::detail::AgentBase< api::model::Cell, GraphCellType, GraphCellBase< GraphCellType, GraphCellType > >, fpmas::model::detail::AgentBase< api::model::GridAgent< model::GridCell >, AgentType, SpatialAgentBase< api::model::GridAgent< model::GridCell >, AgentType, model::GridCell, GridAgent< AgentType, model::GridCell, AgentType > > >, fpmas::model::detail::AgentBase< api::model::GridCell, GridCell, GridCellBase< GridCell, GridCell > >, fpmas::model::detail::AgentBase< api::model::GridCell, GridCellType, GridCellBase< GridCellType, GridCellType > >, and fpmas::model::detail::AgentBase< api::model::SpatialAgent< api::model::Cell >, AgentType, SpatialAgentBase< api::model::SpatialAgent< api::model::Cell >, AgentType, api::model::Cell, AgentType > >.

◆ setGroupId()

virtual void fpmas::api::model::Agent::setGroupId ( GroupId id )

pure virtual

Deprecated:: Sets this Agent group ID.

This method is deprecated and will be removed in a next release. Use addGroupId() instead.

Parameters

id	agent group id

Implemented in fpmas::model::detail::AgentBase< api::model::Cell, GraphCell, GraphCellBase< GraphCell, GraphCell > >, fpmas::model::detail::AgentBase< api::model::Cell, GraphCellType, GraphCellBase< GraphCellType, GraphCellType > >, fpmas::model::detail::AgentBase< api::model::GridAgent< model::GridCell >, AgentType, SpatialAgentBase< api::model::GridAgent< model::GridCell >, AgentType, model::GridCell, GridAgent< AgentType, model::GridCell, AgentType > > >, fpmas::model::detail::AgentBase< api::model::GridCell, GridCell, GridCellBase< GridCell, GridCell > >, fpmas::model::detail::AgentBase< api::model::GridCell, GridCellType, GridCellBase< GridCellType, GridCellType > >, and fpmas::model::detail::AgentBase< api::model::SpatialAgent< api::model::Cell >, AgentType, SpatialAgentBase< api::model::SpatialAgent< api::model::Cell >, AgentType, api::model::Cell, AgentType > >.

◆ addGroupId()

virtual void fpmas::api::model::Agent::addGroupId ( GroupId id )

pure virtual

Adds id to this Agent's group ids.

Parameters

id	agent group id

Implemented in fpmas::model::detail::AgentBase< api::model::Cell, GraphCell, GraphCellBase< GraphCell, GraphCell > >, fpmas::model::detail::AgentBase< api::model::Cell, GraphCellType, GraphCellBase< GraphCellType, GraphCellType > >, fpmas::model::detail::AgentBase< api::model::GridAgent< model::GridCell >, AgentType, SpatialAgentBase< api::model::GridAgent< model::GridCell >, AgentType, model::GridCell, GridAgent< AgentType, model::GridCell, AgentType > > >, fpmas::model::detail::AgentBase< api::model::GridCell, GridCell, GridCellBase< GridCell, GridCell > >, fpmas::model::detail::AgentBase< api::model::GridCell, GridCellType, GridCellBase< GridCellType, GridCellType > >, and fpmas::model::detail::AgentBase< api::model::SpatialAgent< api::model::Cell >, AgentType, SpatialAgentBase< api::model::SpatialAgent< api::model::Cell >, AgentType, api::model::Cell, AgentType > >.

◆ removeGroupId()

virtual void fpmas::api::model::Agent::removeGroupId ( GroupId id )

pure virtual

Removes id from this Agent's group ids.

Parameters

id	agent group id

Implemented in fpmas::model::detail::AgentBase< api::model::Cell, GraphCell, GraphCellBase< GraphCell, GraphCell > >, fpmas::model::detail::AgentBase< api::model::Cell, GraphCellType, GraphCellBase< GraphCellType, GraphCellType > >, fpmas::model::detail::AgentBase< api::model::GridAgent< model::GridCell >, AgentType, SpatialAgentBase< api::model::GridAgent< model::GridCell >, AgentType, model::GridCell, GridAgent< AgentType, model::GridCell, AgentType > > >, fpmas::model::detail::AgentBase< api::model::GridCell, GridCell, GridCellBase< GridCell, GridCell > >, fpmas::model::detail::AgentBase< api::model::GridCell, GridCellType, GridCellBase< GridCellType, GridCellType > >, and fpmas::model::detail::AgentBase< api::model::SpatialAgent< api::model::Cell >, AgentType, SpatialAgentBase< api::model::SpatialAgent< api::model::Cell >, AgentType, api::model::Cell, AgentType > >.

◆ group() [1/2]

virtual AgentGroup * fpmas::api::model::Agent::group ( )

pure virtual

Deprecated:: Returns a pointer to the AgentGroup to which this Agent belong.

This method is deprecated and will be removed in a next release. Use groups() instead.

Returns: pointer to agent group

Implemented in fpmas::model::detail::AgentBase< api::model::Cell, GraphCell, GraphCellBase< GraphCell, GraphCell > >, fpmas::model::detail::AgentBase< api::model::Cell, GraphCellType, GraphCellBase< GraphCellType, GraphCellType > >, fpmas::model::detail::AgentBase< api::model::GridAgent< model::GridCell >, AgentType, SpatialAgentBase< api::model::GridAgent< model::GridCell >, AgentType, model::GridCell, GridAgent< AgentType, model::GridCell, AgentType > > >, fpmas::model::detail::AgentBase< api::model::GridCell, GridCell, GridCellBase< GridCell, GridCell > >, fpmas::model::detail::AgentBase< api::model::GridCell, GridCellType, GridCellBase< GridCellType, GridCellType > >, and fpmas::model::detail::AgentBase< api::model::SpatialAgent< api::model::Cell >, AgentType, SpatialAgentBase< api::model::SpatialAgent< api::model::Cell >, AgentType, api::model::Cell, AgentType > >.

◆ group() [2/2]

virtual const AgentGroup * fpmas::api::model::Agent::group ( ) const

pure virtual

Deprecated:: Returns a pointer to the AgentGroup to which this Agent belong.

This method is deprecated and will be removed in a next release. Use groups() instead.

Returns: pointer to agent group

Implemented in fpmas::model::detail::AgentBase< api::model::Cell, GraphCell, GraphCellBase< GraphCell, GraphCell > >, fpmas::model::detail::AgentBase< api::model::Cell, GraphCellType, GraphCellBase< GraphCellType, GraphCellType > >, fpmas::model::detail::AgentBase< api::model::GridAgent< model::GridCell >, AgentType, SpatialAgentBase< api::model::GridAgent< model::GridCell >, AgentType, model::GridCell, GridAgent< AgentType, model::GridCell, AgentType > > >, fpmas::model::detail::AgentBase< api::model::GridCell, GridCell, GridCellBase< GridCell, GridCell > >, fpmas::model::detail::AgentBase< api::model::GridCell, GridCellType, GridCellBase< GridCellType, GridCellType > >, and fpmas::model::detail::AgentBase< api::model::SpatialAgent< api::model::Cell >, AgentType, SpatialAgentBase< api::model::SpatialAgent< api::model::Cell >, AgentType, api::model::Cell, AgentType > >.

◆ groups() [1/2]

virtual std::vector< AgentGroup * > fpmas::api::model::Agent::groups ( )

pure virtual

Returns a list of AgentGroups to which this Agent belong.

Returns: agent group list

Implemented in fpmas::model::detail::AgentBase< api::model::Cell, GraphCell, GraphCellBase< GraphCell, GraphCell > >, fpmas::model::detail::AgentBase< api::model::Cell, GraphCellType, GraphCellBase< GraphCellType, GraphCellType > >, fpmas::model::detail::AgentBase< api::model::GridAgent< model::GridCell >, AgentType, SpatialAgentBase< api::model::GridAgent< model::GridCell >, AgentType, model::GridCell, GridAgent< AgentType, model::GridCell, AgentType > > >, fpmas::model::detail::AgentBase< api::model::GridCell, GridCell, GridCellBase< GridCell, GridCell > >, fpmas::model::detail::AgentBase< api::model::GridCell, GridCellType, GridCellBase< GridCellType, GridCellType > >, and fpmas::model::detail::AgentBase< api::model::SpatialAgent< api::model::Cell >, AgentType, SpatialAgentBase< api::model::SpatialAgent< api::model::Cell >, AgentType, api::model::Cell, AgentType > >.

◆ groups() [2/2]

virtual std::vector< const AgentGroup * > fpmas::api::model::Agent::groups ( ) const

pure virtual

Returns a list of AgentGroups to which this Agent belong.

Returns: agent group list

Implemented in fpmas::model::detail::AgentBase< api::model::Cell, GraphCell, GraphCellBase< GraphCell, GraphCell > >, fpmas::model::detail::AgentBase< api::model::Cell, GraphCellType, GraphCellBase< GraphCellType, GraphCellType > >, fpmas::model::detail::AgentBase< api::model::GridAgent< model::GridCell >, AgentType, SpatialAgentBase< api::model::GridAgent< model::GridCell >, AgentType, model::GridCell, GridAgent< AgentType, model::GridCell, AgentType > > >, fpmas::model::detail::AgentBase< api::model::GridCell, GridCell, GridCellBase< GridCell, GridCell > >, fpmas::model::detail::AgentBase< api::model::GridCell, GridCellType, GridCellBase< GridCellType, GridCellType > >, and fpmas::model::detail::AgentBase< api::model::SpatialAgent< api::model::Cell >, AgentType, SpatialAgentBase< api::model::SpatialAgent< api::model::Cell >, AgentType, api::model::Cell, AgentType > >.

◆ setGroup()

virtual void fpmas::api::model::Agent::setGroup ( AgentGroup * group )

pure virtual

Deprecated:: Sets the internal pointer of the AgentGroup to which this Agent belong.

This method is deprecated and will be removed in a next release. Use addGroup() instead.

Parameters

group agent group

Implemented in fpmas::model::detail::AgentBase< api::model::Cell, GraphCell, GraphCellBase< GraphCell, GraphCell > >, fpmas::model::detail::AgentBase< api::model::Cell, GraphCellType, GraphCellBase< GraphCellType, GraphCellType > >, fpmas::model::detail::AgentBase< api::model::GridAgent< model::GridCell >, AgentType, SpatialAgentBase< api::model::GridAgent< model::GridCell >, AgentType, model::GridCell, GridAgent< AgentType, model::GridCell, AgentType > > >, fpmas::model::detail::AgentBase< api::model::GridCell, GridCell, GridCellBase< GridCell, GridCell > >, fpmas::model::detail::AgentBase< api::model::GridCell, GridCellType, GridCellBase< GridCellType, GridCellType > >, and fpmas::model::detail::AgentBase< api::model::SpatialAgent< api::model::Cell >, AgentType, SpatialAgentBase< api::model::SpatialAgent< api::model::Cell >, AgentType, api::model::Cell, AgentType > >.

◆ addGroup()

virtual void fpmas::api::model::Agent::addGroup ( AgentGroup * group )

pure virtual

Adds group to the list of AgentGroups to which this Agent belong.

Parameters

group agent group

Implemented in fpmas::model::detail::AgentBase< api::model::Cell, GraphCell, GraphCellBase< GraphCell, GraphCell > >, fpmas::model::detail::AgentBase< api::model::Cell, GraphCellType, GraphCellBase< GraphCellType, GraphCellType > >, fpmas::model::detail::AgentBase< api::model::GridAgent< model::GridCell >, AgentType, SpatialAgentBase< api::model::GridAgent< model::GridCell >, AgentType, model::GridCell, GridAgent< AgentType, model::GridCell, AgentType > > >, fpmas::model::detail::AgentBase< api::model::GridCell, GridCell, GridCellBase< GridCell, GridCell > >, fpmas::model::detail::AgentBase< api::model::GridCell, GridCellType, GridCellBase< GridCellType, GridCellType > >, and fpmas::model::detail::AgentBase< api::model::SpatialAgent< api::model::Cell >, AgentType, SpatialAgentBase< api::model::SpatialAgent< api::model::Cell >, AgentType, api::model::Cell, AgentType > >.

◆ removeGroup()

virtual void fpmas::api::model::Agent::removeGroup ( AgentGroup * group )

pure virtual

Removes group from the list of AgentGroups to wich this Agent belong.

Morever, the entry corresponding to this group's id is removed from tasks().

Parameters

group agent group

Implemented in fpmas::model::detail::AgentBase< api::model::Cell, GraphCell, GraphCellBase< GraphCell, GraphCell > >, fpmas::model::detail::AgentBase< api::model::Cell, GraphCellType, GraphCellBase< GraphCellType, GraphCellType > >, fpmas::model::detail::AgentBase< api::model::GridAgent< model::GridCell >, AgentType, SpatialAgentBase< api::model::GridAgent< model::GridCell >, AgentType, model::GridCell, GridAgent< AgentType, model::GridCell, AgentType > > >, fpmas::model::detail::AgentBase< api::model::GridCell, GridCell, GridCellBase< GridCell, GridCell > >, fpmas::model::detail::AgentBase< api::model::GridCell, GridCellType, GridCellBase< GridCellType, GridCellType > >, and fpmas::model::detail::AgentBase< api::model::SpatialAgent< api::model::Cell >, AgentType, SpatialAgentBase< api::model::SpatialAgent< api::model::Cell >, AgentType, api::model::Cell, AgentType > >.

◆ setGroupPos()

virtual void fpmas::api::model::Agent::setGroupPos	(	api::model::GroupId	gid,
		std::list< Agent * >::iterator	pos
	)

pure virtual

Sets a list position associated to the group represented by gid, that can be retrieved with getGroupPos().

There is no specific requirement about those methods, that can be used or not. However, AgentGroup implementations can take advantage of this feature to optimize Agent insertion and removal in constant time, using an std::list as an internal data structure.

Parameters

gid	group ID
pos	list iterator that references the current Agent within the group associated to `gid`

◆ getGroupPos()

virtual std::list< Agent * >::iterator fpmas::api::model::Agent::getGroupPos ( api::model::GroupId gid ) const

pure virtual

Retrieves a list position that was previously stored using setGroupPos().

Parameters

gid group ID

Returns: list iterator that references the current Agent within the group associated to gid

Implemented in fpmas::model::detail::AgentBase< api::model::Cell, GraphCell, GraphCellBase< GraphCell, GraphCell > >, fpmas::model::detail::AgentBase< api::model::Cell, GraphCellType, GraphCellBase< GraphCellType, GraphCellType > >, fpmas::model::detail::AgentBase< api::model::GridAgent< model::GridCell >, AgentType, SpatialAgentBase< api::model::GridAgent< model::GridCell >, AgentType, model::GridCell, GridAgent< AgentType, model::GridCell, AgentType > > >, fpmas::model::detail::AgentBase< api::model::GridCell, GridCell, GridCellBase< GridCell, GridCell > >, fpmas::model::detail::AgentBase< api::model::GridCell, GridCellType, GridCellBase< GridCellType, GridCellType > >, and fpmas::model::detail::AgentBase< api::model::SpatialAgent< api::model::Cell >, AgentType, SpatialAgentBase< api::model::SpatialAgent< api::model::Cell >, AgentType, api::model::Cell, AgentType > >.

◆ typeId()

virtual TypeId fpmas::api::model::Agent::typeId ( ) const

pure virtual

Returns the ID of the type of this Agent.

Implemented in fpmas::model::detail::AgentBase< api::model::Cell, GraphCell, GraphCellBase< GraphCell, GraphCell > >, fpmas::model::detail::AgentBase< api::model::Cell, GraphCellType, GraphCellBase< GraphCellType, GraphCellType > >, fpmas::model::detail::AgentBase< api::model::GridAgent< model::GridCell >, AgentType, SpatialAgentBase< api::model::GridAgent< model::GridCell >, AgentType, model::GridCell, GridAgent< AgentType, model::GridCell, AgentType > > >, fpmas::model::detail::AgentBase< api::model::GridCell, GridCell, GridCellBase< GridCell, GridCell > >, fpmas::model::detail::AgentBase< api::model::GridCell, GridCellType, GridCellBase< GridCellType, GridCellType > >, and fpmas::model::detail::AgentBase< api::model::SpatialAgent< api::model::Cell >, AgentType, SpatialAgentBase< api::model::SpatialAgent< api::model::Cell >, AgentType, api::model::Cell, AgentType > >.

◆ copy()

virtual Agent * fpmas::api::model::Agent::copy ( ) const

pure virtual

Allocates a new Agent pointer, considered as a copy of the current Agent.

Returns: pointer to a new allocated Agent, copied from this Agent

Implemented in fpmas::model::detail::AgentBase< api::model::Cell, GraphCell, GraphCellBase< GraphCell, GraphCell > >, fpmas::model::detail::AgentBase< api::model::Cell, GraphCellType, GraphCellBase< GraphCellType, GraphCellType > >, fpmas::model::detail::AgentBase< api::model::GridAgent< model::GridCell >, AgentType, SpatialAgentBase< api::model::GridAgent< model::GridCell >, AgentType, model::GridCell, GridAgent< AgentType, model::GridCell, AgentType > > >, fpmas::model::detail::AgentBase< api::model::GridCell, GridCell, GridCellBase< GridCell, GridCell > >, fpmas::model::detail::AgentBase< api::model::GridCell, GridCellType, GridCellBase< GridCellType, GridCellType > >, and fpmas::model::detail::AgentBase< api::model::SpatialAgent< api::model::Cell >, AgentType, SpatialAgentBase< api::model::SpatialAgent< api::model::Cell >, AgentType, api::model::Cell, AgentType > >.

◆ copyAssign()

virtual void fpmas::api::model::Agent::copyAssign ( Agent * agent )

pure virtual

Copies the specified agent to this.

Parameters

agent agent to copy from

Implemented in fpmas::model::detail::AgentBase< api::model::Cell, GraphCell, GraphCellBase< GraphCell, GraphCell > >, fpmas::model::detail::AgentBase< api::model::Cell, GraphCellType, GraphCellBase< GraphCellType, GraphCellType > >, fpmas::model::detail::AgentBase< api::model::GridAgent< model::GridCell >, AgentType, SpatialAgentBase< api::model::GridAgent< model::GridCell >, AgentType, model::GridCell, GridAgent< AgentType, model::GridCell, AgentType > > >, fpmas::model::detail::AgentBase< api::model::GridCell, GridCell, GridCellBase< GridCell, GridCell > >, fpmas::model::detail::AgentBase< api::model::GridCell, GridCellType, GridCellBase< GridCellType, GridCellType > >, and fpmas::model::detail::AgentBase< api::model::SpatialAgent< api::model::Cell >, AgentType, SpatialAgentBase< api::model::SpatialAgent< api::model::Cell >, AgentType, api::model::Cell, AgentType > >.

◆ moveAssign()

virtual void fpmas::api::model::Agent::moveAssign ( Agent * agent )

pure virtual

Moves the specified agent into this.

The specified agent is assumed to be an updated version of this agent.

In the move process, the following fields of "this" host agent keep unchanged, and so are not moved from agent to this :

Other fields are moved according to implementation defined rules.

Parameters

agent agent to move

Implemented in fpmas::model::detail::AgentBase< api::model::Cell, GraphCell, GraphCellBase< GraphCell, GraphCell > >, fpmas::model::detail::AgentBase< api::model::Cell, GraphCellType, GraphCellBase< GraphCellType, GraphCellType > >, fpmas::model::detail::AgentBase< api::model::GridAgent< model::GridCell >, AgentType, SpatialAgentBase< api::model::GridAgent< model::GridCell >, AgentType, model::GridCell, GridAgent< AgentType, model::GridCell, AgentType > > >, fpmas::model::detail::AgentBase< api::model::GridCell, GridCell, GridCellBase< GridCell, GridCell > >, fpmas::model::detail::AgentBase< api::model::GridCell, GridCellType, GridCellBase< GridCellType, GridCellType > >, and fpmas::model::detail::AgentBase< api::model::SpatialAgent< api::model::Cell >, AgentType, SpatialAgentBase< api::model::SpatialAgent< api::model::Cell >, AgentType, api::model::Cell, AgentType > >.

◆ node() [1/2]

virtual AgentNode * fpmas::api::model::Agent::node ( )

pure virtual

Returns a pointer to the AgentNode that contains this Agent.

Returns: pointer to wrapping AgentNode

Implemented in fpmas::model::detail::AgentBase< api::model::Cell, GraphCell, GraphCellBase< GraphCell, GraphCell > >, fpmas::model::detail::AgentBase< api::model::Cell, GraphCellType, GraphCellBase< GraphCellType, GraphCellType > >, fpmas::model::detail::AgentBase< api::model::GridAgent< model::GridCell >, AgentType, SpatialAgentBase< api::model::GridAgent< model::GridCell >, AgentType, model::GridCell, GridAgent< AgentType, model::GridCell, AgentType > > >, fpmas::model::detail::AgentBase< api::model::GridCell, GridCell, GridCellBase< GridCell, GridCell > >, fpmas::model::detail::AgentBase< api::model::GridCell, GridCellType, GridCellBase< GridCellType, GridCellType > >, and fpmas::model::detail::AgentBase< api::model::SpatialAgent< api::model::Cell >, AgentType, SpatialAgentBase< api::model::SpatialAgent< api::model::Cell >, AgentType, api::model::Cell, AgentType > >.

◆ node() [2/2]

virtual const AgentNode * fpmas::api::model::Agent::node ( ) const

pure virtual

Returns a pointer to the AgentNode that contains this Agent.

Returns: pointer to wrapping AgentNode

Implemented in fpmas::model::detail::AgentBase< api::model::Cell, GraphCell, GraphCellBase< GraphCell, GraphCell > >, fpmas::model::detail::AgentBase< api::model::Cell, GraphCellType, GraphCellBase< GraphCellType, GraphCellType > >, fpmas::model::detail::AgentBase< api::model::GridAgent< model::GridCell >, AgentType, SpatialAgentBase< api::model::GridAgent< model::GridCell >, AgentType, model::GridCell, GridAgent< AgentType, model::GridCell, AgentType > > >, fpmas::model::detail::AgentBase< api::model::GridCell, GridCell, GridCellBase< GridCell, GridCell > >, fpmas::model::detail::AgentBase< api::model::GridCell, GridCellType, GridCellBase< GridCellType, GridCellType > >, and fpmas::model::detail::AgentBase< api::model::SpatialAgent< api::model::Cell >, AgentType, SpatialAgentBase< api::model::SpatialAgent< api::model::Cell >, AgentType, api::model::Cell, AgentType > >.

◆ setNode()

virtual void fpmas::api::model::Agent::setNode ( AgentNode * node )

pure virtual

Sets the internal pointer of the AgentNode that contains this Agent.

Parameters

node	pointer to wrapping AgentNode

Implemented in fpmas::model::detail::AgentBase< api::model::Cell, GraphCell, GraphCellBase< GraphCell, GraphCell > >, fpmas::model::detail::AgentBase< api::model::Cell, GraphCellType, GraphCellBase< GraphCellType, GraphCellType > >, fpmas::model::detail::AgentBase< api::model::GridAgent< model::GridCell >, AgentType, SpatialAgentBase< api::model::GridAgent< model::GridCell >, AgentType, model::GridCell, GridAgent< AgentType, model::GridCell, AgentType > > >, fpmas::model::detail::AgentBase< api::model::GridCell, GridCell, GridCellBase< GridCell, GridCell > >, fpmas::model::detail::AgentBase< api::model::GridCell, GridCellType, GridCellBase< GridCellType, GridCellType > >, and fpmas::model::detail::AgentBase< api::model::SpatialAgent< api::model::Cell >, AgentType, SpatialAgentBase< api::model::SpatialAgent< api::model::Cell >, AgentType, api::model::Cell, AgentType > >.

◆ model() [1/2]

virtual Model * fpmas::api::model::Agent::model ( )

pure virtual

Returns a pointer to the Model that contains this Agent.

Returns: pointer to Model

Implemented in fpmas::model::detail::AgentBase< api::model::Cell, GraphCell, GraphCellBase< GraphCell, GraphCell > >, fpmas::model::detail::AgentBase< api::model::Cell, GraphCellType, GraphCellBase< GraphCellType, GraphCellType > >, fpmas::model::detail::AgentBase< api::model::GridAgent< model::GridCell >, AgentType, SpatialAgentBase< api::model::GridAgent< model::GridCell >, AgentType, model::GridCell, GridAgent< AgentType, model::GridCell, AgentType > > >, fpmas::model::detail::AgentBase< api::model::GridCell, GridCell, GridCellBase< GridCell, GridCell > >, fpmas::model::detail::AgentBase< api::model::GridCell, GridCellType, GridCellBase< GridCellType, GridCellType > >, and fpmas::model::detail::AgentBase< api::model::SpatialAgent< api::model::Cell >, AgentType, SpatialAgentBase< api::model::SpatialAgent< api::model::Cell >, AgentType, api::model::Cell, AgentType > >.

◆ model() [2/2]

virtual const Model * fpmas::api::model::Agent::model ( ) const

pure virtual

Returns a pointer to the Model that contains this Agent.

Returns: pointer to Model

Implemented in fpmas::model::detail::AgentBase< api::model::Cell, GraphCell, GraphCellBase< GraphCell, GraphCell > >, fpmas::model::detail::AgentBase< api::model::Cell, GraphCellType, GraphCellBase< GraphCellType, GraphCellType > >, fpmas::model::detail::AgentBase< api::model::GridAgent< model::GridCell >, AgentType, SpatialAgentBase< api::model::GridAgent< model::GridCell >, AgentType, model::GridCell, GridAgent< AgentType, model::GridCell, AgentType > > >, fpmas::model::detail::AgentBase< api::model::GridCell, GridCell, GridCellBase< GridCell, GridCell > >, fpmas::model::detail::AgentBase< api::model::GridCell, GridCellType, GridCellBase< GridCellType, GridCellType > >, and fpmas::model::detail::AgentBase< api::model::SpatialAgent< api::model::Cell >, AgentType, SpatialAgentBase< api::model::SpatialAgent< api::model::Cell >, AgentType, api::model::Cell, AgentType > >.

◆ setModel()

virtual void fpmas::api::model::Agent::setModel ( Model * model )

pure virtual

Sets the internal pointer of the Model that contains this Agent.

Parameters

model pointer to Model

Implemented in fpmas::model::detail::AgentBase< api::model::Cell, GraphCell, GraphCellBase< GraphCell, GraphCell > >, fpmas::model::detail::AgentBase< api::model::Cell, GraphCellType, GraphCellBase< GraphCellType, GraphCellType > >, fpmas::model::detail::AgentBase< api::model::GridAgent< model::GridCell >, AgentType, SpatialAgentBase< api::model::GridAgent< model::GridCell >, AgentType, model::GridCell, GridAgent< AgentType, model::GridCell, AgentType > > >, fpmas::model::detail::AgentBase< api::model::GridCell, GridCell, GridCellBase< GridCell, GridCell > >, fpmas::model::detail::AgentBase< api::model::GridCell, GridCellType, GridCellBase< GridCellType, GridCellType > >, and fpmas::model::detail::AgentBase< api::model::SpatialAgent< api::model::Cell >, AgentType, SpatialAgentBase< api::model::SpatialAgent< api::model::Cell >, AgentType, api::model::Cell, AgentType > >.

◆ task() [1/4]

virtual AgentTask * fpmas::api::model::Agent::task ( )

pure virtual

Returns a pointer to the AgentTask associated to this Agent, that is used to execute the Agent.

Returns: agent task

Implemented in fpmas::model::detail::AgentBase< api::model::Cell, GraphCell, GraphCellBase< GraphCell, GraphCell > >, fpmas::model::detail::AgentBase< api::model::Cell, GraphCellType, GraphCellBase< GraphCellType, GraphCellType > >, fpmas::model::detail::AgentBase< api::model::GridAgent< model::GridCell >, AgentType, SpatialAgentBase< api::model::GridAgent< model::GridCell >, AgentType, model::GridCell, GridAgent< AgentType, model::GridCell, AgentType > > >, fpmas::model::detail::AgentBase< api::model::GridCell, GridCell, GridCellBase< GridCell, GridCell > >, fpmas::model::detail::AgentBase< api::model::GridCell, GridCellType, GridCellBase< GridCellType, GridCellType > >, and fpmas::model::detail::AgentBase< api::model::SpatialAgent< api::model::Cell >, AgentType, SpatialAgentBase< api::model::SpatialAgent< api::model::Cell >, AgentType, api::model::Cell, AgentType > >.

◆ task() [2/4]

virtual const AgentTask * fpmas::api::model::Agent::task ( ) const

pure virtual

Returns a pointer to the AgentTask associated to this Agent, that is used to execute the Agent.

Returns: agent task

Implemented in fpmas::model::detail::AgentBase< api::model::Cell, GraphCell, GraphCellBase< GraphCell, GraphCell > >, fpmas::model::detail::AgentBase< api::model::Cell, GraphCellType, GraphCellBase< GraphCellType, GraphCellType > >, fpmas::model::detail::AgentBase< api::model::GridAgent< model::GridCell >, AgentType, SpatialAgentBase< api::model::GridAgent< model::GridCell >, AgentType, model::GridCell, GridAgent< AgentType, model::GridCell, AgentType > > >, fpmas::model::detail::AgentBase< api::model::GridCell, GridCell, GridCellBase< GridCell, GridCell > >, fpmas::model::detail::AgentBase< api::model::GridCell, GridCellType, GridCellBase< GridCellType, GridCellType > >, and fpmas::model::detail::AgentBase< api::model::SpatialAgent< api::model::Cell >, AgentType, SpatialAgentBase< api::model::SpatialAgent< api::model::Cell >, AgentType, api::model::Cell, AgentType > >.

◆ setTask() [1/2]

virtual void fpmas::api::model::Agent::setTask ( AgentTask * task )

pure virtual

Sets the AgentTask associated to this Agent.

Parameters

task	agent task

Implemented in fpmas::model::detail::AgentBase< api::model::Cell, GraphCell, GraphCellBase< GraphCell, GraphCell > >, fpmas::model::detail::AgentBase< api::model::Cell, GraphCellType, GraphCellBase< GraphCellType, GraphCellType > >, fpmas::model::detail::AgentBase< api::model::GridAgent< model::GridCell >, AgentType, SpatialAgentBase< api::model::GridAgent< model::GridCell >, AgentType, model::GridCell, GridAgent< AgentType, model::GridCell, AgentType > > >, fpmas::model::detail::AgentBase< api::model::GridCell, GridCell, GridCellBase< GridCell, GridCell > >, fpmas::model::detail::AgentBase< api::model::GridCell, GridCellType, GridCellBase< GridCellType, GridCellType > >, and fpmas::model::detail::AgentBase< api::model::SpatialAgent< api::model::Cell >, AgentType, SpatialAgentBase< api::model::SpatialAgent< api::model::Cell >, AgentType, api::model::Cell, AgentType > >.

◆ task() [3/4]

virtual AgentTask * fpmas::api::model::Agent::task ( GroupId id )

pure virtual

Returns the AgentTask associated to this Agent in the AgentGroup corresponding to id.

Behavior is undefined if the Agent does not belong to an AgentGroup with the specified id.

Parameters

id group id

Implemented in fpmas::model::detail::AgentBase< api::model::Cell, GraphCell, GraphCellBase< GraphCell, GraphCell > >, fpmas::model::detail::AgentBase< api::model::Cell, GraphCellType, GraphCellBase< GraphCellType, GraphCellType > >, fpmas::model::detail::AgentBase< api::model::GridAgent< model::GridCell >, AgentType, SpatialAgentBase< api::model::GridAgent< model::GridCell >, AgentType, model::GridCell, GridAgent< AgentType, model::GridCell, AgentType > > >, fpmas::model::detail::AgentBase< api::model::GridCell, GridCell, GridCellBase< GridCell, GridCell > >, fpmas::model::detail::AgentBase< api::model::GridCell, GridCellType, GridCellBase< GridCellType, GridCellType > >, and fpmas::model::detail::AgentBase< api::model::SpatialAgent< api::model::Cell >, AgentType, SpatialAgentBase< api::model::SpatialAgent< api::model::Cell >, AgentType, api::model::Cell, AgentType > >.

◆ task() [4/4]

virtual const AgentTask * fpmas::api::model::Agent::task ( GroupId id ) const

pure virtual

Returns the AgentTask associated to this Agent in the AgentGroup corresponding to id.

Behavior is undefined if the Agent does not belong to an AgentGroup with the specified id.

Parameters

id group id

Implemented in fpmas::model::detail::AgentBase< api::model::Cell, GraphCell, GraphCellBase< GraphCell, GraphCell > >, fpmas::model::detail::AgentBase< api::model::Cell, GraphCellType, GraphCellBase< GraphCellType, GraphCellType > >, fpmas::model::detail::AgentBase< api::model::GridAgent< model::GridCell >, AgentType, SpatialAgentBase< api::model::GridAgent< model::GridCell >, AgentType, model::GridCell, GridAgent< AgentType, model::GridCell, AgentType > > >, fpmas::model::detail::AgentBase< api::model::GridCell, GridCell, GridCellBase< GridCell, GridCell > >, fpmas::model::detail::AgentBase< api::model::GridCell, GridCellType, GridCellBase< GridCellType, GridCellType > >, and fpmas::model::detail::AgentBase< api::model::SpatialAgent< api::model::Cell >, AgentType, SpatialAgentBase< api::model::SpatialAgent< api::model::Cell >, AgentType, api::model::Cell, AgentType > >.

◆ setTask() [2/2]

virtual void fpmas::api::model::Agent::setTask	(	GroupId	id,
		AgentTask *	task
	)

pure virtual

Sets the AgentTask associated to this Agent in the AgentGroup corresponding to id.

Behavior is undefined if the Agent does not belong to an AgentGroup with the specified id.

Parameters

id	group id
task	agent task

Implemented in fpmas::model::detail::AgentBase< api::model::Cell, GraphCell, GraphCellBase< GraphCell, GraphCell > >, fpmas::model::detail::AgentBase< api::model::Cell, GraphCellType, GraphCellBase< GraphCellType, GraphCellType > >, fpmas::model::detail::AgentBase< api::model::GridAgent< model::GridCell >, AgentType, SpatialAgentBase< api::model::GridAgent< model::GridCell >, AgentType, model::GridCell, GridAgent< AgentType, model::GridCell, AgentType > > >, fpmas::model::detail::AgentBase< api::model::GridCell, GridCell, GridCellBase< GridCell, GridCell > >, fpmas::model::detail::AgentBase< api::model::GridCell, GridCellType, GridCellBase< GridCellType, GridCellType > >, and fpmas::model::detail::AgentBase< api::model::SpatialAgent< api::model::Cell >, AgentType, SpatialAgentBase< api::model::SpatialAgent< api::model::Cell >, AgentType, api::model::Cell, AgentType > >.

◆ tasks()

virtual const std::unordered_map< GroupId, AgentTask * > & fpmas::api::model::Agent::tasks ( )

pure virtual

Returns a map containing all the tasks associated to this Agent in the AgentGroups to which it belongs.

Exactly one task is associated to the agent in each group.

Returns: tasks associated to this agent

Implemented in fpmas::model::detail::AgentBase< api::model::Cell, GraphCell, GraphCellBase< GraphCell, GraphCell > >, fpmas::model::detail::AgentBase< api::model::Cell, GraphCellType, GraphCellBase< GraphCellType, GraphCellType > >, fpmas::model::detail::AgentBase< api::model::GridAgent< model::GridCell >, AgentType, SpatialAgentBase< api::model::GridAgent< model::GridCell >, AgentType, model::GridCell, GridAgent< AgentType, model::GridCell, AgentType > > >, fpmas::model::detail::AgentBase< api::model::GridCell, GridCell, GridCellBase< GridCell, GridCell > >, fpmas::model::detail::AgentBase< api::model::GridCell, GridCellType, GridCellBase< GridCellType, GridCellType > >, and fpmas::model::detail::AgentBase< api::model::SpatialAgent< api::model::Cell >, AgentType, SpatialAgentBase< api::model::SpatialAgent< api::model::Cell >, AgentType, api::model::Cell, AgentType > >.

◆ act()

virtual void fpmas::api::model::Agent::act ( )

pure virtual

Deprecated:

Executes the default behavior of the Agent.

This will be remove in a next release, use api::model::Behavior instead to use arbitrary functions as behaviors.

Implemented in fpmas::model::detail::AgentBase< api::model::Cell, GraphCell, GraphCellBase< GraphCell, GraphCell > >, fpmas::model::detail::AgentBase< api::model::Cell, GraphCellType, GraphCellBase< GraphCellType, GraphCellType > >, fpmas::model::detail::AgentBase< api::model::GridAgent< model::GridCell >, AgentType, SpatialAgentBase< api::model::GridAgent< model::GridCell >, AgentType, model::GridCell, GridAgent< AgentType, model::GridCell, AgentType > > >, fpmas::model::detail::AgentBase< api::model::GridCell, GridCell, GridCellBase< GridCell, GridCell > >, fpmas::model::detail::AgentBase< api::model::GridCell, GridCellType, GridCellBase< GridCellType, GridCellType > >, and fpmas::model::detail::AgentBase< api::model::SpatialAgent< api::model::Cell >, AgentType, SpatialAgentBase< api::model::SpatialAgent< api::model::Cell >, AgentType, api::model::Cell, AgentType > >.

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

src/fpmas/api/model/model.h

Public Member Functions

Detailed Description

Member Function Documentation

◆ groupId()

◆ groupIds()

◆ setGroupId()

◆ addGroupId()

◆ removeGroupId()

◆ group() [1/2]

◆ group() [2/2]

◆ groups() [1/2]

◆ groups() [2/2]

◆ setGroup()

◆ addGroup()

◆ removeGroup()

◆ setGroupPos()

◆ getGroupPos()

◆ typeId()

◆ copy()

◆ copyAssign()

◆ moveAssign()

◆ node() [1/2]

◆ node() [2/2]

◆ setNode()

◆ model() [1/2]

◆ model() [2/2]

◆ setModel()

◆ task() [1/4]

◆ task() [2/4]

◆ setTask() [1/2]

◆ task() [3/4]

◆ task() [4/4]

◆ setTask() [2/2]

◆ tasks()

◆ act()