com.kuka.roboticsAPI.controllerModel.sunrise.api
Class ObserverModule

java.lang.Object
  com.kuka.roboticsAPI.controllerModel.sunrise.api.SPRComponent
      com.kuka.roboticsAPI.controllerModel.sunrise.api.Module
          com.kuka.roboticsAPI.controllerModel.sunrise.api.ObserverModule

All Implemented Interfaces:

com.kuka.common.IDataEquatable, IExpressionSegment, ISprComponent, ISegment

Direct Known Subclasses:

DeviceObserverModule, GlobalDataServiceModule

public class ObserverModule
extends Module

Represents an Observer module.

This element is an undocumented internal feature. It is not intended to be used by applications as it might change or be removed in future versions.

Constructor Summary

ObserverModule(String name, SPR parent)
A observer is a special module with no inports.

Method Summary

InPort	addInPort(InPort port) Adds a inport to this compound.
String	getAlias() Gets the alias for the observer.
void	setAlias(String alias) Sets the alias for the observer.

Methods inherited from class com.kuka.roboticsAPI.controllerModel.sunrise.api.Module

getComponentType, getComponentVersion

Methods inherited from class com.kuka.roboticsAPI.controllerModel.sunrise.api.SPRComponent

addInPort, addOutPort, addOutPort, addParameter, getChecksum, getExpressionSegmentString, getInPort, getInPorts, getInstanceName, getName, getOutPort, getOutPorts, getParameter, getParameterList, getSPR, hasSameDataAs, onAsyncEvent, onFinished, onInitialize, onSerialization, onSPRStateChanged, onSPRStateChangedSync, setInstanceName, setName, toString, tryGetParameter

Methods inherited from class java.lang.Object

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

Constructor Detail

ObserverModule

public ObserverModule(String name,
                      SPR parent)

A observer is a special module with no inports.

Parameters:

name - The name of the observer.

parent - SPR for which this instance is created.

This element is an undocumented internal feature. It is not intended to be used by applications as it might change or be removed in future versions.

Method Detail

addInPort

public InPort addInPort(InPort port)

Adds a inport to this compound. If an inport with the same name was already added, this port will be used (as return value of this method). We do this because there may be some references on this port (like return values).

Overrides:

addInPort in class SPRComponent

Parameters:

port - The inport to add.

Returns:

The inport.

This element is an undocumented internal feature. It is not intended to be used by applications as it might change or be removed in future versions.

getAlias

public final String getAlias()

Gets the alias for the observer.

Returns:

The alias for the observer.

This element is an undocumented internal feature. It is not intended to be used by applications as it might change or be removed in future versions.

setAlias

public final void setAlias(String alias)

Sets the alias for the observer.

Parameters:

alias - The the alias for the observer. null is not allowed.

This element is an undocumented internal feature. It is not intended to be used by applications as it might change or be removed in future versions.