

Public Member Functions | |
| RFLEX (ConfigFile *cf, int section) | |
| virtual void | Main () |
| Main method for driver thread. More... | |
| virtual int | Subscribe (player_devaddr_t addr) |
| Subscribe to this driver. More... | |
| virtual int | Unsubscribe (player_devaddr_t addr) |
| Unsubscribe from this driver. More... | |
| virtual void | MainQuit () |
| Cleanup method for driver thread (called when main exits) More... | |
| int | ProcessMessage (QueuePointer &resp_queue, player_msghdr *hdr, void *data) |
| Message handler. More... | |
Public Member Functions inherited from ThreadedDriver | |
| ThreadedDriver (ConfigFile *cf, int section, bool overwrite_cmds, size_t queue_maxlen, int interface_) | |
| Constructor with implicit interface. More... | |
| ThreadedDriver (ConfigFile *cf, int section, bool overwrite_cmds=true, size_t queue_maxlen=PLAYER_MSGQUEUE_DEFAULT_MAXLEN) | |
| Constructor for multiple-interface drivers. More... | |
| virtual | ~ThreadedDriver () |
| Destructor. | |
| virtual int | Setup () |
| Initialize the driver. More... | |
| virtual int | Shutdown () |
| Finalize the driver. More... | |
| virtual int | Terminate () |
| Terminate the driver. More... | |
| virtual int | MainSetup (void) |
| Sets up the resources needed by the driver thread. | |
| bool | Wait (double TimeOut=0.0) |
| Wait for new data to arrive on the driver's queue. More... | |
| virtual void | Update () |
| Update non-threaded drivers. More... | |
Public Member Functions inherited from Driver | |
| bool | HasSubscriptions () |
| virtual void | Publish (player_devaddr_t addr, QueuePointer &queue, uint8_t type, uint8_t subtype, void *src=NULL, size_t deprecated=0, double *timestamp=NULL, bool copy=true) |
| Publish a message via one of this driver's interfaces. More... | |
| virtual void | Publish (player_devaddr_t addr, uint8_t type, uint8_t subtype, void *src=NULL, size_t deprecated=0, double *timestamp=NULL, bool copy=true) |
| Publish a message via one of this driver's interfaces. More... | |
| virtual void | Publish (QueuePointer &queue, player_msghdr_t *hdr, void *src, bool copy=true) |
| Publish a message via one of this driver's interfaces. More... | |
| virtual void | Publish (player_msghdr_t *hdr, void *src, bool copy=true) |
| Publish a message via one of this driver's interfaces. More... | |
| Driver (ConfigFile *cf, int section, bool overwrite_cmds, size_t queue_maxlen, int interf) | |
| Constructor for single-interface drivers. More... | |
| Driver (ConfigFile *cf, int section, bool overwrite_cmds=true, size_t queue_maxlen=PLAYER_MSGQUEUE_DEFAULT_MAXLEN) | |
| Constructor for multiple-interface drivers. More... | |
| virtual | ~Driver () |
| Destructor. | |
| int | GetError () |
| Get last error value. More... | |
| virtual int | Subscribe (QueuePointer &, player_devaddr_t) |
| Subscribe to this driver. More... | |
| virtual int | Unsubscribe (QueuePointer &, player_devaddr_t) |
| Unsubscribe from this driver. More... | |
| void | ProcessMessages (int maxmsgs) |
| Process pending messages. More... | |
| void | ProcessMessages (void) |
| Process pending messages. More... | |
| virtual int | ProcessInternalMessages (QueuePointer &resp_queue, player_msghdr *hdr, void *data) |
| Internal message handler. More... | |
| virtual bool | RegisterProperty (const char *key, Property *property, ConfigFile *cf, int section) |
| Property registration. More... | |
| virtual bool | RegisterProperty (Property *property, ConfigFile *cf, int section) |
| Property registration. More... | |
Static Public Attributes | |
| static int | joy_control |
Private Attributes | |
| player_devaddr_t | position_id |
| player_devaddr_t | sonar_id |
| player_devaddr_t | sonar_id_2 |
| player_devaddr_t | ir_id |
| player_devaddr_t | bumper_id |
| player_devaddr_t | power_id |
| player_devaddr_t | aio_id |
| player_devaddr_t | dio_id |
| player_position2d_cmd_vel_t | command |
| int | command_type |
| int | position_subscriptions |
| int | sonar_subscriptions |
| int | ir_subscriptions |
| int | bumper_subscriptions |
| int | rflex_fd |
| char | rflex_serial_port [MAX_FILENAME_SIZE] |
| double | m_odo_x |
| double | m_odo_y |
| double | rad_odo_theta |
Additional Inherited Members | |
Public Attributes inherited from Driver | |
| QueuePointer | ret_queue |
| Last requester's queue. More... | |
| player_devaddr_t | device_addr |
| Default device address (single-interface drivers) | |
| int | entries |
| Total number of entries in the device table using this driver. More... | |
| bool | alwayson |
| Always on flag. More... | |
| QueuePointer | InQueue |
| Queue for all incoming messages for this driver. | |
Protected Member Functions inherited from ThreadedDriver | |
| virtual void | StartThread (void) |
| virtual void | StopThread (void) |
| Cancel (and wait for termination) of the driver thread. More... | |
| void | TestCancel () |
| enable thread cancellation and test for cancellation More... | |
Protected Member Functions inherited from Driver | |
| int | AddInterface (player_devaddr_t addr) |
| Add an interface. More... | |
| int | AddInterface (player_devaddr_t *addr, ConfigFile *cf, int section, int code, const char *key=NULL) |
| Add an interface. More... | |
| void | SetError (int code) |
| Set/reset error code. | |
| int | AddFileWatch (int fd, bool ReadWatch=true, bool WriteWatch=false, bool ExceptWatch=true) |
| Wake up the driver if the specified event occurs on the file descriptor. | |
| int | RemoveFileWatch (int fd, bool ReadWatch=true, bool WriteWatch=false, bool ExceptWatch=true) |
| Remove a previously added watch, call with the same arguments as when adding the watch. | |
| virtual void | Lock (void) |
| Lock access between the server and driver threads. More... | |
| virtual void | Unlock (void) |
| Unlock access to driver internals. More... | |
| virtual void | SubscriptionLock (void) |
| Lock to protect the subscription count for the driver. | |
| virtual void | SubscriptionUnlock (void) |
| Unlock to protect the subscription count for the driver. More... | |
Static Protected Member Functions inherited from ThreadedDriver | |
| static void * | DummyMain (void *driver) |
| Dummy main (just calls real main). More... | |
| static void | DummyMainQuit (void *driver) |
| Dummy main cleanup (just calls real main cleanup). More... | |
Member Function Documentation
◆ Main()
|
virtual |
Main method for driver thread.
drivers have their own thread of execution, created using StartThread(); this is the entry point for the driver thread, and must be overloaded by all threaded drivers.
Implements ThreadedDriver.
References player_devaddr::interf, PLAYER_AIO_DATA_STATE, PLAYER_BUMPER_DATA_STATE, PLAYER_DIO_DATA_VALUES, PLAYER_ERROR, PLAYER_IR_DATA_RANGES, PLAYER_MSG1, PLAYER_MSGTYPE_DATA, PLAYER_POSITION2D_DATA_STATE, PLAYER_POWER_DATA_STATE, PLAYER_POWER_MASK_PERCENT, PLAYER_POWER_MASK_VOLTS, PLAYER_SONAR_DATA_GEOM, PLAYER_SONAR_DATA_RANGES, player_sonar_geom::poses, player_sonar_geom::poses_count, player_ir_pose::poses_count, Driver::ProcessMessages(), Driver::Publish(), player_pose3d::px, player_pose3d::py, player_pose3d::pyaw, and ThreadedDriver::Wait().

