iox::client::introspection::IntrospectionApp🔗
base class for introspection More...
#include <iceoryx_introspection/introspection_app.hpp>
Inherited by iox::client::introspection::IceOryxIntrospectionApp
Protected Types🔗
Name | |
---|---|
enum | CmdLineArgumentParsingMode |
Public Functions🔗
Name | |
---|---|
IntrospectionApp(int argc, char * argv[]) constructor to create a introspection |
|
virtual | ~IntrospectionApp() |
virtual void | run() =0 interface to start the execution of the introspection |
Protected Functions🔗
Name | |
---|---|
IntrospectionApp() this is needed for the child classes to extend the parseCmdLineArguments function |
|
void | parseCmdLineArguments(int argc, char ** argv, CmdLineArgumentParsingMode cmdLineParsingMode =CmdLineArgumentParsingMode::ALL) |
void | runIntrospection(const iox::units::Duration updatePeriodMs, const IntrospectionSelection introspectionSelection) |
Protected Attributes🔗
Name | |
---|---|
IntrospectionSelection | introspectionSelection |
bool | doIntrospection |
Detailed Description🔗
class iox::client::introspection::IntrospectionApp;
base class for introspection
Todo: Wrap all C calls with posixCall
Protected Types Documentation🔗
enum CmdLineArgumentParsingMode🔗
Enumerator | Value | Description |
---|---|---|
ALL | ||
ONE |
Public Functions Documentation🔗
function IntrospectionApp🔗
IntrospectionApp(
int argc,
char * argv[]
)
constructor to create a introspection
Parameters:
- argc forwarding of command line arguments
- argv forwarding of command line arguments
function ~IntrospectionApp🔗
inline virtual ~IntrospectionApp()
function run🔗
virtual void run() =0
interface to start the execution of the introspection
Reimplemented by: iox::client::introspection::IceOryxIntrospectionApp::run
Protected Functions Documentation🔗
function IntrospectionApp🔗
IntrospectionApp()
this is needed for the child classes to extend the parseCmdLineArguments function
function parseCmdLineArguments🔗
void parseCmdLineArguments(
int argc,
char ** argv,
CmdLineArgumentParsingMode cmdLineParsingMode =CmdLineArgumentParsingMode::ALL
)
function runIntrospection🔗
void runIntrospection(
const iox::units::Duration updatePeriodMs,
const IntrospectionSelection introspectionSelection
)
Protected Attributes Documentation🔗
variable introspectionSelection🔗
IntrospectionSelection introspectionSelection;
variable doIntrospection🔗
bool doIntrospection = false;
Updated on 17 March 2022 at 12:15:57 CET