iristk.situated

Class SystemAgent

java.lang.Object

iristk.util.Record

iristk.situated.Item

iristk.situated.Body

iristk.situated.Agent

iristk.situated.SystemAgent

public class SystemAgent
extends Agent

Nested Class Summary

Nested classes/interfaces inherited from class iristk.util.Record

Record.JsonToRecordException, Record.RecordField

Field Summary

Fields

Modifier and Type	Field and Description
java.util.List<Space>	interactionSpaces
SystemAgentModule	systemAgentModule

Fields inherited from class iristk.situated.Agent

ALL, attending, NOBODY, speaking, UNKNOWN

Fields inherited from class iristk.situated.Body

gaze, handLeft, handRight, head, priority, proximity, recId

Fields inherited from class iristk.situated.Item

expire, id, location, rotation, shape

Constructor Summary

Constructors

Constructor and Description
SystemAgent()
SystemAgent(java.lang.String id, Situation situation)

Method Summary

Modifier and Type	Method and Description
void	addUser(Agent user)
Agent	getAttendedUser()
Agent	getCurrentUser()
Item	getItem(java.lang.String id)
java.util.Map<java.lang.String,Item>	getItems()
int	getMaxUsers()
Agent	getNobody()
Agent	getOtherUser()
Agent	getOtherUser(Event event)
Agent	getOtherUser(java.lang.String agentId) Retrieves another user than the one provided (or the same user if there is only one)
Agent	getRandomUser()
Situation	getSituation()
Agent	getUser(Event event)
Agent	getUser(int i)
Agent	getUser(java.lang.String agentId)
java.lang.String	getUserId(Event event) Returns the user that is the source of an event.
java.util.List<Agent>	getUsers()
Location	getUsersMiddleLocation()
boolean	hasItem(java.lang.String id)
boolean	hasManyUsers()
boolean	hasMaxUsers()
boolean	hasUser(java.lang.String agentId)
boolean	hasUserAttending()
boolean	hasUsers()
boolean	isAgent(Event event)
boolean	isAttending(Event event)
boolean	isHuman()
boolean	isInInteractionSpace(Body body)
boolean	isUser(Agent agent)
boolean	isUser(java.lang.String agentId)
static java.lang.String	processDisplay(java.lang.String text, java.lang.String display)
void	putUsers(java.lang.String key, java.lang.Object value)
void	removeUser(Agent user)
void	removeUser(java.lang.String userId)
void	setAttending(java.lang.String target)
void	setInteractionDistance(double d)
void	setInteractionSpaces(Space... spaces)
void	setMaxUsers(int maxUsers)

Methods inherited from class iristk.situated.Agent

isAttending, isAttendingAll, isAttendingNobody, isAttendingUnknown, isNobody, isOnlyAttending, isSpeaking, setAttendingAll

Methods inherited from class iristk.situated.Body

gazeAngle, getAbsolute, getHeadLocation, getHeadRotation, getRelative, hasHeadRotation, isCloseTo, lookingAt

Methods inherited from class iristk.situated.Item

draw, getPosition

Methods inherited from class iristk.util.Record

adjoin, clone, deepClone, empty, equals, fromJSON, fromJSON, fromJSON, fromProperties, fromProperties, get, get, get, getBoolean, getBoolean, getDouble, getDouble, getFieldClass, getFields, getFieldsOrdered, getFloat, getFloat, getInteger, getInteger, getList, getPersistentFields, getRecord, getString, getString, getValues, has, incrInteger, incrInteger, put, putAll, putAll, putAllExceptNull, putIfNotNull, remove, size, toJSON, toMap, toProperties, toProperties, toString, toStringIndent, toStringIndent

Methods inherited from class java.lang.Object

finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

interactionSpaces

public java.util.List<Space> interactionSpaces

systemAgentModule

public SystemAgentModule systemAgentModule

Constructor Detail

SystemAgent

public SystemAgent()

SystemAgent

public SystemAgent(java.lang.String id,
                   Situation situation)

Method Detail

setInteractionSpaces

public void setInteractionSpaces(Space... spaces)

setInteractionDistance

public void setInteractionDistance(double d)

isInInteractionSpace

public boolean isInInteractionSpace(Body body)

isUser

public boolean isUser(Agent agent)

isUser

public boolean isUser(java.lang.String agentId)

hasMaxUsers

public boolean hasMaxUsers()

getMaxUsers

public int getMaxUsers()

setMaxUsers

public void setMaxUsers(int maxUsers)

getUser

public Agent getUser(java.lang.String agentId)

getUser

public Agent getUser(int i)

getNobody

public Agent getNobody()

getUserId

public java.lang.String getUserId(Event event)

Returns the user that is the source of an event. If the "user" parameter is provided, it is used directly. If the "sensor" parameter is provided, it is used to identify the most likely agent through the situation model.

getUser

public Agent getUser(Event event)

addUser

public void addUser(Agent user)

removeUser

public void removeUser(Agent user)

removeUser

public void removeUser(java.lang.String userId)

getOtherUser

public Agent getOtherUser(java.lang.String agentId)

Retrieves another user than the one provided (or the same user if there is only one)

Parameters:

the - agent id

getOtherUser

public Agent getOtherUser()

Returns:

a user that is currently not in focus (or the current user if there is only one)

getOtherUser

public Agent getOtherUser(Event event)

hasUsers

public boolean hasUsers()

Returns:

whether there are any users interacting with the system agent

hasManyUsers

public boolean hasManyUsers()

Returns:

whether there are more than one user interacting with the system agent

hasUser

public boolean hasUser(java.lang.String agentId)

Parameters:

agent - an Agent, or an agent id (String)

Returns:

whether the agent is interacting with the system

hasUserAttending

public boolean hasUserAttending()

getAttendedUser

public Agent getAttendedUser()

getCurrentUser

public Agent getCurrentUser()

getRandomUser

public Agent getRandomUser()

setAttending

public void setAttending(java.lang.String target)

Overrides:

setAttending in class Agent

isAttending

public boolean isAttending(Event event)

isAgent

public boolean isAgent(Event event)

putUsers

public void putUsers(java.lang.String key,
                     java.lang.Object value)

getUsers

public java.util.List<Agent> getUsers()

getItems

public java.util.Map<java.lang.String,Item> getItems()

getItem

public Item getItem(java.lang.String id)

hasItem

public boolean hasItem(java.lang.String id)

getSituation

public Situation getSituation()

isHuman

public boolean isHuman()

Overrides:

isHuman in class Agent

getUsersMiddleLocation

public Location getUsersMiddleLocation()

processDisplay

public static java.lang.String processDisplay(java.lang.String text,
                                              java.lang.String display)