Collaboration diagram for com.neuronrobotics.sdk.common.RpcEncapsulation:

[legend]

Public Member Functions
	RpcEncapsulation (int namespaceIndex, String namespace, String rpc, BowlerMethod downStreamMethod, BowlerDataType[] downstreamArguments, BowlerMethod upStreamMethod, BowlerDataType[] upstreamArguments)

	RpcEncapsulation (int namespaceIndex, String namespace, String rpc, BowlerMethod downStreamMethod, BowlerDataType[] downstreamArguments, BowlerMethod upStreamMethod, BowlerDataType[] upstreamArguments, IBowlerCommandProcessor processor)

void	setArguments (BowlerMethod downStreamMethod, BowlerDataType[] downstreamArguments, BowlerMethod upStreamMethod, BowlerDataType[] upstreamArguments)

BowlerAbstractCommand	getCommand (Object[] doswnstreamData)

BowlerAbstractCommand	getCommandUpstream (Object[] doswnstreamData)

BowlerAbstractCommand	getCommand (Object[] doswnstreamData, BowlerDataType[] arguments)

Object[]	parseResponse (BowlerDatagram datagram)

Object[]	parseResponseDownstream (BowlerDatagram datagram)

Object[]	parseResponse (BowlerDatagram datagram, BowlerDataType[] arguments)

String	getNamespace ()

void	setNamespace (String namespace)

String	getRpc ()

void	setRpc (String rpc)

BowlerMethod	getDownstreamMethod ()

void	setDownStreamMethod (BowlerMethod method)

BowlerDataType[]	getDownstreamArguments ()

void	setDownstreamArguments (BowlerDataType[] downstreamArguments)

BowlerDataType[]	getUpstreamArguments ()

void	setUpstreamArguments (BowlerDataType[] upstreamArguments)

BowlerMethod	getUpStreamMethod ()

void	setUpStreamMethod (BowlerMethod upStreamMethod)

String	toString ()

int	getNamespaceIndex ()

void	setNamespaceIndex (int namespaceIndex)

IBowlerCommandProcessor	getProcessor ()

void	setProcessor (IBowlerCommandProcessor processor)

Private Attributes
String	rpc

BowlerMethod	method

BowlerDataType[]	downstreamArguments

BowlerDataType[]	upstreamArguments

BowlerMethod	upStreamMethod

int	namespaceIndex

IBowlerCommandProcessor	processor

Detailed Description

The Class RpcEncapsulation.

Definition at line 9 of file RpcEncapsulation.java.

Constructor & Destructor Documentation

◆ RpcEncapsulation() [1/2]

com.neuronrobotics.sdk.common.RpcEncapsulation.RpcEncapsulation	(	int	namespaceIndex,
		String	namespace,
		String	rpc,
		BowlerMethod	downStreamMethod,
		BowlerDataType[]	downstreamArguments,
		BowlerMethod	upStreamMethod,
		BowlerDataType[]	upstreamArguments
	)

This is an encapsulation object for a given RPC.

Parameters

namespaceIndex	the namespace index
namespace	The corosponding Namespace
rpc	The 4 byte RPC code
downStreamMethod	The method for sending messages
downstreamArguments	The array of data types for a downstream message
upStreamMethod	The return method type
upstreamArguments	THe return method arguments

Definition at line 46 of file RpcEncapsulation.java.

References com.neuronrobotics.sdk.common.RpcEncapsulation.downstreamArguments, com.neuronrobotics.sdk.common.RpcEncapsulation.namespaceIndex, com.neuronrobotics.sdk.common.RpcEncapsulation.rpc, com.neuronrobotics.sdk.common.RpcEncapsulation.upstreamArguments, and com.neuronrobotics.sdk.common.RpcEncapsulation.upStreamMethod.

◆ RpcEncapsulation() [2/2]

com.neuronrobotics.sdk.common.RpcEncapsulation.RpcEncapsulation	(	int	namespaceIndex,
		String	namespace,
		String	rpc,
		BowlerMethod	downStreamMethod,
		BowlerDataType[]	downstreamArguments,
		BowlerMethod	upStreamMethod,
		BowlerDataType[]	upstreamArguments,
		IBowlerCommandProcessor	processor
	)

This is an encapsulation object for a given RPC.

Parameters

namespaceIndex	the namespace index
namespace	The corosponding Namespace
rpc	The 4 byte RPC code
downStreamMethod	The method for sending messages
downstreamArguments	The array of data types for a downstream message
upStreamMethod	The return method type
upstreamArguments	THe return method arguments
processor	the processor

