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

Base of ScreenParameters. More...

#include <IScreenParameter.h>

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

Public Member Functions
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

Base of ScreenParameters.

Member Function Documentation

GetDataType()

virtual std::string OpenTestSystem::Otx::Runtime::Api::Custom::CustomScreenImplementation::IScreenParameter::GetDataType ( )

pure virtual

Gets the data type of the parameter as a string.

Returns the parameter data type as a string, supporting simple types like Integer, String or ByteField, as well as more complex structures such as List<String>, Map<String, Integer>, or nested types like Map<List<Integer>>.

DataType	Property value as String
String	"String"
Integer	"Integer"
Float	"Float"
Boolean	"Boolean"
ByteField	"ByteField"
Map	"Map<Integer, String>, Map<String, List<Integer>>" (Example)
List	"List<Integer>, List<Map<String, List<Integer>>" (Example)
Enumeration	"OtxPackage.Document.Color" (Example)
Structure	"OtxPackage.Document.MyStructure<Integer, String>, OtxPackage.Document.Person<StructureElement<Name, String>, StructureElement<Age, Integer>, StructureElement<Family, List<Person>>>"

Notes: A Structure has a data type formatted as follows: "StructureSignatureName<Datatype1, DataType2, ...>". However, when the Structure contains a List, Map of Structure, it is described as follows: "StructureSignatureName<StructureElement<ElementName1, DataType1>, StructureElement<ElementName2, DataType2>, ...>".

Returns

DataType.

GetInitValue()

virtual std::shared_ptr<Object> OpenTestSystem::Otx::Runtime::Api::Custom::CustomScreenImplementation::IScreenParameter::GetInitValue ( )

pure virtual

Gets initial value.

Returns

Initial value.

GetMappingIndex()

virtual int OpenTestSystem::Otx::Runtime::Api::Custom::CustomScreenImplementation::IScreenParameter::GetMappingIndex ( )

pure virtual

Gets mapping index.

If a mapping is related to a list element, the function will return the relate index.

If no mapping a list element, this function will return -1.

Returns

Mapping index.

GetMappingName()

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

pure virtual

Gets mapping name.

If a valid mapping exists for this Parameter, this function will return the related mapping name. The value can be used to make the application independent from different OTX projects which should be use the same system resource.

If no valid mapping exists, this function will return NULL.

The mapping name is the full qualified name of the element inside the external application which is mapped to this Parameter. It contains all namespace elements separated by dots (".").

Returns

Mapping name.

GetName()

virtual std::string OpenTestSystem::Otx::Runtime::Api::Custom::CustomScreenImplementation::IScreenParameter::GetName ( )

pure virtual

Gets name.

Returns

Name.

GetSpecification()

virtual std::string OpenTestSystem::Otx::Runtime::Api::Custom::CustomScreenImplementation::IScreenParameter::GetSpecification ( )

pure virtual

Gets specification.

Returns

Specification.

---

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

• IScreenParameter.h