◆ MainQuit()
|
virtual |
Cleanup method for driver thread (called when main exits)
Overload this method and to do additional cleanup when the driver thread exits.
Reimplemented from ThreadedDriver.
◆ ProcessMessage()
|
virtual |
Message handler.
This function is called once for each message in the incoming queue. Reimplement it to provide message handling. Return 0 if you handled the message and -1 otherwise
- Parameters
-
resp_queue The queue to which any response should go. hdr The message header data The message body
Reimplemented from Driver.
References player_bumper_geom::bumper_def, player_bumper_geom::bumper_def_count, Message::MatchMessage(), player_pose2d::pa, PLAYER_BUMPER_REQ_GET_GEOM, PLAYER_IR_REQ_POSE, PLAYER_IR_REQ_POWER, PLAYER_MSGTYPE_CMD, PLAYER_MSGTYPE_REQ, PLAYER_MSGTYPE_RESP_ACK, PLAYER_POSITION2D_CMD_VEL, PLAYER_POSITION2D_REQ_GET_GEOM, PLAYER_POSITION2D_REQ_MOTOR_POWER, PLAYER_POSITION2D_REQ_RESET_ODOM, PLAYER_POSITION2D_REQ_SET_ODOM, PLAYER_POSITION2D_REQ_VELOCITY_MODE, PLAYER_SONAR_REQ_GET_GEOM, PLAYER_SONAR_REQ_POWER, player_position2d_set_odom_req::pose, player_sonar_geom::poses, player_sonar_geom::poses_count, Driver::Publish(), player_pose2d::px, player_pose2d::py, ConfigFile::ReadDeviceAddr(), player_position2d_geom::size, player_bbox3d::sl, player_ir_power_req::state, player_msghdr::subtype, player_bbox3d::sw, and ThreadedDriver::ThreadedDriver().

◆ Subscribe()
|
virtual |
Subscribe to this driver.
The Subscribe() and Unsubscribe() methods are used to control subscriptions to the driver; a driver MAY override them, but usually won't.
- Parameters
-
addr Address of the device to subscribe to (the driver may have more than one interface).
- Returns
- Returns 0 on success.
Reimplemented from Driver.
References Driver::Subscribe().

◆ Unsubscribe()
|
virtual |
Unsubscribe from this driver.
The Subscribe() and Unsubscribe() methods are used to control subscriptions to the driver; a driver MAY override them, but usually won't.
- Parameters
-
addr Address of the device to unsubscribe from (the driver may have more than one interface).
- Returns
- Returns 0 on success.
Reimplemented from Driver.
References Driver::Unsubscribe().

The documentation for this class was generated from the following files:
- rflex.h
- rflex.cc

Public Member Functions inherited from 