OpenTestSystem::Otx::Runtime::Api::Custom::CustomScreenImplementation::IScreenHandle Class Reference

Represents an handle to an OTX screen instance. More...

#include <IScreenHandle.h>

Public Member Functions
virtual std::string	GetAppId ()=0
	Gets the Id of the mapped external application. More...
virtual std::map< std::string, std::string >	GetExternalApps ()=0
	Gets all externals applications of current OTX mapping More...
virtual std::string	GetMappingName ()=0
	Gets mapping name. More...
virtual std::string	GetScreenId ()=0
	Gets the unique screen id. More...
virtual std::string	GetScreenSignatureName ()=0
	Gets full name of ScreenSignature. More...
virtual void	RaiseScreenClosedEvent ()=0
	Signals the OTX-Runtime that a screen was closed and a ScreenClosedEvent should be raised. More...

Detailed Description

Represents an handle to an OTX screen instance.

Each call of OpenScreen creates a new OTX screen instance.

Member Function Documentation

GetAppId()

virtual std::string OpenTestSystem::Otx::Runtime::Api::Custom::CustomScreenImplementation::IScreenHandle::GetAppId ( )

pure virtual

Gets the Id of the mapped external application.

Returns

Application Id.

GetExternalApps()

virtual std::map<std::string, std::string> OpenTestSystem::Otx::Runtime::Api::Custom::CustomScreenImplementation::IScreenHandle::GetExternalApps ( )

pure virtual

Gets all externals applications of current OTX mapping

All APPs used in the current mapping are returned as a Dictionary. The key is a String and contains the AppId. The value is a String and contains the path of the application. If available, the names of the initialization and deinitialization methods as well as the names of the parameters and the parameter values are also returned.

{
   "AppId1"             = "Production.Otx.Screens.dll",
   "AppId1.Init"        = "InitMethod",
   "AppId1.Init.Param1" = "1",
   "AppId1.Init.Param2" = "Message",
   "AppId1.Deinit"      = "DeinitMethod",
   "AppId2"             = "GalaSoft.MvvmLight.dll",
   "AppId3"             = "GalaSoft.MvvmLight.Platform.dll",
   "AppId4"             = "System.Windows.Interactivity.dll",
   "AppId5"             = "BitFactory.Logging.dll"
}

Returns

A Dictionary String of String.

GetMappingName()

virtual std::string OpenTestSystem::Otx::Runtime::Api::Custom::CustomScreenImplementation::IScreenHandle::GetMappingName ( )

pure virtual

Gets mapping name.

Returns

Mapping name.

GetScreenId()

virtual std::string OpenTestSystem::Otx::Runtime::Api::Custom::CustomScreenImplementation::IScreenHandle::GetScreenId ( )

pure virtual

Gets the unique screen id.

Each call of OpenScreen generates an unique id.

Returns

Screen Id.

GetScreenSignatureName()

virtual std::string OpenTestSystem::Otx::Runtime::Api::Custom::CustomScreenImplementation::IScreenHandle::GetScreenSignatureName ( )

pure virtual

Gets full name of ScreenSignature.

Returns

Full name of ScreenSignature.

RaiseScreenClosedEvent()

virtual void OpenTestSystem::Otx::Runtime::Api::Custom::CustomScreenImplementation::IScreenHandle::RaiseScreenClosedEvent ( )

pure virtual

Signals the OTX-Runtime that a screen was closed and a ScreenClosedEvent should be raised.

---

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

• IScreenHandle.h