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

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

All Implemented Interfaces:

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

public class DynDfeLoggerModule
extends Module

Represents a module to log DFE values.

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

DynDfeLoggerModule.DataTypes Predefined set of possible data types for DFE values.

Constructor Summary

DynDfeLoggerModule(String instanceName, int logFileSize, String logFileName)
Creates a new instance of the DynDfeLogger module.

DynDfeLoggerModule(String loadName, String instanceName, int logFileSize, String logFileName)
Creates a new instance of the DynDfeLogger module.

Method Summary

void	addConversionFactor(String portName, double conversionFactor) Adds a conversion factor to an already configured DFE of the DynDFELogger.
InPort	addLoggableDFE(String portName, DynDfeLoggerModule.DataTypes dataType, int arraySizeDim1, int arraySizeDim2) Adds a loggable DFE to the sunrise module.
static boolean	loadDynDFELogger(SunriseController controller, String instanceName) loads the dynamic DFE logger.
static boolean	unloadDynDFELogger(SunriseController controller, String instanceName) unloads the dynamic DFE logger.

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

DynDfeLoggerModule

public DynDfeLoggerModule(String instanceName,
                          int logFileSize,
                          String logFileName)

Creates a new instance of the DynDfeLogger module.

Parameters:

instanceName - the instance name to use for the logger.

logFileSize - the size of the log file to be created

logFileName - the name of the log file to be 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.

DynDfeLoggerModule

public DynDfeLoggerModule(String loadName,
                          String instanceName,
                          int logFileSize,
                          String logFileName)

Creates a new instance of the DynDfeLogger module.

Parameters:

loadName - the name of the logger (= instance name of the loaded compound).

instanceName - the instance name to use for the logger.

logFileSize - the size of the log file to be created

logFileName - the name of the log file to be 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

addLoggableDFE

public InPort addLoggableDFE(String portName,
                             DynDfeLoggerModule.DataTypes dataType,
                             int arraySizeDim1,
                             int arraySizeDim2)

Adds a loggable DFE to the sunrise module.

Parameters:

portName - the name of the InPort which should be associated with the DFE

dataType - the type of the DFE value

arraySizeDim1 - array size of the DFE value (dimension 1)

arraySizeDim2 - array size of the DFE value (dimension 2)

Returns:

the InPort of the current module that has been associated with the DFE

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.

addConversionFactor

public void addConversionFactor(String portName,
                                double conversionFactor)

Adds a conversion factor to an already configured DFE of the DynDFELogger. The logged output is the result of (conversionFactor * input of portName). This parameter only effects DFEs of type double, integer and the corresponding arrays.

Parameters:

portName - the name of the InPort which should be multiplied with the conversionFactor

conversionFactor - factor which is multiplied

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.

loadDynDFELogger

public static boolean loadDynDFELogger(SunriseController controller,
                                       String instanceName)

loads the dynamic DFE logger.

Parameters:

controller - controller that must load the logger.

instanceName - instance name for the logger.

Returns:

true if a new DynDFELogger instance was loaded, false if the specified instance was already in use.

Throws:

IllegalStateException - if DynDFELogger could not be loaded.

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.

unloadDynDFELogger

public static boolean unloadDynDFELogger(SunriseController controller,
                                         String instanceName)

unloads the dynamic DFE logger.

Parameters:

controller - controller that must unload the logger.

instanceName - instance name for the existing logger.

Returns:

unload result

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.