This is a class to get ROOT's objects from R's objects.

TRObject class

The TRObject class lets you obtain ROOT's objects from R's objects.
It has some basic template operators to convert R's objects into ROOT's datatypes

A simple example

#include<TRInterface.h>
void Proxy()
{
ROOT::R::TRInterface &r=ROOT::R::TRInterface::Instance();
ROOT::R::TRObject obj;
obj=r.Eval("seq(1,10)");
TVectorD v=obj;
v.Print();
}

Output

Vector (10)  is as follows
 
|        1  |
------------------
|1
|2
|3
|4
|5
|6
|7
|8
|9
|10

Users Guide

https://oproject.org/pages/ROOT R Users Guide

Definition at line 70 of file TRObject.h.

Public Member Functions
	TRObject ()
	Default constructor.

	TRObject (SEXP robj)
	Construct a TRObject given a R base object.

	TRObject (SEXP robj, Bool_t status)
	Construct a TRObject given a R base object.

template<class T >
T	As ()
	Some datatypes of ROOT or c++ can be wrapped in to a TRObject, this method lets you unwrap those datatypes encapsulate into this TRObject.

TRObject	GetAttribute (const TString name)
	The R objects can to have associate attributes with this method you can added attribute to TRObject given an object in the template argument.

Bool_t	GetStatus ()
	TRObject is a current valid object?

virtual TClass *	IsA () const

	operator Rcpp::RObject ()

	operator SEXP ()

	operator SEXP () const

template<class T >
	operator T ()

void	operator= (SEXP xx)

template<class T >
T	operator= (TRObject &obj)

template<class T >
void	SetAttribute (const TString name, T obj)
	The R objects can to have associate attributes with this method you can added attribute to TRObject given an object in the template argument.

void	SetStatus (Bool_t status)
	TRObject is a current valid object?

virtual void	Streamer (TBuffer &)
	Stream an object of class TObject.

void	StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)

template<class T >
TRObject &	Wrap (T obj)
	Some datatypes of ROOT or c++ can be wrapped in to a TRObject, this method lets you wrap those datatypes.

Public Member Functions inherited from TObject
	TObject ()
	TObject constructor.

	TObject (const TObject &object)
	TObject copy ctor.

virtual	~TObject ()
	TObject destructor.

void	AbstractMethod (const char *method) const
	Use this method to implement an "abstract" method that you don't want to leave purely abstract.

virtual void	AppendPad (Option_t *option="")
	Append graphics object to current pad.

virtual void	Browse (TBrowser *b)
	Browse object. May be overridden for another default action.

ULong_t	CheckedHash ()
	Check and record whether this class has a consistent Hash/RecursiveRemove setup (*) and then return the regular Hash value for this object.

virtual const char *	ClassName () const
	Returns name of class to which the object belongs.

virtual void	Clear (Option_t *="")

virtual TObject *	Clone (const char *newname="") const
	Make a clone of an object using the Streamer facility.

virtual Int_t	Compare (const TObject *obj) const
	Compare abstract method.

virtual void	Copy (TObject &object) const
	Copy this to obj.

virtual void	Delete (Option_t *option="")
	Delete this object.

virtual Int_t	DistancetoPrimitive (Int_t px, Int_t py)
	Computes distance from point (px,py) to the object.

virtual void	Draw (Option_t *option="")
	Default Draw method for all objects.

virtual void	DrawClass () const
	Draw class inheritance tree of the class to which this object belongs.

virtual TObject *	DrawClone (Option_t *option="") const
	Draw a clone of this object in the current selected pad with: `gROOT->SetSelectedPad(c1)`.

virtual void	Dump () const
	Dump contents of object on stdout.

virtual void	Error (const char method, const char msgfmt,...) const
	Issue error message.

virtual void	Execute (const char method, const char params, Int_t *error=nullptr)
	Execute method on this object with the given parameter string, e.g.

virtual void	Execute (TMethod method, TObjArray params, Int_t *error=nullptr)
	Execute method on this object with parameters stored in the TObjArray.

virtual void	ExecuteEvent (Int_t event, Int_t px, Int_t py)
	Execute action corresponding to an event at (px,py).

virtual void	Fatal (const char method, const char msgfmt,...) const
	Issue fatal error message.

