The API manager is used to manage the global objects required for this API to work. More...

#include "AppBase.h"

Inheritance diagram for AppBase:

Public Types
enum class	ViewHandlingConfig : uint32_t { NoConfig = 0 << 0 , SkipEntitySelection = 1 << 0 }

enum	StartOption { LogExport }

typedef ot::Flags< ViewHandlingConfig >	ViewHandlingFlags

Public Types inherited from otoolkit::APIInterface
enum	InterfaceLogType { Information , Warning , Error }

Public Slots
void	lockUI (bool flag)

void	refreshWelcomeScreen (void)

void	lockSelectionAndModification (bool flag)

void	setProgressBarVisibility (const char *progressMessage, bool progressBaseVisible, bool continuous)
	Will turn on or off the progress bar visibility and set the progress message.

void	setProgressBarValue (int progressPercentage)
	Will set the percentage of the progress bar.

void	showInfoPrompt (const std::string &_message, const std::string &_title)

void	showWarningPrompt (const std::string &_message, const std::string &_title)

void	showErrorPrompt (const std::string &_message, const std::string &_title)

void	slotGraphicsItemRequested (const QString &_name, const QPointF &_pos)

void	slotGraphicsItemChanged (const ot::GraphicsItemCfg *_newConfig)

void	slotGraphicsConnectionRequested (const ot::UID &_fromUid, const std::string &_fromConnector, const ot::UID &_toUid, const std::string &_toConnector)

void	slotGraphicsConnectionToConnectionRequested (const ot::UID &_fromItemUid, const std::string &_fromItemConnector, const ot::UID &_toConnectionUid, const ot::Point2DD &_newControlPoint)

void	slotGraphicsSelectionChanged (void)

void	slotGraphicsRemoveItemsRequested (const ot::UIDList &_items, const std::list< std::string > &_connections)

void	slotCopyRequested (const ot::CopyInformation *_info)

void	slotTextEditorSaveRequested (void)

void	slotTableSaveRequested (void)

void	slotProcessMessage (const QString &_json)

Public Member Functions
virtual void	log (const ot::LogMessage &_message) override
	Called when the a log message was created.

void	updateBufferSizeFromLogFlags (const ot::LogFlags &_flags)

virtual	~AppBase ()
	Deconstructor.

bool	initialize ()
	Will initialize the API Returns: 0: OK -1: Was already initialized 1: Exception catched 2: Non exception catched 3: Log-in failed.

bool	logIn (void)

bool	isInitialized (void) const
	Returns true if the API was initialized.

std::shared_ptr< QSettings >	createSettingsInstance (void) const

void	setUiServiceUID (ak::UID _uid)

ak::UID	getUiServiceUID (void) const

void	setViewerUID (ak::UID _uid)

ak::UID	getViewerUID (void) const

void	setModelUID (ak::UID _uid)

ak::UID	getModelUID (void) const

ViewerComponent *	getViewerComponent (void) const

ExternalServicesComponent *	getExternalServicesComponent (void) const

void	setCurrentProjectIsModified (bool _isModified=true)
	Will set the current project as modified and apply UI changes.

bool	getCurrentProjectIsModified (void) const
	Will get the current project as modified state.

const LoginData &	getCurrentLoginData (void) const
	Will return the current username.

std::string	getCurrentUserCollection (void) const
	Will return the current username.

ak::aWindow *	mainWindow (void)

ControlsManager *	controlsManager (void)

LockManager *	lockManager (void)

virtual void	log (const ot::LogMessage &_message) override
	Called when the a log message was created.

virtual void	notify (ak::UID _senderId, ak::eventType _eventType, int _info1, int _info2) override
	Will call the callback function with the provided parameters.

virtual bool	closeEvent (void) override
	This function will be called by the window when the closeEvent occurs If the return value is true the closeEvent will be acceptet otherwise ignored.

bool	createNewProjectInDatabase (const QString &_projectName, const QString &_projectType)

void	initializeDefaultUserSettings (void)

void	frontendSettingsChanged (const ot::Property *_property)

void	viewerSettingsChanged (const ot::Property *_property)

void	settingsChanged (const std::string &_owner, const ot::Property *_property)

void	setWaitingAnimationVisible (bool flag)

void	createUi (void)

void	setDebug (bool)

bool	debug (void) const

void	registerSession (const std::string &_projectName, const std::string &_collectionName)

ModelUIDtype	createModel ()

ViewerUIDtype	createView (ModelUIDtype _modelUID, const std::string &_projectName)

void	setCurrentVisualizationTabFromEntityName (const std::string &_entityName, ot::WidgetViewBase::ViewType _viewType)

void	setCurrentVisualizationTabFromTitle (const std::string &_tabTitle)

std::string	getCurrentVisualizationTabTitle (void)

void	importProject (void)

void	manageGroups (void)

void	exportLogs (void)

void	setSiteID (int _id)
	Will set the current site ID.

void	setServiceURL (const std::string &_url)
	Will set the current Service URL of this service.

void	setSessionServiceURL (const std::string &_url)
	Will set the session service URL.

void	SetCollectionName (const std::string _collectionName)

void	startSessionRefreshTimer (void)

void	setViewHandlingConfigFlag (ViewHandlingConfig _flag, bool _active=true)

void	setViewHandlingConfigFlags (const ViewHandlingFlags &_flags)

const ViewHandlingFlags &	getViewHandlingConfigFlags (void) const

int	getSiteID (void) const
	Will return the current site ID.

