OpenTestSystem.Otx.RuntimeConverter.Api.IRuntimeConverter Interface Reference

Represents a checker and a compiler. More...

Public Member Functions
void	Compile (string destination)
	Compiles the loaded ptx/ppx/project and exports it with built-in CppOutput. More...
void	LoadPpx (string fileName)
	Loads a PPX file. More...
void	LoadPpx (string fileName, string password)
	Loads a PPX file. More...
void	LoadProject (string projectDirectory)
	Load a project. More...
void	LoadPtx (string fileName)
	Loads a PTX file. More...
void	LoadPtx (string fileName, string password)
	Loads a PTX file. More...
IError[]	Validate ()
	Validates the loaded ptx/ppx/project. More...

Properties
DiagValidationGroups	DiagValidationGroups [get, set]
	Gets or sets DiagValidationGroups. More...
string	ProjectVersion [get]
	Gets project version More...
ushort	XmlDbPort [get, set]
	Gets or sets XmlDbPort. XmlDbPort (default: 1984) is a port number which a BaseX Server is running on. The BaseX Server supports loading (needed for IRuntimeConverter.Compile) and querying (needed for IRuntimeConverter.Validate) OTX files via inter process communication. More...

Detailed Description

Represents a checker and a compiler.

Member Function Documentation

Compile()

void OpenTestSystem.Otx.RuntimeConverter.Api.IRuntimeConverter.Compile

(

string

destination

)

Compiles the loaded ptx/ppx/project and exports it with built-in CppOutput.

Parameters

destination

Path of exported ptx/ppx.

LoadPpx() [1/2]

void OpenTestSystem.Otx.RuntimeConverter.Api.IRuntimeConverter.LoadPpx

(

string

fileName

)

Loads a PPX file.

Parameters

fileName

Path of PPX file to load.

Exceptions

System.ArgumentNullException	Thrown when the given file name is null.
System.ArgumentException	Thrown when the given file name is empty.
System.IO.FileNotFoundException	Thrown when the given file cannot be found.
Exceptions.FileFormatException	Thrown when the file is not a ppx or it has no command.
Exceptions.WrongSignatureException	Thrown when the signature of ptx is wrong. Either the password is wrong or the content of the file was changed.

LoadPpx() [2/2]

void OpenTestSystem.Otx.RuntimeConverter.Api.IRuntimeConverter.LoadPpx	(	string	fileName,
		string	password
	)

Loads a PPX file.

Parameters

fileName	Path of PPX file to load.
password	The password to decrypt the ppx file.

Exceptions

System.ArgumentNullException	Thrown when the given file name is null.
System.ArgumentException	Thrown when the given file name is empty.
System.IO.FileNotFoundException	Thrown when the given file cannot be found.
Exceptions.FileFormatException	Thrown when the file is not a ppx or it has no command.
Exceptions.WrongSignatureException	Thrown when the signature of ptx is wrong. Either the password is wrong or the content of the file was changed.

LoadProject()

void OpenTestSystem.Otx.RuntimeConverter.Api.IRuntimeConverter.LoadProject

(

string

projectDirectory

)

Load a project.

Parameters

projectDirectory

Project directory which contains project file (*.otfPrj).

Exceptions

System.ArgumentNullException	Thrown when the given directory name is null.
System.ArgumentException	Thrown when the given directory name is empty.
System.IO.DirectoryNotFoundException	Thrown when the given directory cannot be found.

LoadPtx() [1/2]

void OpenTestSystem.Otx.RuntimeConverter.Api.IRuntimeConverter.LoadPtx

(

string

fileName

)

Loads a PTX file.

Parameters

fileName

Path of PTX file to load.

Exceptions

System.ArgumentNullException	Thrown when the given file name is null.
System.ArgumentException	Thrown when the given file name is empty.
System.IO.FileNotFoundException	Thrown when the given file cannot be found.
Exceptions.FileFormatException	Thrown when the file is not a ptx.
Exceptions.WrongSignatureException	Thrown when the signature of ptx is wrong. Either the password is wrong or the content of the file was changed.

LoadPtx() [2/2]

void OpenTestSystem.Otx.RuntimeConverter.Api.IRuntimeConverter.LoadPtx	(	string	fileName,
		string	password
	)

Loads a PTX file.

Parameters

fileName	Path of PTX file to load.
password	The password to decrypt the ptx file.

Exceptions

System.ArgumentNullException	Thrown when the given file name is null.
System.ArgumentException	Thrown when the given file name is empty.
System.IO.FileNotFoundException	Thrown when the given file cannot be found.
Exceptions.FileFormatException	Thrown when the file is not a ptx.
Exceptions.WrongSignatureException	Thrown when the signature of ptx is wrong. Either the password is wrong or the content of the file was changed.

Validate()

IError [] OpenTestSystem.Otx.RuntimeConverter.Api.IRuntimeConverter.Validate

(

)

Validates the loaded ptx/ppx/project.

Returns

Errors of the loaded ptx/ppx/project.

Property Documentation

DiagValidationGroups

DiagValidationGroups OpenTestSystem.Otx.RuntimeConverter.Api.IRuntimeConverter.DiagValidationGroups

getset

Gets or sets DiagValidationGroups.

ProjectVersion

string OpenTestSystem.Otx.RuntimeConverter.Api.IRuntimeConverter.ProjectVersion

get

Gets project version

XmlDbPort

ushort OpenTestSystem.Otx.RuntimeConverter.Api.IRuntimeConverter.XmlDbPort

getset

Gets or sets XmlDbPort. XmlDbPort (default: 1984) is a port number which a BaseX Server is running on. The BaseX Server supports loading (needed for IRuntimeConverter.Compile) and querying (needed for IRuntimeConverter.Validate) OTX files via inter process communication.

---

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

• IRuntimeConverter.cs