OTX-Runtime for DotNet  
OpenTestSystem.Otx.Runtime.Api.Project.IProject Interface Reference

The Project is the root element of the OTX Data Structure. It mainly contains the Packages and the Project Settings. More...

Public Member Functions

IProcedure GetProcedureByName (string fullName)
 Gets procedure base on it's full name. More...
 
ISignature GetSignatureByName (string fullName)
 Gets signature having the same full name. More...
 

Properties

IProcedure MainProcedure [get]
 Gets main Procedure of startup Document. More...
 
string Name [get]
 Gets Project name. More...
 
IPackage[] Packages [get]
 Gets all Packages. More...
 
IPlayerProject PlayerProject [get]
 Gets PlayerProject that contains the Project. More...
 
IProjectSettings ProjectSettings [get]
 Gets the Project Settings. More...
 
IRuntimeManager RuntimeManager [get]
 Gets RuntimeManager that contains the Project. More...
 
Dictionary< string, string > Settings [get, set]
 Gets or sets the Project Settings. More...
 
IDocument StartupDocument [get]
 Gets startup Document. More...
 
string Version [get]
 Gets Project version. More...
 

Detailed Description

The Project is the root element of the OTX Data Structure. It mainly contains the Packages and the Project Settings.

Member Function Documentation

◆ GetProcedureByName()

IProcedure OpenTestSystem.Otx.Runtime.Api.Project.IProject.GetProcedureByName ( string  fullName)

Gets procedure base on it's full name.

Returns
A Procedure with following full name. If no procedure was found, return null.

◆ GetSignatureByName()

ISignature OpenTestSystem.Otx.Runtime.Api.Project.IProject.GetSignatureByName ( string  fullName)

Gets signature having the same full name.

Parameters
fullNameThe full name of the signature (package.documentName.signatureName).
Returns
The signature, if no signature was found, returns null.

Property Documentation

◆ MainProcedure

IProcedure OpenTestSystem.Otx.Runtime.Api.Project.IProject.MainProcedure
get

Gets main Procedure of startup Document.

◆ Name

string OpenTestSystem.Otx.Runtime.Api.Project.IProject.Name
get

Gets Project name.

◆ Packages

IPackage [] OpenTestSystem.Otx.Runtime.Api.Project.IProject.Packages
get

Gets all Packages.

◆ PlayerProject

IPlayerProject OpenTestSystem.Otx.Runtime.Api.Project.IProject.PlayerProject
get

Gets PlayerProject that contains the Project.

◆ ProjectSettings

IProjectSettings OpenTestSystem.Otx.Runtime.Api.Project.IProject.ProjectSettings
get

Gets the Project Settings.

As an alternative it is possible to handle the settings inside Settings.

◆ RuntimeManager

IRuntimeManager OpenTestSystem.Otx.Runtime.Api.Project.IProject.RuntimeManager
get

Gets RuntimeManager that contains the Project.

◆ Settings

Dictionary<string, string> OpenTestSystem.Otx.Runtime.Api.Project.IProject.Settings
getset

Gets or sets the Project Settings.

Gets or sets the Project Settings as a map of names and value pairs. The getter returns all settings. The setter sets only the name value pairs in the given map. The other settings will not be influenced. To improve the performance, it is recommended to set all to be changed setting in one map. As an alternative it is possible to handle the single settings inside ProjectSettings. This is more convenient and more type safe but slower than this property.

◆ StartupDocument

IDocument OpenTestSystem.Otx.Runtime.Api.Project.IProject.StartupDocument
get

Gets startup Document.

◆ Version

string OpenTestSystem.Otx.Runtime.Api.Project.IProject.Version
get

Gets Project version.


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