TMethodArg Class Reference

Each ROOT method (see TMethod) has a linked list of its arguments.

This class describes one single method argument. The method argument info is obtained via the CINT api. See class TCling.

The method argument information is used a.o. in the TContextMenu and THtml classes.

Definition at line 36 of file TMethodArg.h.

Public Member Functions
	TMethodArg (MethodArgInfo_t *info=nullptr, TFunction *method=nullptr)
	Default TMethodArg ctor.
virtual	~TMethodArg ()
	TMethodArg dtor deletes adopted CINT MethodArgInfo object.
TDataMember *	GetDataMember () const
	Returns TDataMember pointed by this methodarg.
const char *	GetDefault () const
	Get default value of method argument.
const char *	GetFullTypeName () const
	Get full type description of method argument, e.g.: "class TDirectory*".
TFunction *	GetMethod () const
TList *	GetOptions () const
	Returns list of possible options - according to pointed datamember.
const char *	GetTypeName () const
	Get type of method argument, e.g.: "class TDirectory*" -> "TDirectory" Result needs to be used or copied immediately.
std::string	GetTypeNormalizedName () const
	Get the normalized name of the return type.
Long_t	Property () const
	Get property description word. For meaning of bits see EProperty.
void	Update (MethodArgInfo_t *info)
	Update fInfo (to 0 for unloading and non-zero for reloading).
Public Member Functions inherited from TDictionary
	TDictionary ()
	TDictionary (const char *name)
	TDictionary (const TDictionary &dict)
virtual	~TDictionary ()
void	CreateAttributeMap ()
TDictAttributeMap *	GetAttributeMap () const
TDictionary &	operator= (const TDictionary &other)
Public Member Functions inherited from TNamed
	TNamed ()
	TNamed (const char *name, const char *title)
	TNamed (const TNamed &named)
	TNamed copy ctor.
	TNamed (const TString &name, const TString &title)
virtual	~TNamed ()
	TNamed destructor.
virtual void	Clear (Option_t *option="")
	Set name and title to empty strings ("").
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 two TNamed objects.
virtual void	Copy (TObject &named) const
	Copy this to obj.
virtual void	FillBuffer (char *&buffer)
	Encode TNamed into output buffer.
virtual const char *	GetName () const
	Returns name of object.
virtual const char *	GetTitle () const
	Returns title of object.
virtual ULong_t	Hash () const
	Return hash value for this object.
virtual Bool_t	IsSortable () const
virtual void	ls (Option_t *option="") const
	List TNamed name and title.
TNamed &	operator= (const TNamed &rhs)
	TNamed assignment operator.
virtual void	Print (Option_t *option="") const
	Print TNamed name and title.
virtual void	SetName (const char *name)
	Set the name of the TNamed.
virtual void	SetNameTitle (const char *name, const char *title)
	Set all the TNamed parameters (name and title).
virtual void	SetTitle (const char *title="")
	Set the title of the TNamed.
virtual Int_t	Sizeof () const
	Return size of the TNamed part of the TObject.
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	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 for instance with: gROOT->SetSelectedPad(gPad).
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=0)
	Execute method on this object with the given parameter string, e.g.
virtual void	Execute (TMethod *method, TObjArray *params, Int_t *error=0)
	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 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 UInt_t	GetUniqueID () const
	Return the unique object id.
virtual Bool_t	HandleTimer (TTimer *timer)
	Execute action in response of a timer timing out.
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
R__ALWAYS_INLINE Bool_t	IsZombie () const
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 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.
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=0, Int_t option=0, Int_t bufsize=0)
	Write this object to the current directory.
virtual Int_t	Write (const char *name=0, Int_t option=0, Int_t bufsize=0) const
	Write this object to the current directory.

Private Member Functions
	TMethodArg (const TMethodArg &)=delete
TMethodArg &	operator= (const TMethodArg &)=delete

Private Attributes
TDataMember *	fDataMember
MethodArgInfo_t *	fInfo
TFunction *	fMethod

Friends
class	TMethod

Additional Inherited Members
Public Types inherited from TDictionary
typedef const void *	DeclId_t
enum class	EMemberSelection { kNoUsingDecls , kOnlyUsingDecls , kAlsoUsingDecls }
	Kinds of members to include in lists. More...
enum	ESTLType {   kNone = ROOT::kNotSTL , kVector = ROOT::kSTLvector , kList = ROOT::kSTLlist , kForwardlist = ROOT::kSTLforwardlist ,   kDeque = ROOT::kSTLdeque , kMap = ROOT::kSTLmap , kMultimap = ROOT::kSTLmultimap , kSet = ROOT::kSTLset ,   kMultiset = ROOT::kSTLmultiset , kUnorderedSet = ROOT::kSTLunorderedset , kUnorderedMultiset = ROOT::kSTLunorderedmultiset , kUnorderedMap = ROOT::kSTLunorderedmap ,   kUnorderedMultimap = ROOT::kSTLunorderedmultimap , kBitset = ROOT::kSTLbitset }
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 TDictionary
static TDictionary *	GetDictionary (const char *name)
	Retrieve the type (class, fundamental type, typedef etc) named "name".
static TDictionary *	GetDictionary (const std::type_info &typeinfo)
static bool	WantsRegularMembers (EMemberSelection sel)
static bool	WantsUsingDecls (EMemberSelection sel)
Static Public Member Functions inherited from TObject
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 = BIT(3) }
Protected Member Functions inherited from TDictionary
Bool_t	UpdateInterpreterStateMarker ()
	the Cling ID of the transaction that last updated the object
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 TNamed
TString	fName
TString	fTitle

#include <TMethodArg.h>

Inheritance diagram for TMethodArg:

Constructor & Destructor Documentation

TMethodArg() [1/2]

TMethodArg::TMethodArg ( const TMethodArg &  )

privatedelete

TMethodArg() [2/2]

TMethodArg::TMethodArg	(	MethodArgInfo_t *	info = nullptr,
		TFunction *	method = nullptr
	)

Default TMethodArg ctor.

TMethodArgs are constructed in TFunction via a call to TCling::CreateListOfMethodArgs().

Definition at line 35 of file TMethodArg.cxx.

~TMethodArg()

TMethodArg::~TMethodArg ( )

virtual

TMethodArg dtor deletes adopted CINT MethodArgInfo object.

Definition at line 49 of file TMethodArg.cxx.

Member Function Documentation

GetDataMember()

TDataMember * TMethodArg::GetDataMember

(

)

const

Returns TDataMember pointed by this methodarg.

If you want to specify list of options or current value for your MethodArg (i.e. it is used as initial values in argument-asking dialogs popped up from context-meny),you can get this value from one of data members of the class.

The only restriction is, that this DataMember object must have its Getter/Setter methods set-up correctly - for details look at TDataMember. To learn how to specify the data member to which the argument should "point", look at TMethod. This is TMethod which sets up fDataMember, so it could work correctly.

Definition at line 120 of file TMethodArg.cxx.

GetDefault()

const char * TMethodArg::GetDefault

(

)

const

Get default value of method argument.

Definition at line 57 of file TMethodArg.cxx.

GetFullTypeName()

const char * TMethodArg::GetFullTypeName

(

)

const

Get full type description of method argument, e.g.: "class TDirectory*".

Definition at line 74 of file TMethodArg.cxx.

GetMethod()

TFunction * TMethodArg::GetMethod ( ) const

inline

Definition at line 52 of file TMethodArg.h.

GetOptions()

TList * TMethodArg::GetOptions

(

)

const

Returns list of possible options - according to pointed datamember.

If there is no datamember field assigned to this methodarg - returns 0.

Definition at line 102 of file TMethodArg.cxx.

GetTypeName()

const char * TMethodArg::GetTypeName

(

)

const

Get type of method argument, e.g.: "class TDirectory*" -> "TDirectory" Result needs to be used or copied immediately.

Definition at line 66 of file TMethodArg.cxx.

GetTypeNormalizedName()

std::string TMethodArg::GetTypeNormalizedName

(

)

const

Get the normalized name of the return type.

A normalized name is fully qualified and has all typedef desugared except for the 'special' typedef which include Double32_t, Float16_t, [U]Long64_t and std::string. It also has std:: removed [This is subject to change].

Definition at line 85 of file TMethodArg.cxx.

operator=()

TMethodArg & TMethodArg::operator= ( const TMethodArg &  )

privatedelete

Property()

Long_t TMethodArg::Property ( ) const

virtual

Get property description word. For meaning of bits see EProperty.

Implements TDictionary.

Definition at line 93 of file TMethodArg.cxx.

Update()

void TMethodArg::Update

(

MethodArgInfo_t *

info

)

Update fInfo (to 0 for unloading and non-zero for reloading).

This takes ownership of 'info'

Definition at line 129 of file TMethodArg.cxx.

Friends And Related Symbol Documentation

TMethod

friend class TMethod

friend

Definition at line 38 of file TMethodArg.h.

Member Data Documentation

fDataMember

TDataMember* TMethodArg::fDataMember

private

Definition at line 46 of file TMethodArg.h.

fInfo

MethodArgInfo_t* TMethodArg::fInfo

private

Definition at line 44 of file TMethodArg.h.

fMethod

TFunction* TMethodArg::fMethod

private

Definition at line 45 of file TMethodArg.h.