OpenTestSystem::Otx::Runtime::Api::Otx::IProcedure Class Reference

Represents an OTX Procedure. More...

#include <IProcedure.h>

Public Member Functions
virtual std::shared_ptr< IDocument >	GetDocument ()=0
	Gets Document that contains the Procedure. More...
virtual std::string	GetFullName ()=0
	Gets Procedure full name. More...
virtual std::string	GetName ()=0
	Gets Procedure name. More...
virtual std::vector< std::shared_ptr< IProcedureParameter > >	GetParameters ()=0
	Gets all Parameters. More...
virtual std::string	GetSpecification ()=0
	Gets Procedure specification. More...
virtual bool	IsMain ()=0
	Checks if this procedure is the main procedure. More...

Detailed Description

Represents an OTX Procedure.

Member Function Documentation

GetDocument()

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

pure virtual

Gets Document that contains the Procedure.

Returns

A Document which this Procedure belongs to.

GetFullName()

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

pure virtual

Gets Procedure full name.

Returns

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

GetName()

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

pure virtual

Gets Procedure name.

Returns

Procedure name.

GetParameters()

virtual std::vector<std::shared_ptr<IProcedureParameter> > OpenTestSystem::Otx::Runtime::Api::Otx::IProcedure::GetParameters ( )

pure virtual

Gets all Parameters.

Returns

A list of Parameters.

GetSpecification()

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

pure virtual

Gets Procedure specification.

Returns

Procedure specification.

IsMain()

virtual bool OpenTestSystem::Otx::Runtime::Api::Otx::IProcedure::IsMain ( )

pure virtual

Checks if this procedure is the main procedure.

Returns

True if this procedure is the main procedure; otherwise, false.

---

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

• IProcedure.h