D - The unit data type.public abstract class AbstractUnitRemote<D extends com.google.protobuf.GeneratedMessage> extends org.openbase.jul.extension.rsb.com.AbstractConfigurableRemote<D,rst.domotic.unit.UnitConfigType.UnitConfig> implements UnitRemote<D>
CONNECTION_TIMEOUT, DATA_WAIT_TIMEOUT, logger, LOGGING_TIMEOUT, maintainer, METHOD_CALL_MAX_TIMEOUT, METHOD_CALL_START_TIMEOUT, METHOD_CALL_TIMEOUT_MULTIPLIER, PING_TIMEOUT, REQUEST_TIMEOUT, scopeSERVICE_LABEL, SERVICE_MODE_PACKAGE, SERVICE_STATE_PACKAGE| Constructor and Description |
|---|
AbstractUnitRemote(Class<D> dataClass) |
| Modifier and Type | Method and Description |
|---|---|
void |
activate() |
void |
addServiceStateObserver(rst.domotic.service.ServiceTemplateType.ServiceTemplate.ServiceType serviceType,
org.openbase.jul.pattern.Observer observer) |
Future<rst.domotic.action.ActionFutureType.ActionFuture> |
applyAction(rst.domotic.action.ActionDescriptionType.ActionDescription actionDescription) |
rst.domotic.unit.UnitConfigType.UnitConfig |
applyConfigUpdate(rst.domotic.unit.UnitConfigType.UnitConfig config) |
javax.vecmath.Point3d |
getGlobalBoundingBoxCenterPoint3d()
Gets the center coordinates of the unit's BoundingBox in the coordinate system of the root location as a Point3d object.
|
rst.geometry.TranslationType.Translation |
getGlobalPosition()
Gets the position of the unit relative to the root location as a Translation object.
|
javax.vecmath.Point3d |
getGlobalPositionPoint3d()
Gets the position of the unit relative to the root location as a Point3d object.
|
rst.geometry.RotationType.Rotation |
getGlobalRotation()
Gets the rotation of the unit relative to the root location as a Rotation object.
|
javax.vecmath.Quat4d |
getGlobalRotationQuat4d()
Gets the rotation of the unit relative to the root location as a Quat4d object.
|
String |
getLabel() |
javax.vecmath.Point3d |
getLocalBoundingBoxCenterPoint3d()
Gets the center coordinates of the unit's BoundingBox in the unit coordinate system as a Point3d object.
|
rst.geometry.TranslationType.Translation |
getLocalPosition()
Gets the position of the unit relative to its parent location.
|
rst.geometry.RotationType.Rotation |
getLocalRotation()
Gets the rotation of the unit relative to its parent location.
|
rst.domotic.unit.UnitConfigType.UnitConfig |
getLocationConfig()
Deprecated.
please use getParentLocationConfig() instead.
|
rst.domotic.unit.UnitConfigType.UnitConfig |
getParentLocationConfig()
Method returns the parent location config of this unit.
|
LocationRemote |
getParentLocationRemote(boolean waitForData)
Method returns the parent location remote of this unit.
|
rst.rsb.ScopeType.Scope |
getScope() |
rst.domotic.unit.UnitTemplateType.UnitTemplate |
getTemplate() |
javax.media.j3d.Transform3D |
getTransform3D()
Gets the Transform3D of the transformation from root to unit coordinate system.
|
javax.media.j3d.Transform3D |
getTransform3DInverse()
Gets the inverse Transform3D to getTransform3D().
|
Future<rct.Transform> |
getTransformation()
Method returns the transformation between the root location and this unit.
|
rst.domotic.unit.UnitTemplateType.UnitTemplate.UnitType |
getType() |
protected org.openbase.bco.registry.unit.lib.UnitRegistry |
getUnitRegistry() |
void |
init(rsb.Scope scope) |
void |
init(rst.rsb.ScopeType.Scope scope) |
void |
init(String scope) |
void |
init(String label,
org.openbase.jul.extension.rst.iface.ScopeProvider location)
Deprecated.
|
void |
initById(String id) |
void |
initByLabel(String label) |
boolean |
isEnabled() |
protected void |
notifyDataUpdate(D data) |
protected void |
postInit() |
Future<rst.domotic.action.SnapshotType.Snapshot> |
recordSnapshot() |
void |
removeServiceStateObserver(rst.domotic.service.ServiceTemplateType.ServiceTemplate.ServiceType serviceType,
org.openbase.jul.pattern.Observer observer) |
void |
shutdown() |
protected rst.domotic.action.ActionDescriptionType.ActionDescription.Builder |
updateActionDescription(rst.domotic.action.ActionDescriptionType.ActionDescription.Builder actionDescription,
Object serviceAttribute)
Default version.
|
protected rst.domotic.action.ActionDescriptionType.ActionDescription.Builder |
updateActionDescription(rst.domotic.action.ActionDescriptionType.ActionDescription.Builder actionDescription,
Object serviceAttribute,
rst.domotic.service.ServiceTemplateType.ServiceTemplate.ServiceType serviceType)
Use if serviceType cannot be resolved from serviceAttribute.
|
void |
waitForData() |
void |
waitForData(long timeout,
TimeUnit timeUnit) |
addConfigObserver, getConfig, getConfigClass, getConfigField, getConfigField, getId, hasConfigField, init, notifyConfigUpdate, removeConfigObserver, supportsConfigFieldactivate, addConnectionStateObserver, addDataObserver, addHandler, addObserver, applyExternalDataUpdate, callMethod, callMethod, callMethod, callMethod, callMethodAsync, callMethodAsync, deactivate, getConnectionState, getData, getDataClass, getDataField, getPing, hasDataField, init, init, isActive, isConnected, isDataAvailable, isLocked, lock, ping, reinit, reinit, removeConnectionStateObserver, removeDataObserver, removeObserver, requestData, reset, setMessageProcessor, toString, unlock, validateActivation, validateData, validateInitialization, verifyMaintainability, waitForConnectionState, waitForConnectionStateclone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitrestoreSnapshot, verifyOperationServiceState, verifyOperationServiceStateValuebuildServiceState, detectServiceDataClass, detectServiceMethod, detectServiceMethod, getArgumentClasses, getServiceBaseName, getServicePrefix, getServiceStateClass, getServiceStateName, getServiceStateName, getServiceStateValues, getServiceType, invokeOperationServiceMethod, invokeProviderServiceMethod, invokeServiceMethod, invokeServiceMethod, upateActionDescription, upateActionDescriptionaddConfigObserver, getConfig, getConfigClass, removeConfigObserveractivate, addConnectionStateObserver, getConnectionState, isConnected, removeConnectionStateObserver, requestDataregisterShutdownHook, registerShutdownHookisLocked, lock, unlock, verifyMaintainabilityprotected org.openbase.bco.registry.unit.lib.UnitRegistry getUnitRegistry()
throws InterruptedException,
org.openbase.jul.exception.CouldNotPerformException
InterruptedExceptionorg.openbase.jul.exception.CouldNotPerformExceptionpublic void initById(String id) throws org.openbase.jul.exception.InitializationException, InterruptedException
initById in interface UnitRemote<D extends com.google.protobuf.GeneratedMessage>id - org.openbase.jul.exception.InitializationExceptionInterruptedExceptionpublic void initByLabel(String label) throws org.openbase.jul.exception.InitializationException, InterruptedException
initByLabel in interface UnitRemote<D extends com.google.protobuf.GeneratedMessage>label - org.openbase.jul.exception.InitializationExceptionInterruptedExceptionpublic void init(rst.rsb.ScopeType.Scope scope)
throws org.openbase.jul.exception.InitializationException,
InterruptedException
init in interface UnitRemote<D extends com.google.protobuf.GeneratedMessage>init in interface org.openbase.jul.extension.rsb.com.RSBRemote<D extends com.google.protobuf.GeneratedMessage>init in class org.openbase.jul.extension.rsb.com.RSBRemoteService<D extends com.google.protobuf.GeneratedMessage>scope - org.openbase.jul.exception.InitializationExceptionInterruptedExceptionpublic void init(rsb.Scope scope)
throws org.openbase.jul.exception.InitializationException,
InterruptedException
init in interface UnitRemote<D extends com.google.protobuf.GeneratedMessage>init in interface org.openbase.jul.extension.rsb.com.RSBRemote<D extends com.google.protobuf.GeneratedMessage>init in class org.openbase.jul.extension.rsb.com.RSBRemoteService<D extends com.google.protobuf.GeneratedMessage>scope - org.openbase.jul.exception.InitializationExceptionInterruptedExceptionpublic void init(String scope) throws org.openbase.jul.exception.InitializationException, InterruptedException
init in interface org.openbase.jul.extension.rsb.com.RSBRemote<D extends com.google.protobuf.GeneratedMessage>init in class org.openbase.jul.extension.rsb.com.RSBRemoteService<D extends com.google.protobuf.GeneratedMessage>scope - org.openbase.jul.exception.InitializationExceptionInterruptedException@Deprecated public void init(String label, org.openbase.jul.extension.rst.iface.ScopeProvider location) throws org.openbase.jul.exception.InitializationException, InterruptedException
org.openbase.jul.exception.InitializationExceptionInterruptedExceptionprotected void postInit()
throws org.openbase.jul.exception.InitializationException,
InterruptedException
postInit in class org.openbase.jul.extension.rsb.com.RSBRemoteService<D extends com.google.protobuf.GeneratedMessage>org.openbase.jul.exception.InitializationExceptionInterruptedExceptionprotected void notifyDataUpdate(D data) throws org.openbase.jul.exception.CouldNotPerformException
notifyDataUpdate in class org.openbase.jul.extension.rsb.com.RSBRemoteService<D extends com.google.protobuf.GeneratedMessage>org.openbase.jul.exception.CouldNotPerformExceptionpublic void addServiceStateObserver(rst.domotic.service.ServiceTemplateType.ServiceTemplate.ServiceType serviceType,
org.openbase.jul.pattern.Observer observer)
addServiceStateObserver in interface ServiceProviderpublic void removeServiceStateObserver(rst.domotic.service.ServiceTemplateType.ServiceTemplate.ServiceType serviceType,
org.openbase.jul.pattern.Observer observer)
removeServiceStateObserver in interface ServiceProviderpublic rst.domotic.unit.UnitConfigType.UnitConfig applyConfigUpdate(rst.domotic.unit.UnitConfigType.UnitConfig config)
throws org.openbase.jul.exception.CouldNotPerformException,
InterruptedException
applyConfigUpdate in interface org.openbase.jul.iface.Configurable<String,rst.domotic.unit.UnitConfigType.UnitConfig>applyConfigUpdate in class org.openbase.jul.extension.rsb.com.AbstractConfigurableRemote<D extends com.google.protobuf.GeneratedMessage,rst.domotic.unit.UnitConfigType.UnitConfig>config - org.openbase.jul.exception.CouldNotPerformExceptionInterruptedExceptionpublic void activate()
throws InterruptedException,
org.openbase.jul.exception.CouldNotPerformException
activate in interface org.openbase.jul.iface.Activatableactivate in class org.openbase.jul.extension.rsb.com.RSBRemoteService<D extends com.google.protobuf.GeneratedMessage>InterruptedExceptionorg.openbase.jul.exception.CouldNotPerformExceptionpublic void waitForData()
throws org.openbase.jul.exception.CouldNotPerformException,
InterruptedException
waitForData in interface org.openbase.jul.pattern.provider.DataProvider<D extends com.google.protobuf.GeneratedMessage>waitForData in interface org.openbase.jul.pattern.Remote<D extends com.google.protobuf.GeneratedMessage>waitForData in class org.openbase.jul.extension.rsb.com.RSBRemoteService<D extends com.google.protobuf.GeneratedMessage>org.openbase.jul.exception.CouldNotPerformExceptionInterruptedExceptionpublic void waitForData(long timeout,
TimeUnit timeUnit)
throws org.openbase.jul.exception.CouldNotPerformException,
InterruptedException
waitForData in interface org.openbase.jul.pattern.provider.DataProvider<D extends com.google.protobuf.GeneratedMessage>waitForData in interface org.openbase.jul.pattern.Remote<D extends com.google.protobuf.GeneratedMessage>waitForData in class org.openbase.jul.extension.rsb.com.RSBRemoteService<D extends com.google.protobuf.GeneratedMessage>timeout - timeUnit - org.openbase.jul.exception.CouldNotPerformExceptionInterruptedExceptionpublic boolean isEnabled()
isEnabled in interface UnitRemote<D extends com.google.protobuf.GeneratedMessage>public rst.domotic.unit.UnitTemplateType.UnitTemplate.UnitType getType()
throws org.openbase.jul.exception.NotAvailableException
public rst.domotic.unit.UnitTemplateType.UnitTemplate getTemplate()
throws org.openbase.jul.exception.NotAvailableException
getTemplate in interface Unit<D extends com.google.protobuf.GeneratedMessage>org.openbase.jul.exception.NotAvailableExceptionpublic Future<rct.Transform> getTransformation() throws InterruptedException
InterruptedException - is thrown if the thread was externally interrupted.public String getLabel() throws org.openbase.jul.exception.NotAvailableException
getLabel in interface org.openbase.jul.iface.provider.LabelProviderorg.openbase.jul.exception.NotAvailableExceptionpublic rst.rsb.ScopeType.Scope getScope()
throws org.openbase.jul.exception.NotAvailableException
getScope in interface org.openbase.jul.extension.rsb.com.RSBRemote<D extends com.google.protobuf.GeneratedMessage>getScope in interface org.openbase.jul.extension.rst.iface.ScopeProvidergetScope in class org.openbase.jul.extension.rsb.com.RSBRemoteService<D extends com.google.protobuf.GeneratedMessage>org.openbase.jul.exception.NotAvailableExceptionpublic rst.domotic.unit.UnitConfigType.UnitConfig getParentLocationConfig()
throws org.openbase.jul.exception.NotAvailableException,
InterruptedException
org.openbase.jul.exception.NotAvailableException - is thrown if the location config is currently not available.InterruptedException@Deprecated public rst.domotic.unit.UnitConfigType.UnitConfig getLocationConfig() throws org.openbase.jul.exception.NotAvailableException
org.openbase.jul.exception.NotAvailableExceptionpublic LocationRemote getParentLocationRemote(boolean waitForData) throws org.openbase.jul.exception.NotAvailableException, InterruptedException
waitForData - flag defines if the method should block until the remote is fully synchronized.org.openbase.jul.exception.NotAvailableException - is thrown if the location remote is currently not available.InterruptedException - is thrown if the current was externally interrupted.public Future<rst.domotic.action.ActionFutureType.ActionFuture> applyAction(rst.domotic.action.ActionDescriptionType.ActionDescription actionDescription) throws org.openbase.jul.exception.CouldNotPerformException, InterruptedException
applyAction in interface ServiceProvideractionDescription - org.openbase.jul.exception.CouldNotPerformExceptionInterruptedExceptionpublic Future<rst.domotic.action.SnapshotType.Snapshot> recordSnapshot() throws org.openbase.jul.exception.CouldNotPerformException, InterruptedException
recordSnapshot in interface Unit<D extends com.google.protobuf.GeneratedMessage>recordSnapshot in interface org.openbase.jul.iface.Snapshotable<rst.domotic.action.SnapshotType.Snapshot>org.openbase.jul.exception.CouldNotPerformExceptionInterruptedExceptionprotected rst.domotic.action.ActionDescriptionType.ActionDescription.Builder updateActionDescription(rst.domotic.action.ActionDescriptionType.ActionDescription.Builder actionDescription,
Object serviceAttribute,
rst.domotic.service.ServiceTemplateType.ServiceTemplate.ServiceType serviceType)
throws org.openbase.jul.exception.CouldNotPerformException
actionDescription - serviceAttribute - serviceType - org.openbase.jul.exception.CouldNotPerformExceptionprotected rst.domotic.action.ActionDescriptionType.ActionDescription.Builder updateActionDescription(rst.domotic.action.ActionDescriptionType.ActionDescription.Builder actionDescription,
Object serviceAttribute)
throws org.openbase.jul.exception.CouldNotPerformException
actionDescription - serviceAttribute - org.openbase.jul.exception.CouldNotPerformExceptionpublic rst.geometry.TranslationType.Translation getLocalPosition()
throws org.openbase.jul.exception.NotAvailableException
org.openbase.jul.exception.NotAvailableException - is thrown if the config is not available.public rst.geometry.RotationType.Rotation getLocalRotation()
throws org.openbase.jul.exception.NotAvailableException
org.openbase.jul.exception.NotAvailableException - is thrown if the config is not available.public javax.media.j3d.Transform3D getTransform3D()
throws org.openbase.jul.exception.NotAvailableException,
InterruptedException
org.openbase.jul.exception.NotAvailableException - is thrown if the transformation is not available.InterruptedException - is thrown if the thread was externally interrupted.public javax.media.j3d.Transform3D getTransform3DInverse()
throws org.openbase.jul.exception.NotAvailableException,
InterruptedException
org.openbase.jul.exception.NotAvailableException - is thrown if the transformation is not available.InterruptedException - is thrown if the thread was externally interrupted.public javax.vecmath.Point3d getGlobalPositionPoint3d()
throws org.openbase.jul.exception.NotAvailableException,
InterruptedException
org.openbase.jul.exception.NotAvailableException - is thrown if the transformation is not available.InterruptedException - is thrown if the thread was externally interrupted.public rst.geometry.TranslationType.Translation getGlobalPosition()
throws org.openbase.jul.exception.NotAvailableException,
InterruptedException
org.openbase.jul.exception.NotAvailableException - is thrown if the transformation is not available.InterruptedException - is thrown if the thread was externally interrupted.public javax.vecmath.Quat4d getGlobalRotationQuat4d()
throws org.openbase.jul.exception.NotAvailableException,
InterruptedException
org.openbase.jul.exception.NotAvailableException - is thrown if the transformation is not available.InterruptedException - is thrown if the thread was externally interrupted.public rst.geometry.RotationType.Rotation getGlobalRotation()
throws org.openbase.jul.exception.NotAvailableException,
InterruptedException
org.openbase.jul.exception.NotAvailableException - is thrown if the transformation is not available.InterruptedException - is thrown if the thread was externally interrupted.public javax.vecmath.Point3d getLocalBoundingBoxCenterPoint3d()
throws org.openbase.jul.exception.NotAvailableException
org.openbase.jul.exception.NotAvailableException - is thrown if the center can not be calculate.public javax.vecmath.Point3d getGlobalBoundingBoxCenterPoint3d()
throws org.openbase.jul.exception.NotAvailableException,
InterruptedException
org.openbase.jul.exception.NotAvailableException - is thrown if the center can not be calculate.InterruptedExceptionpublic void shutdown()
shutdown in interface org.openbase.jul.iface.Manageable<rst.domotic.unit.UnitConfigType.UnitConfig>shutdown in interface org.openbase.jul.iface.Shutdownableshutdown in class org.openbase.jul.extension.rsb.com.AbstractConfigurableRemote<D extends com.google.protobuf.GeneratedMessage,rst.domotic.unit.UnitConfigType.UnitConfig>Copyright © 2014–2017 openbase.org. All rights reserved.