Firmware
Public Member Functions | Protected Attributes | List of all members
uORB::SubscriptionBase Class Reference

Base subscription wrapper class, used in list traversal of various subscriptions. More...

#include <Subscription.hpp>

Inheritance diagram for uORB::SubscriptionBase:
uORB::SubscriptionNode uORB::Subscription< actuator_armed_s > uORB::Subscription< actuator_controls_s > uORB::Subscription< airspeed_s > uORB::Subscription< distance_sensor_s > uORB::Subscription< estimator_status_s > uORB::Subscription< home_position_s > uORB::Subscription< landing_target_pose_s > uORB::Subscription< manual_control_setpoint_s > uORB::Subscription< mission_result_s > uORB::Subscription< obstacle_distance_s > uORB::Subscription< optical_flow_s > uORB::Subscription< parameter_update_s > uORB::Subscription< position_controller_status_s > uORB::Subscription< position_setpoint_triplet_s > uORB::Subscription< sensor_bias_s > uORB::Subscription< sensor_combined_s > uORB::Subscription< vehicle_air_data_s > uORB::Subscription< vehicle_attitude_s > uORB::Subscription< vehicle_attitude_setpoint_s > uORB::Subscription< vehicle_global_position_s > uORB::Subscription< vehicle_gps_position_s > uORB::Subscription< vehicle_land_detected_s > uORB::Subscription< vehicle_local_position_s > uORB::Subscription< vehicle_odometry_s > uORB::Subscription< vehicle_rates_setpoint_s > uORB::Subscription< vehicle_status_s > uORB::Subscription< vehicle_trajectory_waypoint_s > uORB::Subscription< T >

Public Member Functions

 SubscriptionBase (const struct orb_metadata *meta, unsigned interval=0, unsigned instance=0)
 Constructor. More...
 
 SubscriptionBase (const SubscriptionBase &)=delete
 
SubscriptionBaseoperator= (const SubscriptionBase &)=delete
 
 SubscriptionBase (SubscriptionBase &&)=delete
 
SubscriptionBaseoperator= (SubscriptionBase &&)=delete
 
bool updated ()
 Check if there is a new update.
 
bool update (void *data)
 Update the struct. More...
 
int getHandle () const
 
const orb_metadatagetMeta () const
 
unsigned getInstance () const
 

Protected Attributes

const struct orb_metadata_meta
 
unsigned _instance
 
int _handle {-1}
 

Detailed Description

Base subscription wrapper class, used in list traversal of various subscriptions.

Constructor & Destructor Documentation

§ SubscriptionBase()

uORB::SubscriptionBase::SubscriptionBase ( const struct orb_metadata meta,
unsigned  interval = 0,
unsigned  instance = 0 
)

Constructor.

Parameters
metaThe uORB metadata (usually from the ORB_ID() macro) for the topic.
intervalThe minimum interval in milliseconds between updates
instanceThe instance for multi sub.

Member Function Documentation

§ update()

bool uORB::SubscriptionBase::update ( void *  data)

Update the struct.

Parameters
dataThe uORB message struct we are updating.

The documentation for this class was generated from the following files: