NavigationClient class Services
A client for the navigation service.
- Inheritance
- Implemented types
- Mixed-in types
Constructors
Properties
- callOptions → CallOptions
-
no setterinherited
- channel ↔ ClientChannelBase
-
getter/setter pairoverride
- client → NavigationServiceClient
-
no setteroverride
- hashCode → int
-
The hash code for this object.
no setterinherited
- name → String
-
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
Methods
-
addWaypoint(
GeoPoint location, {Map< String, dynamic> ? extra}) → Future<void> - Add a common_pb.GeoPoint to the service's data storage of waypoints.
-
disableDebugLogging(
) → void -
Disable debug logging for gRPC calls by removing the trace key from the metadata.
inherited
-
doCommand(
Map< String, dynamic> command) → Future<Map< String, dynamic> > -
Send/Receive arbitrary commands to the Resource
override
-
enableDebugLogging(
{String? traceKey}) → void -
Enable debug logging for gRPC calls by setting a trace key in the metadata.
If no trace key is provided, a random one will be generated.
inherited
-
getLocation(
{Map< String, dynamic> ? extra}) → Future<GetLocationResponse> - Get the current location of the robot as a common_pb.GeoPoint along with its compass heading.
-
getMode(
{Map< String, dynamic> ? extra}) → Future<Mode> - Get the Mode the service is operating in.
-
getObstacles(
{Map< String, dynamic> ? extra}) → Future<List< GeoGeometry> > - Get an array of common_pb.GeoGeometrys representing obstacles that the service is aware of.
-
getPaths(
{Map< String, dynamic> ? extra}) → Future<List< Path> > - Get an array of Paths representing the paths the service is aware of.
-
getProperties(
) → Future< NavigationProperties> - Get information about the navigation service's properties, including its MapType.
-
getStatus(
) → Future< Map< String, dynamic> > -
Get the status of the Resource
inherited
-
getWaypoints(
{Map< String, dynamic> ? extra}) → Future<List< Waypoint> > - Get an array of Waypoints currently in the service's data storage.
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
removeWaypoint(
String id, {Map< String, dynamic> ? extra}) → Future<void> -
Remove a Waypoint from the service's data storage by its
id. -
setMode(
Mode mode, {Map< String, dynamic> ? extra}) → Future<void> - Set the Mode the service is operating in.
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited
Static Methods
-
fromRobot(
RobotClient robot, String name) → NavigationClient -
Get the NavigationClient named
namefrom the provided robot. -
getResourceName(
String name) → ResourceName -
Get the common_pb.ResourceName for this NavigationClient with the given
name