public class DCM extends ALProxy
Modifier and Type | Method and Description |
---|---|
void |
calibration(java.lang.Object calibrationInput)
Calibration of a joint
|
void |
clearStats() |
java.lang.Object |
createAlias(java.lang.Object alias)
Create or change an alias (list of actuators)
|
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 |
getPrefix()
Return the STM base name
|
java.lang.Integer |
getTime(java.lang.Integer offset)
Return the DCM time
|
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.Integer |
preferences(java.lang.String action,
java.lang.String target,
java.lang.String keyName,
java.lang.Object keyValue)
Save updated value from DCM in XML pref file
|
void |
set(java.lang.Object commands)
Call this function to send a timed-command list to an actuator
|
void |
setAlias(java.lang.Object commands)
Call this function to send timed-command list to an alias (list of actuators)
|
void |
setAlias(java.lang.String name,
java.lang.Integer time,
java.util.List<java.lang.Float> commands)
Call this function to send timed-command list to an alias (list of actuators) with "ClearAll" merge startegy
|
void |
special(java.lang.String result)
Special DCM commands
|
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'
|
call, connect, connect, disconnect, getNaoqiType, getService, isProxyReady, setService
public DCM(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 void set(java.lang.Object commands) throws CallError, java.lang.InterruptedException
commands
- AL::ALValue with all dataCallError
java.lang.InterruptedException
public void setAlias(java.lang.Object commands) throws CallError, java.lang.InterruptedException
commands
- AL::ALValue with all dataCallError
java.lang.InterruptedException
public void setAlias(java.lang.String name, java.lang.Integer time, java.util.List<java.lang.Float> commands) throws CallError, java.lang.InterruptedException
name
- alias nametime
- time for the timed commandcommands
- std::vectorCallError
java.lang.InterruptedException
public java.lang.Integer getTime(java.lang.Integer offset) throws CallError, java.lang.InterruptedException
offset
- optional time in ms (signed) to add/removeCallError
java.lang.InterruptedException
public java.lang.Object createAlias(java.lang.Object alias) throws CallError, java.lang.InterruptedException
alias
- Alias name and descriptionCallError
java.lang.InterruptedException
public java.lang.Object getPrefix() throws CallError, java.lang.InterruptedException
CallError
java.lang.InterruptedException
public void special(java.lang.String result) throws CallError, java.lang.InterruptedException
result
- one string and could be Reset, Version, Chain, Diagnostic, ConfigCallError
java.lang.InterruptedException
public void calibration(java.lang.Object calibrationInput) throws CallError, java.lang.InterruptedException
calibrationInput
- A complex ALValue. See red documentationCallError
java.lang.InterruptedException
public java.lang.Integer preferences(java.lang.String action, java.lang.String target, java.lang.String keyName, java.lang.Object keyValue) throws CallError, java.lang.InterruptedException
action
- string : 'Save' 'Load' 'Add'target
- string : 'Chest' 'Head' 'Main' 'All'keyName
- The name of the key if action = 'Add'.keyValue
- The ALVAlue of the key to addCallError
java.lang.InterruptedException
Aldebaran SDK for Java
Copyright 2006-2015 Aldebaran Robotics. All Rights Reserved.