iceoryx_introspection 2.0.5
Loading...
Searching...
No Matches
Public Member Functions | Protected Types | Protected Member Functions | Protected Attributes | List of all members
iox::client::introspection::IntrospectionApp Class Referenceabstract

base class for introspection More...

#include <iceoryx_introspection/introspection_app.hpp>

Inheritance diagram for iox::client::introspection::IntrospectionApp:
Inheritance graph
[legend]
Collaboration diagram for iox::client::introspection::IntrospectionApp:
Collaboration graph
[legend]

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]argcforwarding of command line arguments
[in]argvforwarding 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: