iox::client::introspection::IntrospectionApp Class Reference

base class for introspection More...

#include <iceoryx_introspection/introspection_app.hpp>

Inheritance diagram for iox::client::introspection::IntrospectionApp:

Collaboration diagram for iox::client::introspection::IntrospectionApp:

Public Member Functions
	IntrospectionApp (int argc, char *argv[]) noexcept
	constructor to create a introspection
virtual void	run () noexcept=0
	interface to start the execution of the introspection

Protected Types
enum class	CmdLineArgumentParsingMode { ALL , ONE }

Protected Member Functions
	IntrospectionApp () noexcept
	this is needed for the child classes to extend the parseCmdLineArguments function
void	parseCmdLineArguments (int argc, char **argv, CmdLineArgumentParsingMode cmdLineParsingMode=CmdLineArgumentParsingMode::ALL) noexcept
void	runIntrospection (const iox::units::Duration updatePeriodMs, const IntrospectionSelection introspectionSelection)

Protected Attributes
IntrospectionSelection	introspectionSelection
bool	doIntrospection = false

Detailed Description

base class for introspection

Todo:

Wrap all C calls with posixCall

Constructor & Destructor Documentation

IntrospectionApp()

iox::client::introspection::IntrospectionApp::IntrospectionApp ( int  argc, char *  argv[]  )

noexcept

constructor to create a introspection

Parameters

[in]	argc	forwarding of command line arguments
[in]	argv	forwarding of command line arguments

Member Function Documentation

run()

virtual void iox::client::introspection::IntrospectionApp::run ( )

pure virtualnoexcept

interface to start the execution of the introspection

Implemented in iox::client::introspection::IceOryxIntrospectionApp.

---

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

• iceoryx_introspection/introspection_app.hpp