org.openbase.bco.manager.agent.core

Class AbstractAgentController

java.lang.Object

org.openbase.jul.extension.rsb.com.RSBCommunicationService<M,MB>

org.openbase.jul.extension.rsb.com.AbstractIdentifiableController<M,MB>

org.openbase.jul.extension.rsb.com.AbstractConfigurableController<D,DB,rst.domotic.unit.UnitConfigType.UnitConfig>

org.openbase.bco.dal.lib.layer.unit.AbstractUnitController<D,DB>

org.openbase.bco.dal.lib.layer.unit.AbstractBaseUnitController<D,DB>

org.openbase.bco.dal.lib.layer.unit.AbstractExecutableBaseUnitController<rst.domotic.unit.agent.AgentDataType.AgentData,rst.domotic.unit.agent.AgentDataType.AgentData.Builder>

org.openbase.bco.manager.agent.core.AbstractAgentController

All Implemented Interfaces:

org.openbase.bco.dal.lib.layer.service.operation.ActivationStateOperationService, org.openbase.bco.dal.lib.layer.service.operation.EmphasisStateOperationService, org.openbase.bco.dal.lib.layer.service.operation.OperationService, org.openbase.bco.dal.lib.layer.service.provider.ActivationStateProviderService, org.openbase.bco.dal.lib.layer.service.provider.EmphasisStateProviderService, org.openbase.bco.dal.lib.layer.service.provider.ProviderService, org.openbase.bco.dal.lib.layer.service.Service, org.openbase.bco.dal.lib.layer.service.ServiceProvider, org.openbase.bco.dal.lib.layer.unit.agent.Agent, org.openbase.bco.dal.lib.layer.unit.BaseUnit<rst.domotic.unit.agent.AgentDataType.AgentData>, org.openbase.bco.dal.lib.layer.unit.BaseUnitController<rst.domotic.unit.agent.AgentDataType.AgentData,rst.domotic.unit.agent.AgentDataType.AgentData.Builder>, org.openbase.bco.dal.lib.layer.unit.Unit<rst.domotic.unit.agent.AgentDataType.AgentData>, org.openbase.bco.dal.lib.layer.unit.UnitController<rst.domotic.unit.agent.AgentDataType.AgentData,rst.domotic.unit.agent.AgentDataType.AgentData.Builder>, AgentController, org.openbase.jul.extension.protobuf.iface.DataBuilderProvider<rst.domotic.unit.agent.AgentDataType.AgentData,rst.domotic.unit.agent.AgentDataType.AgentData.Builder>, org.openbase.jul.extension.protobuf.MessageController<rst.domotic.unit.agent.AgentDataType.AgentData,rst.domotic.unit.agent.AgentDataType.AgentData.Builder>, org.openbase.jul.extension.rst.iface.ScopeProvider, org.openbase.jul.iface.Activatable, org.openbase.jul.iface.Changeable, org.openbase.jul.iface.Configurable<String,rst.domotic.unit.UnitConfigType.UnitConfig>, org.openbase.jul.iface.Enableable, org.openbase.jul.iface.Identifiable<String>, org.openbase.jul.iface.Initializable<rst.domotic.unit.UnitConfigType.UnitConfig>, org.openbase.jul.iface.Manageable<rst.domotic.unit.UnitConfigType.UnitConfig>, org.openbase.jul.iface.Pingable, org.openbase.jul.iface.provider.ConfigProvider<rst.domotic.unit.UnitConfigType.UnitConfig>, org.openbase.jul.iface.provider.LabelProvider, org.openbase.jul.iface.Requestable<rst.domotic.unit.agent.AgentDataType.AgentData>, org.openbase.jul.iface.Shutdownable, org.openbase.jul.iface.Snapshotable<rst.domotic.action.SnapshotType.Snapshot>, org.openbase.jul.pattern.ConfigurableController<String,rst.domotic.unit.agent.AgentDataType.AgentData,rst.domotic.unit.UnitConfigType.UnitConfig>, org.openbase.jul.pattern.Controller<rst.domotic.unit.agent.AgentDataType.AgentData>, org.openbase.jul.pattern.IdentifiableController<String,rst.domotic.unit.agent.AgentDataType.AgentData>, org.openbase.jul.pattern.provider.DataProvider<rst.domotic.unit.agent.AgentDataType.AgentData>

Direct Known Subclasses:

AbstractResourceAllocationAgent, AmbientColorAgent, PersonLightProviderAgent, PowerStateSynchroniserAgent, StandbyAgent

public abstract class AbstractAgentController
extends org.openbase.bco.dal.lib.layer.unit.AbstractExecutableBaseUnitController<rst.domotic.unit.agent.AgentDataType.AgentData,rst.domotic.unit.agent.AgentDataType.AgentData.Builder>
implements AgentController

Author:

Divine Threepwood

Nested Class Summary

Nested classes/interfaces inherited from interface org.openbase.jul.pattern.Controller

org.openbase.jul.pattern.Controller.ControllerAvailabilityState

Nested classes/interfaces inherited from interface org.openbase.jul.iface.Shutdownable

org.openbase.jul.iface.Shutdownable.ShutdownDeamon

Field Summary

Fields

Modifier and Type	Field and Description
protected org.openbase.jul.pattern.trigger.TriggerPool	agentTriggerHolder

Fields inherited from class org.openbase.bco.dal.lib.layer.unit.AbstractExecutableBaseUnitController

FIELD_ACTIVATION_STATE, FIELD_AUTOSTART

Fields inherited from class org.openbase.jul.extension.rsb.com.AbstractConfigurableController

FIELD_SCOPE

Fields inherited from class org.openbase.jul.extension.rsb.com.RSBCommunicationService

informer, informerWatchDog, logger, managableLock, RPC_REQUEST_STATUS, scope, SCOPE_SUFFIX_CONTROL, SCOPE_SUFFIX_STATUS, server, serverWatchDog

Fields inherited from interface org.openbase.jul.iface.provider.LabelProvider

TYPE_FIELD_LABEL

Fields inherited from interface org.openbase.jul.iface.Identifiable

TYPE_FIELD_ID

Fields inherited from interface org.openbase.bco.dal.lib.layer.service.provider.ProviderService

UPDATE_METHOD_PREFIX

Constructor Summary

Constructors

Constructor and Description
AbstractAgentController(Class unitClass)

Method Summary

Modifier and Type	Method and Description
rst.domotic.state.EmphasisStateType.EmphasisState	getEmphasisState()
protected rst.domotic.action.ActionDescriptionType.ActionDescription.Builder	getNewActionDescription(rst.domotic.action.ActionAuthorityType.ActionAuthority actionAuthority, rst.communicationpatterns.ResourceAllocationType.ResourceAllocation.Initiator initiator, long executionTimePeriod, rst.communicationpatterns.ResourceAllocationType.ResourceAllocation.Policy policy, rst.communicationpatterns.ResourceAllocationType.ResourceAllocation.Priority priority, org.openbase.bco.dal.lib.layer.unit.UnitRemote unitRemote, Object serviceAttribute, rst.domotic.unit.UnitTemplateType.UnitTemplate.UnitType unitType, rst.domotic.service.ServiceTemplateType.ServiceTemplate.ServiceType serviceType, rst.domotic.action.MultiResourceAllocationStrategyType.MultiResourceAllocationStrategy.Strategy multiResourceAllocationStrategy)
protected boolean	isAutostartEnabled()
Future<rst.domotic.action.ActionFutureType.ActionFuture>	setEmphasisState(rst.domotic.state.EmphasisStateType.EmphasisState emphasisState)

Methods inherited from class org.openbase.bco.dal.lib.layer.unit.AbstractExecutableBaseUnitController

cancelExecution, deactivate, disable, enable, execute, getActivationState, init, isEnabled, isExecuting, setActivationState, stop

Methods inherited from class org.openbase.bco.dal.lib.layer.unit.AbstractUnitController

addServiceStateObserver, applyAction, applyConfigUpdate, applyDataUpdate, getId, getLabel, getServices, getUnitRegistry, getUnitTemplate, getUnitType, getUpdateMethod, init, init, init, notifyDataUpdate, postInit, registerMethods, registerService, removeServiceStateObserver, shutdown, toString, verifyAuthority

Methods inherited from class org.openbase.jul.extension.rsb.com.AbstractConfigurableController

getConfig, getConfigField, getConfigField, hasConfigField, supportsConfigField

Methods inherited from class org.openbase.jul.extension.rsb.com.RSBCommunicationService

activate, addDataObserver, cloneDataBuilder, getBuilderSetup, getControllerAvailabilityState, getData, getDataBuilder, getDataBuilder, getDataClass, getDataField, getDataFieldDescriptor, getDataFuture, getScope, hasDataField, init, init, init, init, isActive, isDataAvailable, notifyChange, ping, removeDataObserver, requestStatus, setDataField, setDataField, supportsDataField, validateInitialization, waitForAvailabilityState, waitForData, waitForData

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.openbase.bco.manager.agent.lib.AgentController

init

Methods inherited from interface org.openbase.jul.iface.Enableable

disable, enable, isEnabled

Methods inherited from interface org.openbase.bco.dal.lib.layer.unit.Unit

getGlobalBoundingBoxCenterPoint3d, getGlobalPosition, getGlobalPositionPoint3d, getGlobalRotation, getGlobalRotationQuat4d, getLocalBoundingBoxCenterPoint3d, getLocalPosition, getLocalRotation, getLocationRegistry, getRootToUnitTransform3D, getRootToUnitTransformation, getRootToUnitTransformationFuture, getTemplate, getTransform3D, getTransform3DInverse, getType, getUnitBoundingBoxCenterGlobalPoint3d, getUnitBoundingBoxCenterPoint3d, getUnitPosition, getUnitPositionGlobal, getUnitPositionGlobalPoint3d, getUnitRotation, getUnitRotationGlobal, getUnitRotationGlobalQuat4d, getUnitShape, getUnitTemplate, getUnitToRootTransform3D, getUnitToRootTransformation, getUnitToRootTransformationFuture, getUnitType, recordSnapshot, restoreSnapshot, verifyOperationServiceState, verifyOperationServiceStateValue

