Represents an OTX ContextVariable.
More...
#include <IContextVariable.h>
Represents an OTX ContextVariable.
◆ GetAppId()
| virtual std::string OpenTestSystem::Otx::Runtime::Api::Otx::IContextVariable::GetAppId |
( |
| ) |
const |
|
pure virtual |
Gets the Id of the mapped external application.
- Returns
- Application Id.
◆ GetDataType()
| virtual std::string OpenTestSystem::Otx::Runtime::Api::Otx::IContextVariable::GetDataType |
( |
| ) |
const |
|
pure virtual |
Gets DataType.
- Returns
- DataType name.
◆ GetDocument()
| virtual std::shared_ptr<IDocument> OpenTestSystem::Otx::Runtime::Api::Otx::IContextVariable::GetDocument |
( |
| ) |
|
|
pure virtual |
Gets Document that contains the ContextVariable.
- Returns
- A Document which this Variable belongs to.
◆ GetExternalApps()
| virtual std::map<std::string, std::string> OpenTestSystem::Otx::Runtime::Api::Otx::IContextVariable::GetExternalApps |
( |
| ) |
const |
|
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.
◆ GetInitValue()
Gets initial value.
- Returns
- Initial value.
◆ GetMappingIndex()
| virtual int OpenTestSystem::Otx::Runtime::Api::Otx::IContextVariable::GetMappingIndex |
( |
| ) |
const |
|
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::Otx::IContextVariable::GetMappingName |
( |
| ) |
const |
|
pure virtual |
Gets mapping name.
If a valid mapping exists for this Variable, 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 Variable. It contains all namespace elements separated by dots (".").
- Returns
- Mapping name.
◆ GetName()
| virtual std::string OpenTestSystem::Otx::Runtime::Api::Otx::IContextVariable::GetName |
( |
| ) |
const |
|
pure virtual |
Gets variable name.
- Returns
- Variable name.
◆ GetSpecification()
| virtual std::string OpenTestSystem::Otx::Runtime::Api::Otx::IContextVariable::GetSpecification |
( |
| ) |
const |
|
pure virtual |
Gets specification.
- Returns
- specification.
◆ IsEnvironmentValueActive()
| virtual bool OpenTestSystem::Otx::Runtime::Api::Otx::IContextVariable::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.
The documentation for this class was generated from the following file:
