cartago
Interface ICartagoSession

All Known Implementing Classes:
CartagoSession

public interface ICartagoSession

Main interface for acting and perceiving in CArtAgO Environments.

Author:
aricci

Method Summary
 long doAction(ArtifactId aid, Op op, IAlignmentTest test, long timeout)
          Executing an action, i.e. an operation over an artifact
 long doAction(Op op, IAlignmentTest test, long timeout)
          Executing an action, i.e. an operation over an artifact in the current workspace.
 long doAction(java.lang.String artName, Op op, IAlignmentTest test, long timeout)
          Executing an action, i.e. an operation over an artifact in the current workspace.
 long doAction(WorkspaceId wspId, Op op, IAlignmentTest test, long timeout)
          Executing an action, i.e. an operation over an artifact In this case, the target artifact is not specified.
 long doAction(WorkspaceId wspId, java.lang.String artName, Op op, IAlignmentTest test, long timeout)
          Executing an action, i.e. an operation over an artifact In this case, the name of the artifact and the workspace are specified.
 CartagoEvent fetchNextPercept()
          Fetch the next percept from the percept queue.
 WorkspaceId getCurrentWorkspace()
          Get the current workspace identifier.
 void setCurrentWorkspace(WorkspaceId wspId)
          Internal action to change the current workspace.
 

Method Detail

doAction

long doAction(ArtifactId aid,
              Op op,
              IAlignmentTest test,
              long timeout)
              throws CartagoException
Executing an action, i.e. an operation over an artifact

Parameters:
aid - target artifact
op - target operation
test - alignment test
timeout - timeout
Returns:
unique action identifier
Throws:
CartagoException

doAction

long doAction(WorkspaceId wspId,
              java.lang.String artName,
              Op op,
              IAlignmentTest test,
              long timeout)
              throws CartagoException
Executing an action, i.e. an operation over an artifact In this case, the name of the artifact and the workspace are specified.

Parameters:
artName - target artifact
wspId - workspace identifier
op - target operation
test - alignment test
timeout - timeout
Returns:
unique action identifier
Throws:
CartagoException

doAction

long doAction(WorkspaceId wspId,
              Op op,
              IAlignmentTest test,
              long timeout)
              throws CartagoException
Executing an action, i.e. an operation over an artifact In this case, the target artifact is not specified.

Parameters:
wspId - workspace identifier
op - target operation
test - alignment test
timeout - timeout
Returns:
unique action identifier
Throws:
CartagoException

doAction

long doAction(java.lang.String artName,
              Op op,
              IAlignmentTest test,
              long timeout)
              throws CartagoException
Executing an action, i.e. an operation over an artifact in the current workspace.

Parameters:
artName - target artifact
op - target operation
test - alignment test
timeout - timeout
Returns:
unique action identifier
Throws:
CartagoException

doAction

long doAction(Op op,
              IAlignmentTest test,
              long timeout)
              throws CartagoException
Executing an action, i.e. an operation over an artifact in the current workspace.

Parameters:
op - target operation
test - alignment test
timeout - timeout
Returns:
unique action identifier
Throws:
CartagoException

setCurrentWorkspace

void setCurrentWorkspace(WorkspaceId wspId)
                         throws CartagoException
Internal action to change the current workspace.

Parameters:
wspId - workspace identifier.
Throws:
CartagoException

getCurrentWorkspace

WorkspaceId getCurrentWorkspace()
                                throws CartagoException
Get the current workspace identifier.

Returns:
workspace identifier.
Throws:
CartagoException

fetchNextPercept

CartagoEvent fetchNextPercept()
Fetch the next percept from the percept queue.

Returns:
null if no percepts are available.


>DEIS - University of Bologna