com.aldebaran.qi.helper.proxies

Class ALResourceManager

java.lang.Object

com.aldebaran.qi.helper.ALProxy

com.aldebaran.qi.helper.proxies.ALResourceManager

public class ALResourceManager
extends ALProxy

Manage robot resources: Synchronize movement, led, sound. Run specific actions when another behavior wants your resources

See Also:

NAOqi APIs for ALResourceManager

Field Summary

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

name, service

Constructor Summary

Constructors

Constructor and Description
ALResourceManager(Session session)

Method Summary

Modifier and Type	Method and Description
void	acquireResource(java.lang.String resourceName, java.lang.String moduleName, java.lang.String callbackName, java.lang.Integer timeoutSeconds) Wait and acquire a resource
void	acquireResourcesTree(java.util.List<java.lang.String> resourceName, java.lang.String moduleName, java.lang.String callbackName, java.lang.Integer timeoutSeconds) Wait for resource tree.
java.lang.Boolean	areResourcesFree(java.util.List<java.lang.String> resourceNames) True if all resources are free
java.lang.Boolean	areResourcesOwnedBy(java.util.List<java.lang.String> resourceNameList, java.lang.String ownerName) True if all the specified resources are owned by the owner
java.lang.Boolean	checkStateResourceFree(java.util.List<java.lang.String> resourceName) check if all the state resource in the list are free
void	clearStats()
void	createResource(java.lang.String resourceName, java.lang.String parentResourceName) Create a resource
void	createResourcesList(java.util.List<java.lang.String> resourceGroupName, java.lang.String resourceName) True if a resource is in another parent resource
void	deleteResource(java.lang.String resourceName, java.lang.Boolean deleteChildResources) Delete a root resource
void	enableStateResource(java.lang.String resourceName, java.lang.Boolean enabled) Enable or disable a state resource
void	exit() Exits and unregisters the module.
java.lang.String	getBrokerName() Gets the name of the parent broker.
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.Object	getResources() Get tree of resources
java.lang.String	getUsage(java.lang.String name) Gets the method usage string.
java.lang.Boolean	isInGroup(java.lang.String resourceGroupName, java.lang.String resourceName) True if a resource is in another parent resource
java.lang.Boolean	isResourceFree(java.lang.String resourceNames) True if the resource is free
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.Object	ownersGet() The tree of the resources owners.
java.lang.Boolean	ping() Just a ping.
void	releaseResource(java.lang.String resourceName, java.lang.String ownerName) Release resource
void	releaseResources(java.util.List<java.lang.String> resourceNames, java.lang.String ownerName) Release resources list
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'
java.util.List<java.lang.String>	waitForOptionalResourcesTree(java.util.List<java.lang.String> param1, java.lang.String param2, java.lang.String param3, java.lang.Integer param4, java.util.List<java.lang.String> param5) Wait resource
void	waitForResource(java.lang.String resourceName, java.lang.String ownerName, java.lang.String callbackName, java.lang.Integer timeoutSeconds) Wait resource
void	waitForResourcesTree(java.util.List<java.lang.String> resourceName, java.lang.String moduleName, java.lang.String callbackName, java.lang.Integer timeoutSeconds) Wait for resource tree.

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

ALResourceManager

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

Throws:

java.lang.Exception

Method Detail

createResourcesList

public void createResourcesList(java.util.List<java.lang.String> resourceGroupName,
                                java.lang.String resourceName)
                         throws CallError,
                                java.lang.InterruptedException

True if a resource is in another parent resource

Parameters:

resourceGroupName - Group name. Ex: Arm

resourceName - Resource name

Throws:

CallError

java.lang.InterruptedException

ownersGet

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

The tree of the resources owners.

Throws:

CallError

java.lang.InterruptedException

getResources

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

Get tree of resources

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

waitForResource

public void waitForResource(java.lang.String resourceName,
                            java.lang.String ownerName,
                            java.lang.String callbackName,
                            java.lang.Integer timeoutSeconds)
                     throws CallError,
                            java.lang.InterruptedException

Wait resource

Parameters:

resourceName - Resource name

ownerName - Module name

callbackName - callback name

timeoutSeconds - Timeout in seconds

Throws:

CallError

java.lang.InterruptedException

acquireResource

public void acquireResource(java.lang.String resourceName,
                            java.lang.String moduleName,
                            java.lang.String callbackName,
                            java.lang.Integer timeoutSeconds)
                     throws CallError,
                            java.lang.InterruptedException

Wait and acquire a resource

Parameters:

resourceName - Resource name

moduleName - Module name

callbackName - callback name

timeoutSeconds - Timeout in seconds

Throws:

CallError

java.lang.InterruptedException

waitForOptionalResourcesTree

