Firmware
Public Member Functions | List of all members
uORB::SubscriptionNode Class Referenceabstract

The subscription base class as a list node. More...

#include <Subscription.hpp>

Inheritance diagram for uORB::SubscriptionNode:
uORB::SubscriptionBase ListNode< 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

 SubscriptionNode (const struct orb_metadata *meta, unsigned interval=0, unsigned instance=0, List< SubscriptionNode *> *list=nullptr)
 Constructor. More...
 
virtual bool update ()=0
 This function is the callback for list traversal updates, a child class must implement it.
 
virtual bool forcedUpdate ()=0
 Like update(), but does not check first if there is data available.
 
- Public Member Functions inherited from uORB::SubscriptionBase
 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
 
- Public Member Functions inherited from ListNode< SubscriptionNode *>
void setSibling (SubscriptionNode * sibling)
 
const SubscriptionNode * getSibling () const
 

Additional Inherited Members

- Protected Attributes inherited from uORB::SubscriptionBase
const struct orb_metadata_meta
 
unsigned _instance
 
int _handle {-1}
 
- Protected Attributes inherited from ListNode< SubscriptionNode *>
SubscriptionNode * _sibling
 

Detailed Description

The subscription base class as a list node.

Constructor & Destructor Documentation

§ SubscriptionNode()

uORB::SubscriptionNode::SubscriptionNode ( const struct orb_metadata meta,
unsigned  interval = 0,
unsigned  instance = 0,
List< SubscriptionNode *> *  list = nullptr 
)

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.
listA pointer to a list of subscriptions that this should be appended to.

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