ak::UID	uiUID (void) const

void	setRelayURLs (const std::string &)
	Will set the Relay URLs.

std::string	getRelayURLs (void) const
	Will return the current Relay URLs.

const std::string &	getServiceURL (void) const
	Will return the current Service URL.

const std::string &	getSessionServiceURL (void) const
	Will return the session service URL.

const std::string &	getCurrentProjectName (void) const
	Will return the current project name.

const std::string &	getCurrentProjectType (void) const

void	setCurrentProjectName (const std::string &_name)
	Will set the name of the currently active project.

void	setCurrentProjectType (const std::string &_type)

std::string	getCollectionName () const

void	switchToViewMenuTab (void)

void	switchToMenuTab (const std::string &_menu)

std::string	getCurrentMenuTab (void)

void	closeAllViewerTabs (void)

void	clearSessionInformation (void)
	Will clear the session information such as the project name, collection name and user name.

void	restoreSessionState (void)

void	storeSessionState (void)

bool	storeSettingToDataBase (const ot::PropertyGridCfg &_config, const std::string &_subKey)

ot::PropertyGridCfg	getSettingsFromDataBase (const std::string &_subKey)

void	updateLogIntensityInfo (void)

const QIcon &	getDefaultProjectTypeIcon (void) const

const std::map< std::string, std::string > &	getProjectTypeDefaultIconNameMap (void) const

const std::map< std::string, std::string > &	getProjectTypeCustomIconNameMap (void) const

QString	availableTabText (const QString &_initialTabText)

ToolBar *	getToolBar (void) const

void	setTabToolBarTabOrder (const QStringList &_lst)

void	activateToolBarTab (const QString &_tab)

void	setNavigationTreeSortingEnabled (bool _enabled)

void	setNavigationTreeMultiselectionEnabled (bool _enabled)

void	clearNavigationTree (void)

ak::ID	addNavigationTreeItem (const QString &_treePath, char _delimiter, bool _isEditable, bool selectChildren)

void	setNavigationTreeItemIcon (ak::ID _itemID, const QString &_iconName, const QString &_iconDefaultPath)

void	setNavigationTreeItemText (ak::ID _itemID, const QString &_itemName)

void	setNavigationTreeItemSelected (ak::ID _itemID, bool _isSelected)

void	setSingleNavigationTreeItemSelected (ak::ID _itemID, bool _isSelected)

void	expandSingleNavigationTreeItem (ak::ID _itemID, bool _isExpanded)

bool	isTreeItemExpanded (ak::ID _itemID)

void	toggleNavigationTreeItemSelection (ak::ID _itemID, bool _considerChilds)

void	removeNavigationTreeItems (const std::vector< ak::ID > &itemIds)

void	clearNavigationTreeSelection (void)

void	setupPropertyGrid (const ot::PropertyGridCfg &_configuration)

void	focusPropertyGridItem (const std::string &_group, const std::string &_name)

QString	getNavigationTreeItemText (ak::ID _itemID)

std::vector< int >	getSelectedNavigationTreeItems (void)

void	setVisible3D (bool visible3D)

void	setVisible1D (bool visible1D)

void	setVisibleBlockPicker (bool visibleBlockPicker)

bool	getVisible3D ()

bool	getVisible1D ()

bool	getVisibleBlockPicker ()

void	replaceInfoMessage (const QString &_message)

void	appendInfoMessage (const QString &_message)

void	appendHtmlInfoMessage (const QString &_html)

ot::VersionGraphManagerView *	getVersionGraph (void)

ot::PropertyGridItem *	findProperty (const std::string &_groupName, const std::string &_itemName)

ot::PropertyGridItem *	findProperty (const std::list< std::string > &_groupPath, const std::string &_itemName)

std::string	getPropertyType (const std::string &_groupName, const std::string &_itemName)

bool	getPropertyIsDeletable (const std::string &_groupName, const std::string &_itemName)

ShortcutManager *	shortcutManager (void)

void	clearPropertyGrid (void)

void	lockPropertyGrid (bool flag)

void	addGraphicsPickerPackage (const ot::GraphicsPickerCollectionPackage &_pckg, const ot::BasicServiceInformation &_serviceInfo)

void	clearGraphicsPickerData (void)
	Clears the graphics picker and stored service picker data.

ot::GraphicsViewView *	createNewGraphicsEditor (const std::string &_entityName, const QString &_title, ot::BasicServiceInformation _serviceInfo, const ot::WidgetView::InsertFlags &_viewInsertFlags)

ot::GraphicsViewView *	findGraphicsEditor (const std::string &_entityName)

ot::GraphicsViewView *	findOrCreateGraphicsEditor (const std::string &_entityName, const QString &_title, const ot::BasicServiceInformation &_serviceInfo, const ot::WidgetView::InsertFlags &_viewInsertFlags)

std::list< ot::GraphicsViewView * >	getAllGraphicsEditors (void)

ot::TextEditorView *	createNewTextEditor (const ot::TextEditorCfg &_config, const ot::BasicServiceInformation &_serviceInfo, const ot::WidgetView::InsertFlags &_viewInsertFlags)

ot::TextEditorView *	findTextEditor (const std::string &_entityName)

ot::TextEditorView *	findOrCreateTextEditor (const ot::TextEditorCfg &_config, const ot::BasicServiceInformation &_serviceInfo, const ot::WidgetView::InsertFlags &_viewInsertFlags)

