Inheritance diagram for grl.flatbuffer.FRI:

Collaboration diagram for grl.flatbuffer.FRI:

Public Member Functions
FRI	__init (int _i, ByteBuffer _bb)

FRI	__init (int _i, ByteBuffer _bb)

byte	overlayType ()

byte	overlayType ()

short	portOnController ()

short	portOnController ()

short	portOnRemote ()

short	portOnRemote ()

int	sendPeriodMillisec ()

int	sendPeriodMillisec ()

int	setReceiveMultiplier ()

int	setReceiveMultiplier ()

boolean	updatePortOnController ()

boolean	updatePortOnController ()

boolean	updatePortOnRemote ()

boolean	updatePortOnRemote ()

Static Public Member Functions
static void	addOverlayType (FlatBufferBuilder builder, byte overlayType)

static void	addOverlayType (FlatBufferBuilder builder, byte overlayType)

static void	addPortOnController (FlatBufferBuilder builder, short portOnController)

static void	addPortOnController (FlatBufferBuilder builder, short portOnController)

static void	addPortOnRemote (FlatBufferBuilder builder, short portOnRemote)

static void	addPortOnRemote (FlatBufferBuilder builder, short portOnRemote)

static void	addSendPeriodMillisec (FlatBufferBuilder builder, int sendPeriodMillisec)

static void	addSendPeriodMillisec (FlatBufferBuilder builder, int sendPeriodMillisec)

static void	addSetReceiveMultiplier (FlatBufferBuilder builder, int setReceiveMultiplier)

static void	addSetReceiveMultiplier (FlatBufferBuilder builder, int setReceiveMultiplier)

static void	addUpdatePortOnController (FlatBufferBuilder builder, boolean updatePortOnController)

static void	addUpdatePortOnController (FlatBufferBuilder builder, boolean updatePortOnController)

static void	addUpdatePortOnRemote (FlatBufferBuilder builder, boolean updatePortOnRemote)

static void	addUpdatePortOnRemote (FlatBufferBuilder builder, boolean updatePortOnRemote)

static int	createFRI (FlatBufferBuilder builder, byte overlayType, int sendPeriodMillisec, int setReceiveMultiplier, boolean updatePortOnRemote, short portOnRemote, boolean updatePortOnController, short portOnController)

static int	createFRI (FlatBufferBuilder builder, byte overlayType, int sendPeriodMillisec, int setReceiveMultiplier, boolean updatePortOnRemote, short portOnRemote, boolean updatePortOnController, short portOnController)

static int	endFRI (FlatBufferBuilder builder)

static int	endFRI (FlatBufferBuilder builder)

static FRI	getRootAsFRI (ByteBuffer _bb)

static FRI	getRootAsFRI (ByteBuffer _bb)

static FRI	getRootAsFRI (ByteBuffer _bb, FRI obj)

static FRI	getRootAsFRI (ByteBuffer _bb, FRI obj)

static void	startFRI (FlatBufferBuilder builder)

static void	startFRI (FlatBufferBuilder builder)

Detailed Description

Definition at line 11 of file build/include/grl/flatbuffer/grl/flatbuffer/FRI.java.

Member Function Documentation

§ __init() [1/2]

FRI grl.flatbuffer.FRI.__init	(	int	_i,
		ByteBuffer	_bb
	)

inline

Definition at line 14 of file build/include/grl/flatbuffer/grl/flatbuffer/FRI.java.

§ __init() [2/2]

FRI grl.flatbuffer.FRI.__init	(	int	_i,
		ByteBuffer	_bb
	)

inline

Definition at line 14 of file src/java/grl/src/grl/flatbuffer/FRI.java.

§ addOverlayType() [1/2]

static void grl.flatbuffer.FRI.addOverlayType	(	FlatBufferBuilder	builder,
		byte	overlayType
	)

inlinestatic

Definition at line 84 of file src/java/grl/src/grl/flatbuffer/FRI.java.

§ addOverlayType() [2/2]

static void grl.flatbuffer.FRI.addOverlayType	(	FlatBufferBuilder	builder,
		byte	overlayType
	)

inlinestatic

Definition at line 84 of file build/include/grl/flatbuffer/grl/flatbuffer/FRI.java.

§ addPortOnController() [1/2]

static void grl.flatbuffer.FRI.addPortOnController	(	FlatBufferBuilder	builder,
		short	portOnController
	)

inlinestatic

Definition at line 90 of file src/java/grl/src/grl/flatbuffer/FRI.java.

§ addPortOnController() [2/2]

static void grl.flatbuffer.FRI.addPortOnController	(	FlatBufferBuilder	builder,
		short	portOnController
	)

inlinestatic

