CXXR (C++ R) API
Public Member Functions
CXXR::Environment::ReturnScope Class Reference

Object authorising R 'return' command. More...

#include <Environment.h>

List of all members.

Public Member Functions

 ReturnScope (Environment *env)
 Constructor.

Detailed Description

Object authorising R 'return' command.

ReturnScope objects must be declared on the processor stack (i.e. as C++ automatic variables). Each Environment object keeps track of the number of ReturnScope objects associated with it. The R command 'return' is legal only when the evaluation Environment has at least one ReturnScope in existence; this can be determined by calling Environment::canReturn(). More generally, a transfer of control to a specified Environment using ReturnException will succeed only if canReturn() is true.


Constructor & Destructor Documentation

CXXR::Environment::ReturnScope::ReturnScope ( Environment env)
inline

Constructor.

Parameters:
envPointer to the Environment with which this ReturnScope is to be associated.

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