public class ALBehaviorManager extends ALProxy
Constructor and Description |
---|
ALBehaviorManager(Session session) |
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
|
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'
|
call, connect, connect, disconnect, getNaoqiType, getService, isProxyReady, setService
public ALBehaviorManager(Session session) throws java.lang.Exception
java.lang.Exception
public java.util.List<java.lang.String> getTagList() throws CallError, java.lang.InterruptedException
CallError
java.lang.InterruptedException
public void addDefaultBehavior(java.lang.String behavior) throws CallError, java.lang.InterruptedException
behavior
- Behavior nameCallError
java.lang.InterruptedException
public java.lang.Boolean isBehaviorRunning(java.lang.String behavior) throws CallError, java.lang.InterruptedException
behavior
- Behavior nameCallError
java.lang.InterruptedException
public java.util.List<java.lang.String> getDefaultBehaviors() throws CallError, java.lang.InterruptedException
CallError
java.lang.InterruptedException
public void playDefaultProject() throws CallError, java.lang.InterruptedException
CallError
java.lang.InterruptedException
public java.util.List<java.lang.String> getRunningBehaviors() throws CallError, java.lang.InterruptedException
CallError
java.lang.InterruptedException
public java.lang.String resolveBehaviorName(java.lang.String name) throws CallError, java.lang.InterruptedException
name
- name of a behaviorCallError
java.lang.InterruptedException
public java.util.List<java.lang.String> getLoadedBehaviors() throws CallError, java.lang.InterruptedException
CallError
java.lang.InterruptedException
public java.util.List<java.lang.String> getBehaviorTags(java.lang.String behavior) throws CallError, java.lang.InterruptedException
behavior
- The local path towards a behavior or a directory.CallError
java.lang.InterruptedException
public java.lang.String getBehaviorNature(java.lang.String behavior) throws CallError, java.lang.InterruptedException
behavior
- The local path towards a behavior or a directory.CallError
java.lang.InterruptedException
public java.lang.Boolean isBehaviorLoaded(java.lang.String behavior) throws CallError, java.lang.InterruptedException
behavior
- Behavior nameCallError
java.lang.InterruptedException
public void removeDefaultBehavior(java.lang.String behavior) throws CallError, java.lang.InterruptedException
behavior
- Behavior nameCallError
java.lang.InterruptedException
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.Boolean installBehavior(java.lang.String localPath) throws CallError, java.lang.InterruptedException
localPath
- the relative destination path.CallError
java.lang.InterruptedException
public java.lang.Boolean installBehavior(java.lang.String absolutePath, java.lang.String localPath, java.lang.Boolean overwrite) throws CallError, java.lang.InterruptedException
absolutePath
- a behavior on the local file system to install.localPath
- the relative destination path.overwrite
- whether to replace existing behavior if present.CallError
java.lang.InterruptedException
public java.lang.Boolean preloadBehavior(java.lang.String behavior) throws CallError, java.lang.InterruptedException
behavior
- Behavior nameCallError
java.lang.InterruptedException
public void startBehavior(java.lang.String behavior) throws CallError, java.lang.InterruptedException
behavior
- Behavior nameCallError
java.lang.InterruptedException
public void runBehavior(java.lang.String behavior) throws CallError, java.lang.InterruptedException
behavior
- Behavior nameCallError
java.lang.InterruptedException
public void stopBehavior(java.lang.String behavior) throws CallError, java.lang.InterruptedException
behavior
- Behavior nameCallError
java.lang.InterruptedException
public void stopAllBehaviors() throws CallError, java.lang.InterruptedException
CallError
java.lang.InterruptedException
public java.lang.Boolean removeBehavior(java.lang.String behavior) throws CallError, java.lang.InterruptedException
behavior
- Behavior nameCallError
java.lang.InterruptedException
public java.lang.Boolean isBehaviorInstalled(java.lang.String name) throws CallError, java.lang.InterruptedException
name
- The behavior directory nameCallError
java.lang.InterruptedException
public java.lang.Boolean isBehaviorPresent(java.lang.String prefixedBehavior) throws CallError, java.lang.InterruptedException
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.CallError
java.lang.InterruptedException
public java.util.List<java.lang.String> getBehaviorNames() throws CallError, java.lang.InterruptedException
CallError
java.lang.InterruptedException
public java.util.List<java.lang.String> getUserBehaviorNames() throws CallError, java.lang.InterruptedException
CallError
java.lang.InterruptedException
public java.util.List<java.lang.String> getSystemBehaviorNames() throws CallError, java.lang.InterruptedException
CallError
java.lang.InterruptedException
public java.util.List<java.lang.String> getInstalledBehaviors() throws CallError, java.lang.InterruptedException
CallError
java.lang.InterruptedException
public java.util.List<java.lang.String> getBehaviorsByTag(java.lang.String tag) throws CallError, java.lang.InterruptedException
tag
- A tag to filter the list with.CallError
java.lang.InterruptedException
Aldebaran SDK for Java
Copyright 2006-2015 Aldebaran Robotics. All Rights Reserved.