The TEnum class implements the enum type.

Definition at line 33 of file TEnum.h.

Public Types
enum	ESearchAction { kNone = 0 , kAutoload = 1 , kInterpLookup = 2 , kALoadAndInterpLookup = 3 }

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

Public Member Functions
	TEnum ()

	TEnum (const char name, DeclId_t declid, TClass cls)
	Constructor for TEnum class.

	TEnum (const TEnum &)
	Copy constructor.

virtual	~TEnum ()
	Destructor.

void	AddConstant (TEnumConstant *constant)
	Add a EnumConstant to the list of constants of the Enum Type.

TClass *	GetClass () const

const TEnumConstant *	GetConstant (const char *name) const

const TSeqCollection *	GetConstants () const

DeclId_t	GetDeclId () const

const char *	GetQualifiedName () const

EDataType	GetUnderlyingType () const
	Get the underlying integer type of the enum: enum E { kOne }; // ==> int enum F: long; // ==> long Returns kNumDataTypes if the enum is unknown / invalid.

TClass *	IsA () const override

Bool_t	IsValid ()
	Return true if this enum object is pointing to a currently loaded enum.

TEnum &	operator= (const TEnum &)
	Assign operator.

Long_t	Property () const override
	Get property description word. For meaning of bits see EProperty.

void	SetClass (TClass *cl)

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

void	StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)

void	Update (DeclId_t id)

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)

void	StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)

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.

void	Clear (Option_t *option="") override
	Set name and title to empty strings ("").

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

Int_t	Compare (const TObject *obj) const override
	Compare two TNamed objects.

void	Copy (TObject &named) const override
	Copy this to obj.

virtual void	FillBuffer (char *&buffer)
	Encode TNamed into output buffer.

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

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

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

TClass *	IsA () const override

Bool_t	IsSortable () const override

void	ls (Option_t *option="") const override
	List TNamed name and title.

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

