com.aldebaran.qi.helper.proxies

Class ALBehaviorManager

java.lang.Object

com.aldebaran.qi.helper.ALProxy

com.aldebaran.qi.helper.proxies.ALBehaviorManager

public class ALBehaviorManager
extends ALProxy

This module is intended to manage behaviors. With this module, you can load, start, stop behaviors, add default behaviors or remove them.

See Also:

NAOqi APIs for ALBehaviorManager

Field Summary

Fields inherited from class com.aldebaran.qi.helper.ALProxy

name, service

Constructor Summary

Constructors

Constructor and Description
ALBehaviorManager(Session session)

Method Summary

Modifier and Type	Method and Description
void	addDefaultBehavior(java.lang.String behavior) Set the given behavior as default
void	clearStats()
void	exit() Exits and unregisters the module.
java.util.List<java.lang.String>	getBehaviorNames() Get behaviors
java.lang.String	getBehaviorNature(java.lang.String behavior) Get the nature of the given behavior.
java.util.List<java.lang.String>	getBehaviorsByTag(java.lang.String tag) Get installed behaviors directories names and filter it by tag.
java.util.List<java.lang.String>	getBehaviorTags(java.lang.String behavior) Get tags found on the given behavior.
java.lang.String	getBrokerName() Gets the name of the parent broker.
java.util.List<java.lang.String>	getDefaultBehaviors() Get default behaviors
java.util.List<java.lang.String>	getInstalledBehaviors() Get installed behaviors directories names
java.util.List<java.lang.String>	getLoadedBehaviors() Get loaded behaviors
java.lang.Object	getMethodHelp(java.lang.String methodName) Retrieves a method's description.
java.util.List<java.lang.String>	getMethodList() Retrieves the module's method list.
java.lang.Object	getModuleHelp() Retrieves the module's description.
java.util.List<java.lang.String>	getRunningBehaviors() Get running behaviors
java.util.List<java.lang.String>	getSystemBehaviorNames() Get system behaviors
java.util.List<java.lang.String>	getTagList() Get tags found on installed behaviors.
java.lang.String	getUsage(java.lang.String name) Gets the method usage string.
java.util.List<java.lang.String>	getUserBehaviorNames() Get user's behaviors
java.lang.Boolean	installBehavior(java.lang.String localPath) Install a behavior.
java.lang.Boolean	installBehavior(java.lang.String absolutePath, java.lang.String localPath, java.lang.Boolean overwrite) Install a behavior.
java.lang.Boolean	isBehaviorInstalled(java.lang.String name) Tell if supplied name corresponds to a behavior that has been installed
java.lang.Boolean	isBehaviorLoaded(java.lang.String behavior) Tell if supplied name corresponds to a loaded behavior
java.lang.Boolean	isBehaviorPresent(java.lang.String prefixedBehavior) Tell if the supplied namecorresponds to an existing behavior.
java.lang.Boolean	isBehaviorRunning(java.lang.String behavior) Tell if supplied name corresponds to a running behavior
java.lang.Boolean	isRunning(java.lang.Integer id) Returns true if the method is currently running.
java.lang.Boolean	isStatsEnabled()
java.lang.Boolean	isTraceEnabled()
java.lang.Boolean	ping() Just a ping.
void	playDefaultProject() Play default behaviors
java.lang.Boolean	preloadBehavior(java.lang.String behavior) Load a behavior
java.lang.Boolean	removeBehavior(java.lang.String behavior) Remove a behavior from the filesystem.
void	removeDefaultBehavior(java.lang.String behavior) Remove the given behavior from the default behaviors
java.lang.String	resolveBehaviorName(java.lang.String name) Find out the actual / path behind a behavior name.
void	runBehavior(java.lang.String behavior) Runs a behavior, returns when finished
void	startBehavior(java.lang.String behavior) Starts a behavior, returns when started.
void	stop(java.lang.Integer id) returns true if the method is currently running
void	stopAllBehaviors() Stop all behaviors
void	stopBehavior(java.lang.String behavior) Stop a behavior
java.lang.String	version() Returns the version of the module.
java.lang.Boolean	wait(java.lang.Integer id, java.lang.Integer timeoutPeriod) Wait for the end of a long running method that was called using 'post'

Methods inherited from class com.aldebaran.qi.helper.ALProxy

