Skip to content

Class ILLIXR::switchboard::reader

template <typename specific_event>

ClassList > ILLIXR > switchboard > reader

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

  • #include <switchboard.hpp>

Public Functions

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

Public Functions Documentation

function get_ro

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

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

Exception:

  • runtime_error If no event is on the topic yet.

function get_ro_nullable

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

inline ptr < const specific_event > ILLIXR::switchboard::reader::get_ro_nullable () noexcept const

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

function get_rw

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

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

Exception:

  • runtime_error If no event is on the topic yet.

function reader

inline ILLIXR::switchboard::reader::reader (
    topic & topic_
)

The documentation for this class was generated from the following file include/illixr/switchboard.hpp