rmf_adapter
index
/__w/rmf_fleet_adapter_python/rmf_fleet_adapter_python/rmf_ws/install/rmf_fleet_adapter_python/lib/python3.8/site-packages/rmf_adapter.cpython-38-x86_64-linux-gnu.so

 
Modules
       
rmf_adapter.battery
rmf_adapter.easy_traffic_light
rmf_adapter.geometry
rmf_adapter.graph
rmf_adapter.nodes
rmf_adapter.plan
rmf_adapter.schedule
rmf_adapter.type
rmf_adapter.vehicletraits

 
Classes
       
pybind11_builtins.pybind11_object(builtins.object)
Adapter
EasyTrafficLight
FleetUpdateHandle
MockAdapter
Node
NodeOptions
RobotCommandHandle
RobotUpdateHandle
Waypoint

 
class Adapter(pybind11_builtins.pybind11_object)
    
Method resolution order:
Adapter
pybind11_builtins.pybind11_object
builtins.object

Methods defined here:
__init__(self, /, *args, **kwargs)
Initialize self.  See help(type(self)) for accurate signature.
add_easy_traffic_light(...)
add_easy_traffic_light(self: rmf_adapter.Adapter, handle_callback: Callable[[rmf_adapter.EasyTrafficLight], None], fleet_name: str, robot_name: str, traits: rmf_adapter.vehicletraits.VehicleTraits, pause_callback: Callable[[], None], resume_callback: Callable[[], None], blocker_callback: Callable[[List[rmf_fleet_adapter::agv::TrafficLight::CommandHandle::Blocker]], None] = None) -> None
add_fleet(...)
add_fleet(self: rmf_adapter.Adapter, fleet_name: str, traits: rmf_adapter.vehicletraits.VehicleTraits, navigation_graph: rmf_adapter.graph.Graph) -> rmf_adapter.FleetUpdateHandle
now(...)
now(self: rmf_adapter.Adapter) -> datetime.datetime
start(...)
start(self: rmf_adapter.Adapter) -> rmf_adapter.Adapter
stop(...)
stop(self: rmf_adapter.Adapter) -> rmf_adapter.Adapter

Static methods defined here:
make(...) from builtins.PyCapsule
make(node_name: str, node_options: rmf_adapter.NodeOptions = <rmf_adapter.NodeOptions object at 0x7fca6ee65230>, wait_time: Optional[datetime.timedelta] = None) -> rmf_adapter.Adapter

Readonly properties defined here:
node

Static methods inherited from pybind11_builtins.pybind11_object:
__new__(*args, **kwargs) from pybind11_builtins.pybind11_type
Create and return a new object.  See help(type) for accurate signature.

 
class EasyTrafficLight(pybind11_builtins.pybind11_object)
    
Method resolution order:
EasyTrafficLight
pybind11_builtins.pybind11_object
builtins.object

Methods defined here:
__init__(self, /, *args, **kwargs)
Initialize self.  See help(type(self)) for accurate signature.
follow_new_path(...)
follow_new_path(self: rmf_adapter.EasyTrafficLight, waypoint: List[rmf_adapter.Waypoint]) -> None
last_reached(...)
last_reached(self: rmf_adapter.EasyTrafficLight) -> int
moving_from(...)
moving_from(self: rmf_adapter.EasyTrafficLight, checkpoint: int, location: numpy.ndarray[numpy.float64[3, 1]]) -> rmf_fleet_adapter::agv::EasyTrafficLight::MovingInstruction
update_idle_location(...)
update_idle_location(self: rmf_adapter.EasyTrafficLight, map_name: str, position: numpy.ndarray[numpy.float64[3, 1]]) -> rmf_adapter.EasyTrafficLight
waiting_after(...)
waiting_after(self: rmf_adapter.EasyTrafficLight, checkpoint: int, location: numpy.ndarray[numpy.float64[3, 1]]) -> rmf_fleet_adapter::agv::EasyTrafficLight::WaitingInstruction
waiting_at(...)
waiting_at(self: rmf_adapter.EasyTrafficLight, checkpoint: int) -> rmf_fleet_adapter::agv::EasyTrafficLight::WaitingInstruction

Data descriptors defined here:
__dict__

Static methods inherited from pybind11_builtins.pybind11_object:
__new__(*args, **kwargs) from pybind11_builtins.pybind11_type
Create and return a new object.  See help(type) for accurate signature.

 
class FleetUpdateHandle(pybind11_builtins.pybind11_object)
    
Method resolution order:
FleetUpdateHandle
pybind11_builtins.pybind11_object
builtins.object

Methods defined here:
__init__(self, /, *args, **kwargs)
Initialize self.  See help(type(self)) for accurate signature.
accept_delivery_requests(...)
accept_delivery_requests(self: rmf_adapter.FleetUpdateHandle, arg0: Callable[[rmf_adapter.type.CPPDeliveryMsg], bool]) -> rmf_adapter.FleetUpdateHandle
 
NOTE: deprecated, use accept_task_reqeusts() instead
accept_task_requests(...)
accept_task_requests(self: rmf_adapter.FleetUpdateHandle, check: Callable[[rmf_adapter.type.CPPTaskProfileMsg], bool]) -> rmf_adapter.FleetUpdateHandle
 
Provide a callback function which will accept rmf tasks requests
account_for_battery_drain(...)
account_for_battery_drain(self: rmf_adapter.FleetUpdateHandle, value: bool = True) -> bool
add_robot(...)
add_robot(self: rmf_adapter.FleetUpdateHandle, command: rmf_adapter.RobotCommandHandle, name: str, profile: rmf_adapter.vehicletraits.Profile, start: List[rmf_adapter.plan.Start], handle_cb: Callable[[rmf_adapter.RobotUpdateHandle], None]) -> None
fleet_state_publish_period(...)
fleet_state_publish_period(self: rmf_adapter.FleetUpdateHandle, value: Optional[datetime.timedelta]) -> rmf_adapter.FleetUpdateHandle
 
The default value is 1s
set_recharge_threshold(...)
set_recharge_threshold(self: rmf_adapter.FleetUpdateHandle, threshold: float) -> rmf_adapter.FleetUpdateHandle
set_task_planner_params(...)
set_task_planner_params(self: rmf_adapter.FleetUpdateHandle, battery_system: rmf_adapter.battery.BatterySystem, motion_sink: rmf_adapter.battery.SimpleMotionPowerSink, ambient_sink: rmf_adapter.battery.SimpleDevicePowerSink, tool_sink: rmf_adapter.battery.SimpleDevicePowerSink) -> bool

Data descriptors defined here:
default_maximum_delay

Static methods inherited from pybind11_builtins.pybind11_object:
__new__(*args, **kwargs) from pybind11_builtins.pybind11_type
Create and return a new object.  See help(type) for accurate signature.

 
class MockAdapter(pybind11_builtins.pybind11_object)
    
Method resolution order:
MockAdapter
pybind11_builtins.pybind11_object
builtins.object

Methods defined here:
__init__(...)
__init__(self: rmf_adapter.MockAdapter, node_name: str, node_options: rmf_adapter.NodeOptions = <rmf_adapter.NodeOptions object at 0x7fca6ee65770>) -> None
add_fleet(...)
add_fleet(self: rmf_adapter.MockAdapter, fleet_name: str, traits: rmf_adapter.vehicletraits.VehicleTraits, navigation_graph: rmf_adapter.graph.Graph) -> rmf_adapter.FleetUpdateHandle
dispatch_task(...)
dispatch_task(self: rmf_adapter.MockAdapter, arg0: rmf_adapter.type.CPPTaskProfileMsg) -> None
now(...)
now(self: rmf_adapter.MockAdapter) -> datetime.datetime
start(...)
start(self: rmf_adapter.MockAdapter) -> None
stop(...)
stop(self: rmf_adapter.MockAdapter) -> None

Readonly properties defined here:
node

Static methods inherited from pybind11_builtins.pybind11_object:
__new__(*args, **kwargs) from pybind11_builtins.pybind11_type
Create and return a new object.  See help(type) for accurate signature.

 
class Node(pybind11_builtins.pybind11_object)
    
Method resolution order:
Node
pybind11_builtins.pybind11_object
builtins.object

Methods defined here:
__init__(self, /, *args, **kwargs)
Initialize self.  See help(type(self)) for accurate signature.
now(...)
now(self: rmf_adapter.Node) -> datetime.timedelta

Static methods inherited from pybind11_builtins.pybind11_object:
__new__(*args, **kwargs) from pybind11_builtins.pybind11_type
Create and return a new object.  See help(type) for accurate signature.

 
class NodeOptions(pybind11_builtins.pybind11_object)
    
Method resolution order:
NodeOptions
pybind11_builtins.pybind11_object
builtins.object

Methods defined here:
__init__(...)
__init__(self: rmf_adapter.NodeOptions) -> None

Static methods inherited from pybind11_builtins.pybind11_object:
__new__(*args, **kwargs) from pybind11_builtins.pybind11_type
Create and return a new object.  See help(type) for accurate signature.

 
class RobotCommandHandle(pybind11_builtins.pybind11_object)
    
Method resolution order:
RobotCommandHandle
pybind11_builtins.pybind11_object
builtins.object

