Class describing an archive file containing multiple sub-files, like a ZIP or TAR archive.

Definition at line 24 of file TArchiveFile.h.

Public Member Functions
	TArchiveFile ()

	TArchiveFile (const char archive, const char member, TFile *file)
	Specify the archive name and member name.

	~TArchiveFile () override
	Dtor.

const char *	GetArchiveName () const

TArchiveMember *	GetMember () const

Long64_t	GetMemberFilePosition () const
	Return position in archive of current member.

Int_t	GetMemberIndex () const

const char *	GetMemberName () const

TObjArray *	GetMembers () const

Int_t	GetNumberOfMembers () const
	Returns number of members in archive.

TClass *	IsA () const override

virtual Int_t	OpenArchive ()=0

virtual Int_t	SetCurrentMember ()=0

virtual Int_t	SetMember (const char *member)
	Explicitely make the specified member the current member.

virtual Int_t	SetMember (Int_t idx)
	Explicitely make the member with the specified index the current member.

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.

Static Public Member Functions
static TClass *	Class ()

static const char *	Class_Name ()

static constexpr Version_t	Class_Version ()

static const char *	DeclFileName ()

static TArchiveFile *	Open (const char url, TFile file)
	Return proper archive file handler depending on passed url.

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.

Static Protected Member Functions
static Bool_t	ParseUrl (const char *url, TString &archive, TString &member, TString &type)
	Try to determine if url contains an anchor specifying an archive member.

Protected Attributes
TString	fArchiveName
	Archive file name.

TArchiveMember *	fCurMember
	Current archive member.

TFile *	fFile
	File stream used to access the archive.

Int_t	fMemberIndex
	Index of sub-file in archive.

TString	fMemberName
	Sub-file name.

TObjArray *	fMembers
	Members in this archive.

Private Member Functions
	TArchiveFile (const TArchiveFile &)=delete
	Not implemented because TArchiveFile can not be copied.

TArchiveFile &	operator= (const TArchiveFile &)=delete
	Not implemented because TArchiveFile can not be copied.

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 <TArchiveFile.h>

Inheritance diagram for TArchiveFile:

[legend]

Constructor & Destructor Documentation

◆ TArchiveFile() [1/3]

TArchiveFile::TArchiveFile ( const TArchiveFile & )

privatedelete

Not implemented because TArchiveFile can not be copied.

◆ TArchiveFile() [2/3]

TArchiveFile::TArchiveFile ( )

inline

Definition at line 41 of file TArchiveFile.h.

◆ TArchiveFile() [3/3]

TArchiveFile::TArchiveFile	(	const char *	archive,
		const char *	member,
		TFile *	file
	)

Specify the archive name and member name.

Parameters

[in]	archive	Name of the archive file
[in]	member	Name of the ROOT file or integer number
[in]	file	Address of the TFile instance from where the call takes place

The member can be a decimal number which allows to access the n-th sub-file. This method is normally only called via TFile.

Definition at line 44 of file TArchiveFile.cxx.

◆ ~TArchiveFile()

TArchiveFile::~TArchiveFile ( )

override

Dtor.

Definition at line 63 of file TArchiveFile.cxx.

Member Function Documentation

◆ Class()

static TClass * TArchiveFile::Class ( )

static

Returns: TClass describing this class

◆ Class_Name()

static const char * TArchiveFile::Class_Name ( )

static

Returns: Name of this class

◆ Class_Version()

static constexpr Version_t TArchiveFile::Class_Version ( )

inlinestaticconstexpr

Returns: Version of this class

Definition at line 61 of file TArchiveFile.h.

◆ DeclFileName()

static const char * TArchiveFile::DeclFileName ( )

inlinestatic

Returns: Name of the file containing the class declaration

Definition at line 61 of file TArchiveFile.h.

◆ GetArchiveName()

const char * TArchiveFile::GetArchiveName ( ) const

inline

Definition at line 55 of file TArchiveFile.h.

◆ GetMember()

TArchiveMember * TArchiveFile::GetMember ( ) const

inline

Definition at line 51 of file TArchiveFile.h.

◆ GetMemberFilePosition()

Long64_t TArchiveFile::GetMemberFilePosition ( ) const

Return position in archive of current member.

Definition at line 71 of file TArchiveFile.cxx.

◆ GetMemberIndex()

Int_t TArchiveFile::GetMemberIndex ( ) const

inline

Definition at line 57 of file TArchiveFile.h.

◆ GetMemberName()

const char * TArchiveFile::GetMemberName ( ) const

inline

Definition at line 56 of file TArchiveFile.h.

◆ GetMembers()

TObjArray * TArchiveFile::GetMembers ( ) const

inline

Definition at line 52 of file TArchiveFile.h.

◆ GetNumberOfMembers()

Int_t TArchiveFile::GetNumberOfMembers ( ) const

Returns number of members in archive.