Definition at line 90 of file build/include/grl/flatbuffer/grl/flatbuffer/FRI.java.

§ addPortOnRemote() [1/2]

static void grl.flatbuffer.FRI.addPortOnRemote	(	FlatBufferBuilder	builder,
		short	portOnRemote
	)

inlinestatic

Definition at line 88 of file build/include/grl/flatbuffer/grl/flatbuffer/FRI.java.

§ addPortOnRemote() [2/2]

static void grl.flatbuffer.FRI.addPortOnRemote	(	FlatBufferBuilder	builder,
		short	portOnRemote
	)

inlinestatic

Definition at line 88 of file src/java/grl/src/grl/flatbuffer/FRI.java.

§ addSendPeriodMillisec() [1/2]

static void grl.flatbuffer.FRI.addSendPeriodMillisec	(	FlatBufferBuilder	builder,
		int	sendPeriodMillisec
	)

inlinestatic

Definition at line 85 of file src/java/grl/src/grl/flatbuffer/FRI.java.

§ addSendPeriodMillisec() [2/2]

static void grl.flatbuffer.FRI.addSendPeriodMillisec	(	FlatBufferBuilder	builder,
		int	sendPeriodMillisec
	)

inlinestatic

Definition at line 85 of file build/include/grl/flatbuffer/grl/flatbuffer/FRI.java.

§ addSetReceiveMultiplier() [1/2]

static void grl.flatbuffer.FRI.addSetReceiveMultiplier	(	FlatBufferBuilder	builder,
		int	setReceiveMultiplier
	)

inlinestatic

Definition at line 86 of file src/java/grl/src/grl/flatbuffer/FRI.java.

§ addSetReceiveMultiplier() [2/2]

static void grl.flatbuffer.FRI.addSetReceiveMultiplier	(	FlatBufferBuilder	builder,
		int	setReceiveMultiplier
	)

inlinestatic

Definition at line 86 of file build/include/grl/flatbuffer/grl/flatbuffer/FRI.java.

§ addUpdatePortOnController() [1/2]

static void grl.flatbuffer.FRI.addUpdatePortOnController	(	FlatBufferBuilder	builder,
		boolean	updatePortOnController
	)

inlinestatic

Definition at line 89 of file build/include/grl/flatbuffer/grl/flatbuffer/FRI.java.

§ addUpdatePortOnController() [2/2]

static void grl.flatbuffer.FRI.addUpdatePortOnController	(	FlatBufferBuilder	builder,
		boolean	updatePortOnController
	)

inlinestatic

Definition at line 89 of file src/java/grl/src/grl/flatbuffer/FRI.java.

§ addUpdatePortOnRemote() [1/2]

static void grl.flatbuffer.FRI.addUpdatePortOnRemote	(	FlatBufferBuilder	builder,
		boolean	updatePortOnRemote
	)

inlinestatic

Definition at line 87 of file src/java/grl/src/grl/flatbuffer/FRI.java.

§ addUpdatePortOnRemote() [2/2]

static void grl.flatbuffer.FRI.addUpdatePortOnRemote	(	FlatBufferBuilder	builder,
		boolean	updatePortOnRemote
	)

inlinestatic

Definition at line 87 of file build/include/grl/flatbuffer/grl/flatbuffer/FRI.java.

§ createFRI() [1/2]

static int grl.flatbuffer.FRI.createFRI	(	FlatBufferBuilder	builder,
		byte	overlayType,
		int	sendPeriodMillisec,
		int	setReceiveMultiplier,
		boolean	updatePortOnRemote,
		short	portOnRemote,
		boolean	updatePortOnController,
		short	portOnController
	)

inlinestatic

Definition at line 64 of file build/include/grl/flatbuffer/grl/flatbuffer/FRI.java.

§ createFRI() [2/2]

static int grl.flatbuffer.FRI.createFRI	(	FlatBufferBuilder	builder,
		byte	overlayType,
		int	sendPeriodMillisec,
		int	setReceiveMultiplier,
		boolean	updatePortOnRemote,
		short	portOnRemote,
		boolean	updatePortOnController,
		short	portOnController
	)

inlinestatic

Definition at line 64 of file src/java/grl/src/grl/flatbuffer/FRI.java.

§ endFRI() [1/2]

static int grl.flatbuffer.FRI.endFRI ( FlatBufferBuilder builder )

inlinestatic

Definition at line 91 of file src/java/grl/src/grl/flatbuffer/FRI.java.

§ endFRI() [2/2]

static int grl.flatbuffer.FRI.endFRI ( FlatBufferBuilder builder )

inlinestatic

Definition at line 91 of file build/include/grl/flatbuffer/grl/flatbuffer/FRI.java.

§ getRootAsFRI() [1/4]

