OpenTestSystem::Otx::Runtime::Api::Otx::IDocument Class Reference

Represents an OTX. More...

#include <IDocument.h>

Public Member Functions
virtual std::vector< std::shared_ptr< IContextVariable > >	GetContextVariables ()=0
	Gets all ContextVariables. More...
virtual std::string	GetFullName ()=0
	Gets Document full name. More...
virtual std::vector< std::shared_ptr< IDocument > >	GetImports ()=0
	Gets all imported Documents. An imported Documents can also contain Imports in an arbitrary depth depending on the OTX Document structure. More...
virtual std::shared_ptr< IProcedure >	GetMainProcedure ()=0
	Gets main Procedure. More...
virtual std::string	GetName ()=0
	Gets Document name. More...
virtual std::shared_ptr< IPackage >	GetPackage ()=0
	Gets Package that contains the Document. More...
virtual std::vector< std::shared_ptr< IProcedure > >	GetProcedures ()=0
	Gets all Procedures. More...
virtual std::vector< std::shared_ptr< Signature::ISignature > >	GetSignatures ()=0
	Gets all Signatures. More...
virtual std::string	GetSpecification ()=0
	Gets Otx specification. More...
virtual std::vector< std::shared_ptr< IStateVariable > >	GetStateVariables ()=0
	Gets all StateVariables. More...
virtual std::string	GetVersion ()=0
	Gets Otx version. More...
virtual bool	IsStartup ()=0
	Checks if the Document is the startup Document. More...

Detailed Description

Represents an OTX.

Member Function Documentation

GetContextVariables()

virtual std::vector<std::shared_ptr<IContextVariable> > OpenTestSystem::Otx::Runtime::Api::Otx::IDocument::GetContextVariables ( )

pure virtual

Gets all ContextVariables.

Returns

A list of ContextVariables.

GetFullName()

virtual std::string OpenTestSystem::Otx::Runtime::Api::Otx::IDocument::GetFullName ( )

pure virtual

Gets Document full name.

Returns

A combination of Package full name and Document name, separated by '.'.

GetImports()

virtual std::vector<std::shared_ptr<IDocument> > OpenTestSystem::Otx::Runtime::Api::Otx::IDocument::GetImports ( )

pure virtual

Gets all imported Documents. An imported Documents can also contain Imports in an arbitrary depth depending on the OTX Document structure.

Returns

A list of imported Documents.

GetMainProcedure()

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

pure virtual

Gets main Procedure.

Returns

Main Procedure.

GetName()

virtual std::string OpenTestSystem::Otx::Runtime::Api::Otx::IDocument::GetName ( )

pure virtual

Gets Document name.

Returns

Document name.

GetPackage()

virtual std::shared_ptr<IPackage> OpenTestSystem::Otx::Runtime::Api::Otx::IDocument::GetPackage ( )

pure virtual

Gets Package that contains the Document.

Returns

A Package which this Document belongs to.

GetProcedures()

virtual std::vector<std::shared_ptr<IProcedure> > OpenTestSystem::Otx::Runtime::Api::Otx::IDocument::GetProcedures ( )

pure virtual

Gets all Procedures.

Returns

A list of Procedures.

GetSignatures()

virtual std::vector<std::shared_ptr<Signature::ISignature> > OpenTestSystem::Otx::Runtime::Api::Otx::IDocument::GetSignatures ( )

pure virtual

Gets all Signatures.

GetSpecification()

virtual std::string OpenTestSystem::Otx::Runtime::Api::Otx::IDocument::GetSpecification ( )

pure virtual

Gets Otx specification.

Returns

Otx specification.

GetStateVariables()

virtual std::vector<std::shared_ptr<IStateVariable> > OpenTestSystem::Otx::Runtime::Api::Otx::IDocument::GetStateVariables ( )

pure virtual

Gets all StateVariables.

Returns

A list of StateVariables.

GetVersion()

virtual std::string OpenTestSystem::Otx::Runtime::Api::Otx::IDocument::GetVersion ( )

pure virtual

Gets Otx version.

Returns

Otx version.

IsStartup()

virtual bool OpenTestSystem::Otx::Runtime::Api::Otx::IDocument::IsStartup ( )

pure virtual

Checks if the Document is the startup Document.

Returns

True if this document is startup; otherwise, false.

---

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

• IDocument.h