com.aldebaran.qi.helper.proxies

Class ALWorldRepresentation

java.lang.Object

com.aldebaran.qi.helper.ALProxy

com.aldebaran.qi.helper.proxies.ALWorldRepresentation

public class ALWorldRepresentation
extends ALProxy

See Also:

NAOqi APIs for ALWorldRepresentation

Field Summary

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

name, service

Constructor Summary

Constructors

Constructor and Description
ALWorldRepresentation(Session session)

Method Summary

Modifier and Type	Method and Description
java.lang.Integer	addAttributeToCategory(java.lang.String param1, java.lang.String param2, java.lang.Object param3) Add an attribute to a category.
java.lang.Integer	clearObject(java.lang.String param1) Clear an object.
java.lang.Integer	clearOldPositions(java.lang.String param1, java.lang.Integer param2) Clear recording of old positions.
void	clearStats()
java.lang.Integer	createObjectCategory(java.lang.String param1, java.lang.Boolean param2) Create a new object category
java.lang.Integer	deleteObjectAttribute(java.lang.String param1, java.lang.String param2, java.lang.String param3) Delete an object attribute
void	exit() Exits and unregisters the module.
java.lang.Boolean	findObject(java.lang.String param1) Check that an object is present.
java.lang.Object	getAttributesFromCategory(java.lang.String param1) Get all attributes from a category if it exists.
java.lang.String	getBrokerName() Gets the name of the parent broker.
java.util.List<java.lang.String>	getChildrenNames(java.lang.String param1) Get the direct children of an object.
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	getObjectAttributes(java.lang.String param1)
java.lang.Object	getObjectAttributeValues(java.lang.String param1, java.lang.String param2, java.lang.Integer param3)
java.lang.String	getObjectCategory(java.lang.String param1) Get the name of the database where the object is stored.
java.lang.Object	getObjectLatestAttributes(java.lang.String param1, java.lang.Integer param2)
java.util.List<java.lang.String>	getObjectNames() Get the name of the objects.
java.lang.String	getObjectParentName(java.lang.String param1)
java.util.List<java.lang.String>	getObjectsInCategory(java.lang.String param1) Get the name of the objects stored in the database.
java.lang.Object	getPosition(java.lang.String param1, java.lang.String param2) Get the position of an object with quaternion / translation.
java.util.List<java.lang.Float>	getPosition6D(java.lang.String param1, java.lang.String param2) Get the position from one object to another.
java.util.List<java.lang.Float>	getPosition6DAtTime(java.lang.String param1, java.lang.String param2, java.lang.Integer param3, java.lang.Integer param4) Get the interpolated position of an object
java.lang.String	getRootName()
java.lang.String	getUsage(java.lang.String name) Gets the method usage string.
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.Integer	load()
java.lang.Boolean	objectCategoryExists(java.lang.String param1) Tells if an object category exists
java.lang.Boolean	ping() Just a ping.
java.lang.Integer	removeObjectCategory(java.lang.String param1) Remove an object category
java.lang.Integer	save()
java.lang.Object	select(java.lang.String param1, java.lang.String param2, java.lang.String param3, java.lang.String param4) Select information from a database.
java.lang.Object	selectWithOrder(java.lang.String param1, java.lang.String param2, java.lang.String param3, java.lang.String param4, java.lang.String param5) Select ordered information from a database.
void	stop(java.lang.Integer id) returns true if the method is currently running
java.lang.Integer	storeObject(java.lang.String param1, java.lang.String param2, java.util.List<java.lang.Float> param3, java.lang.String param4, java.lang.Object param5)
java.lang.Integer	storeObjectAttribute(java.lang.String param1, java.lang.String param2, java.lang.Object param3)
java.lang.Integer	storeObjectWithReference(java.lang.String param1, java.lang.String param2, java.lang.String param3, java.util.List<java.lang.Float> param4, java.lang.String param5, java.lang.Object param6)
java.lang.Integer	updateAttribute(java.lang.String param1, java.lang.String param2, java.lang.String param3, java.lang.Object param4)
java.lang.Integer	updatePosition(java.lang.String param1, java.util.List<java.lang.Float> param2, java.lang.Boolean param3) Update the position of an object.
java.lang.Integer	updatePositionWithReference(java.lang.String param1, java.lang.String param2, java.util.List<java.lang.Float> param3, java.lang.Boolean param4) Update the position of an object relative to another.
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

ALWorldRepresentation

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

Throws:

java.lang.Exception

Method Detail

getPosition6D

public java.util.List<java.lang.Float> getPosition6D(java.lang.String param1,
                                                     java.lang.String param2)
                                              throws CallError,
                                                     java.lang.InterruptedException

Get the position from one object to another.

Throws:

CallError

java.lang.InterruptedException

selectWithOrder

public java.lang.Object selectWithOrder(java.lang.String param1,
                                        java.lang.String param2,
                                        java.lang.String param3,
                                        java.lang.String param4,
                                        java.lang.String param5)
                                 throws CallError,
                                        java.lang.InterruptedException

Select ordered information from a database.

Throws:

CallError

java.lang.InterruptedException

getObjectParentName

public java.lang.String getObjectParentName(java.lang.String param1)
                                     throws CallError,
                                            java.lang.InterruptedException

Throws:

CallError

java.lang.InterruptedException

storeObjectWithReference

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

Throws:

CallError

java.lang.InterruptedException

storeObjectAttribute

