CXXR::ReturnException Class Reference

Exception class to convey return value. More...

#include <ReturnException.hpp>

List of all members.

Public Member Functions
	ReturnException (Environment *the_environment, RObject *the_value)
	Constructor.
Environment *	environment () const
	Target Environment of this ReturnException.
RObject *	value () const
	Payload of this ReturnException.

---

Detailed Description

Exception class to convey return value.

An exception of this class conveys a value back to a computation (typically a Closure application) operating within a specified working Environment, and is used for example to implement the R return command.

---

Constructor & Destructor Documentation

CXXR::ReturnException::ReturnException ( Environment *  the_environment, RObject *  the_value  )

inline

Constructor.

Parameters:

the_environment	Pointer to the working Environment of the computational context within which the exception is to be caught. (catch blocks within other contexts should rethrow the exception.)
the_value	Pointer, possibly null, to the RObject to be conveyed back to the target Environment.

---

Member Function Documentation

Environment* CXXR::ReturnException::environment ( ) const

inline

Target Environment of this ReturnException.

Returns:

pointer to the Environment within which this ReturnException should be caught.

RObject* CXXR::ReturnException::value ( ) const

inline

Payload of this ReturnException.

Returns:

Pointer, possibly null, to the RObject conveyed to the target Environment by this ReturnException.

---

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

• ReturnException.hpp ($Id: ReturnException.hpp 1348 2013-02-25 17:49:03Z arr $)