This namespace contains all relevent methods to parse and print options and propertiesas used by the armarx::Application. More...
Classes | |
| struct | Options |
| Stucture containing the parsed options of the application. More... | |
Enumerations | |
| enum | OptionsFormat { eHelpBrief, eOptionsDetailed, eDoxygen, eDoxygenComponentPages, eConfig, eXml } |
| Help format to display. More... | |
Functions | |
| PropertyUserList | getPropertyUsers (ArmarXDummyManagerPtr dummyManager) |
| Return the list of property users. More... | |
| Ice::PropertiesPtr | mergeProperties (Ice::PropertiesPtr properties, int argc, char *argv[]) |
| Merge command line options into properties. More... | |
| Options | parseHelpOptions (Ice::PropertiesPtr properties, int argc, char *argv[]) |
| Parse the help options. More... | |
| void | showHelp (ApplicationPtr application, ArmarXDummyManagerPtr dummyManager, Options options, Ice::PropertiesPtr properties, std::ostream &out=std::cout) |
| Prints help according to the format selection in options. More... | |
Detailed Description
This namespace contains all relevent methods to parse and print options and propertiesas used by the armarx::Application.
Function Documentation
◆ getPropertyUsers()
| PropertyUserList getPropertyUsers | ( | ArmarXDummyManagerPtr | dummyManager | ) |
Return the list of property users.
In this case all components are property users stored in the ComponentManager.
- Returns
- PropertyUser List
Definition at line 291 of file ApplicationOptions.cpp.
Here is the caller graph for this function:◆ mergeProperties()
| Ice::PropertiesPtr mergeProperties | ( | Ice::PropertiesPtr | properties, |
| int | argc, | ||
| char * | argv[] | ||
| ) |
Merge command line options into properties.
Command line options override already set properties.
- Parameters
-
properties initialized properties object (see Ice::createProperties()) argc number of command line arguments argv command line arguments
- Returns
- merged properties
Definition at line 63 of file ApplicationOptions.cpp.
Here is the caller graph for this function:◆ parseHelpOptions()
| ApplicationOptions::Options parseHelpOptions | ( | Ice::PropertiesPtr | properties, |
| int | argc, | ||
| char * | argv[] | ||
| ) |
Parse the help options.
- Parameters
-
properties properties object from Application argc number of command line arguments argv command line arguments
- Returns
- the parsed options structure
Definition at line 73 of file ApplicationOptions.cpp.
Here is the call graph for this function: Here is the caller graph for this function:◆ showHelp()
| void showHelp | ( | ApplicationPtr | application, |
| ArmarXDummyManagerPtr | dummyManager, | ||
| ApplicationOptions::Options | options, | ||
| Ice::PropertiesPtr | properties, | ||
| std::ostream & | out = std::cout |
||
| ) |
Prints help according to the format selection in options.
- Parameters
-
application pointer to application in order to display application properties dummyManager pointer to dummyManager in order to display properties of add ManagedIceObjects options the parsed help options out optional output stream (default: std::cout)
Definition at line 187 of file ApplicationOptions.cpp.
Here is the call graph for this function: Here is the caller graph for this function: