Logo ROOT   master
Reference Guide
ROOT::R::TRObject Class Reference

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 opetarors to convert R's objects into ROOT's datatypes

A simple example

Output

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

Users Guide

http://oproject.org/tiki-index.php?page=ROOT+R+Users+Guide
https://root.cern.ch/drupal/content/how-use-r-root-root-r-interface

Definition at line 71 of file TRObject.h.

Public Member Functions

 TRObject ()
 Default constructor. More...
 
 TRObject (SEXP robj)
 Construct a TRObject given a R base object. More...
 
 TRObject (SEXP robj, Bool_t status)
 Construct a TRObject given a R base object. More...
 
template<class 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. More...
 
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. More...
 
Bool_t GetStatus ()
 TRObject is a current valid object? More...
 
 operator Rcpp::RObject ()
 
 operator SEXP ()
 
 operator SEXP () const
 
template<class T >
 operator T ()
 
void operator= (SEXP xx)
 
template<class 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. More...
 
void SetStatus (Bool_t status)
 TRObject is a current valid object? More...
 
template<class T >
TRObjectWrap (T obj)
 
Some datatypes of ROOT or c++ can be wrapped in to a TRObject, this method lets you wrap those datatypes More...
 
- Public Member Functions inherited from TObject
 TObject ()
 TObject constructor. More...
 
 TObject (const TObject &object)
 TObject copy ctor. More...
 
virtual ~TObject ()
 TObject destructor. More...
 
void AbstractMethod (const char *method) const
 Use this method to implement an "abstract" method that you don't want to leave purely abstract. More...
 
virtual void AppendPad (Option_t *option="")
 Append graphics object to current pad. More...
 
virtual void Browse (TBrowser *b)
 Browse object. May be overridden for another default action. More...
 
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. More...
 
virtual const char * ClassName () const
 Returns name of class to which the object belongs. More...
 
virtual void Clear (Option_t *="")
 
virtual TObjectClone (const char *newname="") const
 Make a clone of an object using the Streamer facility. More...
 
virtual Int_t Compare (const TObject *obj) const
 Compare abstract method. More...
 
virtual void Copy (TObject &object) const
 Copy this to obj. More...
 
virtual void Delete (Option_t *option="")
 Delete this object. More...
 
virtual Int_t DistancetoPrimitive (Int_t px, Int_t py)
 Computes distance from point (px,py) to the object. More...
 
virtual void Draw (Option_t *option="")
 Default Draw method for all objects. More...
 
virtual void DrawClass () const
 Draw class inheritance tree of the class to which this object belongs. More...
 
virtual TObjectDrawClone (Option_t *option="") const
 Draw a clone of this object in the current selected pad for instance with: gROOT->SetSelectedPad(gPad). More...
 
virtual void Dump () const
 Dump contents of object on stdout. More...
 
virtual void Error (const char *method, const char *msgfmt,...) const
 Issue error message. More...
 
virtual void Execute (const char *method, const char *params, Int_t *error=0)
 Execute method on this object with the given parameter string, e.g. More...
 
virtual void Execute (TMethod *method, TObjArray *params, Int_t *error=0)
 Execute method on this object with parameters stored in the TObjArray. More...
 
virtual void ExecuteEvent (Int_t event, Int_t px, Int_t py)
 Execute action corresponding to an event at (px,py). More...
 
virtual void Fatal (const char *method, const char *msgfmt,...) const
 Issue fatal error message. More...
 
virtual TObjectFindObject (const char *name) const
 Must be redefined in derived classes. More...
 
virtual TObjectFindObject (const TObject *obj) const
 Must be redefined in derived classes. More...
 
virtual Option_tGetDrawOption () const
 Get option used by the graphics system to draw this object. More...
 
virtual const char * GetIconName () const
 Returns mime type name of object. More...
 
virtual const char * GetName () const
 Returns name of object. More...
 
virtual char * GetObjectInfo (Int_t px, Int_t py) const
 Returns string containing info about the object at position (px,py). More...
 
virtual Option_tGetOption () const
 
virtual const char * GetTitle () const
 Returns title of object. More...
 
virtual UInt_t GetUniqueID () const
 Return the unique object id. More...
 
virtual Bool_t HandleTimer (TTimer *timer)
 Execute action in response of a timer timing out. More...
 
virtual ULong_t Hash () const
 Return hash value for this object. More...
 
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. More...
 
virtual void Info (const char *method, const char *msgfmt,...) const
 Issue info message. More...
 
virtual Bool_t InheritsFrom (const char *classname) const
 Returns kTRUE if object inherits from class "classname". More...
 
virtual Bool_t InheritsFrom (const TClass *cl) const
 Returns kTRUE if object inherits from TClass cl. More...
 
virtual void Inspect () const
 Dump contents of this object in a graphics canvas. More...
 
void InvertBit (UInt_t f)
 
virtual Bool_t IsEqual (const TObject *obj) const
 Default equal comparison (objects are equal if they have the same address in memory). More...
 
virtual Bool_t IsFolder () const
 Returns kTRUE in case object contains browsable objects (like containers or lists of other objects). More...
 
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. More...
 
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). More...
 
virtual Bool_t Notify ()
 This method must be overridden to handle object notification. More...
 
void Obsolete (const char *method, const char *asOfVers, const char *removedFromVers) const
 Use this method to declare a method obsolete. More...
 