void	closeTextEditor (const std::string &_entityName)

void	closeAllTextEditors (const ot::BasicServiceInformation &_serviceInfo)

ot::TableView *	createNewTable (const ot::TableCfg &_config, const ot::BasicServiceInformation &_serviceInfo, const ot::WidgetView::InsertFlags &_viewInsertFlags)

ot::TableView *	findTable (const std::string &_entityName)

ot::TableView *	findOrCreateTable (const ot::TableCfg &_config, const ot::BasicServiceInformation &_serviceInfo, const ot::WidgetView::InsertFlags &_viewInsertFlags)

void	closeTable (const std::string &_name)

virtual ot::MessageDialogCfg::BasicButton	showPrompt (const ot::MessageDialogCfg &_config) override

ot::MessageDialogCfg::BasicButton	showPrompt (const std::string &_message, const std::string &_title, ot::MessageDialogCfg::BasicIcon _icon, const ot::MessageDialogCfg::BasicButtons &_buttons)

void	destroyObjects (const std::vector< ak::UID > &_objects)

void	makeWidgetViewCurrentWithoutInputFocus (ot::WidgetView *_view, bool _ignoreEntitySelect)

virtual void	log (const ot::LogMessage &_message) override
	Called when the a log message was created.

virtual void	log (const QString &_sender, InterfaceLogType _type, const QString &_message) override

virtual bool	addTool (otoolkit::Tool *_tool) override

virtual void	updateStatusString (const QString &_statusText) override

virtual void	updateStatusStringAsError (const QString &_statusText) override

virtual void	registerToolActivityNotifier (otoolkit::ToolActivityNotifier *_notifier) override

virtual void	removeToolActivityNotifier (otoolkit::ToolActivityNotifier *_notifier) override

virtual otoolkit::SettingsRef	createSettingsInstance (void) override

virtual const QWidget *	rootWidget (void) const override

virtual void	closeEvent (QCloseEvent *_event) override

void	setUrl (const QString &_url)

const QString &	url (void) const

void	parseStartArgs (const std::string &_args)

void	setApplicationInstance (QApplication *_app)

QApplication *	applicationInstance (void)

void	setUpdateTransparentColorStyleValueEnabled (bool _enabled)

bool	getUpdateTransparentColorStyleValueEnabled (void) const

void	updateTransparentColorStyleValue (void)

Public Member Functions inherited from ot::ServiceBase
	ServiceBase ()
	Constructor.

	ServiceBase (const std::string &_name, const std::string &_type)
	Constructor.

	ServiceBase (const std::string &_name, const std::string &_type, const std::string &_url, serviceID_t _id, const std::string &_siteId=std::string())
	Constructor.

	ServiceBase (const ServiceBase &_other)
	Copy constructor.

ServiceBase &	operator= (const ServiceBase &_other)

bool	operator== (const ServiceBase &_other) const

bool	operator!= (const ServiceBase &_other) const

virtual	~ServiceBase ()
	Deconstructor.

void	setServiceID (serviceID_t _id)
	Set the service ID.

void	setServiceURL (const std::string &_url)
	Set the service URL.

void	setServiceName (const std::string &_name)
	Set the service name.

void	setServiceType (const std::string &_type)
	Set the service type.

void	setSiteId (const std::string &_id)
	Set the site ID.

void	setSessionCount (int _count)
	Set the session count.

serviceID_t	getServiceID (void) const
	Return the service ID.

int	getServiceIDAsInt (void) const
	Return the service ID as an Integer (The service ID is an Integer stored as a String)

int	getSessionCount (void) const
	Return the session count.

const std::string &	getServiceURL (void) const
	Return the service URL.

std::string	getServiceName (void) const
	Return the service name.

std::string	getServiceType (void) const
	Return the service type.

std::string	getSiteId (void) const
	Return the site ID.

BasicServiceInformation	getBasicServiceInformation (void) const

Public Member Functions inherited from ot::ActionHandler
	ActionHandler ()

	ActionHandler (const ActionHandler &_other)=default

	ActionHandler (ActionHandler &&_other)=default

virtual	~ActionHandler ()

ActionHandler &	operator= (const ActionHandler &_other)=default

ActionHandler &	operator= (ActionHandler &&_other)=default

Public Member Functions inherited from ot::AbstractLogNotifier
	AbstractLogNotifier ()

virtual	~AbstractLogNotifier ()

void	setDeleteLogNotifierLater (bool _deleteLater=true)
	Will set the delete later flag. If delete later is set, the creator keeps ownership of this object even after it is added to the LogDispatcher.

bool	getDeleteLogNotifierLater (void) const
	Returns true if the delete later mode is set.

Public Member Functions inherited from ak::aWindowEventHandler
	aWindowEventHandler ()

virtual	~aWindowEventHandler ()

Public Member Functions inherited from ak::aNotifier
	aNotifier ()
	Will initialize the notifier.

virtual	~aNotifier ()
	Destructor.

void	enable (void)
	Will enable this notifier.

void	disable (void)
	Will disable this notifier.

bool	isEnabled (void) const
	Will return true if this notifier is enabled.

Public Member Functions inherited from ot::MessageBoxHandler
	MessageBoxHandler ()

virtual	~MessageBoxHandler ()

Static Public Member Functions
static AppBase &	instance (void)

static AppBase *	instance (void)

static AppBase *	instance (QApplication _app=(QApplication ) nullptr)

Private Member Functions
virtual	~AppBase ()

Friends
class	ToolBar

class	KeyboardCommandHandler

Additional Inherited Members
Protected Member Functions inherited from otoolkit::APIInterface
	APIInterface ()

virtual	~APIInterface ()

Protected Attributes inherited from ot::ServiceBase
serviceID_t	m_serviceID

std::string	m_serviceURL
	Service ID.

std::string	m_serviceName
	Service URL.

std::string	m_serviceType
	Service name.

std::string	m_siteId
	Service type.

int	m_sessionCount
	Site ID.

Protected Attributes inherited from ak::aNotifier
bool	m_isEnabled

Detailed Description

The API manager is used to manage the global objects required for this API to work.

Member Typedef Documentation

◆ ViewHandlingFlags

typedef ot::Flags<ViewHandlingConfig> AppBase::ViewHandlingFlags

Member Enumeration Documentation

◆ StartOption

enum AppBase::StartOption

Enumerator
LogExport

◆ ViewHandlingConfig

enum class AppBase::ViewHandlingConfig : uint32_t

strong

Enumerator
NoConfig
SkipEntitySelection	Default view handling.

Constructor & Destructor Documentation

◆ ~AppBase()

virtual AppBase::~AppBase ( )

virtual

Deconstructor.

Member Function Documentation

◆ activateToolBarTab()

void AppBase::activateToolBarTab ( const QString & _tab )

◆ addGraphicsPickerPackage()

void AppBase::addGraphicsPickerPackage	(	const ot::GraphicsPickerCollectionPackage &	_pckg,
		const ot::BasicServiceInformation &	_serviceInfo )

◆ addNavigationTreeItem()

ID AppBase::addNavigationTreeItem	(	const QString &	_treePath,
		char	_delimiter,
		bool	_isEditable,
		bool	selectChildren )

◆ addTool()

bool AppBase::addTool ( otoolkit::Tool * _tool )

overridevirtual

Implements otoolkit::APIInterface.

◆ appendHtmlInfoMessage()

void AppBase::appendHtmlInfoMessage ( const QString & _html )

◆ appendInfoMessage()

void AppBase::appendInfoMessage ( const QString & _message )

◆ applicationInstance()

QApplication * AppBase::applicationInstance ( void )

inline

◆ availableTabText()

QString AppBase::availableTabText ( const QString & _initialTabText )

◆ clearGraphicsPickerData()

void AppBase::clearGraphicsPickerData ( void )

Clears the graphics picker and stored service picker data.

◆ clearNavigationTree()

void AppBase::clearNavigationTree ( void )

◆ clearNavigationTreeSelection()

void AppBase::clearNavigationTreeSelection ( void )

◆ clearPropertyGrid()

void AppBase::clearPropertyGrid ( void )

◆ clearSessionInformation()

void AppBase::clearSessionInformation ( void )

Will clear the session information such as the project name, collection name and user name.

◆ closeAllTextEditors()

void AppBase::closeAllTextEditors ( const ot::BasicServiceInformation & _serviceInfo )

◆ closeAllViewerTabs()

void AppBase::closeAllViewerTabs ( void )

◆ closeEvent() [1/2]

void AppBase::closeEvent ( QCloseEvent * _event )

overridevirtual

◆ closeEvent() [2/2]

bool AppBase::closeEvent ( void )

overridevirtual

This function will be called by the window when the closeEvent occurs If the return value is true the closeEvent will be acceptet otherwise ignored.

Reimplemented from ak::aWindowEventHandler.

◆ closeTable()

void AppBase::closeTable ( const std::string & _name )

◆ closeTextEditor()

void AppBase::closeTextEditor ( const std::string & _entityName )

◆ controlsManager()

ControlsManager * AppBase::controlsManager ( void )

◆ createModel()

ModelUIDtype AppBase::createModel ( )

◆ createNewGraphicsEditor()

ot::GraphicsViewView * AppBase::createNewGraphicsEditor	(	const std::string &	_entityName,
		const QString &	_title,
		ot::BasicServiceInformation	_serviceInfo,
		const ot::WidgetView::InsertFlags &	_viewInsertFlags )

◆ createNewProjectInDatabase()

bool AppBase::createNewProjectInDatabase	(	const QString &	_projectName,
		const QString &	_projectType )

◆ createNewTable()

ot::TableView * AppBase::createNewTable	(	const ot::TableCfg &	_config,
		const ot::BasicServiceInformation &	_serviceInfo,
		const ot::WidgetView::InsertFlags &	_viewInsertFlags )

◆ createNewTextEditor()

ot::TextEditorView * AppBase::createNewTextEditor	(	const ot::TextEditorCfg &	_config,
		const ot::BasicServiceInformation &	_serviceInfo,
		const ot::WidgetView::InsertFlags &	_viewInsertFlags )

◆ createSettingsInstance() [1/2]

std::shared_ptr< QSettings > AppBase::createSettingsInstance ( void ) const

◆ createSettingsInstance() [2/2]

otoolkit::SettingsRef AppBase::createSettingsInstance ( void )

overridevirtual

Implements otoolkit::APIInterface.

◆ createUi()

void AppBase::createUi ( void )

◆ createView()

ViewerUIDtype AppBase::createView	(	ModelUIDtype	_modelUID,
		const std::string &	_projectName )

◆ debug()

bool AppBase::debug ( void ) const

◆ destroyObjects()

void AppBase::destroyObjects ( const std::vector< ak::UID > & _objects )

◆ expandSingleNavigationTreeItem()

void AppBase::expandSingleNavigationTreeItem	(	ak::ID	_itemID,
		bool	_isExpanded )

◆ exportLogs()

void AppBase::exportLogs ( void )

◆ findGraphicsEditor()

ot::GraphicsViewView * AppBase::findGraphicsEditor ( const std::string & _entityName )

◆ findOrCreateGraphicsEditor()

ot::GraphicsViewView * AppBase::findOrCreateGraphicsEditor	(	const std::string &	_entityName,
		const QString &	_title,
		const ot::BasicServiceInformation &	_serviceInfo,
		const ot::WidgetView::InsertFlags &	_viewInsertFlags )

◆ findOrCreateTable()

ot::TableView * AppBase::findOrCreateTable	(	const ot::TableCfg &	_config,
		const ot::BasicServiceInformation &	_serviceInfo,
		const ot::WidgetView::InsertFlags &	_viewInsertFlags )

◆ findOrCreateTextEditor()

ot::TextEditorView * AppBase::findOrCreateTextEditor	(	const ot::TextEditorCfg &	_config,
		const ot::BasicServiceInformation &	_serviceInfo,
		const ot::WidgetView::InsertFlags &	_viewInsertFlags )

◆ findProperty() [1/2]

ot::PropertyGridItem * AppBase::findProperty	(	const std::list< std::string > &	_groupPath,
		const std::string &	_itemName )

◆ findProperty() [2/2]

ot::PropertyGridItem * AppBase::findProperty	(	const std::string &	_groupName,
		const std::string &	_itemName )

◆ findTable()

ot::TableView * AppBase::findTable ( const std::string & _entityName )

◆ findTextEditor()

ot::TextEditorView * AppBase::findTextEditor ( const std::string & _entityName )

◆ focusPropertyGridItem()

void AppBase::focusPropertyGridItem	(	const std::string &	_group,
		const std::string &	_name )

◆ frontendSettingsChanged()

void AppBase::frontendSettingsChanged ( const ot::Property * _property )

◆ getAllGraphicsEditors()

std::list< ot::GraphicsViewView * > AppBase::getAllGraphicsEditors ( void )

◆ getCollectionName()

std::string AppBase::getCollectionName ( ) const

inline

◆ getCurrentLoginData()

const LoginData & AppBase::getCurrentLoginData ( void ) const

inline

Will return the current username.

◆ getCurrentMenuTab()

std::string AppBase::getCurrentMenuTab ( void )

◆ getCurrentProjectIsModified()

bool AppBase::getCurrentProjectIsModified ( void ) const

Will get the current project as modified state.

◆ getCurrentProjectName()

const std::string & AppBase::getCurrentProjectName ( void ) const

inline

Will return the current project name.

◆ getCurrentProjectType()

const std::string & AppBase::getCurrentProjectType ( void ) const

inline

◆ getCurrentUserCollection()

std::string AppBase::getCurrentUserCollection ( void ) const

inline

Will return the current username.

◆ getCurrentVisualizationTabTitle()

std::string AppBase::getCurrentVisualizationTabTitle ( void )

◆ getDefaultProjectTypeIcon()

const QIcon & AppBase::getDefaultProjectTypeIcon ( void ) const

inline

◆ getExternalServicesComponent()

ExternalServicesComponent * AppBase::getExternalServicesComponent ( void ) const

inline

◆ getModelUID()

ak::UID AppBase::getModelUID ( void ) const

inline

◆ getNavigationTreeItemText()

QString AppBase::getNavigationTreeItemText ( ak::ID _itemID )

◆ getProjectTypeCustomIconNameMap()

const std::map< std::string, std::string > & AppBase::getProjectTypeCustomIconNameMap ( void ) const

inline

◆ getProjectTypeDefaultIconNameMap()

const std::map< std::string, std::string > & AppBase::getProjectTypeDefaultIconNameMap ( void ) const

inline

◆ getPropertyIsDeletable()

bool AppBase::getPropertyIsDeletable	(	const std::string &	_groupName,
		const std::string &	_itemName )

◆ getPropertyType()

std::string AppBase::getPropertyType	(	const std::string &	_groupName,
		const std::string &	_itemName )

◆ getRelayURLs()

std::string AppBase::getRelayURLs ( void ) const

Will return the current Relay URLs.

◆ getSelectedNavigationTreeItems()

std::vector< int > AppBase::getSelectedNavigationTreeItems ( void )

◆ getServiceURL()

const std::string & AppBase::getServiceURL ( void ) const

inline

Will return the current Service URL.

◆ getSessionServiceURL()

const std::string & AppBase::getSessionServiceURL ( void ) const

inline

Will return the session service URL.

◆ getSettingsFromDataBase()

ot::PropertyGridCfg AppBase::getSettingsFromDataBase ( const std::string & _subKey )

◆ getSiteID()

int AppBase::getSiteID ( void ) const

inline

Will return the current site ID.

◆ getToolBar()

ToolBar * AppBase::getToolBar ( void ) const

inline

◆ getUiServiceUID()

ak::UID AppBase::getUiServiceUID ( void ) const

inline

◆ getUpdateTransparentColorStyleValueEnabled()

bool AppBase::getUpdateTransparentColorStyleValueEnabled ( void ) const

inline

◆ getVersionGraph()

ot::VersionGraphManagerView * AppBase::getVersionGraph ( void )

inline

◆ getViewerComponent()

ViewerComponent * AppBase::getViewerComponent ( void ) const

