OTX-Runtime for C++  
OpenTestSystem::Otx::Runtime::Api::Otx::IPackage Class Referenceabstract

Contains Documents and child Packages. More...

#include <IPackage.h>

Public Member Functions

virtual std::vector< std::shared_ptr< IDocument > > GetDocuments ()=0
 Gets all Documents. More...
 
virtual std::string GetFullName ()=0
 Gets Package full name. More...
 
virtual std::string GetName ()=0
 Gets Package name. More...
 
virtual std::vector< std::shared_ptr< IPackage > > GetPackages ()=0
 Gets all child Packages. More...
 
virtual std::shared_ptr< IPackageGetParent ()=0
 Gets parent Package of the current Package or NULL, if the current package is the root Package. More...
 
virtual std::shared_ptr< Project::IProjectGetProject ()=0
 Gets Project that contains the Package. More...
 

Detailed Description

Contains Documents and child Packages.

Member Function Documentation

◆ GetDocuments()

virtual std::vector<std::shared_ptr<IDocument> > OpenTestSystem::Otx::Runtime::Api::Otx::IPackage::GetDocuments ( )
pure virtual

Gets all Documents.

Returns
A list of Documents.

◆ GetFullName()

virtual std::string OpenTestSystem::Otx::Runtime::Api::Otx::IPackage::GetFullName ( )
pure virtual

Gets Package full name.

Returns
A combination of all levels from this to the root, separated by '.'.

◆ GetName()

virtual std::string OpenTestSystem::Otx::Runtime::Api::Otx::IPackage::GetName ( )
pure virtual

Gets Package name.

Returns
Package name.

◆ GetPackages()

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

Gets all child Packages.

Returns
A list of child Packages.

◆ GetParent()

virtual std::shared_ptr<IPackage> OpenTestSystem::Otx::Runtime::Api::Otx::IPackage::GetParent ( )
pure virtual

Gets parent Package of the current Package or NULL, if the current package is the root Package.

Returns
A Package which this Package belongs to.

◆ GetProject()

virtual std::shared_ptr<Project::IProject> OpenTestSystem::Otx::Runtime::Api::Otx::IPackage::GetProject ( )
pure virtual

Gets Project that contains the Package.

Returns
A Project which this Package belongs to.

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