public class ALPreferences extends ALProxy
Constructor and Description |
---|
ALPreferences(Session session) |
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.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 |
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.
|
java.lang.Object |
readPrefFile(java.lang.String fileName,
java.lang.Boolean autoGenerateMemoryNames)
Reads all preferences from an xml files and stores them in an ALValue.
|
void |
removePrefFile(java.lang.String fileName)
Remove the xml file.
|
java.lang.Boolean |
saveToMemory(java.lang.Object prefs)
Writes all preferences from ALValue to an xml file.
|
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'
|
void |
writePrefFile(java.lang.String fileName,
java.lang.Object prefs,
java.lang.Boolean ignoreMemoryNames)
Writes all preferences from ALValue to an xml file.
|
call, connect, connect, disconnect, getNaoqiType, getService, isProxyReady, setService
public ALPreferences(Session session) throws java.lang.Exception
java.lang.Exception
public java.lang.Boolean isStatsEnabled() throws CallError, java.lang.InterruptedException
CallError
java.lang.InterruptedException
public void clearStats() throws CallError, java.lang.InterruptedException
CallError
java.lang.InterruptedException
public java.lang.Boolean isTraceEnabled() throws CallError, java.lang.InterruptedException
CallError
java.lang.InterruptedException
public void exit() throws CallError, java.lang.InterruptedException
CallError
java.lang.InterruptedException
public java.lang.String version() throws CallError, java.lang.InterruptedException
CallError
java.lang.InterruptedException
public java.lang.Boolean ping() throws CallError, java.lang.InterruptedException
CallError
java.lang.InterruptedException
public java.util.List<java.lang.String> getMethodList() throws CallError, java.lang.InterruptedException
CallError
java.lang.InterruptedException
public java.lang.Object getMethodHelp(java.lang.String methodName) throws CallError, java.lang.InterruptedException
methodName
- The name of the method.CallError
java.lang.InterruptedException
public java.lang.Object getModuleHelp() throws CallError, java.lang.InterruptedException
CallError
java.lang.InterruptedException
public java.lang.Boolean wait(java.lang.Integer id, java.lang.Integer timeoutPeriod) throws CallError, java.lang.InterruptedException
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.CallError
java.lang.InterruptedException
public java.lang.Boolean isRunning(java.lang.Integer id) throws CallError, java.lang.InterruptedException
id
- The ID of the method that was returned when calling the method using 'post'CallError
java.lang.InterruptedException
public void stop(java.lang.Integer id) throws CallError, java.lang.InterruptedException
id
- the ID of the method to wait forCallError
java.lang.InterruptedException
public java.lang.String getBrokerName() throws CallError, java.lang.InterruptedException
CallError
java.lang.InterruptedException
public java.lang.String getUsage(java.lang.String name) throws CallError, java.lang.InterruptedException
name
- The name of the method.CallError
java.lang.InterruptedException
public java.lang.Object readPrefFile(java.lang.String fileName, java.lang.Boolean autoGenerateMemoryNames) throws CallError, java.lang.InterruptedException
fileName
- Name of the module associated to the preference.autoGenerateMemoryNames
- If true a memory name will be generated for each non-array preference.CallError
java.lang.InterruptedException
public void writePrefFile(java.lang.String fileName, java.lang.Object prefs, java.lang.Boolean ignoreMemoryNames) throws CallError, java.lang.InterruptedException
fileName
- Name of the module associated to the preference.prefs
- array reprenting the whole file.ignoreMemoryNames
- If true all memory names will be removed before saving.CallError
java.lang.InterruptedException
public void removePrefFile(java.lang.String fileName) throws CallError, java.lang.InterruptedException
fileName
- Name of the module associated to the preference.CallError
java.lang.InterruptedException
public java.lang.Boolean saveToMemory(java.lang.Object prefs) throws CallError, java.lang.InterruptedException
prefs
- array representing the whole file.CallError
java.lang.InterruptedException
Aldebaran SDK for Java
Copyright 2006-2015 Aldebaran Robotics. All Rights Reserved.