CXXR (C++ R)
Public Member Functions | Static Public Member Functions
CXXR::Browser Class Reference

Class recording the use of R browsers. More...

#include <Browser.hpp>

List of all members.

Public Member Functions

 Browser (RObject *the_text, RObject *the_condition)
 Constructor.
RObject * condition () const
 Condition argument associated with a Browser.
Evaluator::Context * context () const
 Context within which Browser was declared.
RObject * text () const
 Text argument associated with Browser.

Static Public Member Functions

static unsigned int numberActive ()
 Number of browser levels currently active.
static Browser * fromOutermost (unsigned int i)
 Browser at specified level of nesting.

Detailed Description

Class recording the use of R browsers.

Browser objects must be declared on the processor stack (i.e. as C++ automatic variables). The class maintains a vector of pointers to the Browser objects currently in existence.


Constructor & Destructor Documentation

CXXR::Browser::Browser ( RObject *  the_text,
RObject *  the_condition 
)
inline

Constructor.

Parameters:
the_text'text' argument supplied to R browser command.
the_condition'condition' argument supplied to R browser command.

Member Function Documentation

RObject* CXXR::Browser::condition ( ) const
inline

Condition argument associated with a Browser.

Returns:
The 'condition' argument associated with this Browser.
Evaluator::Context* CXXR::Browser::context ( ) const
inline

Context within which Browser was declared.

Returns:
Pointer to the Context in which this Browser was declared.
Note:
This function is used to reproduce the rather strange behaviour of the R function browserSetDebug in CR.
static Browser* CXXR::Browser::fromOutermost ( unsigned int  i)
inlinestatic

Browser at specified level of nesting.

Parameters:
iIndex of the Browser required. 0 signifies the outermost (first invoked) browser level. Must be less than numberActive().
Returns:
Pointer to the Browser at level i.
static unsigned int CXXR::Browser::numberActive ( )
inlinestatic

Number of browser levels currently active.

Returns:
the number of browser levels currently active.
RObject* CXXR::Browser::text ( ) const
inline

Text argument associated with Browser.

Returns:
The 'text' argument associated with this Browser.

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