OpenTestSystem::Otx::Runtime::Api::Project::IProject Class Reference

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

#include <IProject.h>

Public Member Functions
virtual std::shared_ptr< OpenTestSystem::Otx::Runtime::Api::Otx::IProcedure >	GetMainProcedure ()=0
	Gets main Procedure of startup Document. More...
virtual std::string	GetName ()=0
	Gets Project name. More...
virtual std::vector< std::shared_ptr< OpenTestSystem::Otx::Runtime::Api::Otx::IPackage > >	GetPackages ()=0
	Gets all Packages. More...
virtual std::shared_ptr< IPlayerProject >	GetPlayerProject ()=0
	Gets PlayerProject that contains the Project. More...
virtual std::shared_ptr< OpenTestSystem::Otx::Runtime::Api::Otx::IProcedure >	GetProcedureByName (std::string fullName)=0
	Gets procedure by it full name. More...
virtual std::shared_ptr< Settings::IProjectSettings >	GetProjectSettings ()=0
	Gets the Project Settings. More...
virtual std::shared_ptr< IRuntimeManager >	GetRuntimeManager ()=0
	Gets RuntimeManager that contains the Project. More...
virtual std::map< std::string, std::string >	GetSettings ()=0
	Gets all available Project Settings as a map of names and values. More...
virtual std::shared_ptr< OpenTestSystem::Otx::Runtime::Api::Otx::Signature::ISignature >	GetSignatureByName (std::string fullName)=0
	Gets signature having the same full name. More...
virtual std::shared_ptr< OpenTestSystem::Otx::Runtime::Api::Otx::IDocument >	GetStartupDocument ()=0
	Gets startup Document. More...
virtual std::string	GetVersion ()=0
	Gets Project version. More...
virtual void	SetSettings (std::map< std::string, std::string > settings)=0
	Sets the Project Settings as a map of names and values. Only the name value pairs in the given map will be set. The other settings will not be influenced. To improve the performance, it is recommended to set all to be changed setting in one map. 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

GetMainProcedure()

virtual std::shared_ptr<OpenTestSystem::Otx::Runtime::Api::Otx::IProcedure> OpenTestSystem::Otx::Runtime::Api::Project::IProject::GetMainProcedure ( )

pure virtual

Gets main Procedure of startup Document.

Returns

Main Procedure of startup Document.

GetName()

virtual std::string OpenTestSystem::Otx::Runtime::Api::Project::IProject::GetName ( )

pure virtual

Gets Project name.

Returns

Project name.

GetPackages()

virtual std::vector<std::shared_ptr<OpenTestSystem::Otx::Runtime::Api::Otx::IPackage> > OpenTestSystem::Otx::Runtime::Api::Project::IProject::GetPackages ( )

pure virtual

Gets all Packages.

Returns

A list of Packages.

GetPlayerProject()

virtual std::shared_ptr<IPlayerProject> OpenTestSystem::Otx::Runtime::Api::Project::IProject::GetPlayerProject ( )

pure virtual

Gets PlayerProject that contains the Project.

Returns

A PlayerProject which this Project belongs to.

GetProcedureByName()

virtual std::shared_ptr<OpenTestSystem::Otx::Runtime::Api::Otx::IProcedure> OpenTestSystem::Otx::Runtime::Api::Project::IProject::GetProcedureByName ( std::string  fullName )

pure virtual

Gets procedure by it full name.

Returns

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

GetProjectSettings()

virtual std::shared_ptr<Settings::IProjectSettings> OpenTestSystem::Otx::Runtime::Api::Project::IProject::GetProjectSettings ( )

pure virtual

Gets the Project Settings.

Returns

A ProjectSettings which this Project belongs to.

GetRuntimeManager()

virtual std::shared_ptr<IRuntimeManager> OpenTestSystem::Otx::Runtime::Api::Project::IProject::GetRuntimeManager ( )

pure virtual

Gets RuntimeManager that contains the Project.

Returns

A RuntimeManager which this Project belongs to.

GetSettings()

virtual std::map<std::string, std::string> OpenTestSystem::Otx::Runtime::Api::Project::IProject::GetSettings ( )

pure virtual

Gets all available Project Settings as a map of names and values.

Returns

A map of property names and setting values.

GetSignatureByName()

virtual std::shared_ptr<OpenTestSystem::Otx::Runtime::Api::Otx::Signature::ISignature> OpenTestSystem::Otx::Runtime::Api::Project::IProject::GetSignatureByName ( std::string  fullName )

pure virtual

Gets signature having the same full name.

Parameters

fullName

The full name of the signature (package.documentName.signatureName).

Returns

The signature, if no signature was found, returns null.

GetStartupDocument()

virtual std::shared_ptr<OpenTestSystem::Otx::Runtime::Api::Otx::IDocument> OpenTestSystem::Otx::Runtime::Api::Project::IProject::GetStartupDocument ( )

pure virtual

Gets startup Document.

Returns

Startup Document.

GetVersion()

virtual std::string OpenTestSystem::Otx::Runtime::Api::Project::IProject::GetVersion ( )

pure virtual

Gets Project version.

Returns

Project version.

SetSettings()

virtual void OpenTestSystem::Otx::Runtime::Api::Project::IProject::SetSettings ( std::map< std::string, std::string >  settings )

pure virtual

Sets the Project Settings as a map of names and values. Only the name value pairs in the given map will be set. The other settings will not be influenced. To improve the performance, it is recommended to set all to be changed setting in one map.

Parameters

settings

A map of property names and setting values.

---

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

• IProject.h