Skip to content

iox::client::introspection🔗

Classes🔗

Name
class iox::client::introspection::IceOryxIntrospectionApp
class iox::client::introspection::IntrospectionApp
base class for introspection
struct iox::client::introspection::IntrospectionSelection
struct iox::client::introspection::ComposedPublisherPortData
struct iox::client::introspection::ComposedSubscriberPortData

Types🔗

Name
enum uint8_t ColorPairs { redOnBlack = 1, whiteOnRed}
color pairs for terminal printing
enum PrettyOptions

Attributes🔗

Name
constexpr option longOptions
constexpr const char * shortOptions
constexpr iox::units::Duration MIN_UPDATE_PERIOD
constexpr iox::units::Duration DEFAULT_UPDATE_PERIOD
constexpr iox::units::Duration MAX_UPDATE_PERIOD
const std::map< PrettyOptions, uint32_t > prettyMap
formatting options for terminal printing
constexpr units::Duration WAIT_INTERVAL

Types Documentation🔗

enum ColorPairs🔗

Enumerator Value Description
redOnBlack 1
whiteOnRed

color pairs for terminal printing

enum PrettyOptions🔗

Enumerator Value Description
title
highlight
error
bold
normal

Attributes Documentation🔗

variable longOptions🔗

static constexpr option longOptions = {{"help", no_argument, nullptr, 'h'},
                                         {"version", no_argument, nullptr, 'v'},
                                         {"time", required_argument, nullptr, 't'},
                                         {"mempool", no_argument, nullptr, 0},
                                         {"port", no_argument, nullptr, 0},
                                         {"process", no_argument, nullptr, 0},
                                         {"all", no_argument, nullptr, 0},
                                         {nullptr, 0, nullptr, 0}};

variable shortOptions🔗

static constexpr const char * shortOptions = "hvt:";

variable MIN_UPDATE_PERIOD🔗

static constexpr iox::units::Duration MIN_UPDATE_PERIOD = 500_ms;

variable DEFAULT_UPDATE_PERIOD🔗

static constexpr iox::units::Duration DEFAULT_UPDATE_PERIOD = 1000_ms;

variable MAX_UPDATE_PERIOD🔗

static constexpr iox::units::Duration MAX_UPDATE_PERIOD = 10000_ms;

variable prettyMap🔗

static const std::map< PrettyOptions, uint32_t > prettyMap = {
    {PrettyOptions::title, A_BOLD | COLOR_PAIR(static_cast<uint8_t>(ColorPairs::redOnBlack))},
    {PrettyOptions::highlight, A_BOLD | A_UNDERLINE},
    {PrettyOptions::error, A_BOLD | COLOR_PAIR(static_cast<uint8_t>(ColorPairs::whiteOnRed))},
    {PrettyOptions::bold, A_BOLD},
    {PrettyOptions::normal, A_NORMAL}};

formatting options for terminal printing

variable WAIT_INTERVAL🔗

constexpr units::Duration WAIT_INTERVAL = 10_ms;

Updated on 17 March 2022 at 12:15:57 CET