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

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

All Implemented Interfaces:

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

public class FreezeModule
extends Module

Used to freeze the DFE elements in active SPR phase.

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

FreezeModule()
Creates a new instance.

Method Summary

com.kuka.common.Pair<InPort,OutPort>	getNextDoublePair() Gets the next double pair of this freezer.
com.kuka.common.Pair<InPort,OutPort>	getNextFramePair() Gets the next frame pair of this freezer.
com.kuka.common.Pair<InPort,OutPort>	getNextIntPair() Gets the next integer pair of this freezer.
com.kuka.common.Pair<InPort,OutPort>	getNextJointsPair() Gets the next joints pair of this freezer.
<T> OutPort	getNextParameterPortFrame(T value) Creates and gets the next frame pair of this freeze where input element is a parameter (instead of a port) and output element is port.

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

FreezeModule

public FreezeModule()

Creates a new instance.

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

getNextFramePair

public com.kuka.common.Pair<InPort,OutPort> getNextFramePair()

Gets the next frame pair of this freezer.

Returns:

The next frame pair of this freezer.

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.

getNextParameterPortFrame

public <T> OutPort getNextParameterPortFrame(T value)

Creates and gets the next frame pair of this freeze where input element is a parameter (instead of a port) and output element is port.

Type Parameters:

T - type of the input parameter.

Parameters:

value - value of the input parameter.

Returns:

frame out port for this pair.

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.

getNextJointsPair

public com.kuka.common.Pair<InPort,OutPort> getNextJointsPair()

Gets the next joints pair of this freezer.

Returns:

The next joints pair of this freezer.

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.

getNextDoublePair

public com.kuka.common.Pair<InPort,OutPort> getNextDoublePair()

Gets the next double pair of this freezer.

Returns:

The next double pair of this freezer.

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.

getNextIntPair

public com.kuka.common.Pair<InPort,OutPort> getNextIntPair()

Gets the next integer pair of this freezer.

Returns:

The next integer pair of this freezer.

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.