virtual TObject *	FindObject (const char *name) const
	Must be redefined in derived classes.

virtual TObject *	FindObject (const TObject *obj) const
	Must be redefined in derived classes.

virtual Option_t *	GetDrawOption () const
	Get option used by the graphics system to draw this object.

virtual const char *	GetIconName () const
	Returns mime type name of object.

virtual const char *	GetName () const
	Returns name of object.

virtual char *	GetObjectInfo (Int_t px, Int_t py) const
	Returns string containing info about the object at position (px,py).

virtual Option_t *	GetOption () const

virtual const char *	GetTitle () const
	Returns title of object.

virtual UInt_t	GetUniqueID () const
	Return the unique object id.

virtual Bool_t	HandleTimer (TTimer *timer)
	Execute action in response of a timer timing out.

virtual ULong_t	Hash () const
	Return hash value for this object.

Bool_t	HasInconsistentHash () const
	Return true is the type of this object is known to have an inconsistent setup for Hash and RecursiveRemove (i.e.

virtual void	Info (const char method, const char msgfmt,...) const
	Issue info message.

virtual Bool_t	InheritsFrom (const char *classname) const
	Returns kTRUE if object inherits from class "classname".

virtual Bool_t	InheritsFrom (const TClass *cl) const
	Returns kTRUE if object inherits from TClass cl.

virtual void	Inspect () const
	Dump contents of this object in a graphics canvas.

void	InvertBit (UInt_t f)

Bool_t	IsDestructed () const
	IsDestructed.

virtual Bool_t	IsEqual (const TObject *obj) const
	Default equal comparison (objects are equal if they have the same address in memory).

virtual Bool_t	IsFolder () const
	Returns kTRUE in case object contains browsable objects (like containers or lists of other objects).

R__ALWAYS_INLINE Bool_t	IsOnHeap () const

virtual Bool_t	IsSortable () const

R__ALWAYS_INLINE Bool_t	IsZombie () const

virtual void	ls (Option_t *option="") const
	The ls function lists the contents of a class on stdout.

void	MayNotUse (const char *method) const
	Use this method to signal that a method (defined in a base class) may not be called in a derived class (in principle against good design since a child class should not provide less functionality than its parent, however, sometimes it is necessary).

virtual Bool_t	Notify ()
	This method must be overridden to handle object notification.

void	Obsolete (const char method, const char asOfVers, const char *removedFromVers) const
	Use this method to declare a method obsolete.

void	operator delete (void *ptr)
	Operator delete.

void	operator delete[] (void *ptr)
	Operator delete [].

void *	operator new (size_t sz)

void *	operator new (size_t sz, void *vp)

void *	operator new[] (size_t sz)

void *	operator new[] (size_t sz, void *vp)

TObject &	operator= (const TObject &rhs)
	TObject assignment operator.

virtual void	Paint (Option_t *option="")
	This method must be overridden if a class wants to paint itself.

virtual void	Pop ()
	Pop on object drawn in a pad to the top of the display list.

virtual void	Print (Option_t *option="") const
	This method must be overridden when a class wants to print itself.

virtual Int_t	Read (const char *name)
	Read contents of object with specified name from the current directory.

virtual void	RecursiveRemove (TObject *obj)
	Recursively remove this object from a list.

void	ResetBit (UInt_t f)

virtual void	SaveAs (const char filename="", Option_t option="") const
	Save this object in the file specified by filename.

virtual void	SavePrimitive (std::ostream &out, Option_t *option="")
	Save a primitive as a C++ statement(s) on output stream "out".

void	SetBit (UInt_t f)

void	SetBit (UInt_t f, Bool_t set)
	Set or unset the user status bits as specified in f.

virtual void	SetDrawOption (Option_t *option="")
	Set drawing option for object.

virtual void	SetUniqueID (UInt_t uid)
	Set the unique object id.

void	StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)

virtual void	SysError (const char method, const char msgfmt,...) const
	Issue system error message.

R__ALWAYS_INLINE Bool_t	TestBit (UInt_t f) const

Int_t	TestBits (UInt_t f) const

virtual void	UseCurrentStyle ()
	Set current style settings in this object This function is called when either TCanvas::UseCurrentStyle or TROOT::ForceStyle have been invoked.

virtual void	Warning (const char method, const char msgfmt,...) const
	Issue warning message.

