ILLIXR: Illinois Extended Reality Testbed
Public Member Functions | List of all members
ILLIXR::switchboard::reader< specific_event > Class Template Reference

A handle which can read the latest event on a topic. More...

#include <switchboard.hpp>

Public Member Functions

 reader (topic &topic_)
 
ptr< const specific_event > get_ro_nullable () const noexcept
 Gets a "read-only" copy of the latest value. More...
 
ptr< const specific_event > get_ro () const
 Gets a non-null "read-only" copy of the latest value. More...
 
ptr< specific_event > get_rw () const
 Gets a non-null mutable copy of the latest value. More...
 

Detailed Description

template<typename specific_event>
class ILLIXR::switchboard::reader< specific_event >

A handle which can read the latest event on a topic.

Member Function Documentation

◆ get_ro()

template<typename specific_event >
ptr<const specific_event> ILLIXR::switchboard::reader< specific_event >::get_ro ( ) const
inline

Gets a non-null "read-only" copy of the latest value.

Exceptions
<tt>runtime_error</tt>If no event is on the topic yet.

Otherwise, no event on the topic yet

◆ get_ro_nullable()

template<typename specific_event >
ptr<const specific_event> ILLIXR::switchboard::reader< specific_event >::get_ro_nullable ( ) const
inlinenoexcept

Gets a "read-only" copy of the latest value.

This will return null if no event is on the topic yet.

◆ get_rw()

template<typename specific_event >
ptr<specific_event> ILLIXR::switchboard::reader< specific_event >::get_rw ( ) const
inline

Gets a non-null mutable copy of the latest value.

Exceptions
<tt>runtime_error</tt>If no event is on the topic yet.

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