vs.plotagent
Interface ICharacterManager

All Superinterfaces:

IAgentModule

All Known Implementing Classes:

BasicCharacterManager

public interface ICharacterManager
extends IAgentModule

A character manager has the following functionality: * Keep track of the characters in the agent environment, and their commitments to the story * Cast characters to give them a place in the story

Author:

swartjes

Method Summary

void	addCharacterAgent(jade.core.AID characterAgent) Adds a character agent to the list of available characters
void	addSettingChange(java.util.Collection<RDFtriple> triples) Adds multiple setting changes to be broadcast to all new characters
void	addSettingChange(RDFtriple triple) Adds a setting change to be broadcast to all new characters
void	addWantedCharacter(java.lang.String characterURI) Registers that given character URI is necessary to cast. castCharacter uses this information to decide what name to give a character.
void	castCharacter(jade.core.AID characterAgent, java.lang.String characterURI) Casts a character agent to play a certain role in the story (role is determined by character manager)
jade.core.AID	getAgentForStoryWorldRepresentation(java.lang.String characterURI) The inverse: retrieves the agent ID for a character's personality in the story, i.e. which agent 'controls' it.
java.util.Set<jade.core.AID>	getAvailableCharacters() Retrieves all characters that are available to play a role
java.util.Set<jade.core.AID>	getCastedCharacters() Retrieves all characters that are casted to play a role in the story
java.util.Set<jade.core.AID>	getCharacters() Retrieves all characters the character manager knows of
java.lang.String	getStoryWorldRepresentationForAgent(jade.core.AID characterAgent) Retrieves the name of the character's personality in the story (i.e., how they are 'casted')
void	removeCharacterAgent(jade.core.AID characterAgent) Removes a character agent from the list of available characters

Methods inherited from interface vs.IAgentModule

getAgent

Method Detail

addCharacterAgent

void addCharacterAgent(jade.core.AID characterAgent)

Adds a character agent to the list of available characters

Parameters:

characterAgent - the AID of an available character to add

addSettingChange

void addSettingChange(java.util.Collection<RDFtriple> triples)

Adds multiple setting changes to be broadcast to all new characters

Parameters:

triples - the setting triples

addSettingChange

void addSettingChange(RDFtriple triple)

Adds a setting change to be broadcast to all new characters

Parameters:

triple - the setting triple

addWantedCharacter

void addWantedCharacter(java.lang.String characterURI)

Registers that given character URI is necessary to cast. castCharacter uses this information to decide what name to give a character.

Parameters:

characterURI - the URI of the character in the story world that we need a character agent for

castCharacter

void castCharacter(jade.core.AID characterAgent,
                   java.lang.String characterURI)

Casts a character agent to play a certain role in the story (role is determined by character manager)

Parameters:

characterAgent - the AID of an available character to add

characterURI - the URI representing the character Individual in the story

getAgentForStoryWorldRepresentation

jade.core.AID getAgentForStoryWorldRepresentation(java.lang.String characterURI)

The inverse: retrieves the agent ID for a character's personality in the story, i.e. which agent 'controls' it.

Parameters:

characterURI - the URI of the casted agent in the story

Returns:

the AID of the character agent playing that character URI in the story

getAvailableCharacters

java.util.Set<jade.core.AID> getAvailableCharacters()

Retrieves all characters that are available to play a role

Returns:

a list of character AIDs

getCastedCharacters

java.util.Set<jade.core.AID> getCastedCharacters()

Retrieves all characters that are casted to play a role in the story

Returns:

a list of character AIDs

getCharacters

java.util.Set<jade.core.AID> getCharacters()

Retrieves all characters the character manager knows of

Returns:

a set of character AIDs

getStoryWorldRepresentationForAgent

java.lang.String getStoryWorldRepresentationForAgent(jade.core.AID characterAgent)

Retrieves the name of the character's personality in the story (i.e., how they are 'casted')

Parameters:

characterAgent - the AID of the casted agent

Returns:

the URI of the character in the story world representation

removeCharacterAgent

void removeCharacterAgent(jade.core.AID characterAgent)

Removes a character agent from the list of available characters

Parameters:

characterAgent - the AID of an available character to remove