virtual Int_t	Write (const char *name=nullptr, Int_t option=0, Int_t bufsize=0)
	Write this object to the current directory.

virtual Int_t	Write (const char *name=nullptr, Int_t option=0, Int_t bufsize=0) const
	Write this object to the current directory.

Static Public Member Functions
static TClass *	Class ()

static const char *	Class_Name ()

static constexpr Version_t	Class_Version ()

static const char *	DeclFileName ()

Static Public Member Functions inherited from TObject
static TClass *	Class ()

static const char *	Class_Name ()

static constexpr Version_t	Class_Version ()

static const char *	DeclFileName ()

static Longptr_t	GetDtorOnly ()
	Return destructor only flag.

static Bool_t	GetObjectStat ()
	Get status of object stat flag.

static void	SetDtorOnly (void *obj)
	Set destructor only flag.

static void	SetObjectStat (Bool_t stat)
	Turn on/off tracking of objects in the TObjectTable.

Private Attributes
Rcpp::RObject	fObj

Bool_t	fStatus

Friends
SEXP	Rcpp::wrap (const TRObject &f)

Additional Inherited Members
Public Types inherited from TObject
enum	{ kIsOnHeap = 0x01000000 , kNotDeleted = 0x02000000 , kZombie = 0x04000000 , kInconsistent = 0x08000000 , kBitMask = 0x00ffffff }

enum	{ kSingleKey = (1ULL << ( 0 )) , kOverwrite = (1ULL << ( 1 )) , kWriteDelete = (1ULL << ( 2 )) }

enum	EDeprecatedStatusBits { kObjInCanvas = (1ULL << ( 3 )) }

enum	EStatusBits { kCanDelete = (1ULL << ( 0 )) , kMustCleanup = (1ULL << ( 3 )) , kIsReferenced = (1ULL << ( 4 )) , kHasUUID = (1ULL << ( 5 )) , kCannotPick = (1ULL << ( 6 )) , kNoContextMenu = (1ULL << ( 8 )) , kInvalidObject = (1ULL << ( 13 )) }

Protected Types inherited from TObject
enum	{ kOnlyPrepStep = (1ULL << ( 3 )) }

Protected Member Functions inherited from TObject
virtual void	DoError (int level, const char location, const char fmt, va_list va) const
	Interface to ErrorHandler (protected).

void	MakeZombie ()

#include <TRObject.h>

Inheritance diagram for ROOT::R::TRObject:

[legend]

Constructor & Destructor Documentation

◆ TRObject() [1/3]

ROOT::R::TRObject::TRObject ( )

inline

Default constructor.

Definition at line 79 of file TRObject.h.

◆ TRObject() [2/3]

TRObject::TRObject ( SEXP robj )

Construct a TRObject given a R base object.

Parameters

robj	raw R object

Definition at line 17 of file TRObject.cxx.

◆ TRObject() [3/3]

TRObject::TRObject	(	SEXP	robj,
		Bool_t	status
	)

Construct a TRObject given a R base object.

Parameters

robj	raw R object
status	if the raw object is valid obj

Definition at line 28 of file TRObject.cxx.

Member Function Documentation

◆ As()

template<class T >

T ROOT::R::TRObject::As ( )

inline

Some datatypes of ROOT or c++ can be wrapped in to a TRObject, this method lets you unwrap those datatypes encapsulate into this TRObject.

Note: If the current TRObject is not a valid object it will return and empty object and it will print an error message

Returns: template return with the require datatype

Definition at line 152 of file TRObject.h.

◆ Class()

static TClass * ROOT::R::TRObject::Class ( )

static

Returns: TClass describing this class

◆ Class_Name()

static const char * ROOT::R::TRObject::Class_Name ( )

static

Returns: Name of this class

◆ Class_Version()

static constexpr Version_t ROOT::R::TRObject::Class_Version ( )

inlinestaticconstexpr

Returns: Version of this class

Definition at line 194 of file TRObject.h.

◆ DeclFileName()

static const char * ROOT::R::TRObject::DeclFileName ( )

inlinestatic

Returns: Name of the file containing the class declaration

Definition at line 194 of file TRObject.h.

◆ GetAttribute()

TRObject ROOT::R::TRObject::GetAttribute ( const TString name )

inline