Definition at line 64 of file RpcEncapsulation.java.

Here is the call graph for this function:

Member Function Documentation

◆ getCommand() [1/2]

BowlerAbstractCommand com.neuronrobotics.sdk.common.RpcEncapsulation.getCommand ( Object[] doswnstreamData )

Gets the command.

Parameters

doswnstreamData the doswnstream data

Returns: the command

Definition at line 95 of file RpcEncapsulation.java.

References com.neuronrobotics.sdk.common.RpcEncapsulation.downstreamArguments.

Referenced by com.neuronrobotics.sdk.common.BowlerAbstractConnection.getCommand(), and com.neuronrobotics.sdk.common.RpcEncapsulation.getCommandUpstream().

◆ getCommand() [2/2]

BowlerAbstractCommand com.neuronrobotics.sdk.common.RpcEncapsulation.getCommand	(	Object[]	doswnstreamData,
		BowlerDataType[]	arguments
	)

Gets the command.

Parameters

doswnstreamData	the doswnstream data
arguments	the arguments

Returns: the command

Definition at line 117 of file RpcEncapsulation.java.

Here is the call graph for this function:

◆ getCommandUpstream()

BowlerAbstractCommand com.neuronrobotics.sdk.common.RpcEncapsulation.getCommandUpstream ( Object[] doswnstreamData )

Gets the command upstream.

Parameters

doswnstreamData the doswnstream data

Returns: the command upstream

Definition at line 105 of file RpcEncapsulation.java.

References com.neuronrobotics.sdk.common.RpcEncapsulation.getCommand(), and com.neuronrobotics.sdk.common.RpcEncapsulation.upstreamArguments.

Referenced by com.neuronrobotics.sdk.common.device.server.BowlerAbstractDeviceServerNamespace.process().

Here is the call graph for this function:

◆ getDownstreamArguments()

BowlerDataType [] com.neuronrobotics.sdk.common.RpcEncapsulation.getDownstreamArguments ( )

Gets the downstream arguments.

Returns: the downstream arguments

Definition at line 398 of file RpcEncapsulation.java.

References com.neuronrobotics.sdk.common.RpcEncapsulation.downstreamArguments.

Referenced by com.neuronrobotics.sdk.common.device.server.bcs.rpc.BcsRpcNamespaceImp.BcsRpcNamespaceImp(), and com.neuronrobotics.sdk.common.RpcEncapsulation.toString().

◆ getDownstreamMethod()

BowlerMethod com.neuronrobotics.sdk.common.RpcEncapsulation.getDownstreamMethod ( )

Gets the downstream method.

Returns: the downstream method

Definition at line 380 of file RpcEncapsulation.java.

References com.neuronrobotics.sdk.common.RpcEncapsulation.method.

Referenced by com.neuronrobotics.sdk.common.device.server.bcs.rpc.BcsRpcNamespaceImp.BcsRpcNamespaceImp(), com.neuronrobotics.sdk.common.RpcEncapsulation.getCommand(), and com.neuronrobotics.sdk.common.RpcEncapsulation.toString().

◆ getNamespace()

String com.neuronrobotics.sdk.common.RpcEncapsulation.getNamespace ( )

Gets the namespace.

Returns: the namespace

Definition at line 344 of file RpcEncapsulation.java.

Referenced by com.neuronrobotics.sdk.common.RpcEncapsulation.toString().

◆ getNamespaceIndex()

int com.neuronrobotics.sdk.common.RpcEncapsulation.getNamespaceIndex ( )

Gets the namespace index.

Returns: the namespace index

Definition at line 487 of file RpcEncapsulation.java.

References com.neuronrobotics.sdk.common.RpcEncapsulation.namespaceIndex.

Referenced by com.neuronrobotics.sdk.common.RpcEncapsulation.getCommand().

◆ getProcessor()

IBowlerCommandProcessor com.neuronrobotics.sdk.common.RpcEncapsulation.getProcessor ( )

Gets the processor.

Returns: the processor

Definition at line 505 of file RpcEncapsulation.java.

References com.neuronrobotics.sdk.common.RpcEncapsulation.processor.

Referenced by com.neuronrobotics.sdk.common.device.server.BowlerAbstractDeviceServerNamespace.process().

◆ getRpc()

String com.neuronrobotics.sdk.common.RpcEncapsulation.getRpc ( )

Gets the rpc.

Returns: the rpc

Definition at line 362 of file RpcEncapsulation.java.

References com.neuronrobotics.sdk.common.RpcEncapsulation.rpc.

