#include "hrfiofiletsm.h"

HRFIOFileTSM


class description - source file - inheritance tree (.pdf)

class HRFIOFileTSM : public TObject

Inheritance Chart:
TObject
<-
HRFIOFileTSM

    public:
HRFIOFileTSM(const char* name, int mode = ios::in HRFIOFileTSM(const HRFIOFileTSM&) ~HRFIOFileTSM() static int access(const char* name, int mode = 0) Bool_t bad() static TClass* Class() int close() Bool_t eof() Bool_t fail() Bool_t good() void ignore(int max = 1, int term = EOF) virtual TClass* IsA() const int open(const char* name, int mode = ios::in HRFIOFileTSM& operator<<(const HRFIOFileTSM& u) HRFIOFileTSM& operator=(const HRFIOFileTSM&) HRFIOFileTSM& operator>>(HRFIOFileTSM& u) int rdstat() int read(char* buffer, int len) HRFIOFileTSM& seekg(streampos offs, int p) HRFIOFileTSM& seekp(streampos n) char* serror() virtual void ShowMembers(TMemberInspector& insp, char* parent) int stat(Long_t* id, Long_t* size, Long_t* flags, Long_t* modtime) virtual void Streamer(TBuffer& b) void StreamerNVirtual(TBuffer& b) streampos tellg() static int unlink(char* name) int write(const char* buffer, int len)

Data Members


    protected:
srawAPIFile* file ! pointer to file in taperobot int status ! status variable streampos pos ! position in file char* fname ! name of file int fmode ! mode of file open HRFIOTsmSignalHandler* handler

Class Description

HRfioFile

  Class used for reading HLD events from file on taperobot



HRFIOFileTSM(const char *name, int mode) : TObject()
 Default constructor. sET ALL PARAMETERS TO DEFAULT VALUES.

 Input parameters:
    const char* name
       Name of the file

    int mode
       Mode to be used for file opening,
       one of the ios::xxx

 Output parameters:
    none

 Return code:
    none

~HRFIOFileTSM(void)
 Default destructor. cLOSE FILE IF OPEN.

 Input parameters:
    none

 Output parameters:
    none

 Return code:
   none

int open(const char *name, int mode )
 Open a file on taperobot with name and mode. Tests first if file is accessible.

 Input parameters:
   const char* name
      Name of the file to be opened.

   int mode
       Mode to be used for file opening,
       one of the ios::xxx

 Output parameters:
    none

 Return code:
    0 on success, -1 otherwise.

int close(void)
 Closes file.

 Input parameters:
    none

 Output parameters:
   none

 Return code:
   0 if closed, -1 if no file opened.

int access(const char *name, int mode)
 Tests for accessibility of file on taperobot.

 Input parameters:
   const char* name
       Name of the file to be tested

   int mode
       Mode to be used for file opening,
       one of the ios::xxx

 Output parameters:
    none

 Return code:
    0 on success, -1 in case of failure.
    If mode is set to !=0 returns -1.

int read(char *buffer, int len)
 Reads a buffer with length len from the file

 Input parameters:
   int len
     Length of buffer, defines maximum number of bytes to be read from file.

 Output parameters:
   char* buffer
      Pointer to buffer to store data from file into.

 Return code:
   Number of bytes read from file

int write(const char *buffer, int len)
 Writes buffer to file. NOT TESTED!!

 Input Parameters:
   const char* buffer
     Buffer with data to be written to file.

   int len
     Number of bytes to write to file.

 Output parameters:
   none

 Return code:
   Number of bytes written.

HRFIOFileTSM& seekp(streampos n)
 Moves accesspointer in file relative to current position.

 Input parameters:
   streampos n
      Position in stream to move filepointer to.

 Output parameters:
   none

 Return code:
   Pointer to this object.

HRFIOFileTSM& seekg(streampos offs, int p)
 Moves accesspointer in file relative.

 Input parameters:
   streampos offs
     number of bytes to move filepointer relativ to position defined via p.

   int p
     Relativ to what position to move fileponter. Can be one of :
     ios::beg

 Output parameters:
   none

 Return code:
   Pointer to this object.

streampos tellg(void)
 Returns current position in file.

 Input parameters:
   none

 Output parameters:
   none

 Return code:
   Actual position in file.

void ignore(int max, int term)
 Ignore max bytes in file. Moves access pointer to new position.

 Input parameters:
   int max
     Maximum number of bytes to skip.

   int term
     Ignored parameter, provided for compatibility.

 Return code:
   none

Bool_t good(void)
 Return status of last operation.

 Input parameters:
   none

 Output parameters:
   none

 Return code:
   kTRUE, if last operation was successfull, kFALSE otherwise.

Bool_t eof(void)
 Check if filepointer has reachjed the end of file marker.

 Input parameters:
   none

 Output parameters:
   none

 Return code:
   kTRUE if accesspointer has reached the end of file marker, kFALSE otherwise.

Bool_t fail(void)
 Check for file status.

 Input parameters:
   none

 Output parameters:
   none

 Return code:
   kTRUE if last operation failed, kFALSE otherwise.
   File unusable if kTRUE!

Bool_t bad(void)
 Check for file status.

 Input parameters:
   none

 Output parameters:
   none

 Return code:
    kTRUE, if last operation failed, but error can be repaired,
    otherwise kFALSE.

int rdstat(void)
 Return status.
 Check for file status.

 Input parameters:
   none

 Output parameters:
   none

 Return code:
   Status of file.

int stat(Long_t *id, Long_t *size, Long_t *flags, Long_t *modtime)
 Get information about file.

 Input parameters:
   none

 Output parameters:
   Long_t* id
     Contains device descriptor in the bits above 24, and the inode of the
     file in the lower 24 bits.

   Long_t* size
      Size of the file in bytes.

   Long_t* flags
      Bitmask defining the file type:
       bit 0 set if owner has execute permission,
       bit 1 set if is a directory,
       bit 3 set if not a regular file and not a directory.

 Return code:
   0 on success, -1 otherwise.

char* serror(void)
 Get the error message of the last operation.

 Input parameters:
   none

 Output parameters:
   none

 Return code:
   String describing error from last operation on file.

Int_t unlink(char *name)
 Delete a file. NOT IMPLEMENTED

 Input parameters:
   char* name
     Name of file to be deleted.

 Output parameters:
   none

  Return code:
    unknownw, as not implemented in underlying rfio code!



Inline Functions


        HRFIOFileTSM& operator>>(HRFIOFileTSM& u)
        HRFIOFileTSM& operator<<(const HRFIOFileTSM& u)
              TClass* Class()
              TClass* IsA() const
                 void ShowMembers(TMemberInspector& insp, char* parent)
                 void Streamer(TBuffer& b)
                 void StreamerNVirtual(TBuffer& b)
         HRFIOFileTSM HRFIOFileTSM(const HRFIOFileTSM&)
        HRFIOFileTSM& operator=(const HRFIOFileTSM&)


Author: J.Wuestenfeld
Last update: 11/19/2003 by J.Wuestenfeld


ROOT page - Class index - Class Hierarchy - Top of the page

This page has been automatically generated. If you have any comments or suggestions about the page layout send a mail to ROOT support, or contact the developers with any questions or problems regarding ROOT.