Class SwitchControllerServiceResponse
The SwitchController service allows you stop a number of controllers and start a number of controllers, all in one single timestep of the controller_manager control loop.
To switch controllers, specify
- the list of controller names to start,
- the list of controller names to stop, and
- the strictness (BEST_EFFORT or STRICT)
- STRICT means that switching will fail if anything goes wrong (an invalid controller name, a controller that failed to start, etc. )
- BEST_EFFORT means that even when something goes wrong with on controller, the service will still try to start/stop the remaining controllers
- start the controllers as soon as their hardware dependencies are ready, will wait for all interfaces to be ready otherwise
- the timeout in seconds before aborting pending controllers. Zero for infinite
The return value "ok" indicates if the controllers were switched successfully or not. The meaning of success depends on the specified strictness.
Inheritance
System.Object
SwitchControllerServiceResponse
Implements
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.MessageTypes.ControllerManager
Assembly: Unity.ZeroSim.dll
Syntax
public class SwitchControllerServiceResponse : ZOROSMessageInterface
Constructors
| Improve this Doc View SourceSwitchControllerServiceResponse()
Declaration
public SwitchControllerServiceResponse()
SwitchControllerServiceResponse(Boolean)
Declaration
public SwitchControllerServiceResponse(bool ok)
Parameters
Type | Name | Description |
---|---|---|
System.Boolean | ok |
Fields
| Improve this Doc View SourceType
Declaration
[JsonIgnore]
public static string Type
Field Value
Type | Description |
---|---|
System.String |
Properties
| Improve this Doc View SourceMessageType
Declaration
[JsonIgnore]
public string MessageType { get; }
Property Value
Type | Description |
---|---|
System.String |
ok
Declaration
public bool ok { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |