Class defining interface to a TTree query result with the same interface as for SQL databases.

A TTreeResult is returned by TTree::Query() (actually TTreePlayer::Query()).

Related classes are TTreeRow.

Definition at line 34 of file TTreeResult.h.

Public Member Functions
	TTreeResult ()
	Create a query result object.

	TTreeResult (Int_t nfields)
	Create a query result object.

	~TTreeResult () override
	Cleanup result object.

void	Close (Option_t *option="") override
	Close query result.

Int_t	GetFieldCount () override
	Get number of fields in result.

const char *	GetFieldName (Int_t field) override
	Get name of specified field.

TObjArray *	GetRows () const

TSQLRow *	Next () override
	Get next query result row.

Public Member Functions inherited from TSQLResult
virtual	~TSQLResult ()

virtual Int_t	GetRowCount () const

TClass *	IsA () const override

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

void	StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)

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 (the base implementation is no-op).

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, void vp)
	Only called by placement new when throwing an exception.

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

void	operator delete[] (void ptr, void vp)
	Only called by placement new[] when throwing an exception.

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.

Private Member Functions
void	AddField (Int_t field, const char *fieldname)
	Add field name to result set.

void	AddRow (TSQLRow *row)
	Adopt a row to result set.

Bool_t	IsValid (Int_t field)
	Check if result set is open and field index within range.

Private Attributes
Int_t	fColumnCount
	number of columns in result

TString *	fFields
	[fColumnCount] array containing field strings

Int_t	fNextRow
	row iterator

TObjArray *	fResult
	query result (TTreeRow objects)

Friends
class	TTreePlayer

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 )) }

Static Public Member Functions inherited from TSQLResult
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.

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

Protected Member Functions inherited from TSQLResult
	TSQLResult ()

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 ()

Protected Attributes inherited from TSQLResult
Int_t	fRowCount

#include <TTreeResult.h>

Inheritance diagram for TTreeResult:

[legend]

Constructor & Destructor Documentation

◆ TTreeResult() [1/2]

TTreeResult::TTreeResult ( )

Create a query result object.

Definition at line 32 of file TTreeResult.cxx.

◆ TTreeResult() [2/2]

TTreeResult::TTreeResult ( Int_t nfields )

Create a query result object.

Definition at line 44 of file TTreeResult.cxx.

◆ ~TTreeResult()

TTreeResult::~TTreeResult ( )

override

Cleanup result object.

Definition at line 56 of file TTreeResult.cxx.

Member Function Documentation

◆ AddField()

void TTreeResult::AddField	(	Int_t	field,
		const char *	fieldname
	)

private

Add field name to result set.

This is an internal method that is not exported via the abstract interface and that should not be user called.

Definition at line 142 of file TTreeResult.cxx.

◆ AddRow()

void TTreeResult::AddRow ( TSQLRow * row )

private

Adopt a row to result set.

This is an internal method that is not exported via the abstract interface and that should not be user called.

Definition at line 154 of file TTreeResult.cxx.

◆ Close()

void TTreeResult::Close ( Option_t * option = "" )

overridevirtual

Close query result.

Implements TSQLResult.

Definition at line 67 of file TTreeResult.cxx.

◆ GetFieldCount()

Int_t TTreeResult::GetFieldCount ( )

overridevirtual

Get number of fields in result.

Implements TSQLResult.

Definition at line 97 of file TTreeResult.cxx.

◆ GetFieldName()

const char * TTreeResult::GetFieldName ( Int_t field )

overridevirtual

Get name of specified field.

Implements TSQLResult.

Definition at line 109 of file TTreeResult.cxx.

◆ GetRows()

TObjArray * TTreeResult::GetRows ( ) const

inline

Definition at line 56 of file TTreeResult.h.

◆ IsValid()

Bool_t TTreeResult::IsValid ( Int_t field )

private

Check if result set is open and field index within range.

Definition at line 81 of file TTreeResult.cxx.

◆ Next()

TSQLRow * TTreeResult::Next ( )

overridevirtual

Get next query result row.

The returned object must be deleted by the user and becomes invalid when the result set is closed or deleted.

Implements TSQLResult.

Definition at line 122 of file TTreeResult.cxx.

Friends And Related Symbol Documentation

◆ TTreePlayer

friend class TTreePlayer

friend

Definition at line 36 of file TTreeResult.h.

Member Data Documentation

◆ fColumnCount

Int_t TTreeResult::fColumnCount

private

number of columns in result

Definition at line 39 of file TTreeResult.h.

◆ fFields

TString* TTreeResult::fFields

private

[fColumnCount] array containing field strings

Definition at line 40 of file TTreeResult.h.

◆ fNextRow

Int_t TTreeResult::fNextRow

private

row iterator

Definition at line 42 of file TTreeResult.h.

◆ fResult

TObjArray* TTreeResult::fResult

private

query result (TTreeRow objects)

Definition at line 41 of file TTreeResult.h.

Libraries for TTreeResult:

[legend]

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

tree/tree/inc/TTreeResult.h
tree/tree/src/TTreeResult.cxx

Public Member Functions

Private Member Functions

Private Attributes

Friends

Additional Inherited Members

Constructor & Destructor Documentation

◆ TTreeResult() [1/2]

◆ TTreeResult() [2/2]

◆ ~TTreeResult()

Member Function Documentation

◆ AddField()

◆ AddRow()

◆ Close()

◆ GetFieldCount()

◆ GetFieldName()

◆ GetRows()

◆ IsValid()

◆ Next()

Friends And Related Symbol Documentation

◆ TTreePlayer

Member Data Documentation

◆ fColumnCount

◆ fFields

◆ fNextRow

◆ fResult