static FRI grl.flatbuffer.FRI.getRootAsFRI ( ByteBuffer _bb )

inlinestatic

Definition at line 12 of file src/java/grl/src/grl/flatbuffer/FRI.java.

§ getRootAsFRI() [2/4]

static FRI grl.flatbuffer.FRI.getRootAsFRI ( ByteBuffer _bb )

inlinestatic

Definition at line 12 of file build/include/grl/flatbuffer/grl/flatbuffer/FRI.java.

§ getRootAsFRI() [3/4]

static FRI grl.flatbuffer.FRI.getRootAsFRI	(	ByteBuffer	_bb,
		FRI	obj
	)

inlinestatic

Definition at line 13 of file build/include/grl/flatbuffer/grl/flatbuffer/FRI.java.

§ getRootAsFRI() [4/4]

static FRI grl.flatbuffer.FRI.getRootAsFRI	(	ByteBuffer	_bb,
		FRI	obj
	)

inlinestatic

Definition at line 13 of file src/java/grl/src/grl/flatbuffer/FRI.java.

§ overlayType() [1/2]

byte grl.flatbuffer.FRI.overlayType ( )

inline

Definition at line 16 of file build/include/grl/flatbuffer/grl/flatbuffer/FRI.java.

§ overlayType() [2/2]

byte grl.flatbuffer.FRI.overlayType ( )

inline

Definition at line 16 of file src/java/grl/src/grl/flatbuffer/FRI.java.

§ portOnController() [1/2]

short grl.flatbuffer.FRI.portOnController ( )

inline

Set the port ID of the FRI channel at the remote side. By default, this port ID is used on both sides of the FRI channel, unless specified otherwise by setPortOnController(int).

Values of portID:

default port ID: 30200 recommended range of port IDs: 30200 <= portID < 30210 Since the FRI channel utilizes UDP as connection layer, make sure, that your network topology (firewall, network services) are chosen accordingly.

Parameters: portID - the port ID > 0 (also known as UDP port number)

Definition at line 62 of file build/include/grl/flatbuffer/grl/flatbuffer/FRI.java.

§ portOnController() [2/2]

short grl.flatbuffer.FRI.portOnController ( )

inline

Set the port ID of the FRI channel at the remote side. By default, this port ID is used on both sides of the FRI channel, unless specified otherwise by setPortOnController(int).

Values of portID:

default port ID: 30200 recommended range of port IDs: 30200 <= portID < 30210 Since the FRI channel utilizes UDP as connection layer, make sure, that your network topology (firewall, network services) are chosen accordingly.

Parameters: portID - the port ID > 0 (also known as UDP port number)

Definition at line 62 of file src/java/grl/src/grl/flatbuffer/FRI.java.

§ portOnRemote() [1/2]

short grl.flatbuffer.FRI.portOnRemote ( )

inline

Set the port ID of the socket at the controller side. Note: Do not change this port ID, unless your application requires different port IDs on both ends of the FRI channel. For changing the FRI port ID on both sides, it is sufficient to call setPortOnRemote(int). Values of controllerPortID: "-1" - The configuration of setPortOnRemote(int) is used. This is the default. recommended range of port IDs: 30200 <= controllerPortID < 30210

Definition at line 47 of file build/include/grl/flatbuffer/grl/flatbuffer/FRI.java.

§ portOnRemote() [2/2]

short grl.flatbuffer.FRI.portOnRemote ( )

inline

Set the port ID of the socket at the controller side. Note: Do not change this port ID, unless your application requires different port IDs on both ends of the FRI channel. For changing the FRI port ID on both sides, it is sufficient to call setPortOnRemote(int). Values of controllerPortID: "-1" - The configuration of setPortOnRemote(int) is used. This is the default. recommended range of port IDs: 30200 <= controllerPortID < 30210

Definition at line 47 of file src/java/grl/src/grl/flatbuffer/FRI.java.

§ sendPeriodMillisec() [1/2]

int grl.flatbuffer.FRI.sendPeriodMillisec ( )

inline

Set the value for the send period of the connection from the KUKA controller to the remote side in [ms]. This means, the KUKA controller will send cyclic FRI messages every sendPeriod milliseconds to the remote side.

Parameters: sendPeriod - the send period in milliseconds, 1 <= sendPeriod <= 100. Note: The recommended value for good performance should be between 1-5 milliseconds.

Definition at line 26 of file build/include/grl/flatbuffer/grl/flatbuffer/FRI.java.

§ sendPeriodMillisec() [2/2]

int grl.flatbuffer.FRI.sendPeriodMillisec ( )

inline

Set the value for the send period of the connection from the KUKA controller to the remote side in [ms]. This means, the KUKA controller will send cyclic FRI messages every sendPeriod milliseconds to the remote side.