Definition at line 79 of file TArchiveFile.cxx.

◆ IsA()

TClass * TArchiveFile::IsA ( ) const

inlineoverridevirtual

Returns: TClass describing current object

Reimplemented from TObject.

Reimplemented in TZIPFile.

Definition at line 61 of file TArchiveFile.h.

◆ Open()

TArchiveFile * TArchiveFile::Open	(	const char *	url,
		TFile *	file
	)

static

Return proper archive file handler depending on passed url.

The handler is loaded via the plugin manager and is triggered by the extension of the archive file. In case no handler is found 0 is returned. The file argument is used to access the archive. The archive should be specified as url with the member name as the anchor, e.g. "root://pcsalo.cern.ch/alice/event_1.zip#tpc.root", where tpc.root is the file in the archive to be opened. Alternatively the sub-file can be specified via its index number, e.g. "root://pcsalo.cern.ch/alice/event_1.zip#3". This function is normally only called via TFile::Open().

Definition at line 121 of file TArchiveFile.cxx.

◆ OpenArchive()

virtual Int_t TArchiveFile::OpenArchive ( )

pure virtual

Implemented in TZIPFile.

◆ operator=()

TArchiveFile & TArchiveFile::operator= ( const TArchiveFile & )

privatedelete

Not implemented because TArchiveFile can not be copied.

◆ ParseUrl()

Bool_t TArchiveFile::ParseUrl	(	const char *	url,
		TString &	archive,
		TString &	member,
		TString &	type
	)

staticprotected

Try to determine if url contains an anchor specifying an archive member.

Returns kFALSE in case of an error.

Definition at line 149 of file TArchiveFile.cxx.

◆ SetCurrentMember()

virtual Int_t TArchiveFile::SetCurrentMember ( )

pure virtual

Implemented in TZIPFile.

◆ SetMember() [1/2]

Int_t TArchiveFile::SetMember ( const char * member )

virtual

Explicitely make the specified member the current member.

Returns -1 in case of error, 0 otherwise.

Definition at line 88 of file TArchiveFile.cxx.

◆ SetMember() [2/2]

Int_t TArchiveFile::SetMember ( Int_t idx )

virtual

Explicitely make the member with the specified index the current member.

Returns -1 in case of error, 0 otherwise.

Definition at line 100 of file TArchiveFile.cxx.

◆ Streamer()

void TArchiveFile::Streamer ( TBuffer & R__b )

overridevirtual

Stream an object of class TObject.

Reimplemented from TObject.

Reimplemented in TZIPFile.

◆ StreamerNVirtual()

void TArchiveFile::StreamerNVirtual ( TBuffer & ClassDef_StreamerNVirtual_b )

inline

Definition at line 61 of file TArchiveFile.h.

Member Data Documentation

◆ fArchiveName

TString TArchiveFile::fArchiveName

protected

Archive file name.

Definition at line 31 of file TArchiveFile.h.

◆ fCurMember

TArchiveMember* TArchiveFile::fCurMember

protected

Current archive member.

Definition at line 36 of file TArchiveFile.h.

◆ fFile

TFile* TArchiveFile::fFile

protected

File stream used to access the archive.

Definition at line 34 of file TArchiveFile.h.

◆ fMemberIndex

Int_t TArchiveFile::fMemberIndex

protected

Index of sub-file in archive.

Definition at line 33 of file TArchiveFile.h.

◆ fMemberName

TString TArchiveFile::fMemberName

protected

Sub-file name.

Definition at line 32 of file TArchiveFile.h.

◆ fMembers

TObjArray* TArchiveFile::fMembers

protected

Members in this archive.

Definition at line 35 of file TArchiveFile.h.

Libraries for TArchiveFile:

[legend]

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

io/io/inc/TArchiveFile.h
io/io/src/TArchiveFile.cxx

Public Member Functions

Static Public Member Functions

Static Protected Member Functions

Protected Attributes

Private Member Functions

Additional Inherited Members

Constructor & Destructor Documentation

◆ TArchiveFile() [1/3]

◆ TArchiveFile() [2/3]

◆ TArchiveFile() [3/3]

◆ ~TArchiveFile()

Member Function Documentation

◆ Class()

◆ Class_Name()

◆ Class_Version()

◆ DeclFileName()

◆ GetArchiveName()

◆ GetMember()

◆ GetMemberFilePosition()

◆ GetMemberIndex()

◆ GetMemberName()

◆ GetMembers()

◆ GetNumberOfMembers()

◆ IsA()

◆ Open()

◆ OpenArchive()

◆ operator=()

◆ ParseUrl()

◆ SetCurrentMember()

◆ SetMember() [1/2]

◆ SetMember() [2/2]

◆ Streamer()

◆ StreamerNVirtual()

Member Data Documentation

◆ fArchiveName

◆ fCurMember

◆ fFile

◆ fMemberIndex

◆ fMemberName

◆ fMembers