void	Print (Option_t *option="") const override
	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.

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	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 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 (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 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 TEnum *	GetEnum (const char *enumName, ESearchAction sa=kALoadAndInterpLookup)
	Static function to retrieve enumerator from the ROOT's typesystem.

static TEnum *	GetEnum (const std::type_info &ti, ESearchAction sa=kALoadAndInterpLookup)

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

static const char *	Class_Name ()

static constexpr Version_t	Class_Version ()

static const char *	DeclFileName ()

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 TNamed
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 Types
enum	EBits { kBitIsScopedEnum = (1ULL << ( 14 )) }

Private Attributes
TClass *	fClass = nullptr
	Interpreter information, owned by TEnum.

THashList	fConstantList

ClassInfo_t *	fInfo = nullptr

std::string	fQualName
	Owning class.

EDataType	fUnderlyingType = kInt_t

Additional Inherited Members
Protected Types inherited from TObject
enum	{ kOnlyPrepStep = (1ULL << ( 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 <TEnum.h>

Inheritance diagram for TEnum:

[legend]

Member Enumeration Documentation

◆ EBits

enum TEnum::EBits

private

Enumerator
kBitIsScopedEnum	The enum is an enum class.

Definition at line 42 of file TEnum.h.

◆ ESearchAction

enum TEnum::ESearchAction

Enumerator
kNone
kAutoload
kInterpLookup
kALoadAndInterpLookup

Definition at line 48 of file TEnum.h.

Constructor & Destructor Documentation

◆ TEnum() [1/3]

TEnum::TEnum ( )

inline

Definition at line 54 of file TEnum.h.

◆ TEnum() [2/3]

TEnum::TEnum	(	const char *	name,
		DeclId_t	declid,
		TClass *	cls
	)

Constructor for TEnum class.

It takes the name of the TEnum type, interpreter info and surrounding class the enum it is not globalat namespace scope. Constant List is owner if enum not on global scope (thus constants not in TROOT::GetListOfGlobals).

Definition at line 38 of file TEnum.cxx.

◆ TEnum() [3/3]

TEnum::TEnum ( const TEnum & src )

Copy constructor.

Definition at line 63 of file TEnum.cxx.

◆ ~TEnum()

TEnum::~TEnum ( )

virtual

Destructor.

Definition at line 106 of file TEnum.cxx.

Member Function Documentation

◆ AddConstant()

void TEnum::AddConstant ( TEnumConstant * constant )

Add a EnumConstant to the list of constants of the Enum Type.

Definition at line 114 of file TEnum.cxx.

◆ Class()

static TClass * TEnum::Class ( )

static

Returns: TClass describing this class

◆ Class_Name()

static const char * TEnum::Class_Name ( )

static

Returns: Name of this class

◆ Class_Version()

static constexpr Version_t TEnum::Class_Version ( )

inlinestaticconstexpr

Returns: Version of this class

Definition at line 81 of file TEnum.h.

◆ DeclFileName()

static const char * TEnum::DeclFileName ( )

inlinestatic

Returns: Name of the file containing the class declaration

Definition at line 81 of file TEnum.h.

◆ GetClass()

TClass * TEnum::GetClass ( ) const

inline

Definition at line 62 of file TEnum.h.

◆ GetConstant()

const TEnumConstant * TEnum::GetConstant ( const char * name ) const

inline

Definition at line 64 of file TEnum.h.

◆ GetConstants()

const TSeqCollection * TEnum::GetConstants ( ) const

inline

Definition at line 63 of file TEnum.h.

◆ GetDeclId()

TDictionary::DeclId_t TEnum::GetDeclId ( ) const

Definition at line 146 of file TEnum.cxx.

◆ GetEnum() [1/2]

TEnum * TEnum::GetEnum	(	const char *	enumName,
		ESearchAction	sa = `kALoadAndInterpLookup`
	)

static

Static function to retrieve enumerator from the ROOT's typesystem.

It has no side effect, except when the load flag is true. In this case, the load of the library containing the scope of the enumerator is attempted. There are two top level code paths: the enumerator is scoped or isn't. If it is not, a lookup in the list of global enums is performed. If it is, two lookups are carried out for its scope: one in the list of classes and one in the list of protoclasses. If a scope with the desired name is found, the enum is searched. If the scope is not found, and the load flag is true, the aforementioned two steps are performed again after an autoload attempt with the name of the scope as key is tried out. If the interpreter lookup flag is false, the ListOfEnums objects are not treated as such, but rather as THashList objects. This prevents any flow of information from the interpreter into the ROOT's typesystem: a snapshot of the typesystem status is taken.

Definition at line 209 of file TEnum.cxx.

◆ GetEnum() [2/2]

TEnum * TEnum::GetEnum	(	const std::type_info &	ti,
		ESearchAction	sa = `kALoadAndInterpLookup`
	)

static

Definition at line 175 of file TEnum.cxx.

◆ GetQualifiedName()

const char * TEnum::GetQualifiedName ( ) const

inline

Definition at line 77 of file TEnum.h.

◆ GetUnderlyingType()

EDataType TEnum::GetUnderlyingType ( ) const

inline

Get the underlying integer type of the enum: enum E { kOne }; // ==> int enum F: long; // ==> long Returns kNumDataTypes if the enum is unknown / invalid.

Definition at line 71 of file TEnum.h.

◆ IsA()

TClass * TEnum::IsA ( ) const

inlineoverridevirtual

Returns: TClass describing current object

Reimplemented from TDictionary.

Definition at line 81 of file TEnum.h.

◆ IsValid()

Bool_t TEnum::IsValid ( )

Return true if this enum object is pointing to a currently loaded enum.

If a enum is unloaded after the TEnum is created, the TEnum will be set to be invalid.

Definition at line 124 of file TEnum.cxx.

◆ operator=()

TEnum & TEnum::operator= ( const TEnum & src )

Assign operator.

Definition at line 81 of file TEnum.cxx.

◆ Property()

Long_t TEnum::Property ( ) const

overridevirtual

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

Implements TDictionary.

Definition at line 139 of file TEnum.cxx.

◆ SetClass()

void TEnum::SetClass ( TClass * cl )

inline

Definition at line 75 of file TEnum.h.

◆ Streamer()

void TEnum::Streamer ( TBuffer & R__b )

overridevirtual

Stream an object of class TObject.

Reimplemented from TDictionary.

◆ StreamerNVirtual()

void TEnum::StreamerNVirtual ( TBuffer & ClassDef_StreamerNVirtual_b )

inline

Definition at line 81 of file TEnum.h.

◆ Update()

void TEnum::Update ( DeclId_t id )

Definition at line 156 of file TEnum.cxx.

Member Data Documentation

◆ fClass

TClass* TEnum::fClass = nullptr

private

Interpreter information, owned by TEnum.

Definition at line 38 of file TEnum.h.

◆ fConstantList

THashList TEnum::fConstantList

private

Definition at line 36 of file TEnum.h.

◆ fInfo

ClassInfo_t* TEnum::fInfo = nullptr

private

Definition at line 37 of file TEnum.h.

◆ fQualName

std::string TEnum::fQualName

private

Owning class.

Definition at line 39 of file TEnum.h.

◆ fUnderlyingType

EDataType TEnum::fUnderlyingType = kInt_t

private

Definition at line 40 of file TEnum.h.

Libraries for TEnum:

[legend]

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

core/meta/inc/TEnum.h
core/meta/src/TEnum.cxx

Public Types

Public Member Functions

Static Public Member Functions

Private Types

Private Attributes

Additional Inherited Members

Member Enumeration Documentation

◆ EBits

◆ ESearchAction

Constructor & Destructor Documentation

◆ TEnum() [1/3]

◆ TEnum() [2/3]

◆ TEnum() [3/3]

◆ ~TEnum()

Member Function Documentation

◆ AddConstant()

◆ Class()

◆ Class_Name()

◆ Class_Version()

◆ DeclFileName()

◆ GetClass()

◆ GetConstant()

◆ GetConstants()

◆ GetDeclId()

◆ GetEnum() [1/2]

◆ GetEnum() [2/2]

◆ GetQualifiedName()

◆ GetUnderlyingType()

◆ IsA()

◆ IsValid()

◆ operator=()

◆ Property()

◆ SetClass()

◆ Streamer()

◆ StreamerNVirtual()

◆ Update()

Member Data Documentation

◆ fClass

◆ fConstantList

◆ fInfo

◆ fQualName

◆ fUnderlyingType