inline

◆ getViewerUID()

ak::UID AppBase::getViewerUID ( void ) const

inline

◆ getViewHandlingConfigFlags()

const ViewHandlingFlags & AppBase::getViewHandlingConfigFlags ( void ) const

inline

◆ getVisible1D()

bool AppBase::getVisible1D ( )

inline

◆ getVisible3D()

bool AppBase::getVisible3D ( )

inline

◆ getVisibleBlockPicker()

bool AppBase::getVisibleBlockPicker ( )

inline

◆ importProject()

void AppBase::importProject ( void )

◆ initialize()

bool AppBase::initialize ( )

Will initialize the API Returns: 0: OK -1: Was already initialized 1: Exception catched 2: Non exception catched 3: Log-in failed.

◆ initializeDefaultUserSettings()

void AppBase::initializeDefaultUserSettings ( void )

◆ instance() [1/3]

AppBase * AppBase::instance ( QApplication * _app = (QApplication*)nullptr )

static

◆ instance() [2/3]

AppBase * AppBase::instance ( void )

static

◆ instance() [3/3]

static AppBase * AppBase::instance ( void )

static

◆ isInitialized()

bool AppBase::isInitialized ( void ) const

Returns true if the API was initialized.

◆ isTreeItemExpanded()

bool AppBase::isTreeItemExpanded ( ak::ID _itemID )

◆ lockManager()

LockManager * AppBase::lockManager ( void )

◆ lockPropertyGrid()

void AppBase::lockPropertyGrid ( bool flag )

◆ lockSelectionAndModification

void AppBase::lockSelectionAndModification ( bool flag )

slot

◆ lockUI

void AppBase::lockUI ( bool flag )

slot

◆ log() [1/4]

void AppBase::log ( const ot::LogMessage & _message )

overridevirtual

Called when the a log message was created.

Implements ot::AbstractLogNotifier.

◆ log() [2/4]

virtual void AppBase::log ( const ot::LogMessage & _message )

overridevirtual

Called when the a log message was created.

Implements ot::AbstractLogNotifier.

◆ log() [3/4]

virtual void AppBase::log ( const ot::LogMessage & _message )

overridevirtual

Called when the a log message was created.

Implements ot::AbstractLogNotifier.

◆ log() [4/4]

void AppBase::log	(	const QString &	_sender,
		InterfaceLogType	_type,
		const QString &	_message )

overridevirtual

Implements otoolkit::APIInterface.

◆ logIn()

bool AppBase::logIn ( void )

◆ mainWindow()

aWindow * AppBase::mainWindow ( void )

◆ makeWidgetViewCurrentWithoutInputFocus()

void AppBase::makeWidgetViewCurrentWithoutInputFocus	(	ot::WidgetView *	_view,
		bool	_ignoreEntitySelect )

◆ manageGroups()

void AppBase::manageGroups ( void )

◆ notify()

void AppBase::notify	(	ak::UID	_senderId,
		ak::eventType	_eventType,
		int	_info1,
		int	_info2 )

overridevirtual

Will call the callback function with the provided parameters.

Parameters

_senderId	The sender ID the message was send from
_message	The message
_messageType	The type of the messsage
_info1	Message addition 1
_info2	Message addition 2

Exceptions

sim::Exception to forward exceptions coming from the application core class

Implements ak::aNotifier.

◆ parseStartArgs()

void AppBase::parseStartArgs ( const std::string & _args )

◆ refreshWelcomeScreen

void AppBase::refreshWelcomeScreen ( void )

slot

◆ registerSession()

void AppBase::registerSession	(	const std::string &	_projectName,
		const std::string &	_collectionName )

◆ registerToolActivityNotifier()

void AppBase::registerToolActivityNotifier ( otoolkit::ToolActivityNotifier * _notifier )

overridevirtual

Implements otoolkit::APIInterface.

◆ removeNavigationTreeItems()

void AppBase::removeNavigationTreeItems ( const std::vector< ak::ID > & itemIds )

◆ removeToolActivityNotifier()

void AppBase::removeToolActivityNotifier ( otoolkit::ToolActivityNotifier * _notifier )

overridevirtual

Implements otoolkit::APIInterface.

◆ replaceInfoMessage()

void AppBase::replaceInfoMessage ( const QString & _message )

◆ restoreSessionState()

void AppBase::restoreSessionState ( void )

◆ rootWidget()

virtual const QWidget * AppBase::rootWidget ( void ) const

inlineoverridevirtual

Implements otoolkit::APIInterface.

◆ setApplicationInstance()

void AppBase::setApplicationInstance ( QApplication * _app )

inline

◆ SetCollectionName()

void AppBase::SetCollectionName ( const std::string _collectionName )

◆ setCurrentProjectIsModified()

void AppBase::setCurrentProjectIsModified ( bool _isModified = true )

Will set the current project as modified and apply UI changes.

◆ setCurrentProjectName()

void AppBase::setCurrentProjectName ( const std::string & _name )

inline

Will set the name of the currently active project.

◆ setCurrentProjectType()

void AppBase::setCurrentProjectType ( const std::string & _type )

inline

◆ setCurrentVisualizationTabFromEntityName()

void AppBase::setCurrentVisualizationTabFromEntityName	(	const std::string &	_entityName,
		ot::WidgetViewBase::ViewType	_viewType )

◆ setCurrentVisualizationTabFromTitle()

void AppBase::setCurrentVisualizationTabFromTitle ( const std::string & _tabTitle )

◆ setDebug()

void AppBase::setDebug ( bool _debug )

◆ setModelUID()

void AppBase::setModelUID ( ak::UID _uid )

inline

◆ setNavigationTreeItemIcon()

void AppBase::setNavigationTreeItemIcon	(	ak::ID	_itemID,
		const QString &	_iconName,
		const QString &	_iconDefaultPath )

◆ setNavigationTreeItemSelected()

void AppBase::setNavigationTreeItemSelected	(	ak::ID	_itemID,
		bool	_isSelected )

◆ setNavigationTreeItemText()

void AppBase::setNavigationTreeItemText	(	ak::ID	_itemID,
		const QString &	_itemName )

◆ setNavigationTreeMultiselectionEnabled()

void AppBase::setNavigationTreeMultiselectionEnabled ( bool _enabled )

◆ setNavigationTreeSortingEnabled()

void AppBase::setNavigationTreeSortingEnabled ( bool _enabled )

◆ setProgressBarValue

void AppBase::setProgressBarValue ( int progressPercentage )

slot

Will set the percentage of the progress bar.

◆ setProgressBarVisibility

void AppBase::setProgressBarVisibility	(	const char *	progressMessage,
		bool	progressBaseVisible,
		bool	continuous )

slot

Will turn on or off the progress bar visibility and set the progress message.

◆ setRelayURLs()

void AppBase::setRelayURLs ( const std::string & _url )

Will set the Relay URLs.

◆ setServiceURL()

void AppBase::setServiceURL ( const std::string & _url )

Will set the current Service URL of this service.

◆ setSessionServiceURL()

void AppBase::setSessionServiceURL ( const std::string & _url )

Will set the session service URL.

◆ setSingleNavigationTreeItemSelected()

void AppBase::setSingleNavigationTreeItemSelected	(	ak::ID	_itemID,
		bool	_isSelected )

◆ setSiteID()

void AppBase::setSiteID ( int _id )

Will set the current site ID.

◆ setTabToolBarTabOrder()

void AppBase::setTabToolBarTabOrder ( const QStringList & _lst )

◆ settingsChanged()

void AppBase::settingsChanged	(	const std::string &	_owner,
		const ot::Property *	_property )

◆ setUiServiceUID()

void AppBase::setUiServiceUID ( ak::UID _uid )

inline

◆ setUpdateTransparentColorStyleValueEnabled()

void AppBase::setUpdateTransparentColorStyleValueEnabled ( bool _enabled )

◆ setupPropertyGrid()

void AppBase::setupPropertyGrid ( const ot::PropertyGridCfg & _configuration )

◆ setUrl()

void AppBase::setUrl ( const QString & _url )

◆ setViewerUID()

void AppBase::setViewerUID ( ak::UID _uid )

inline

◆ setViewHandlingConfigFlag()

void AppBase::setViewHandlingConfigFlag	(	ViewHandlingConfig	_flag,
		bool	_active = true )

inline

◆ setViewHandlingConfigFlags()

void AppBase::setViewHandlingConfigFlags ( const ViewHandlingFlags & _flags )

inline

◆ setVisible1D()

void AppBase::setVisible1D ( bool visible1D )

inline

◆ setVisible3D()

void AppBase::setVisible3D ( bool visible3D )

inline

◆ setVisibleBlockPicker()

void AppBase::setVisibleBlockPicker ( bool visibleBlockPicker )

inline

◆ setWaitingAnimationVisible()

void AppBase::setWaitingAnimationVisible ( bool flag )

◆ shortcutManager()

ShortcutManager * AppBase::shortcutManager ( void )

inline

◆ showErrorPrompt

void AppBase::showErrorPrompt	(	const std::string &	_message,
		const std::string &	_title )

slot

◆ showInfoPrompt

void AppBase::showInfoPrompt	(	const std::string &	_message,
		const std::string &	_title )

slot

◆ showPrompt() [1/2]

ot::MessageDialogCfg::BasicButton AppBase::showPrompt ( const ot::MessageDialogCfg & _config )

overridevirtual

Implements ot::MessageBoxHandler.

◆ showPrompt() [2/2]

ot::MessageDialogCfg::BasicButton AppBase::showPrompt	(	const std::string &	_message,
		const std::string &	_title,
		ot::MessageDialogCfg::BasicIcon	_icon,
		const ot::MessageDialogCfg::BasicButtons &	_buttons )

◆ showWarningPrompt

void AppBase::showWarningPrompt	(	const std::string &	_message,
		const std::string &	_title )

slot

◆ slotCopyRequested

void AppBase::slotCopyRequested ( const ot::CopyInformation * _info )

slot

◆ slotGraphicsConnectionRequested

void AppBase::slotGraphicsConnectionRequested	(	const ot::UID &	_fromUid,
		const std::string &	_fromConnector,
		const ot::UID &	_toUid,
		const std::string &	_toConnector )

slot

◆ slotGraphicsConnectionToConnectionRequested

void AppBase::slotGraphicsConnectionToConnectionRequested	(	const ot::UID &	_fromItemUid,
		const std::string &	_fromItemConnector,
		const ot::UID &	_toConnectionUid,
		const ot::Point2DD &	_newControlPoint )

slot

◆ slotGraphicsItemChanged

void AppBase::slotGraphicsItemChanged ( const ot::GraphicsItemCfg * _newConfig )

slot

◆ slotGraphicsItemRequested

void AppBase::slotGraphicsItemRequested	(	const QString &	_name,
		const QPointF &	_pos )

slot

◆ slotGraphicsRemoveItemsRequested

void AppBase::slotGraphicsRemoveItemsRequested	(	const ot::UIDList &	_items,
		const std::list< std::string > &	_connections )

slot

◆ slotGraphicsSelectionChanged

void AppBase::slotGraphicsSelectionChanged ( void )

slot

◆ slotProcessMessage

void AppBase::slotProcessMessage ( const QString & _json )

slot

◆ slotTableSaveRequested

void AppBase::slotTableSaveRequested ( void )

slot

◆ slotTextEditorSaveRequested

void AppBase::slotTextEditorSaveRequested ( void )

slot

◆ startSessionRefreshTimer()

void AppBase::startSessionRefreshTimer ( void )

◆ storeSessionState()

void AppBase::storeSessionState ( void )

◆ storeSettingToDataBase()

bool AppBase::storeSettingToDataBase	(	const ot::PropertyGridCfg &	_config,
		const std::string &	_subKey )

◆ switchToMenuTab()

void AppBase::switchToMenuTab ( const std::string & _menu )

◆ switchToViewMenuTab()

void AppBase::switchToViewMenuTab ( void )

◆ toggleNavigationTreeItemSelection()

void AppBase::toggleNavigationTreeItemSelection	(	ak::ID	_itemID,
		bool	_considerChilds )

◆ uiUID()

ak::UID AppBase::uiUID ( void ) const

inline

◆ updateBufferSizeFromLogFlags()

void AppBase::updateBufferSizeFromLogFlags ( const ot::LogFlags & _flags )

◆ updateLogIntensityInfo()

void AppBase::updateLogIntensityInfo ( void )

◆ updateStatusString()

void AppBase::updateStatusString ( const QString & _statusText )

overridevirtual

Implements otoolkit::APIInterface.

◆ updateStatusStringAsError()

void AppBase::updateStatusStringAsError ( const QString & _statusText )

overridevirtual

Implements otoolkit::APIInterface.

◆ updateTransparentColorStyleValue()

void AppBase::updateTransparentColorStyleValue ( void )

◆ url()

const QString & AppBase::url ( void ) const

inline

◆ viewerSettingsChanged()

void AppBase::viewerSettingsChanged ( const ot::Property * _property )

◆ ~AppBase()

AppBase::~AppBase ( )

privatevirtual

Friends And Related Symbol Documentation

◆ KeyboardCommandHandler

friend class KeyboardCommandHandler

friend

◆ ToolBar

friend class ToolBar

friend

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

Services/LoggerService/include/AppBase.h
Services/uiService/include/AppBase.h
Tools/OToolkit/include/AppBase.h
Services/LoggerService/src/AppBase.cpp
Services/uiService/src/AppBase.cpp
Tools/OToolkit/src/AppBase.cpp

	OpenTwin 0.1 OpenTwin

Public Types

Public Slots

Public Member Functions

Static Public Member Functions

Private Member Functions

Friends

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ ViewHandlingFlags

Member Enumeration Documentation

◆ StartOption

◆ ViewHandlingConfig

Constructor & Destructor Documentation

◆ ~AppBase()

Member Function Documentation

◆ activateToolBarTab()

◆ addGraphicsPickerPackage()

◆ addNavigationTreeItem()

◆ addTool()

◆ appendHtmlInfoMessage()

◆ appendInfoMessage()

◆ applicationInstance()

◆ availableTabText()

◆ clearGraphicsPickerData()

◆ clearNavigationTree()

◆ clearNavigationTreeSelection()

◆ clearPropertyGrid()

◆ clearSessionInformation()

◆ closeAllTextEditors()

◆ closeAllViewerTabs()

◆ closeEvent() [1/2]

◆ closeEvent() [2/2]

◆ closeTable()

◆ closeTextEditor()

◆ controlsManager()

◆ createModel()

◆ createNewGraphicsEditor()

◆ createNewProjectInDatabase()

◆ createNewTable()

◆ createNewTextEditor()

◆ createSettingsInstance() [1/2]

◆ createSettingsInstance() [2/2]

◆ createUi()

◆ createView()

◆ debug()

◆ destroyObjects()

◆ expandSingleNavigationTreeItem()

◆ exportLogs()

◆ findGraphicsEditor()

◆ findOrCreateGraphicsEditor()

◆ findOrCreateTable()

◆ findOrCreateTextEditor()

◆ findProperty() [1/2]

◆ findProperty() [2/2]

◆ findTable()

◆ findTextEditor()

◆ focusPropertyGridItem()

◆ frontendSettingsChanged()

◆ getAllGraphicsEditors()

◆ getCollectionName()

◆ getCurrentLoginData()

◆ getCurrentMenuTab()

◆ getCurrentProjectIsModified()

◆ getCurrentProjectName()

◆ getCurrentProjectType()

◆ getCurrentUserCollection()

◆ getCurrentVisualizationTabTitle()

◆ getDefaultProjectTypeIcon()

◆ getExternalServicesComponent()

◆ getModelUID()

◆ getNavigationTreeItemText()

◆ getProjectTypeCustomIconNameMap()

◆ getProjectTypeDefaultIconNameMap()

◆ getPropertyIsDeletable()

◆ getPropertyType()

◆ getRelayURLs()

◆ getSelectedNavigationTreeItems()

◆ getServiceURL()

◆ getSessionServiceURL()