ArmarXGuiApp Class Reference

The main ArmarX gui application. More...

#include <ArmarXGui/applications/ArmarXGui/ArmarXGuiApp.h>

+ Inheritance diagram for ArmarXGuiApp:

Public Member Functions

 ArmarXGuiApp (int &argc=ArmarXGuiApp::globalargc, char **argv=NULL)
 Constructs and initialized an ArmarXGuiApp. More...
 
armarx::PropertyDefinitionsPtr createPropertyDefinitions () override
 
int exec (const ArmarXManagerPtr &armarXManager) override
 Runs the Qt Event Loop. More...
 
int run (int argc, char *argv[]) override
 
void setup (const ManagedIceObjectRegistryInterfacePtr &registry, Ice::PropertiesPtr properties) override
 Configures the app, sets Qt up. More...
 
 ~ArmarXGuiApp () override
 
- Public Member Functions inherited from Application
 Application ()
 Application initalizes the Ice::Application base class. More...
 
void enableLibLoading (bool enable=true)
 
const std::vector< std::string > & getCommandLineArguments () const
 
std::vector< std::string > getDefaultPackageNames ()
 getDefaultPackageNames returns the value of the ArmarX.DefaultPackages property It splits the string by , and returns the elements as a vector. More...
 
bool getForbidThreadCreation () const
 
std::string getName () const
 Retrieve name of the application. More...
 
const ThreadPoolPtrgetThreadPool () 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...
 
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< TgetPropertyAsCSV (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
 
- Public Member Functions inherited from Logging
SpamFilterDataPtr deactivateSpam (float deactivationDurationSec=10.0f, const std::string &identifier="", bool deactivate=true) const
 disables the logging for the current line for the given amount of seconds. More...
 
MessageTypeT getEffectiveLoggingLevel () const
 
 Logging ()
 
void setLocalMinimumLoggingLevel (MessageTypeT level)
 With setLocalMinimumLoggingLevel the minimum verbosity-level of log-messages can be set. More...
 
void setTag (const LogTag &tag)
 
void setTag (const std::string &tagName)
 
virtual ~Logging ()
 

Static Public Attributes

static int globalargc = 0
 
- Static Public Attributes inherited from Application
static const std::string ArmarXUserConfigDirEnvVar = "ARMARX_CONFIG_DIR"
 

Additional Inherited Members

- Static Public Member Functions inherited from Application
template<class T >
static ApplicationPtr createInstance ()
 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)
 
- Protected Member Functions inherited from Application
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...
 
- Protected Member Functions inherited from Logging
bool checkLogLevel (MessageTypeT level) const
 
const LogSenderPtrgetLogSender () const
 Retrieve log sender. More...
 
LogSenderPtr loghelper (const char *file, int line, const char *function) const
 
- 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...
 
- Protected Attributes inherited from Logging
MessageTypeT minimumLoggingLevel
 
SpamFilterDataPtr spamFilter
 
LogTag tag
 

Detailed Description

The main ArmarX gui application.

Instantiates an armarx::GuiWindow with the following functionality

  • Gui config saving and loading.
  • Wraps Qt-based plugin mechanism for gui plugin loading.
  • Offers an SoQt examiner viewer for rendering 3d data. One ore multiple sources can be handled.

Definition at line 94 of file ArmarXGuiApp.h.

Constructor & Destructor Documentation

◆ ArmarXGuiApp()

ArmarXGuiApp ( int &  argc = ArmarXGuiApp::globalargc,
char **  argv = NULL 
)

Constructs and initialized an ArmarXGuiApp.

Definition at line 43 of file ArmarXGuiApp.cpp.

◆ ~ArmarXGuiApp()

~ArmarXGuiApp ( )
override

Definition at line 54 of file ArmarXGuiApp.cpp.

Member Function Documentation

◆ createPropertyDefinitions()

armarx::PropertyDefinitionsPtr createPropertyDefinitions ( )
inlineoverridevirtual
See also
PropertyUser::createPropertyDefinitions()

Reimplemented from Application.

Definition at line 122 of file ArmarXGuiApp.h.

◆ exec()

int exec ( const ArmarXManagerPtr armarXManager)
overridevirtual

Runs the Qt Event Loop.

Reimplemented from Application.

Definition at line 86 of file ArmarXGuiApp.cpp.

+ Here is the call graph for this function:

◆ run()

int run ( int  argc,
char *  argv[] 
)
override

Definition at line 64 of file ArmarXGuiApp.cpp.

+ Here is the call graph for this function:

◆ setup()

void setup ( const ManagedIceObjectRegistryInterfacePtr registry,
Ice::PropertiesPtr  properties 
)
overridevirtual

Configures the app, sets Qt up.

Implements Application.

Definition at line 59 of file ArmarXGuiApp.cpp.

Field Documentation

◆ globalargc

int globalargc = 0
static

Definition at line 101 of file ArmarXGuiApp.h.


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