NAOqi Core - Overview | API
Namespace : AL
#include <alcommon/almodule.h>
Determines if the method created with a ‘post’ is still running.
Parameters: |
|
---|---|
Returns: | true if the method is still running, false otherwise |
Waits until the end of a long running method using the ID that was returned from a method started with ‘post’
Parameters: |
|
---|---|
Returns: | true if the timeout period expired, false otherwise |
Stops a module’s method using the ID given returned by a ‘post’ call. Module authors are encouraged to implement this if they have long running methods that they wish to allow users to interrupt.
Parameters: |
|
---|
Unregisters the module from the parent broker. Once this is called the method of your module will no longer be available. Module authors who override this method are expected to perform a clean shutdown.
Warning
It is not advised to call exit on Core modules such as ALMemory or ALMotion while other module or code are accessing them.
Gets the name of the parent broker
Returns: | The name of the parent broker |
---|
Retrieves the module’s method list
Returns: | A vector of method names |
---|
Retrieves a method’s description
Parameters: |
|
---|---|
Returns: | A structure containing the method’s description |
[
std::string methodName,
[ parameter, ...],
std::string returnName,
std::string returnDescription
]
Where parameter is
[
std::string parameterName,
std::string parameterDescription
]
Retrieves a structure containing the module’s description:
Returns: | A structure describing the module |
---|
[
std::string moduleDescription,
[ moduleExample, ...]
]
Where moduleExample is
[
std::string language,
std::string example
]
Gets the method usage string. This summarises how to use the method.
Parameters: |
|
---|---|
Returns: | A string that summarises the usage of the method |
Returns the version of the module
Returns: | The version as a string |
---|
The broker brokerName is connected.
The broker brokerName has been disconnect.