void operator delete (void *ptr)
 Operator delete. More...
 
void operator delete[] (void *ptr)
 Operator delete []. More...
 
voidoperator new (size_t sz)
 
voidoperator new (size_t sz, void *vp)
 
voidoperator new[] (size_t sz)
 
voidoperator new[] (size_t sz, void *vp)
 
TObjectoperator= (const TObject &rhs)
 TObject assignment operator. More...
 
virtual void Paint (Option_t *option="")
 This method must be overridden if a class wants to paint itself. More...
 
virtual void Pop ()
 Pop on object drawn in a pad to the top of the display list. More...
 
virtual void Print (Option_t *option="") const
 This method must be overridden when a class wants to print itself. More...
 
virtual Int_t Read (const char *name)
 Read contents of object with specified name from the current directory. More...
 
virtual void RecursiveRemove (TObject *obj)
 Recursively remove this object from a list. More...
 
void ResetBit (UInt_t f)
 
virtual void SaveAs (const char *filename="", Option_t *option="") const
 Save this object in the file specified by filename. More...
 
virtual void SavePrimitive (std::ostream &out, Option_t *option="")
 Save a primitive as a C++ statement(s) on output stream "out". More...
 
void SetBit (UInt_t f, Bool_t set)
 Set or unset the user status bits as specified in f. More...
 
void SetBit (UInt_t f)
 
virtual void SetDrawOption (Option_t *option="")
 Set drawing option for object. More...
 
virtual void SetUniqueID (UInt_t uid)
 Set the unique object id. More...
 
virtual void SysError (const char *method, const char *msgfmt,...) const
 Issue system error message. More...
 
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. More...
 
virtual void Warning (const char *method, const char *msgfmt,...) const
 Issue warning message. More...
 
virtual Int_t Write (const char *name=0, Int_t option=0, Int_t bufsize=0)
 Write this object to the current directory. More...
 
virtual Int_t Write (const char *name=0, Int_t option=0, Int_t bufsize=0) const
 Write this object to the current directory. More...
 

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 = BIT(0), kOverwrite = BIT(1), kWriteDelete = BIT(2) }
 
enum  EDeprecatedStatusBits { kObjInCanvas = BIT(3) }
 
enum  EStatusBits {
  kCanDelete = BIT(0), kMustCleanup = BIT(3), kIsReferenced = BIT(4), kHasUUID = BIT(5),
  kCannotPick = BIT(6), kNoContextMenu = BIT(8), kInvalidObject = BIT(13)
}
 
- Static Public Member Functions inherited from TObject
static Long_t GetDtorOnly ()
 Return destructor only flag. More...
 
static Bool_t GetObjectStat ()
 Get status of object stat flag. More...
 
static void SetDtorOnly (void *obj)
 Set destructor only flag. More...
 
static void SetObjectStat (Bool_t stat)
 Turn on/off tracking of objects in the TObjectTable. More...
 
- 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). More...
 
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 80 of file TRObject.h.

◆ TRObject() [2/3]

TRObject::TRObject ( SEXP  robj)

Construct a TRObject given a R base object.

Parameters
robjraw R object

Definition at line 15 of file TRObject.cxx.

◆ TRObject() [3/3]

TRObject::TRObject ( SEXP  robj,
Bool_t  status 
)

Construct a TRObject given a R base object.

Parameters
robjraw R object
statusif the raw object is valid obj

Definition at line 26 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 153 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
nameattribute name
Returns
object associated to the attribute name in the current TRObject

Definition at line 128 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 106 of file TRObject.h.

◆ operator Rcpp::RObject()

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

Definition at line 179 of file TRObject.h.

◆ operator SEXP() [1/2]

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

Definition at line 169 of file TRObject.h.

◆ operator SEXP() [2/2]

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

Definition at line 174 of file TRObject.h.

◆ operator T()

template<class T >
ROOT::R::TRObject::operator T ( )
inline

Definition at line 184 of file TRObject.h.

◆ operator=() [1/2]

void TRObject::operator= ( SEXP  xx)

Definition at line 19 of file TRObject.cxx.

◆ operator=() [2/2]

template<class T >
T ROOT::R::TRObject::operator= ( TRObject obj)
inline

Definition at line 164 of file TRObject.h.

◆ SetAttribute()

template<class T >
void ROOT::R::TRObject::SetAttribute ( const TString  name,
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
nameattribute name
objobject associated to the attribute name in the current TRObject

Definition at line 117 of file TRObject.h.

◆ SetStatus()

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

TRObject is a current valid object?

Parameters
statusif the current object is valid obj

Definition at line 97 of file TRObject.h.

◆ Wrap()

template<class T >
TRObject& ROOT::R::TRObject::Wrap ( obj)
inline


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

Parameters
objtemplate object to be wrapped
Returns
TRObject reference of wrapped object

Definition at line 141 of file TRObject.h.

Friends And Related Function Documentation

◆ Rcpp::wrap

SEXP Rcpp::wrap ( const TRObject f)
friend

Member Data Documentation

◆ fObj

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

Definition at line 74 of file TRObject.h.

◆ fStatus

Bool_t ROOT::R::TRObject::fStatus
private

Definition at line 75 of file TRObject.h.

Libraries for ROOT::R::TRObject:
[legend]

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