call, connect, connect, disconnect, getNaoqiType, getService, isProxyReady, setService

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ALBehaviorManager

public ALBehaviorManager(Session session)
                  throws java.lang.Exception

Throws:

java.lang.Exception

Method Detail

getTagList

public java.util.List<java.lang.String> getTagList()
                                            throws CallError,
                                                   java.lang.InterruptedException

Get tags found on installed behaviors.

Returns:

The list of tags found.

Throws:

CallError

java.lang.InterruptedException

addDefaultBehavior

public void addDefaultBehavior(java.lang.String behavior)
                        throws CallError,
                               java.lang.InterruptedException

Set the given behavior as default

Parameters:

behavior - Behavior name

Throws:

CallError

java.lang.InterruptedException

isBehaviorRunning

public java.lang.Boolean isBehaviorRunning(java.lang.String behavior)
                                    throws CallError,
                                           java.lang.InterruptedException

Tell if supplied name corresponds to a running behavior

Parameters:

behavior - Behavior name

Returns:

Returns true if it is a running behavior

Throws:

CallError

java.lang.InterruptedException

getDefaultBehaviors

public java.util.List<java.lang.String> getDefaultBehaviors()
                                                     throws CallError,
                                                            java.lang.InterruptedException

Get default behaviors

Returns:

Return default behaviors

Throws:

CallError

java.lang.InterruptedException

playDefaultProject

public void playDefaultProject()
                        throws CallError,
                               java.lang.InterruptedException

Play default behaviors

Throws:

CallError

java.lang.InterruptedException

getRunningBehaviors

public java.util.List<java.lang.String> getRunningBehaviors()
                                                     throws CallError,
                                                            java.lang.InterruptedException

Get running behaviors

Returns:

Return running behaviors

Throws:

CallError

java.lang.InterruptedException

resolveBehaviorName

public java.lang.String resolveBehaviorName(java.lang.String name)
                                     throws CallError,
                                            java.lang.InterruptedException

Find out the actual / path behind a behavior name.

Parameters:

name - name of a behavior

Returns:

The actual / path if found, else an empty string. Throws an ALERROR if two behavior names conflicted.

Throws:

CallError

java.lang.InterruptedException

getLoadedBehaviors

public java.util.List<java.lang.String> getLoadedBehaviors()
                                                    throws CallError,
                                                           java.lang.InterruptedException

Get loaded behaviors

Returns:

Return loaded behaviors

Throws:

CallError

java.lang.InterruptedException

getBehaviorTags

public java.util.List<java.lang.String> getBehaviorTags(java.lang.String behavior)
                                                 throws CallError,
                                                        java.lang.InterruptedException

Get tags found on the given behavior.

Parameters:

behavior - The local path towards a behavior or a directory.

Returns:

The list of tags found.

Throws:

CallError

java.lang.InterruptedException

getBehaviorNature

public java.lang.String getBehaviorNature(java.lang.String behavior)
                                   throws CallError,
                                          java.lang.InterruptedException

Get the nature of the given behavior.

Parameters:

behavior - The local path towards a behavior or a directory.

Returns:

The nature of the behavior.

Throws:

CallError

java.lang.InterruptedException

isBehaviorLoaded

public java.lang.Boolean isBehaviorLoaded(java.lang.String behavior)
                                   throws CallError,
                                          java.lang.InterruptedException

Tell if supplied name corresponds to a loaded behavior

Parameters:

behavior - Behavior name

Returns:

Returns true if it is a loaded behavior

Throws:

CallError

java.lang.InterruptedException

removeDefaultBehavior

public void removeDefaultBehavior(java.lang.String behavior)
                           throws CallError,
                                  java.lang.InterruptedException

Remove the given behavior from the default behaviors

Parameters:

behavior - Behavior name

Throws:

CallError

java.lang.InterruptedException

isStatsEnabled

public java.lang.Boolean isStatsEnabled()
                                 throws CallError,
                                        java.lang.InterruptedException

Throws:

CallError

java.lang.InterruptedException

clearStats

public void clearStats()
                throws CallError,
                       java.lang.InterruptedException

Throws:

CallError

java.lang.InterruptedException

isTraceEnabled

public java.lang.Boolean isTraceEnabled()
                                 throws CallError,
                                        java.lang.InterruptedException

Throws:

CallError

java.lang.InterruptedException

exit

public void exit()
          throws CallError,
                 java.lang.InterruptedException

Exits and unregisters the module.

Throws:

CallError

java.lang.InterruptedException

version

public java.lang.String version()
                         throws CallError,
                                java.lang.InterruptedException

Returns the version of the module.

Returns:

A string containing the version of the module.

Throws:

CallError

java.lang.InterruptedException

ping

public java.lang.Boolean ping()
                       throws CallError,
                              java.lang.InterruptedException

Just a ping. Always returns true

Returns:

returns true

Throws:

CallError

java.lang.InterruptedException

getMethodList

public java.util.List<java.lang.String> getMethodList()
                                               throws CallError,
                                                      java.lang.InterruptedException

Retrieves the module's method list.

Returns:

An array of method names.

Throws:

CallError

java.lang.InterruptedException

getMethodHelp

public java.lang.Object getMethodHelp(java.lang.String methodName)
                               throws CallError,
                                      java.lang.InterruptedException

Retrieves a method's description.

Parameters:

methodName - The name of the method.

Returns:

A structure containing the method's description.

Throws:

CallError

java.lang.InterruptedException

getModuleHelp

public java.lang.Object getModuleHelp()
                               throws CallError,
                                      java.lang.InterruptedException

Retrieves the module's description.

Returns:

A structure describing the module.

Throws:

CallError

java.lang.InterruptedException

wait

public java.lang.Boolean wait(java.lang.Integer id,
                              java.lang.Integer timeoutPeriod)
                       throws CallError,
                              java.lang.InterruptedException

Wait for the end of a long running method that was called using 'post'

Parameters:

id - The ID of the method that was returned when calling the method using 'post'

timeoutPeriod - The timeout period in ms. To wait indefinately, use a timeoutPeriod of zero.

Returns:

True if the timeout period terminated. False if the method returned.

Throws:

CallError

java.lang.InterruptedException

isRunning

public java.lang.Boolean isRunning(java.lang.Integer id)
                            throws CallError,
                                   java.lang.InterruptedException

Returns true if the method is currently running.

Parameters:

id - The ID of the method that was returned when calling the method using 'post'

Returns:

True if the method is currently running

Throws:

CallError

java.lang.InterruptedException

stop

public void stop(java.lang.Integer id)
          throws CallError,
                 java.lang.InterruptedException

returns true if the method is currently running

Parameters:

id - the ID of the method to wait for

Throws:

CallError

java.lang.InterruptedException

getBrokerName

public java.lang.String getBrokerName()
                               throws CallError,
                                      java.lang.InterruptedException

Gets the name of the parent broker.

Returns:

The name of the parent broker.

Throws:

CallError

java.lang.InterruptedException

getUsage

public java.lang.String getUsage(java.lang.String name)
                          throws CallError,
                                 java.lang.InterruptedException

Gets the method usage string. This summarises how to use the method.

Parameters:

name - The name of the method.

Returns:

A string that summarises the usage of the method.

Throws:

CallError

java.lang.InterruptedException

installBehavior

public java.lang.Boolean installBehavior(java.lang.String localPath)
                                  throws CallError,
                                         java.lang.InterruptedException

Install a behavior. Check the given local path for a valid behavior or package. On success, behavior added or updated signal is emitted. DEPRECATED in favor of PackageManager.install.

Parameters:

localPath - the relative destination path.

Returns:

true on success, false on failure.

Throws:

CallError

java.lang.InterruptedException

installBehavior

public java.lang.Boolean installBehavior(java.lang.String absolutePath,
                                         java.lang.String localPath,
                                         java.lang.Boolean overwrite)
                                  throws CallError,
                                         java.lang.InterruptedException

Install a behavior. Check and take the behavior found at the given absolute path andimport it to the given local path, relative to behaviors path. On success, behavior added signal is emitted before returning.DEPRECATED in favor of PackageManager.install.

Parameters:

absolutePath - a behavior on the local file system to install.

localPath - the relative destination path.

overwrite - whether to replace existing behavior if present.

Returns:

true on success, false on failure.

Throws:

CallError

java.lang.InterruptedException

preloadBehavior

