TSLWPSExecuteResponse Class Reference

Detailed Description

Represents a WPS Execute operation response. By default, this XML document is delivered to the client in response to an Execute request. It encodes the ExecuteResponse element from the WPS Schema.

Public Member Functions
	TSLWPSExecuteResponse (const TSLWPSProcessBriefType &process, const TSLWPSStatusType &status)
	TSLWPSExecuteResponse (const TSLWPSExecuteResponse &rhs)
void	addProcessOutput (const TSLWPSOutputDataType &output)
void	destroy ()
const TSLWPSOutputDataType *	getProcessOutputAt (unsigned int index) const
TSLWPSOutputDataType *	getProcessOutputAt (unsigned int index)
unsigned int	noOfProcessOutputs () const
const TSLWPSProcessBriefType &	process () const
TSLWPSProcessBriefType &	process ()
bool	removeProcessOutput (unsigned int index)
const TSLWPSStatusType &	status () const
TSLWPSStatusType &	status ()
void *	operator new (size_t size)
void *	operator new (size_t size, char *filename, int line)

Constructor & Destructor Documentation

TSLWPSExecuteResponse() [1/2]

TSLWPSExecuteResponse::TSLWPSExecuteResponse	(	const TSLWPSProcessBriefType &	process,
		const TSLWPSStatusType &	status )

Basic constructor. Creates an execute response with the given process brief and status.

Parameters

process	The process brief (description).
status	The status of the process execution.

TSLWPSExecuteResponse() [2/2]

TSLWPSExecuteResponse::TSLWPSExecuteResponse

(

const TSLWPSExecuteResponse &

rhs

)

Copy constructor, performs a deep copy of the given execute response.

Parameters

rhs	Const reference to the execute response type to copy.

Member Function Documentation

addProcessOutput()

void TSLWPSExecuteResponse::addProcessOutput

(

const TSLWPSOutputDataType &

output

)

Adds a process output.

Parameters

output

The process output to add.

destroy()

void TSLWPSExecuteResponse::destroy

(

)

Used to delete this object

getProcessOutputAt() [1/2]

TSLWPSOutputDataType * TSLWPSExecuteResponse::getProcessOutputAt

(

unsigned int

index

)

Retrieves a specified process output.

Parameters

index

The index of the required process output.

Returns

a pointer to the process output at the specified index. If there is no process output at the specified index then the method will return 0.

getProcessOutputAt() [2/2]

const TSLWPSOutputDataType * TSLWPSExecuteResponse::getProcessOutputAt

(

unsigned int

index

)

const

Retrieves a specified process output.

Parameters

index

The index of the required process output.

Returns

a const pointer to the process output at the specified index. If there is no process output at the specified index then the method will return 0.

noOfProcessOutputs()

unsigned int TSLWPSExecuteResponse::noOfProcessOutputs

(

)

const

Returns the number of process outputs in the execute response.

operator new() [1/2]

void * TSLWPSExecuteResponse::operator new

(

size_t

size

)

operator new() [2/2]

void * TSLWPSExecuteResponse::operator new	(	size_t	size,
		char *	filename,
		int	line )

When included in an MFC applicaton in debug mode, the debug new expects this to be here. Override it and return the same as the normal one. The library must include it when compiled in release mode, since the users application may be in debug mode.

process() [1/2]

TSLWPSProcessBriefType & TSLWPSExecuteResponse::process

(

)

Returns a reference to the process description. This accessor method should be used to modify the description.

process() [2/2]

const TSLWPSProcessBriefType & TSLWPSExecuteResponse::process

(

)

const

Returns a const reference to the process description.

removeProcessOutput()

bool TSLWPSExecuteResponse::removeProcessOutput

(

unsigned int

index

)

Removes the process output at the specified index.

Parameters

index

The index of the process output item to remove.

Returns

true if successful, false otherwise.

status() [1/2]

TSLWPSStatusType & TSLWPSExecuteResponse::status

(

)

Returns a reference to the status description. This accessor method should be used to modify the status.

status() [2/2]

const TSLWPSStatusType & TSLWPSExecuteResponse::status

(

)

const

Returns a const reference to the process status.