Methods defined here:
__init__(...)
__init__(self: rmf_adapter.RobotCommandHandle) -> None
dock(...)
dock(self: rmf_adapter.RobotCommandHandle, arg0: str, arg1: Callable[[], None]) -> None
follow_new_path(...)
follow_new_path(self: rmf_adapter.RobotCommandHandle, arg0: List[rmf_adapter.plan.Waypoint], arg1: Callable[[int, datetime.timedelta], None], arg2: Callable[[], None]) -> None
stop(...)
stop(self: rmf_adapter.RobotCommandHandle) -> None

Data descriptors defined here:
__dict__

Static methods inherited from pybind11_builtins.pybind11_object:
__new__(*args, **kwargs) from pybind11_builtins.pybind11_type
Create and return a new object.  See help(type) for accurate signature.

 
class RobotUpdateHandle(pybind11_builtins.pybind11_object)
    
Method resolution order:
RobotUpdateHandle
pybind11_builtins.pybind11_object
builtins.object

Methods defined here:
__init__(self, /, *args, **kwargs)
Initialize self.  See help(type(self)) for accurate signature.
get_unstable_participant(...)
get_unstable_participant(self: rmf_adapter.RobotUpdateHandle) -> rmf_adapter.schedule.Participant
 
Experimental API to access the schedule participant
interrupted(...)
interrupted(self: rmf_adapter.RobotUpdateHandle) -> None
set_charger_waypoint(...)
set_charger_waypoint(self: rmf_adapter.RobotUpdateHandle, charger_wp: int) -> rmf_adapter.RobotUpdateHandle
set_infinite_delay(...)
set_infinite_delay(self: rmf_adapter.RobotUpdateHandle) -> None
update_battery_soc(...)
update_battery_soc(self: rmf_adapter.RobotUpdateHandle, battery_soc: float) -> None
update_current_lanes(...)
update_current_lanes(self: rmf_adapter.RobotUpdateHandle, position: numpy.ndarray[numpy.float64[3, 1]], lanes: List[int]) -> None
update_current_waypoint(...)
update_current_waypoint(self: rmf_adapter.RobotUpdateHandle, waypoint: int, orientation: float) -> None
update_lost_position(...)
update_lost_position(self: rmf_adapter.RobotUpdateHandle, map_name: str, position: numpy.ndarray[numpy.float64[3, 1]], max_merge_waypoint_distance: float = 0.1, max_merge_lane_distance: float = 1.0, min_lane_length: float = 1e-08) -> None
update_off_grid_position(...)
update_off_grid_position(self: rmf_adapter.RobotUpdateHandle, position: numpy.ndarray[numpy.float64[3, 1]], target_waypoint: int) -> None

Data descriptors defined here:
maximum_delay

Static methods inherited from pybind11_builtins.pybind11_object:
__new__(*args, **kwargs) from pybind11_builtins.pybind11_type
Create and return a new object.  See help(type) for accurate signature.

 
class Waypoint(pybind11_builtins.pybind11_object)
    
Method resolution order:
Waypoint
pybind11_builtins.pybind11_object
builtins.object

Methods defined here:
__init__(...)
__init__(self: rmf_adapter.Waypoint, map_name: str, position: numpy.ndarray[numpy.float64[3, 1]], mandatory_delay: datetime.timedelta, yield: bool) -> None

Data descriptors defined here:
mandatory_delay
map_name
position
yield

Static methods inherited from pybind11_builtins.pybind11_object:
__new__(*args, **kwargs) from pybind11_builtins.pybind11_type
Create and return a new object.  See help(type) for accurate signature.

 
Functions
       
init_rclcpp(...) method of builtins.PyCapsule instance
init_rclcpp() -> None
spin_rclcpp(...) method of builtins.PyCapsule instance
spin_rclcpp(arg0: rmf_adapter.Node) -> None
spin_some_rclcpp(...) method of builtins.PyCapsule instance
spin_some_rclcpp(arg0: rmf_adapter.Node) -> None
test_clone_ptr(...) method of builtins.PyCapsule instance
test_clone_ptr(arg0: rmf_adapter.graph.OrientationConstraintPtr, arg1: numpy.ndarray[numpy.float64[3, 1]], arg2: numpy.ndarray[numpy.float64[2, 1]]) -> bool
 
Test a clone_ptr<rmf_traffic::agv::Graph::OrientationConstraint> by testing its get() method
test_lambda(...) method of builtins.PyCapsule instance
test_lambda(arg0: Callable[[], None]) -> None
 
Call a C++ lambda function created in Python.
test_shared_ptr(...) method of builtins.PyCapsule instance
test_shared_ptr(handle: rmf_fleet_adapter::agv::RobotCommandHandle, print_str: str = 'DUMMY_DOCK_NAME', docking_finished_callback: Callable[[], None] = <built-in method  of PyCapsule object at 0x7fca6ee4dcc0>) -> None
 
Test a shared_ptr<agv::RobotCommandHandle> by testing its dock() method