com.aldebaran.qi.helper.proxies

Class ALLauncher

java.lang.Object

com.aldebaran.qi.helper.ALProxy

com.aldebaran.qi.helper.proxies.ALLauncher

public class ALLauncher
extends ALProxy

ALlauncher allows to link dynamicaly with library, run executable, unload library, check if module is loaded...

See Also:

NAOqi APIs for ALLauncher

Field Summary

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

name, service

Constructor Summary

Constructors

Constructor and Description
ALLauncher(Session session)

Method Summary

Modifier and Type	Method and Description
void	clearStats()
void	exit() Exits and unregisters the module.
java.lang.String	getBrokerName() Gets the name of the parent broker.
java.util.List<java.lang.String>	getGlobalModuleList() get the list of modules loaded on the robot and connected on the robot
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.lang.String	getUsage(java.lang.String name) Gets the method usage string.
java.lang.Boolean	isModulePresent(java.lang.String strPartOfModuleName) Tests the existence of an active module in the global system (in same executable or in another executable of the distributed system)
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	launchExecutable(java.lang.String moduleName) runs an executable and connect it to current broker (executable)
java.util.List<java.lang.String>	launchLocal(java.lang.String moduleName) Loads dynamicaly a module
java.lang.Boolean	launchPythonModule(java.lang.String moduleName) Import a python module
java.lang.Boolean	launchScript(java.lang.String moduleName) runs a script connected the current broker
java.lang.Boolean	ping() Just a ping.
void	stop(java.lang.Integer id) returns true if the method is currently running
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

ALLauncher

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

Throws:

java.lang.Exception

Method Detail

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

launchLocal

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

Loads dynamicaly a module

Parameters:

moduleName - the name of the module to launch or the name of the python script to evaluate

Returns:

list of modules loaded

Throws:

CallError

java.lang.InterruptedException

launchExecutable

public java.lang.Boolean launchExecutable(java.lang.String moduleName)
                                   throws CallError,
                                          java.lang.InterruptedException

runs an executable and connect it to current broker (executable)

Parameters:

moduleName - the name of the module to launch or the name of the script file to execute

Returns:

true if ok

Throws:

CallError

java.lang.InterruptedException

launchScript

public java.lang.Boolean launchScript(java.lang.String moduleName)
                               throws CallError,
                                      java.lang.InterruptedException

runs a script connected the current broker

Parameters:

moduleName - the name of the script to launch (python)

Returns:

true if ok

Throws:

CallError

java.lang.InterruptedException

launchPythonModule

public java.lang.Boolean launchPythonModule(java.lang.String moduleName)
                                     throws CallError,
                                            java.lang.InterruptedException

Import a python module

Parameters:

moduleName - the name of the module to launch

Returns:

true if ok

Throws:

CallError

java.lang.InterruptedException

isModulePresent

public java.lang.Boolean isModulePresent(java.lang.String strPartOfModuleName)
                                  throws CallError,
                                         java.lang.InterruptedException

Tests the existence of an active module in the global system (in same executable or in another executable of the distributed system)

Parameters:

strPartOfModuleName - a part of the name of the module to test existence

Returns:

the returned value is true if this module is present

Throws:

CallError

java.lang.InterruptedException

getGlobalModuleList

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

get the list of modules loaded on the robot and connected on the robot

Returns:

array of present modules

Throws:

CallError

java.lang.InterruptedException