com.kuka.roboticsAPI.controllerModel.sunrise.predefinedCompounds
Class DFEStatisticModule

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

All Implemented Interfaces:

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

public class DFEStatisticModule
extends Module

Module for statistic calculation (like minimum, maximum, etc.) over some data (e.g. torque).

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.

Nested Class Summary

static class	DFEStatisticModule.OutPortType Output port type.
static class	DFEStatisticModule.ValueType Value type of the data.

Constructor Summary

DFEStatisticModule(String instanceName, DFEStatisticModule.ValueType valueType, int dim)
Constructor.

Method Summary

OutPort	addStatisticPort(DFEStatisticModule.OutPortType type) Adds the output port to the module according to specified port type.
InPort	getInPort() Gets the input port of this module.

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, 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

DFEStatisticModule

public DFEStatisticModule(String instanceName,
                          DFEStatisticModule.ValueType valueType,
                          int dim)

Constructor.

Parameters:

instanceName - the name of this module instance.

valueType - the value type of this module data.

dim - dimension of data array.

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

addStatisticPort

public OutPort addStatisticPort(DFEStatisticModule.OutPortType type)

Adds the output port to the module according to specified port type. Also adds the parameter for the type of statistic.

Parameters:

type - the type of output port.

Returns:

The added output port.

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.

getInPort

public InPort getInPort()

Gets the input port of this module.

Returns:

The input port of this 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.