com.aldebaran.qi

Class DynamicObjectBuilder

java.lang.Object

com.aldebaran.qi.DynamicObjectBuilder

public class DynamicObjectBuilder
extends java.lang.Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DynamicObjectBuilder.ObjectThreadingModel

Constructor Summary

Constructors

Constructor and Description
DynamicObjectBuilder()

Method Summary

Modifier and Type	Method and Description
void	advertiseMethod(java.lang.String methodSignature, QiService service, java.lang.String description) Bind method from a qimessaging.service to GenericObject.
void	advertiseProperty(java.lang.String name, java.lang.Class<?> propertyBase)
void	advertiseSignal(java.lang.String signalSignature) Advertise an signal with its callback signature.
protected void	finalize() Called by garbage collector Finalize is overriden to manually delete C++ data
AnyObject	object() Instantiate new AnyObject after builder template.
void	setThreadingModel(DynamicObjectBuilder.ObjectThreadingModel threadModel) Declare the thread-safeness state of an instance

Methods inherited from class java.lang.Object

clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DynamicObjectBuilder

public DynamicObjectBuilder()

Method Detail

advertiseMethod

public void advertiseMethod(java.lang.String methodSignature,
                            QiService service,
                            java.lang.String description)
                     throws QiException

Bind method from a qimessaging.service to GenericObject.

Parameters:

methodSignature - Signature of method to bind.

service - Service implementing method.

Throws:

java.lang.Exception - on error.

QiException

advertiseSignal

public void advertiseSignal(java.lang.String signalSignature)
                     throws java.lang.Exception

Advertise an signal with its callback signature.

Parameters:

signalSignature - Signature of available callback.

Throws:

java.lang.Exception - If GenericObject is not initialized internally.

advertiseProperty

public void advertiseProperty(java.lang.String name,
                              java.lang.Class<?> propertyBase)
                       throws QiException

Throws:

QiException

setThreadingModel

public void setThreadingModel(DynamicObjectBuilder.ObjectThreadingModel threadModel)
                       throws QiException

Declare the thread-safeness state of an instance

Parameters:

threadModel - if set to ObjectThreadingModel.MultiThread, your object is expected to be thread safe, and calls to its method will potentially occur in parallel in multiple threads. If false, qimessaging will use a per-instance mutex to prevent multiple calls at the same time.

Throws:

QiException

object

public AnyObject object()

Instantiate new AnyObject after builder template.

Returns:

AnyObject

See Also:

AnyObject

finalize

protected void finalize()
                 throws java.lang.Throwable

Called by garbage collector Finalize is overriden to manually delete C++ data

Overrides:

finalize in class java.lang.Object

Throws:

java.lang.Throwable