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

Represents OTX ScreenOutParameter. More...

#include <IScreenOutParameter.h>

Inheritance diagram for OpenTestSystem::Otx::Runtime::Api::Custom::CustomScreenImplementation::IScreenOutParameter:

Public Member Functions
virtual std::shared_ptr< OpenTestSystem::Otx::Runtime::Api::DataTypes::Object >	GetValue ()=0
	Gets value. More...
virtual bool	IsEnvironmentValueActive ()=0
	The environment value setting was set for the parameter. More...
virtual void	SetValue (std::shared_ptr< Object >)=0
	Sets value. More...
virtual bool	SetValue (std::string literalValue)=0
	Sets value. More...
Public Member Functions inherited from OpenTestSystem::Otx::Runtime::Api::Custom::CustomScreenImplementation::IScreenParameter
virtual std::string	GetDataType ()=0
	Gets the data type of the parameter as a string. More...
virtual std::shared_ptr< Object >	GetInitValue ()=0
	Gets initial value. More...
virtual int	GetMappingIndex ()=0
	Gets mapping index. More...
virtual std::string	GetMappingName ()=0
	Gets mapping name. More...
virtual std::string	GetName ()=0
	Gets name. More...
virtual std::string	GetSpecification ()=0
	Gets specification. More...

Detailed Description

Represents OTX ScreenOutParameter.

Member Function Documentation

GetValue()

virtual std::shared_ptr<OpenTestSystem::Otx::Runtime::Api::DataTypes::Object> OpenTestSystem::Otx::Runtime::Api::Custom::CustomScreenImplementation::IScreenOutParameter::GetValue ( )

pure virtual

Gets value.

IsEnvironmentValueActive()

virtual bool OpenTestSystem::Otx::Runtime::Api::Custom::CustomScreenImplementation::IScreenOutParameter::IsEnvironmentValueActive ( )

pure virtual

The environment value setting was set for the parameter.

Returns

Returns true if the environment value setting was set for the related parameter. Using the environment value setting, unmapped InOut or Out parameters as well as context variables can be set to a fixed value. This means that a non-existent environment can be simulated.

SetValue() [1/2]

virtual void OpenTestSystem::Otx::Runtime::Api::Custom::CustomScreenImplementation::IScreenOutParameter::SetValue ( std::shared_ptr< Object >  )

pure virtual

Sets value.

Parameters

value

New value.

SetValue() [2/2]

virtual bool OpenTestSystem::Otx::Runtime::Api::Custom::CustomScreenImplementation::IScreenOutParameter::SetValue ( std::string  literalValue )

pure virtual

Sets value.

Parameters

literalValue

A new value.

---

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

• IScreenOutParameter.h