OpenTestSystem::Otx::Runtime::Api::Custom::ICustomScreenImplementation Class Reference

Allows users to implement their own Screens. More...

#include <ICustomScreenImplementation.h>

Inheritance diagram for OpenTestSystem::Otx::Runtime::Api::Custom::ICustomScreenImplementation:

Public Member Functions
virtual void	CloseAll (std::shared_ptr< IRuntimeContext > runtimeContext)=0
	The log file related to the IRuntimeContext should be closed More...
virtual void	CloseScreen (std::shared_ptr< CustomScreenImplementation::IScreenHandle > screen)=0
	Invoked when a CloseScreen occurs in OTX-Runtime. More...
virtual void	HighlightScreen (std::shared_ptr< CustomScreenImplementation::IScreenHandle > screen)=0
	Invoked when a HighlightScreen occurs in OTX-Runtime. More...
virtual void	OpenScreen (std::shared_ptr< IRuntimeContext > runtimeContext, std::shared_ptr< CustomScreenImplementation::IScreenHandle > screen, std::vector< std::shared_ptr< CustomScreenImplementation::IScreenParameter >> parameters, bool modal)=0
	Invoked when an OpenScreen occurs in OTX-Runtime. More...
virtual bool	ScreenIsOpen (std::shared_ptr< CustomScreenImplementation::IScreenHandle > screen)=0
	Invoked when a ScreenIsOpen occurs in OTX-Runtime. More...
virtual void	UpdateScreenParameterValues (std::shared_ptr< CustomScreenImplementation::IScreenHandle > screen, std::vector< std::string > parameterNames, std::shared_ptr< DataTypes::Object > value)=0
	Invoked when one ore more ScreenParameters was changed in OTX-Runtime to the same value. More...

Detailed Description

Allows users to implement their own Screens.

Important: While the custom implementation is processing a method call, the OTX runtime is blocked. It waits until the custom implementation has finished processing before resuming execution.

Member Function Documentation

CloseAll()

virtual void OpenTestSystem::Otx::Runtime::Api::Custom::ICustomScreenImplementation::CloseAll ( std::shared_ptr< IRuntimeContext >  runtimeContext )

pure virtual

The log file related to the IRuntimeContext should be closed

Parameters

runtimeContext

The related runtime context.

Implemented in OpenTestSystem::Otx::Runtime::Api::Custom::DefaultCustomScreenImplementation.

CloseScreen()

virtual void OpenTestSystem::Otx::Runtime::Api::Custom::ICustomScreenImplementation::CloseScreen ( std::shared_ptr< CustomScreenImplementation::IScreenHandle >  screen )

pure virtual

Invoked when a CloseScreen occurs in OTX-Runtime.

Parameters

screen

Represents a screen instance.

Implemented in OpenTestSystem::Otx::Runtime::Api::Custom::DefaultCustomScreenImplementation.

HighlightScreen()

virtual void OpenTestSystem::Otx::Runtime::Api::Custom::ICustomScreenImplementation::HighlightScreen ( std::shared_ptr< CustomScreenImplementation::IScreenHandle >  screen )

pure virtual

Invoked when a HighlightScreen occurs in OTX-Runtime.

Parameters

screen

Represents a screen instance.

Implemented in OpenTestSystem::Otx::Runtime::Api::Custom::DefaultCustomScreenImplementation.

OpenScreen()

virtual void OpenTestSystem::Otx::Runtime::Api::Custom::ICustomScreenImplementation::OpenScreen ( std::shared_ptr< IRuntimeContext >  runtimeContext, std::shared_ptr< CustomScreenImplementation::IScreenHandle >  screen, std::vector< std::shared_ptr< CustomScreenImplementation::IScreenParameter >>  parameters, bool  modal  )

pure virtual

Invoked when an OpenScreen occurs in OTX-Runtime.

Parameters

runtimeContext	The related runtime context.
screen	Represents a screen instance.
parameters	Arguments which are passed to OpenScreen.
model	If modal is false, the OTX execution flow will immediately move on to the next Action, without waiting for the screen to close. If modal is true, the screen implementation must wait until the screen was closed. Please note, that this behavior must be implemented inside the screen implementation.

Implemented in OpenTestSystem::Otx::Runtime::Api::Custom::DefaultCustomScreenImplementation.

ScreenIsOpen()

virtual bool OpenTestSystem::Otx::Runtime::Api::Custom::ICustomScreenImplementation::ScreenIsOpen ( std::shared_ptr< CustomScreenImplementation::IScreenHandle >  screen )

pure virtual

Invoked when a ScreenIsOpen occurs in OTX-Runtime.

Parameters

screen

Represents a screen instance.

Implemented in OpenTestSystem::Otx::Runtime::Api::Custom::DefaultCustomScreenImplementation.

UpdateScreenParameterValues()

virtual void OpenTestSystem::Otx::Runtime::Api::Custom::ICustomScreenImplementation::UpdateScreenParameterValues ( std::shared_ptr< CustomScreenImplementation::IScreenHandle >  screen, std::vector< std::string >  parameterNames, std::shared_ptr< DataTypes::Object >  value  )

pure virtual

Invoked when one ore more ScreenParameters was changed in OTX-Runtime to the same value.

Parameters

screen	Represents a screen instance.
parameterNames	Names of the parameters which value was changed.
value	Value to all listed parameters was changed.

---

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

• ICustomScreenImplementation.h