Class ILLIXR::oxr_relay
ClassList > ILLIXR > oxr_relay
#include <oxr_relay.hpp>
Inherits the following classes: ILLIXR::threadloop
Public Functions
| Type | Name |
|---|---|
| bool | get_pose_history (uint64_t id, pose_history_entry & out_entry) const |
| oxr_relay (const std::string & name, phonebook * pb) |
|
| ~oxr_relay () override |
Public Functions inherited from ILLIXR::threadloop
| Type | Name |
|---|---|
| virtual void | internal_stop () Stops the thread. |
| virtual void | start () override Starts the thread. |
| virtual void | stop () override Joins the thread. |
| threadloop (const std::string & name, phonebook * pb) |
|
| ~threadloop () override |
Public Functions inherited from ILLIXR::plugin
See ILLIXR::plugin
| Type | Name |
|---|---|
| std::string | get_name () noexcept const |
| plugin (std::string name, phonebook * pb) |
|
| void | spd_add_file_sink (const std::string & file_name, const std::string & extension, const std::string & log_level) |
| auto | spdlogger (const char * log_level) |
| virtual void | start () A method which Spindle calls when it starts the component. |
| virtual void | stop () A method which Spindle calls when it stops the component. |
| virtual | ~plugin () = default |
Protected Types inherited from ILLIXR::threadloop
| Type | Name |
|---|---|
| enum | skip_option |
Protected Attributes inherited from ILLIXR::threadloop
| Type | Name |
|---|---|
| std::size_t | iteration_no = 0 |
| std::size_t | skip_no = 0 |
Protected Attributes inherited from ILLIXR::plugin
See ILLIXR::plugin
| Type | Name |
|---|---|
| const std::size_t | id_ |
| std::string | name_ |
| const phonebook * | phonebook_ |
| std::shared_ptr< spdlog::logger > | plugin_logger_ |
| const std::shared_ptr< record_logger > | record_logger_ |
Protected Functions
| Type | Name |
|---|---|
| virtual void | _p_one_iteration () override Override with the computation the thread does every loop. |
| virtual skip_option | _p_should_skip () override Gets called in a tight loop, to gate the invocation of _p_one_iteration() __ |
Protected Functions inherited from ILLIXR::threadloop
| Type | Name |
|---|---|
| virtual void | _p_one_iteration () = 0 Override with the computation the thread does every loop. |
| virtual skip_option | _p_should_skip () Gets called in a tight loop, to gate the invocation of _p_one_iteration() __ |
| virtual void | _p_thread_setup () Gets called at setup time, from the new thread. |
| bool | should_terminate () Whether the thread has been asked to terminate. |
Public Functions Documentation
function get_pose_history
bool ILLIXR::oxr_relay::get_pose_history (
uint64_t id,
pose_history_entry & out_entry
) const
Look up a pose history entry by combined_pose id. Returns true and populates out_entry if found, false otherwise. Thread-safe.
function oxr_relay
ILLIXR::oxr_relay::oxr_relay (
const std::string & name,
phonebook * pb
)
function ~oxr_relay
ILLIXR::oxr_relay::~oxr_relay () override
Protected Functions Documentation
function _p_one_iteration
Override with the computation the thread does every loop.
virtual void ILLIXR::oxr_relay::_p_one_iteration () override
This gets called in rapid succession.
Implements ILLIXR::threadloop::_p_one_iteration
function _p_should_skip
Gets called in a tight loop, to gate the invocation of _p_one_iteration() __
virtual skip_option ILLIXR::oxr_relay::_p_should_skip () override
Implements ILLIXR::threadloop::_p_should_skip
The documentation for this class was generated from the following file /home/friedel/devel/ILLIXR/illixr_release/ILLIXR/plugins/openxr_interface/oxr_relay.hpp