public java.lang.Boolean preloadBehavior(java.lang.String behavior)
                                  throws CallError,
                                         java.lang.InterruptedException

Load a behavior

Parameters:

behavior - Behavior name

Returns:

Returns true if it was successfully loaded.

Throws:

CallError

java.lang.InterruptedException

startBehavior

public void startBehavior(java.lang.String behavior)
                   throws CallError,
                          java.lang.InterruptedException

Starts a behavior, returns when started.

Parameters:

behavior - Behavior name

Throws:

CallError

java.lang.InterruptedException

runBehavior

public void runBehavior(java.lang.String behavior)
                 throws CallError,
                        java.lang.InterruptedException

Runs a behavior, returns when finished

Parameters:

behavior - Behavior name

Throws:

CallError

java.lang.InterruptedException

stopBehavior

public void stopBehavior(java.lang.String behavior)
                  throws CallError,
                         java.lang.InterruptedException

Stop a behavior

Parameters:

behavior - Behavior name

Throws:

CallError

java.lang.InterruptedException

stopAllBehaviors

public void stopAllBehaviors()
                      throws CallError,
                             java.lang.InterruptedException

Stop all behaviors

Throws:

CallError

java.lang.InterruptedException

removeBehavior

public java.lang.Boolean removeBehavior(java.lang.String behavior)
                                 throws CallError,
                                        java.lang.InterruptedException

Remove a behavior from the filesystem. DEPRECATED in favor of PackageManager.remove.

Parameters:

behavior - Behavior name

Throws:

CallError

java.lang.InterruptedException

isBehaviorInstalled

public java.lang.Boolean isBehaviorInstalled(java.lang.String name)
                                      throws CallError,
                                             java.lang.InterruptedException

Tell if supplied name corresponds to a behavior that has been installed

Parameters:

name - The behavior directory name

Returns:

Returns true if it is a valid behavior

Throws:

CallError

java.lang.InterruptedException

isBehaviorPresent

public java.lang.Boolean isBehaviorPresent(java.lang.String prefixedBehavior)
                                    throws CallError,
                                           java.lang.InterruptedException

Tell if the supplied namecorresponds to an existing behavior.

Parameters:

prefixedBehavior - Prefixed behavior or just behavior's name (latter usage deprecated, in this case the behavior is searched for amongst user's behaviors, then in system behaviors) DEPRECATED in favor of ALBehaviorManager.isBehaviorInstalled.

Returns:

Returns true if it is an existing behavior

Throws:

CallError

java.lang.InterruptedException

getBehaviorNames

public java.util.List<java.lang.String> getBehaviorNames()
                                                  throws CallError,
                                                         java.lang.InterruptedException

Get behaviors

Returns:

Returns the list of behaviors prefixed by their type (User/ or System/). DEPRECATED in favor of ALBehaviorManager.getInstalledBehaviors.

Throws:

CallError

java.lang.InterruptedException

getUserBehaviorNames

public java.util.List<java.lang.String> getUserBehaviorNames()
                                                      throws CallError,
                                                             java.lang.InterruptedException

Get user's behaviors

Returns:

Returns the list of user's behaviors prefixed by User/. DEPRECATED in favor of ALBehaviorManager.getInstalledBehaviors.

Throws:

CallError

java.lang.InterruptedException

getSystemBehaviorNames

public java.util.List<java.lang.String> getSystemBehaviorNames()
                                                        throws CallError,
                                                               java.lang.InterruptedException

Get system behaviors

Returns:

Returns the list of system behaviors prefixed by System/. DEPRECATED in favor of ALBehaviorManager.getInstalledBehaviors.

Throws:

CallError

java.lang.InterruptedException

getInstalledBehaviors

public java.util.List<java.lang.String> getInstalledBehaviors()
                                                       throws CallError,
                                                              java.lang.InterruptedException

Get installed behaviors directories names

Returns:

Returns the behaviors list

Throws:

CallError

java.lang.InterruptedException

getBehaviorsByTag

public java.util.List<java.lang.String> getBehaviorsByTag(java.lang.String tag)
                                                   throws CallError,
                                                          java.lang.InterruptedException

Get installed behaviors directories names and filter it by tag.

Parameters:

tag - A tag to filter the list with.

Returns:

Returns the behaviors list

Throws:

CallError

java.lang.InterruptedException