Parameters: sendPeriod - the send period in milliseconds, 1 <= sendPeriod <= 100. Note: The recommended value for good performance should be between 1-5 milliseconds.

Definition at line 26 of file src/java/grl/src/grl/flatbuffer/FRI.java.

§ setReceiveMultiplier() [1/2]

int grl.flatbuffer.FRI.setReceiveMultiplier ( )

inline

Set the receive multiplier of the cycle time from the remote side to the KUKA controller. This multiplier defines the value of the receivePeriod which is calculated: receivePeriod = receiveMultiplier * sendPeriod

The KUKA controller will expect a FRI response message every receivePeriod milliseconds from the remote side.

The receivePeriod has to be within the range of: 1 <= receivePeriod <= 100.

Definition at line 37 of file src/java/grl/src/grl/flatbuffer/FRI.java.

§ setReceiveMultiplier() [2/2]

int grl.flatbuffer.FRI.setReceiveMultiplier ( )

inline

Set the receive multiplier of the cycle time from the remote side to the KUKA controller. This multiplier defines the value of the receivePeriod which is calculated: receivePeriod = receiveMultiplier * sendPeriod

The KUKA controller will expect a FRI response message every receivePeriod milliseconds from the remote side.

The receivePeriod has to be within the range of: 1 <= receivePeriod <= 100.

Definition at line 37 of file build/include/grl/flatbuffer/grl/flatbuffer/FRI.java.

§ startFRI() [1/2]

static void grl.flatbuffer.FRI.startFRI ( FlatBufferBuilder builder )

inlinestatic

Definition at line 83 of file src/java/grl/src/grl/flatbuffer/FRI.java.

§ startFRI() [2/2]

static void grl.flatbuffer.FRI.startFRI ( FlatBufferBuilder builder )

inlinestatic

Definition at line 83 of file build/include/grl/flatbuffer/grl/flatbuffer/FRI.java.

§ updatePortOnController() [1/2]

boolean grl.flatbuffer.FRI.updatePortOnController ( )

inline

Definition at line 48 of file src/java/grl/src/grl/flatbuffer/FRI.java.

§ updatePortOnController() [2/2]

boolean grl.flatbuffer.FRI.updatePortOnController ( )

inline

Definition at line 48 of file build/include/grl/flatbuffer/grl/flatbuffer/FRI.java.

§ updatePortOnRemote() [1/2]

boolean grl.flatbuffer.FRI.updatePortOnRemote ( )

inline

Definition at line 38 of file src/java/grl/src/grl/flatbuffer/FRI.java.

§ updatePortOnRemote() [2/2]

boolean grl.flatbuffer.FRI.updatePortOnRemote ( )

inline

Definition at line 38 of file build/include/grl/flatbuffer/grl/flatbuffer/FRI.java.

The documentation for this class was generated from the following file:

build/include/grl/flatbuffer/grl/flatbuffer/FRI.java

Public Member Functions

Static Public Member Functions

Detailed Description

Member Function Documentation

§ __init() [1/2]

§ __init() [2/2]

§ addOverlayType() [1/2]

§ addOverlayType() [2/2]

§ addPortOnController() [1/2]

§ addPortOnController() [2/2]

§ addPortOnRemote() [1/2]

§ addPortOnRemote() [2/2]

§ addSendPeriodMillisec() [1/2]

§ addSendPeriodMillisec() [2/2]

§ addSetReceiveMultiplier() [1/2]

§ addSetReceiveMultiplier() [2/2]

§ addUpdatePortOnController() [1/2]

§ addUpdatePortOnController() [2/2]

§ addUpdatePortOnRemote() [1/2]

§ addUpdatePortOnRemote() [2/2]

§ createFRI() [1/2]

§ createFRI() [2/2]

§ endFRI() [1/2]

§ endFRI() [2/2]

§ getRootAsFRI() [1/4]

§ getRootAsFRI() [2/4]

§ getRootAsFRI() [3/4]

§ getRootAsFRI() [4/4]

§ overlayType() [1/2]

§ overlayType() [2/2]

§ portOnController() [1/2]

§ portOnController() [2/2]

§ portOnRemote() [1/2]

§ portOnRemote() [2/2]

§ sendPeriodMillisec() [1/2]

§ sendPeriodMillisec() [2/2]

§ setReceiveMultiplier() [1/2]

§ setReceiveMultiplier() [2/2]

§ startFRI() [1/2]

§ startFRI() [2/2]

§ updatePortOnController() [1/2]

§ updatePortOnController() [2/2]

§ updatePortOnRemote() [1/2]

§ updatePortOnRemote() [2/2]