Methods inherited from interface org.openbase.jul.iface.provider.LabelProvider

getLabel

Methods inherited from interface org.openbase.jul.extension.rst.iface.ScopeProvider

getScope

Methods inherited from interface org.openbase.jul.iface.Configurable

applyConfigUpdate

Methods inherited from interface org.openbase.jul.iface.Identifiable

getId

Methods inherited from interface org.openbase.jul.iface.provider.ConfigProvider

getConfig

Methods inherited from interface org.openbase.jul.pattern.provider.DataProvider

addDataObserver, getData, getDataClass, getDataFuture, isDataAvailable, removeDataObserver, waitForData, waitForData

Methods inherited from interface org.openbase.bco.dal.lib.layer.service.ServiceProvider

addServiceStateObserver, applyAction, removeServiceStateObserver

Methods inherited from interface org.openbase.bco.dal.lib.layer.service.operation.ActivationStateOperationService

setActivationState, setActivationState

Methods inherited from interface org.openbase.bco.dal.lib.layer.service.provider.ActivationStateProviderService

getActivationState

Methods inherited from interface org.openbase.bco.dal.lib.layer.service.provider.ProviderService

getUpdateMethodName

Methods inherited from interface org.openbase.jul.pattern.Controller

getControllerAvailabilityState, getData, getDataClass, notifyChange, waitForAvailabilityState

Methods inherited from interface org.openbase.jul.iface.Shutdownable

registerShutdownHook, registerShutdownHook, shutdown

Methods inherited from interface org.openbase.jul.iface.Activatable

activate, deactivate, isActive

Methods inherited from interface org.openbase.jul.iface.Pingable

ping

Methods inherited from interface org.openbase.jul.iface.Requestable

requestStatus

Methods inherited from interface org.openbase.jul.extension.protobuf.iface.DataBuilderProvider

cloneDataBuilder, getBuilderSetup, getDataBuilder, getDataBuilder

Methods inherited from interface org.openbase.bco.dal.lib.layer.unit.UnitController

applyDataUpdate, getUpdateMethod

Field Detail

agentTriggerHolder

protected org.openbase.jul.pattern.trigger.TriggerPool agentTriggerHolder

Constructor Detail

AbstractAgentController

public AbstractAgentController(Class unitClass)
                        throws org.openbase.jul.exception.InstantiationException

Throws:

org.openbase.jul.exception.InstantiationException

Method Detail

isAutostartEnabled

protected boolean isAutostartEnabled()
                              throws org.openbase.jul.exception.CouldNotPerformException

Specified by:

isAutostartEnabled in class org.openbase.bco.dal.lib.layer.unit.AbstractExecutableBaseUnitController<rst.domotic.unit.agent.AgentDataType.AgentData,rst.domotic.unit.agent.AgentDataType.AgentData.Builder>

Throws:

org.openbase.jul.exception.CouldNotPerformException

setEmphasisState

public Future<rst.domotic.action.ActionFutureType.ActionFuture> setEmphasisState(rst.domotic.state.EmphasisStateType.EmphasisState emphasisState)
                                                                          throws org.openbase.jul.exception.CouldNotPerformException

Specified by:

setEmphasisState in interface org.openbase.bco.dal.lib.layer.service.operation.EmphasisStateOperationService

Throws:

org.openbase.jul.exception.CouldNotPerformException

getEmphasisState

public rst.domotic.state.EmphasisStateType.EmphasisState getEmphasisState()
                                                                   throws org.openbase.jul.exception.NotAvailableException

Specified by:

getEmphasisState in interface org.openbase.bco.dal.lib.layer.service.provider.EmphasisStateProviderService

Throws:

org.openbase.jul.exception.NotAvailableException

getNewActionDescription

protected rst.domotic.action.ActionDescriptionType.ActionDescription.Builder getNewActionDescription(rst.domotic.action.ActionAuthorityType.ActionAuthority actionAuthority,
                                                                                                     rst.communicationpatterns.ResourceAllocationType.ResourceAllocation.Initiator initiator,
                                                                                                     long executionTimePeriod,
                                                                                                     rst.communicationpatterns.ResourceAllocationType.ResourceAllocation.Policy policy,
                                                                                                     rst.communicationpatterns.ResourceAllocationType.ResourceAllocation.Priority priority,
                                                                                                     org.openbase.bco.dal.lib.layer.unit.UnitRemote unitRemote,
                                                                                                     Object serviceAttribute,
                                                                                                     rst.domotic.unit.UnitTemplateType.UnitTemplate.UnitType unitType,
                                                                                                     rst.domotic.service.ServiceTemplateType.ServiceTemplate.ServiceType serviceType,
                                                                                                     rst.domotic.action.MultiResourceAllocationStrategyType.MultiResourceAllocationStrategy.Strategy multiResourceAllocationStrategy)
                                                                                              throws org.openbase.jul.exception.CouldNotPerformException

Throws:

org.openbase.jul.exception.CouldNotPerformException