AutoTestQueueInterface Class Reference

#include <autotestqueue.h>

Inheritance diagram for AutoTestQueueInterface:

Detailed Description

A queue of test commands. A queue is executed with AutoTestInterface::StartTests().

Public Member Functions
MAXON_METHOD maxon::Result< void >	AddCommmand (const maxon::String &cmd, const maxon::Url &path)
MAXON_METHOD maxon::Result< void >	AddCommandsFromFile (const maxon::Url &file)
MAXON_METHOD maxon::Int	GetCommandCount ()
MAXON_METHOD maxon::Result< void >	GetCommand (maxon::String &cmd, maxon::Url &path)

Private Member Functions
	MAXON_INTERFACE (AutoTestQueueInterface, MAXON_REFERENCE_NORMAL, "net.maxonexample.tool.autotest.interfaces.autotestqueue")

Member Function Documentation

MAXON_INTERFACE()

MAXON_INTERFACE ( AutoTestQueueInterface  , MAXON_REFERENCE_NORMAL  , "net.maxonexample.tool.autotest.interfaces.autotestqueue"    )

private

AddCommmand()

MAXON_METHOD maxon::Result<void> AddCommmand	(	const maxon::String &	cmd,
		const maxon::Url &	path
	)

Adds a command to the queue.

Parameters

[in]	cmd	The command to add.
[in]	path	A path providing context for the command.

Returns

maxon::OK on success.

AddCommandsFromFile()

MAXON_METHOD maxon::Result<void> AddCommandsFromFile

(

const maxon::Url &

file

)

Reads commands from the given file and adds them to the queue.

Parameters

[in]

file

The file to read.

Returns

maxon::OK on success.

GetCommandCount()

MAXON_METHOD maxon::Int GetCommandCount

(

)

Returns the number of commands in the queue.

Returns

The number of commands left.

GetCommand()

MAXON_METHOD maxon::Result<void> GetCommand	(	maxon::String &	cmd,
		maxon::Url &	path
	)

Returns the first element of the queue and removes if from the queue.

Parameters

[out]	cmd	The command to execute
[out]	path	A path providing context for the command.

Returns

maxon::OK on success.