public java.util.List<java.lang.String> waitForOptionalResourcesTree(java.util.List<java.lang.String> param1,
                                                                     java.lang.String param2,
                                                                     java.lang.String param3,
                                                                     java.lang.Integer param4,
                                                                     java.util.List<java.lang.String> param5)
                                                              throws CallError,
                                                                     java.lang.InterruptedException

Wait resource

Throws:

CallError

java.lang.InterruptedException

waitForResourcesTree

public void waitForResourcesTree(java.util.List<java.lang.String> resourceName,
                                 java.lang.String moduleName,
                                 java.lang.String callbackName,
                                 java.lang.Integer timeoutSeconds)
                          throws CallError,
                                 java.lang.InterruptedException

Wait for resource tree. Parent and children are not in conflict. Local function

Parameters:

resourceName - Resource name

moduleName - Module name

callbackName - callback name

timeoutSeconds - Timeout in seconds

Throws:

CallError

java.lang.InterruptedException

acquireResourcesTree

public void acquireResourcesTree(java.util.List<java.lang.String> resourceName,
                                 java.lang.String moduleName,
                                 java.lang.String callbackName,
                                 java.lang.Integer timeoutSeconds)
                          throws CallError,
                                 java.lang.InterruptedException

Wait for resource tree. Parent and children are not in conflict. Local function

Parameters:

resourceName - Resource name

moduleName - Module name

callbackName - callback name

timeoutSeconds - Timeout in seconds

Throws:

CallError

java.lang.InterruptedException

areResourcesOwnedBy

public java.lang.Boolean areResourcesOwnedBy(java.util.List<java.lang.String> resourceNameList,
                                             java.lang.String ownerName)
                                      throws CallError,
                                             java.lang.InterruptedException

True if all the specified resources are owned by the owner

Parameters:

resourceNameList - Resource name

ownerName - Owner pointer with hierarchy

Returns:

True if all the specify resources are owned by the owner

Throws:

CallError

java.lang.InterruptedException

releaseResource

public void releaseResource(java.lang.String resourceName,
                            java.lang.String ownerName)
                     throws CallError,
                            java.lang.InterruptedException

Release resource

Parameters:

resourceName - Resource name

ownerName - Existing owner name

Throws:

CallError

java.lang.InterruptedException

releaseResources

public void releaseResources(java.util.List<java.lang.String> resourceNames,
                             java.lang.String ownerName)
                      throws CallError,
                             java.lang.InterruptedException

Release resources list

Parameters:

resourceNames - Resource names

ownerName - Owner name

Throws:

CallError

java.lang.InterruptedException

enableStateResource

public void enableStateResource(java.lang.String resourceName,
                                java.lang.Boolean enabled)
                         throws CallError,
                                java.lang.InterruptedException

Enable or disable a state resource

Parameters:

resourceName - The name of the resource that you wish enable of disable. e.g. Standing

enabled - True to enable, false to disable

Throws:

CallError

java.lang.InterruptedException

checkStateResourceFree

public java.lang.Boolean checkStateResourceFree(java.util.List<java.lang.String> resourceName)
                                         throws CallError,
                                                java.lang.InterruptedException

check if all the state resource in the list are free

Parameters:

resourceName - Resource name

Throws:

CallError

java.lang.InterruptedException

areResourcesFree

public java.lang.Boolean areResourcesFree(java.util.List<java.lang.String> resourceNames)
                                   throws CallError,
                                          java.lang.InterruptedException

True if all resources are free

Parameters:

resourceNames - Resource names

Returns:

True if all the specify resources are free

Throws:

CallError

java.lang.InterruptedException

isResourceFree

public java.lang.Boolean isResourceFree(java.lang.String resourceNames)
                                 throws CallError,
                                        java.lang.InterruptedException

True if the resource is free

Parameters:

resourceNames - Resource name

Returns:

True if the specify resources is free

Throws:

CallError

java.lang.InterruptedException

createResource

public void createResource(java.lang.String resourceName,
                           java.lang.String parentResourceName)
                    throws CallError,
                           java.lang.InterruptedException

Create a resource

Parameters:

resourceName - Resource name to create

parentResourceName - Parent resource name or empty string for root resource

Throws:

CallError

java.lang.InterruptedException

deleteResource

public void deleteResource(java.lang.String resourceName,
                           java.lang.Boolean deleteChildResources)
                    throws CallError,
                           java.lang.InterruptedException

Delete a root resource

Parameters:

resourceName - Resource name to delete

deleteChildResources - DEPRECATED: Delete child resources if true

Throws:

CallError

java.lang.InterruptedException

isInGroup

public java.lang.Boolean isInGroup(java.lang.String resourceGroupName,
                                   java.lang.String resourceName)
                            throws CallError,
                                   java.lang.InterruptedException

True if a resource is in another parent resource

Parameters:

resourceGroupName - Group name. Ex: Arm

resourceName - Resource name

Throws:

CallError

java.lang.InterruptedException