com.kuka.roboticsAPI.controllerModel.sunrise.predefinedCompounds.kmp
Class AdvancedDfeLogger

java.lang.Object
  com.kuka.roboticsAPI.controllerModel.sunrise.api.SPRComponent
      com.kuka.roboticsAPI.controllerModel.sunrise.api.Module
          com.kuka.roboticsAPI.controllerModel.sunrise.predefinedCompounds.DynDFELoggerModule
              com.kuka.roboticsAPI.controllerModel.sunrise.predefinedCompounds.kmp.AdvancedDfeLogger

All Implemented Interfaces:

com.kuka.common.IDataEquatable, com.kuka.roboticsAPI.controllerModel.sunrise.api.expressions.IExpressionSegment, com.kuka.roboticsAPI.controllerModel.sunrise.api.ISprComponent, com.kuka.roboticsAPI.controllerModel.sunrise.connectionLib.ISegment

public class AdvancedDfeLogger
extends com.kuka.roboticsAPI.controllerModel.sunrise.predefinedCompounds.DynDFELoggerModule

DFE Logger to make DynDFELoggerModuel more user friendly. Adding logged inputs is more convenient with this.

Nested Class Summary

Nested classes/interfaces inherited from class com.kuka.roboticsAPI.controllerModel.sunrise.predefinedCompounds.DynDFELoggerModule

com.kuka.roboticsAPI.controllerModel.sunrise.predefinedCompounds.DynDFELoggerModule.DataType, com.kuka.roboticsAPI.controllerModel.sunrise.predefinedCompounds.DynDFELoggerModule.RecordingState

Constructor Summary

AdvancedDfeLogger(String instanceName, String logFileName)
Creates a new instance of the AdvancedDfeLogger module.

Method Summary

com.kuka.roboticsAPI.controllerModel.sunrise.api.InPort

addLoggableDFE(String portName, com.kuka.roboticsAPI.controllerModel.sunrise.api.DynDfeLoggerModule.DataTypes dataType, int arraySizeDim1, int arraySizeDim2) Add a new port to be logged.

Methods inherited from class com.kuka.roboticsAPI.controllerModel.sunrise.predefinedCompounds.DynDFELoggerModule

addConversionFactorToDFE, addDFEToLog, setLogfileName, setNumberOfSamples, setRecordingStates, setSampleInterval, setTimeout, setWriteWhenBufferFull

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

AdvancedDfeLogger

public AdvancedDfeLogger(String instanceName,
                         String logFileName)

Creates a new instance of the AdvancedDfeLogger module.

Parameters:

instanceName - the logger instance name

logFileName - the log file name to be created in Sunrise

Method Detail

addLoggableDFE

public com.kuka.roboticsAPI.controllerModel.sunrise.api.InPort addLoggableDFE(String portName,
                                                                              com.kuka.roboticsAPI.controllerModel.sunrise.api.DynDfeLoggerModule.DataTypes dataType,
                                                                              int arraySizeDim1,
                                                                              int arraySizeDim2)

Add a new port to be logged.

Parameters:

portName - the name of the port

dataType - the port data type. See @DataTypes

arraySizeDim1 - the dfe output data array dimension 1

arraySizeDim2 - the dfe output data array dimension 2

Returns:

the inport where you have to connect the logged module out port