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

Contains Projects. More...

#include <IPlayerProject.h>

Public Member Functions
virtual std::string	GetName ()=0
	Gets PlayerProject name. More...
virtual std::string	GetPlayerLayoutPath ()=0
	Gets Layout path. More...
virtual std::string	GetPlaylistPath ()=0
	Gets Playlist path. More...
virtual std::vector< std::shared_ptr< IProject > >	GetProjects ()=0
	Gets all Projects. More...
virtual std::shared_ptr< Settings::IProjectSettings >	GetProjectSettings ()=0
virtual std::map< std::string, std::string >	GetSettings ()=0
	Gets all available Project Settings as a map of names and values. More...
virtual std::string	GetVersion ()=0
	Gets PlayerProject 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

Contains Projects.

Member Function Documentation

GetName()

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

pure virtual

Gets PlayerProject name.

Returns

PlayerProject name.

GetPlayerLayoutPath()

virtual std::string OpenTestSystem::Otx::Runtime::Api::Project::IPlayerProject::GetPlayerLayoutPath ( )

pure virtual

Gets Layout path.

Returns

Path of Layout file.

GetPlaylistPath()

virtual std::string OpenTestSystem::Otx::Runtime::Api::Project::IPlayerProject::GetPlaylistPath ( )

pure virtual

Gets Playlist path.

Returns

Path of Playlist file.

GetProjects()

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

pure virtual

Gets all Projects.

Returns

A list of Projects.

GetProjectSettings()

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

pure virtual

Gets the Project Settings.

Returns

A ProjectSettings which this Project belongs to.

GetSettings()

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

pure virtual

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

Returns

A map of property names and setting values.

GetVersion()

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

pure virtual

Gets PlayerProject version.

Returns

PlayerProject version.

SetSettings()

virtual void OpenTestSystem::Otx::Runtime::Api::Project::IPlayerProject::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:

• IPlayerProject.h