ScenarioCli Class Reference
#include <ArmarXCore/applications/ScenarioCli/ScenarioCli.h>
Inheritance diagram for ScenarioCli:Public Member Functions | |
| ScenarioCli () | |
| Public Member Functions inherited from Application | |
| Application () | |
| Application initalizes the Ice::Application base class. More... | |
| void | enableLibLoading (bool enable=true) |
| std::vector< std::string > | getArmarXPackageNames () |
| getDefaultPackageNames returns the value of the ArmarX.DefaultPackages property It splits the string by , and returns the elements as a vector. More... | |
| const std::vector< std::string > & | getCommandLineArguments () const |
| bool | getForbidThreadCreation () const |
| std::string | getName () const |
| Retrieve name of the application. More... | |
| const ThreadPoolPtr & | getThreadPool () const |
| void | icePropertiesUpdated (const std::set< std::string > &changedProperties) override |
| This method is called when new Properties are set via setIceProperties(). More... | |
| void | interruptCallback (int signal) override |
| Cleans up connections with IceStorm before terminating the app. More... | |
| bool | isPackageAutoDiscoveryEnabled () |
| void | registerDataPathsFromDependencies (std::string dependencies) |
| int | run (int argc, char *argv[]) override |
| Ice::Application replacement for the main function. More... | |
| void | setForbidThreadCreation (bool value) |
| void | setIceProperties (Ice::PropertiesPtr properties) override |
| Overrides PropertyUser::setIceProperties() which is called internally. More... | |
| void | setName (const std::string &name) |
| Set name of the application. More... | |
| void | storeCommandLineArguments (int argc, char *argv[]) |
| void | updateIceProperties (const Ice::PropertyDict &properties) override |
| Public Member Functions inherited from PropertyUser | |
| std::vector< std::string > | getComponentProxyNames () |
| Ice::PropertiesPtr | getIceProperties () const |
| Returns the set of Ice properties. More... | |
| template<typename PropertyType > | |
| Property< PropertyType > | getProperty (const std::string &name) |
| Property creation and retrieval. More... | |
| template<typename PropertyType > | |
| Property< PropertyType > | getProperty (const std::string &name) const |
Hack to allow using getProperty in const-modified methods. More... | |
| template<class T > | |
| void | getProperty (std::atomic< T > &val, const std::string &name) const |
| template<class T > | |
| void | getProperty (T &val, const std::string &name) const |
| template<class T > | |
| std::vector< T > | getPropertyAsCSV (const std::string &name, const std::string &splitBy=",;", bool trimElements=true, bool removeEmptyElements=true) |
| template<class ContainerT > | |
| void | getPropertyAsCSV (ContainerT &val, const std::string &name, const std::string &splitBy=",;", bool trimElements=true, bool removeEmptyElements=true) |
| PropertyDefinitionsPtr | getPropertyDefinitions () |
| Returns the component's property definition container. More... | |
| std::vector< std::string > | getSubscribedTopicNames () |
| std::vector< std::string > | getTopicProxyNames () |
| bool | hasProperty (const std::string &name) |
| virtual void | injectPropertyDefinitions (PropertyDefinitionsPtr &) |
| Called after createPropertyDefinitions by Component to inject propertes of ComponentPlugin. More... | |
| PropertyUser () | |
| bool | tryAddProperty (const std::string &propertyName, const std::string &value) |
| virtual void | updateIceProperties (const std::map< std::string, std::string > &changes) |
| void | updateProperties () |
| void | updateProxies (IceManagerPtr) |
| ~PropertyUser () override | |
Protected Member Functions | |
| int | exec (const ArmarXManagerPtr &armarXManager) override |
| Exec method is the main process of the application. More... | |
| void | setup (const ManagedIceObjectRegistryInterfacePtr ®istry, Ice::PropertiesPtr properties) override |
| Setup method to be implemented by user applications. More... | |
| Protected Member Functions inherited from Application | |
| PropertyDefinitionsPtr | createPropertyDefinitions () override |
| int | doMain (int argc, char *argv[], const Ice::InitializationData &initData, Ice::Int i) override |
| Ice::Application::doMain() is called by Ice::Application::main() and does setup of Ice::Communicator before calling the virtual Ice::Application::run() method. More... | |
| ArmarXManagerPtr | getArmarXManager () |
| virtual std::string | getDomainName () |
| Retrieve the domain name used for property parsing. More... | |
| void | loadDefaultConfig (int argc, char *argv[], const Ice::InitializationData &initData) |
| void | loadDependentProjectDatapaths () |
| Ice::PropertiesPtr | parseOptionsMergeProperties (int argc, char *argv[]) |
| Parse options given on the commandline and merge them into the regular properties. More... | |
| void | showHelp (ApplicationOptions::Options &options) |
| Print help onto the screen or into a file. More... | |
Additional Inherited Members | |
| Static Public Member Functions inherited from Application | |
| template<class T , typename... Args> | |
| static ApplicationPtr | createInstance (Args &&... args) |
| Creates the one application instance of type T. More... | |
| static std::string | GetArmarXConfigDefaultPath (bool envVarExpanded=true) |
| static Ice::StringSeq | GetDefaultsPaths () |
| static ApplicationPtr | getInstance () |
| Retrieve shared pointer to the application object. More... | |
| static const Ice::StringSeq & | GetProjectDependencies () |
| static const std::string & | GetProjectName () |
| static std::string | GetVersion () |
| static void | LoadDefaultConfig (Ice::PropertiesPtr properties) |
| static void | setInstance (ApplicationPtr const &inst) |
| Static Public Attributes inherited from Application | |
| static const std::string | ArmarXUserConfigDirEnvVar = "ARMARX_CONFIG_DIR" |
| Static Protected Member Functions inherited from Application | |
| static void | HandlerFault (int sig) |
| handlerFault handles signals sendt to the application such as SIGSEGF or SIGABRT (Linux) More... | |
| static void | HandlerInterrupt (int sig) |
| handlerInterrupt handles interrupt signals sent to the application (Linux) More... | |
Detailed Description
Definition at line 34 of file ScenarioCli.h.
Constructor & Destructor Documentation
◆ ScenarioCli()
| ScenarioCli | ( | ) |
Definition at line 47 of file ScenarioCli.cpp.
Member Function Documentation
◆ exec()
|
overrideprotectedvirtual |
Exec method is the main process of the application.
The default implementation only calls
armarXManager->waitForShutdown();
If you need to do something in the main process (e.g. processing QT guis) overwrite this method.
- Returns
- program exit status
Reimplemented from Application.
Definition at line 59 of file ScenarioCli.cpp.
Here is the call graph for this function:◆ setup()
|
overrideprotectedvirtual |
Setup method to be implemented by user applications.
Use this method to add all required ManagedIceObject to the application
- See also
- void ManagedIceObjectRegistryInterfacePtr::addObject(ManagedIceObjectPtr object)
Implements Application.
Definition at line 52 of file ScenarioCli.cpp.
The documentation for this class was generated from the following files:
- ArmarXCore/applications/ScenarioCli/ScenarioCli.h
- ArmarXCore/applications/ScenarioCli/ScenarioCli.cpp
