Class ZOROSAPI

rosapi provides service calls for getting meta-information related to ROS like topic lists as well as interacting with the Parameter Server.

Inheritance

System.Object

ZOROSAPI

Inherited Members

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: ZO.ROS

Assembly: Unity.ZeroSim.dll

Syntax

public static class ZOROSAPI

Methods

GetParam(String, String, Func<String, Task>)

Get a rosparam parameter.

Declaration

public static void GetParam(string paramName, string id, Func<string, Task> onGetParam)

Parameters

Type	Name	Description
System.String	paramName	Parameter name
System.String	id	Unique ID for the service call.
System.Func<System.String, System.Threading.Tasks.Task>	onGetParam	Callback on getting the parameter value.

GetParamNames(String, Func<String[], Task>)

Get all the parameter names published on the rosparam server.

Declaration

public static void GetParamNames(string id, Func<string[], Task> onGetParamNames)

Parameters

Type	Name	Description
System.String	id	Unique ID for the service call.
System.Func<System.String[], System.Threading.Tasks.Task>	onGetParamNames	Callback on getting the parameter names.

HasParam(String, String, Func<Boolean, Task>)

Checks if a ROS parameter exists.

Declaration

public static void HasParam(string paramName, string id, Func<bool, Task> onHasParam)

Parameters

Type	Name	Description
System.String	paramName	Name of the parameter
System.String	id	Unique id of caller
System.Func<System.Boolean, System.Threading.Tasks.Task>	onHasParam	callback for result.

SetParam(String, String, String)

Set a rosparam parameter.

Declaration

public static void SetParam(string paramName, string paramValue, string id)

Parameters

Type	Name	Description
System.String	paramName	Parameter Name
System.String	paramValue	Parameter value
System.String	id	Unique ID for the service call.