Logo ROOT   6.13/01
Reference Guide
List of all members | Public Member Functions | Static Public Member Functions | Static Protected Member Functions | Protected Attributes | Private Member Functions | List of all members
TArchiveFile Class Referenceabstract

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. More...
 
virtual ~TArchiveFile ()
 Dtor. More...
 
const char * GetArchiveName () const
 
TArchiveMemberGetMember () const
 
Long64_t GetMemberFilePosition () const
 Return position in archive of current member. More...
 
Int_t GetMemberIndex () const
 
const char * GetMemberName () const
 
TObjArrayGetMembers () const
 
Int_t GetNumberOfMembers () const
 Returns number of members in archive. More...
 
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. More...
 
virtual Int_t SetMember (Int_t idx)
 Explicitely make the member with the specified index the current member. 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 ()
 Checked and record whether for 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...
 

Static Public Member Functions

static TArchiveFileOpen (const char *url, TFile *file)
 Return proper archive file handler depending on passed url. More...
 
- 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...
 

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. More...
 

Protected Attributes

TString fArchiveName
 Archive file name. More...
 
TArchiveMemberfCurMember
 Current archive member. More...
 
TFilefFile
 File stream used to access the archive. More...
 
Int_t fMemberIndex
 Index of sub-file in archive. More...
 
TString fMemberName
 Sub-file name. More...
 
TObjArrayfMembers
 Members in this archive. More...
 

Private Member Functions

 TArchiveFile (const TArchiveFile &)
 Not implemented because TArchiveFile can not be copied. More...
 
TArchiveFileoperator= (const TArchiveFile &)
 Not implemented because TArchiveFile can not be copied. More...
 

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

Inheritance diagram for TArchiveFile:
[legend]

Constructor & Destructor Documentation

◆ TArchiveFile() [1/3]

TArchiveFile::TArchiveFile ( const TArchiveFile )
private

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]archiveName of the archive file
[in]memberName of the ROOT file or integer number
[in]fileAddress 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 ( )
virtual

Dtor.

Definition at line 63 of file TArchiveFile.cxx.

Member Function Documentation

◆ 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.

◆ 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 )
private

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.

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: