Default custom screen implementation More...

#include <DefaultCustomScreenImplementation.h>

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

Public Member Functions
CUSTOMIMPLEMENTATIONS_EXPORTS void	ActivateHmiScreen ()
	Activates the top screen of the Assembly-Screen Implementation More...

CUSTOMIMPLEMENTATIONS_EXPORTS void	AddKeyDownListener (std::shared_ptr< std::function< void(std::shared_ptr< KeyEventArgs >)>> listener)
	Occurs when a key is pressed inside a screen of the Assembly-Screen Implementation when the is active. More...

CUSTOMIMPLEMENTATIONS_EXPORTS void	CloseAll (std::shared_ptr< IRuntimeContext > runtimeContext) override
	Close all screen are opening. Should be called after each procedure execution. More...

CUSTOMIMPLEMENTATIONS_EXPORTS void	CloseScreen (std::shared_ptr< CustomScreenImplementation::IScreenHandle > screen) override
	Invoked when a CloseScreen occurs in OTX-Runtime. More...

virtual CUSTOMIMPLEMENTATIONS_EXPORTS void	HighlightScreen (std::shared_ptr< CustomScreenImplementation::IScreenHandle > screen) override
	Invoked when a HighlightScreen occurs in OTX-Runtime. More...

CUSTOMIMPLEMENTATIONS_EXPORTS void	OpenScreen (std::shared_ptr< IRuntimeContext > runtimeContext, std::shared_ptr< CustomScreenImplementation::IScreenHandle > screen, std::vector< std::shared_ptr< CustomScreenImplementation::IScreenParameter >> parameters, bool modal) override
	Invoked when an OpenScreen occurs in OTX-Runtime. More...

CUSTOMIMPLEMENTATIONS_EXPORTS void	RefreshHmiScreen ()
	Refreshes all screens of the Assembly-Screen Implementation More...

CUSTOMIMPLEMENTATIONS_EXPORTS bool	ScreenIsOpen (std::shared_ptr< CustomScreenImplementation::IScreenHandle > screen) override
	Invoked when a ScreenIsOpen occurs in OTX-Runtime. More...

CUSTOMIMPLEMENTATIONS_EXPORTS void	SetHmiScreenHandle (long hmiHandle)
	Sets a HWND where screens of the Assembly-Screen Implementation will be displayed More...

CUSTOMIMPLEMENTATIONS_EXPORTS void	StartHtmlWebServer ()
	Start html Webserver when starting HtmlScreen binding. More...

CUSTOMIMPLEMENTATIONS_EXPORTS void	StartHtmlWebServer (std::string configFilePath)
	Start html Webserver when starting HtmlScreen binding with optional configFilePath. More...

CUSTOMIMPLEMENTATIONS_EXPORTS void	StopHtmlWebServer ()
	Stop html Webserver More...

CUSTOMIMPLEMENTATIONS_EXPORTS void	UpdateScreenParameterValues (std::shared_ptr< CustomScreenImplementation::IScreenHandle > screen, std::vector< std::string > parameterNames, std::shared_ptr< Object > value) override
	Invoked when one ore more ScreenParameters was changed in OTX-Runtime to the same value. More...

Public Member Functions inherited from OpenTestSystem::Otx::Runtime::Api::Custom::ICustomScreenImplementation
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

Default custom screen implementation

Member Function Documentation

◆ ActivateHmiScreen()

CUSTOMIMPLEMENTATIONS_EXPORTS void OpenTestSystem::Otx::Runtime::Api::Custom::DefaultCustomScreenImplementation::ActivateHmiScreen ( )

Activates the top screen of the Assembly-Screen Implementation

Important: The method is not part of OTX HMI extension and is only valid for Assembly-Screen Implementation!

◆ AddKeyDownListener()

CUSTOMIMPLEMENTATIONS_EXPORTS void OpenTestSystem::Otx::Runtime::Api::Custom::DefaultCustomScreenImplementation::AddKeyDownListener	(	std::shared_ptr< std::function< void(std::shared_ptr< KeyEventArgs >)>	,
		listener
	)

Occurs when a key is pressed inside a screen of the Assembly-Screen Implementation when the is active.

Important: The event is not part of OTX HMI extension and is only valid for Assembly-Screen Implementation!

◆ CloseAll()

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

overridevirtual

Close all screen are opening. Should be called after each procedure execution.

Implements OpenTestSystem::Otx::Runtime::Api::Custom::ICustomScreenImplementation.

◆ CloseScreen()

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

overridevirtual

Invoked when a CloseScreen occurs in OTX-Runtime.

Parameters

screen Screen represents a screen signature.

Implements OpenTestSystem::Otx::Runtime::Api::Custom::ICustomScreenImplementation.

◆ HighlightScreen()

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

overridevirtual

Invoked when a HighlightScreen occurs in OTX-Runtime.

Parameters

screen Screen represents a screen signature.

Implements OpenTestSystem::Otx::Runtime::Api::Custom::ICustomScreenImplementation.

◆ OpenScreen()

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

overridevirtual

Invoked when an OpenScreen occurs in OTX-Runtime.

Parameters

runtimeContext	The related runtime context.
screen	Screen represents an OTX ScreenSignature.
parameters	Arguments which are passed to OpenScreen.
model	Modal is false, the OTX execution flow will immediately move on to the next Action, without waiting for the screen to close. Otherwise, if modal is true.

Implements OpenTestSystem::Otx::Runtime::Api::Custom::ICustomScreenImplementation.

◆ RefreshHmiScreen()

CUSTOMIMPLEMENTATIONS_EXPORTS void OpenTestSystem::Otx::Runtime::Api::Custom::DefaultCustomScreenImplementation::RefreshHmiScreen ( )

Refreshes all screens of the Assembly-Screen Implementation

Important: The method is not part of OTX HMI extension and is only valid for Assembly-Screen Implementation!

◆ ScreenIsOpen()

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

overridevirtual

Invoked when a ScreenIsOpen occurs in OTX-Runtime.

Parameters

screen Screen represents a screen signature.

Implements OpenTestSystem::Otx::Runtime::Api::Custom::ICustomScreenImplementation.

◆ SetHmiScreenHandle()

CUSTOMIMPLEMENTATIONS_EXPORTS void OpenTestSystem::Otx::Runtime::Api::Custom::DefaultCustomScreenImplementation::SetHmiScreenHandle ( long hmiHandle )

Sets a HWND where screens of the Assembly-Screen Implementation will be displayed

If an application sets this value to a windows handle (HWND) all screens of the Assembly-Screen Implementation will be displayed inside this window. If the value is not set, a new window will be created. This is the default behavior.

If the value will be set to 0, all open screens will be closed.

Important: The method is not part of OTX HMI extension and is only valid for Assembly-Screen Implementation!

Parameters

hmiHandle HWND Windows Handle.

◆ StartHtmlWebServer() [1/2]

CUSTOMIMPLEMENTATIONS_EXPORTS void OpenTestSystem::Otx::Runtime::Api::Custom::DefaultCustomScreenImplementation::StartHtmlWebServer ( )

Start html Webserver when starting HtmlScreen binding.

◆ StartHtmlWebServer() [2/2]

CUSTOMIMPLEMENTATIONS_EXPORTS void OpenTestSystem::Otx::Runtime::Api::Custom::DefaultCustomScreenImplementation::StartHtmlWebServer ( std::string configFilePath )

Start html Webserver when starting HtmlScreen binding with optional configFilePath.

Parameters

configFilePath Optional path to web server configuration file. The path must address a JSON file with a valid web server configuration. If not set the file [UserPublic]/OpenTestSystem/HtmlScreen/config.json will be used

◆ StopHtmlWebServer()

CUSTOMIMPLEMENTATIONS_EXPORTS void OpenTestSystem::Otx::Runtime::Api::Custom::DefaultCustomScreenImplementation::StopHtmlWebServer ( )

Stop html Webserver

◆ UpdateScreenParameterValues()

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

override

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

Parameters

screen	Screen represents a screen signature.
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:

DefaultCustomScreenImplementation.h

Public Member Functions

Detailed Description

Member Function Documentation

◆ ActivateHmiScreen()

◆ AddKeyDownListener()

◆ CloseAll()

◆ CloseScreen()

◆ HighlightScreen()

◆ OpenScreen()

◆ RefreshHmiScreen()

◆ ScreenIsOpen()

◆ SetHmiScreenHandle()

◆ StartHtmlWebServer() [1/2]

◆ StartHtmlWebServer() [2/2]

◆ StopHtmlWebServer()

◆ UpdateScreenParameterValues()