ros

Class SubscriptionRequestMsg

java.lang.Object

ros.SubscriptionRequestMsg

public class SubscriptionRequestMsg
extends Object

A Subscription request builder. Supports all Rosbridge protocol fields for a subscription request except png compression. Requires a topic to be set, with the rest of the optional values set with setter methods that return the this object so that you can chain settters on a single line. Use the static generate(String) to start the sequence. If a value is set to null, it will be removed from the message.

When everything is set, the JSON message can be retrieved with the generateJsonString()

Author:

James MacGlashan.

Field Summary

Fields

Modifier and Type	Field and Description
protected Map<String,Object>	keyValues

Constructor Summary

Constructors

Constructor and Description
SubscriptionRequestMsg(String topic)

Method Summary

Modifier and Type	Method and Description
static SubscriptionRequestMsg	generate(String topic)
String	generateJsonString() Generates the JSON string for this subscription request.
Integer	getFragmentSize()
String	getId()
Integer	getQueueLength()
Integer	getThrottleRate()
String	getTopic()
String	getType()
SubscriptionRequestMsg	setFragmentSize(Integer fragmentSize)
SubscriptionRequestMsg	setId(String id)
protected void	setKeyValue(String key, Object value)
SubscriptionRequestMsg	setQueueLength(Integer queueLength)
SubscriptionRequestMsg	setThrottleRate(Integer throttleRate)
SubscriptionRequestMsg	setTopic(String topic)
SubscriptionRequestMsg	setType(String type)

Methods inherited from class java.lang.Object

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

Field Detail

keyValues

protected Map<String,Object> keyValues

Constructor Detail

SubscriptionRequestMsg

public SubscriptionRequestMsg(String topic)

Method Detail

generate

public static SubscriptionRequestMsg generate(String topic)

setTopic

public SubscriptionRequestMsg setTopic(String topic)

setType

public SubscriptionRequestMsg setType(String type)

setThrottleRate

public SubscriptionRequestMsg setThrottleRate(Integer throttleRate)

setQueueLength

public SubscriptionRequestMsg setQueueLength(Integer queueLength)

setFragmentSize

public SubscriptionRequestMsg setFragmentSize(Integer fragmentSize)

setId

public SubscriptionRequestMsg setId(String id)

getTopic

public String getTopic()

getType

public String getType()

getThrottleRate

public Integer getThrottleRate()

getQueueLength

public Integer getQueueLength()

getFragmentSize

public Integer getFragmentSize()

getId

public String getId()

generateJsonString

public String generateJsonString()

Generates the JSON string for this subscription request.

Returns:

the JSON string for this subscription request.

setKeyValue

protected void setKeyValue(String key,
                           Object value)