public java.lang.Integer storeObjectAttribute(java.lang.String param1,
                                              java.lang.String param2,
                                              java.lang.Object param3)
                                       throws CallError,
                                              java.lang.InterruptedException

Throws:

CallError

java.lang.InterruptedException

getObjectCategory

public java.lang.String getObjectCategory(java.lang.String param1)
                                   throws CallError,
                                          java.lang.InterruptedException

Get the name of the database where the object is stored.

Throws:

CallError

java.lang.InterruptedException

updatePositionWithReference

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

Update the position of an object relative to another.

Throws:

CallError

java.lang.InterruptedException

updateAttribute

public java.lang.Integer updateAttribute(java.lang.String param1,
                                         java.lang.String param2,
                                         java.lang.String param3,
                                         java.lang.Object param4)
                                  throws CallError,
                                         java.lang.InterruptedException

Throws:

CallError

java.lang.InterruptedException

getPosition

public java.lang.Object getPosition(java.lang.String param1,
                                    java.lang.String param2)
                             throws CallError,
                                    java.lang.InterruptedException

Get the position of an object with quaternion / translation.

Throws:

CallError

java.lang.InterruptedException

getPosition6DAtTime

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

Get the interpolated position of an object

Throws:

CallError

java.lang.InterruptedException

getRootName

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

Throws:

CallError

java.lang.InterruptedException

getObjectsInCategory

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

Get the name of the objects stored in the database.

Throws:

CallError

java.lang.InterruptedException

save

public java.lang.Integer save()
                       throws CallError,
                              java.lang.InterruptedException

Throws:

CallError

java.lang.InterruptedException

select

public java.lang.Object select(java.lang.String param1,
                               java.lang.String param2,
                               java.lang.String param3,
                               java.lang.String param4)
                        throws CallError,
                               java.lang.InterruptedException

Select information from a database.

Throws:

CallError

java.lang.InterruptedException

storeObject

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

Throws:

CallError

java.lang.InterruptedException

updatePosition

public java.lang.Integer updatePosition(java.lang.String param1,
                                        java.util.List<java.lang.Float> param2,
                                        java.lang.Boolean param3)
                                 throws CallError,
                                        java.lang.InterruptedException

Update the position of an object.

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

addAttributeToCategory

public java.lang.Integer addAttributeToCategory(java.lang.String param1,
                                                java.lang.String param2,
                                                java.lang.Object param3)
                                         throws CallError,
                                                java.lang.InterruptedException

Add an attribute to a category.

Throws:

CallError

java.lang.InterruptedException

clearObject

public java.lang.Integer clearObject(java.lang.String param1)
                              throws CallError,
                                     java.lang.InterruptedException

Clear an object.

Throws:

CallError

java.lang.InterruptedException

clearOldPositions

public java.lang.Integer clearOldPositions(java.lang.String param1,
                                           java.lang.Integer param2)
                                    throws CallError,
                                           java.lang.InterruptedException

Clear recording of old positions.

Throws:

CallError

java.lang.InterruptedException

createObjectCategory

public java.lang.Integer createObjectCategory(java.lang.String param1,
                                              java.lang.Boolean param2)
                                       throws CallError,
                                              java.lang.InterruptedException

Create a new object category

Throws:

CallError

java.lang.InterruptedException

removeObjectCategory

public java.lang.Integer removeObjectCategory(java.lang.String param1)
                                       throws CallError,
                                              java.lang.InterruptedException

Remove an object category

Throws:

CallError

java.lang.InterruptedException

objectCategoryExists

public java.lang.Boolean objectCategoryExists(java.lang.String param1)
                                       throws CallError,
                                              java.lang.InterruptedException

Tells if an object category exists

Throws:

CallError

java.lang.InterruptedException

deleteObjectAttribute

public java.lang.Integer deleteObjectAttribute(java.lang.String param1,
                                               java.lang.String param2,
                                               java.lang.String param3)
                                        throws CallError,
                                               java.lang.InterruptedException

Delete an object attribute

Throws:

CallError

java.lang.InterruptedException

findObject

public java.lang.Boolean findObject(java.lang.String param1)
                             throws CallError,
                                    java.lang.InterruptedException

Check that an object is present.

Throws:

CallError

java.lang.InterruptedException

load

public java.lang.Integer load()
                       throws CallError,
                              java.lang.InterruptedException

Throws:

CallError

java.lang.InterruptedException

getAttributesFromCategory

public java.lang.Object getAttributesFromCategory(java.lang.String param1)
                                           throws CallError,
                                                  java.lang.InterruptedException

Get all attributes from a category if it exists.

Throws:

CallError

java.lang.InterruptedException

getChildrenNames

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

Get the direct children of an object.

Throws:

CallError

java.lang.InterruptedException

getObjectNames

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

Get the name of the objects.

Throws:

CallError

java.lang.InterruptedException

getObjectAttributes

public java.lang.Object getObjectAttributes(java.lang.String param1)
                                     throws CallError,
                                            java.lang.InterruptedException

Throws:

CallError

java.lang.InterruptedException

getObjectAttributeValues

public java.lang.Object getObjectAttributeValues(java.lang.String param1,
                                                 java.lang.String param2,
                                                 java.lang.Integer param3)
                                          throws CallError,
                                                 java.lang.InterruptedException

Throws:

CallError

java.lang.InterruptedException

getObjectLatestAttributes

public java.lang.Object getObjectLatestAttributes(java.lang.String param1,
                                                  java.lang.Integer param2)
                                           throws CallError,
                                                  java.lang.InterruptedException

Throws:

CallError

java.lang.InterruptedException