Referenced by com.neuronrobotics.sdk.common.RpcEncapsulation.getCommand(), and com.neuronrobotics.sdk.common.RpcEncapsulation.toString().

◆ getUpstreamArguments()

BowlerDataType [] com.neuronrobotics.sdk.common.RpcEncapsulation.getUpstreamArguments ( )

Gets the upstream arguments.

Returns: the upstream arguments

Definition at line 422 of file RpcEncapsulation.java.

References com.neuronrobotics.sdk.common.RpcEncapsulation.upstreamArguments.

Referenced by com.neuronrobotics.sdk.common.device.server.bcs.rpc.BcsRpcNamespaceImp.BcsRpcNamespaceImp(), and com.neuronrobotics.sdk.common.RpcEncapsulation.toString().

◆ getUpStreamMethod()

BowlerMethod com.neuronrobotics.sdk.common.RpcEncapsulation.getUpStreamMethod ( )

Gets the up stream method.

Returns: the up stream method

Definition at line 447 of file RpcEncapsulation.java.

References com.neuronrobotics.sdk.common.RpcEncapsulation.upStreamMethod.

Referenced by com.neuronrobotics.sdk.common.device.server.bcs.rpc.BcsRpcNamespaceImp.BcsRpcNamespaceImp(), and com.neuronrobotics.sdk.common.RpcEncapsulation.toString().

◆ parseResponse() [1/2]

Object [] com.neuronrobotics.sdk.common.RpcEncapsulation.parseResponse ( BowlerDatagram datagram )

Parses the response.

Parameters

datagram the datagram

Returns: the object[]

Definition at line 225 of file RpcEncapsulation.java.

References com.neuronrobotics.sdk.common.RpcEncapsulation.upstreamArguments.

Referenced by com.neuronrobotics.sdk.common.BowlerAbstractConnection.parseResponse(), and com.neuronrobotics.sdk.common.RpcEncapsulation.parseResponseDownstream().

◆ parseResponse() [2/2]

Object [] com.neuronrobotics.sdk.common.RpcEncapsulation.parseResponse	(	BowlerDatagram	datagram,
		BowlerDataType[]	arguments
	)

Parses the response.

Parameters

datagram	the datagram
arguments	the arguments

Returns: the object[]

Definition at line 246 of file RpcEncapsulation.java.

References com.neuronrobotics.sdk.common.ByteList.add(), com.neuronrobotics.sdk.common.ByteList.asString(), com.neuronrobotics.sdk.common.ByteList.convertToInt(), com.neuronrobotics.sdk.common.Log.error(), com.neuronrobotics.sdk.common.BowlerDatagram.getData(), com.neuronrobotics.sdk.common.ByteList.getUnsigned(), com.neuronrobotics.sdk.common.ByteList.pop(), and com.neuronrobotics.sdk.common.ByteList.popList().

Here is the call graph for this function:

◆ parseResponseDownstream()

Object [] com.neuronrobotics.sdk.common.RpcEncapsulation.parseResponseDownstream ( BowlerDatagram datagram )

Parses the response downstream.

Parameters

datagram the datagram

Returns: the object[]

Definition at line 235 of file RpcEncapsulation.java.

References com.neuronrobotics.sdk.common.RpcEncapsulation.downstreamArguments, and com.neuronrobotics.sdk.common.RpcEncapsulation.parseResponse().

Referenced by com.neuronrobotics.sdk.common.device.server.BowlerAbstractDeviceServerNamespace.process().

Here is the call graph for this function:

◆ setArguments()

void com.neuronrobotics.sdk.common.RpcEncapsulation.setArguments	(	BowlerMethod	downStreamMethod,
		BowlerDataType[]	downstreamArguments,
		BowlerMethod	upStreamMethod,
		BowlerDataType[]	upstreamArguments
	)

Sets the arguments.

Parameters

downStreamMethod	the down stream method
downstreamArguments	the downstream arguments
upStreamMethod	the up stream method
upstreamArguments	the upstream arguments

Definition at line 82 of file RpcEncapsulation.java.

References com.neuronrobotics.sdk.common.RpcEncapsulation.setDownstreamArguments(), com.neuronrobotics.sdk.common.RpcEncapsulation.setDownStreamMethod(), com.neuronrobotics.sdk.common.RpcEncapsulation.setUpstreamArguments(), and com.neuronrobotics.sdk.common.RpcEncapsulation.setUpStreamMethod().

Referenced by com.neuronrobotics.sdk.common.RpcEncapsulation.RpcEncapsulation().

Here is the call graph for this function: