com.kuka.roboticsAPI.ioModel
Class IOGroupClassGenerator

java.lang.Object
  com.kuka.roboticsAPI.ioModel.IOGroupClassGenerator

public class IOGroupClassGenerator
extends Object

Java class generator for IO-group implementations.

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

IOGroupClassGenerator()
Creates a new IO-group class generator.

Method Summary

void	addAnalogInput(String name, String description, IecType dataType, int usedBitWidth, double rangeStart, double rangeEnd, boolean isConnected) Method to add an analog input to the code generator instance of the current I/O group.
void	addAnalogOutput(String name, String description, IecType dataType, int usedBitWidth, double rangeStart, double rangeEnd, boolean isConnected) Method to add an analog output to the code generator instance of the current I/O group.
void	addDigitalInput(String name, String description, IecType dataType, int usedBitWidth, boolean isConnected) Method to add an digital input to the code generator instance of the current I/O group.
void	addDigitalOutput(String name, String description, IecType dataType, int usedBitWidth, boolean isConnected, boolean isReserved) Method to add an digital output to the code generator instance of the current I/O group.
void	create(String ioGroupName, String ioGroupDescription) Method to start the code generation for a specific I/O group.
File	finish(File targetFolder, String namespace) Method to finish the code generation for a specific I/O group.

Methods inherited from class java.lang.Object

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

Constructor Detail

IOGroupClassGenerator

public IOGroupClassGenerator()

Creates a new IO-group class generator.

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

create

public void create(String ioGroupName,
                   String ioGroupDescription)

Method to start the code generation for a specific I/O group.
Note: The generation process has to be started by calling create and is finished by calling finish.

Parameters:

ioGroupName - Name of the I/O group

ioGroupDescription - User defined description for the I/O group.

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.

finish

public File finish(File targetFolder,
                   String namespace)

Method to finish the code generation for a specific I/O group. If all I/Os have been specified, the generation process can be finished by this method. It creates an appropriate Java code file in the given target folder.
Note: The generation process has to be started by calling create and is finished by calling finish.

Parameters:

targetFolder - Target folder for the Java code file to be generated.

namespace - The Java namespace / package for the generated Java code file.

Returns:

A reference to the generated Java code file.

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.

addAnalogOutput

public void addAnalogOutput(String name,
                            String description,
                            IecType dataType,
                            int usedBitWidth,
                            double rangeStart,
                            double rangeEnd,
                            boolean isConnected)

Method to add an analog output to the code generator instance of the current I/O group.
Note: The generation process has to be started by calling create and is finished by calling finish.

Parameters:

name - Name of the output.

description - User defined description for the output.

dataType - IEC data type of the output.

usedBitWidth - Used bit width for the output on the field bus.

rangeStart - Start of the value range of the analog output.

rangeEnd - End of the value range of the analog output.

isConnected - Flag, signalizing whether the output is assigned to a field bus address.

Throws:

IllegalArgumentException - If no name for the analog output is specified, this exception will be thrown.

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.

addAnalogInput

public void addAnalogInput(String name,
                           String description,
                           IecType dataType,
                           int usedBitWidth,
                           double rangeStart,
                           double rangeEnd,
                           boolean isConnected)

Method to add an analog input to the code generator instance of the current I/O group.
Note: The generation process has to be started by calling create and is finished by calling finish.

Parameters:

name - Name of the input.

description - User defined description for the input.

dataType - IEC data type of the input.

usedBitWidth - Used bit width for the input on the field bus.

rangeStart - Start of the value range of the analog input.

rangeEnd - End of the value range of the analog input.

isConnected - Flag, signalizing whether the input is assigned to a field bus address.

Throws:

IllegalArgumentException - If no name for the analog input is specified, this exception will be thrown.

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.

addDigitalOutput

public void addDigitalOutput(String name,
                             String description,
                             IecType dataType,
                             int usedBitWidth,
                             boolean isConnected,
                             boolean isReserved)

Method to add an digital output to the code generator instance of the current I/O group.
Note: The generation process has to be started by calling create and is finished by calling finish.

Parameters:

name - Name of the output.

description - User defined description for the output.

dataType - IEC data type of the output.

usedBitWidth - Used bit width for the output on the field bus.

isConnected - Flag, signalizing whether the output is assigned to a field bus address.

isReserved - Specifies whether the output is reserved for a station state.

Throws:

IllegalArgumentException - If no name for the digital output is specified, this exception will be thrown.

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.

addDigitalInput

public void addDigitalInput(String name,
                            String description,
                            IecType dataType,
                            int usedBitWidth,
                            boolean isConnected)

Method to add an digital input to the code generator instance of the current I/O group.
Note: The generation process has to be started by calling create and is finished by calling finish.

Parameters:

name - Name of the input.

description - User defined description for the input.

dataType - IEC data type of the input.

usedBitWidth - Used bit width for the input on the field bus.

isConnected - Flag, signalizing whether the input is assigned to a field bus address.

Throws:

IllegalArgumentException - If no name for the digital input is specified, this exception will be thrown.

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.