The R objects can to have associate attributes with this method you can added attribute to TRObject given an object in the template argument.

Parameters

name	attribute name

Returns: object associated to the attribute name in the current TRObject

Definition at line 127 of file TRObject.h.

◆ GetStatus()

Bool_t ROOT::R::TRObject::GetStatus ( )

inline

TRObject is a current valid object?

Returns: status if the current object

Definition at line 105 of file TRObject.h.

◆ IsA()

virtual TClass * ROOT::R::TRObject::IsA ( ) const

inlinevirtual

Returns: TClass describing current object

Reimplemented from TObject.

Definition at line 194 of file TRObject.h.

◆ operator Rcpp::RObject()

ROOT::R::TRObject::operator Rcpp::RObject ( )

inline

Definition at line 178 of file TRObject.h.

◆ operator SEXP() [1/2]

ROOT::R::TRObject::operator SEXP ( )

inline

Definition at line 168 of file TRObject.h.

◆ operator SEXP() [2/2]

ROOT::R::TRObject::operator SEXP ( ) const

inline

Definition at line 173 of file TRObject.h.

◆ operator T()

template<class T >

ROOT::R::TRObject::operator T ( )

inline

Definition at line 183 of file TRObject.h.

◆ operator=() [1/2]

void TRObject::operator= ( SEXP xx )

Definition at line 21 of file TRObject.cxx.

◆ operator=() [2/2]

template<class T >

T ROOT::R::TRObject::operator= ( TRObject & obj )

inline

Definition at line 163 of file TRObject.h.

◆ SetAttribute()

template<class T >

void ROOT::R::TRObject::SetAttribute	(	const TString	name,
		T	obj
	)

inline

The R objects can to have associate attributes with this method you can added attribute to TRObject given an object in the template argument.

Parameters

name	attribute name
obj	object associated to the attribute name in the current TRObject

Definition at line 116 of file TRObject.h.

◆ SetStatus()

void ROOT::R::TRObject::SetStatus ( Bool_t status )

inline

TRObject is a current valid object?

Parameters

status if the current object is valid obj

Definition at line 96 of file TRObject.h.

◆ Streamer()

virtual void ROOT::R::TRObject::Streamer ( TBuffer & R__b )

virtual

Stream an object of class TObject.

Reimplemented from TObject.

◆ StreamerNVirtual()

void ROOT::R::TRObject::StreamerNVirtual ( TBuffer & ClassDef_StreamerNVirtual_b )

inline

Definition at line 194 of file TRObject.h.

◆ Wrap()

template<class T >

TRObject & ROOT::R::TRObject::Wrap ( T obj )

inline

Some datatypes of ROOT or c++ can be wrapped in to a TRObject, this method lets you wrap those datatypes.

Parameters

obj	template object to be wrapped

Returns: TRObject reference of wrapped object

Definition at line 140 of file TRObject.h.

Friends And Related Symbol Documentation

◆ Rcpp::wrap

SEXP Rcpp::wrap ( const TRObject & f )

friend

Member Data Documentation

◆ fObj

Rcpp::RObject ROOT::R::TRObject::fObj

private

Definition at line 73 of file TRObject.h.

◆ fStatus

Bool_t ROOT::R::TRObject::fStatus

private

Definition at line 74 of file TRObject.h.

Libraries for ROOT::R::TRObject:

[legend]

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

bindings/r/inc/TRObject.h
bindings/r/src/TRObject.cxx

TRObject class

Users Guide

Public Member Functions

Static Public Member Functions

Private Attributes

Friends

Additional Inherited Members

Constructor & Destructor Documentation

◆ TRObject() [1/3]

◆ TRObject() [2/3]

◆ TRObject() [3/3]

Member Function Documentation

◆ As()

◆ Class()

◆ Class_Name()

◆ Class_Version()

◆ DeclFileName()

◆ GetAttribute()

◆ GetStatus()

◆ IsA()

◆ operator Rcpp::RObject()

◆ operator SEXP() [1/2]

◆ operator SEXP() [2/2]

◆ operator T()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ SetAttribute()

◆ SetStatus()

◆ Streamer()

◆ StreamerNVirtual()

◆ Wrap()

Friends And Related Symbol Documentation

◆ Rcpp::wrap

Member Data Documentation

◆ fObj

◆ fStatus