CascadeFile.h

Go to the documentation of this file.

//
// CascadeFile.h - header file for class CascadeFile
//
// Copyright (c) 2002, Roku, LLC.  All rights reserved.
//

#ifndef _ROKU_INCLUDE_CASCADE_UTIL_CASCADEFILE_H
#define _ROKU_INCLUDE_CASCADE_UTIL_CASCADEFILE_H

#include <cascade/util/CascadeFSObject.h>
#include <cascade/util/CascadeString.h>

// Forward declaration
class CascadeDirectory;

class CascadeFile : public CascadeFSObject
{
public:
        CascadeFile();
        
    CascadeFile(const char * pName);
        
        virtual ~CascadeFile();

public:
    virtual bool Open(const char * pMode);
        
    virtual bool Close();

    virtual bool Delete();
    
    typedef bool (FileCopyCallback)(u64 inTotal, 
                                    u64 inComplete, 
                                    void *pClientData );

    virtual bool CopyInto( CascadeDirectory &inDestination,
                           FSCopyError &outError,
                           FileCopyCallback *inCallback = NULL,
                           void *inClientData = NULL,
                           bool inReplace = false );
        
    virtual bool IsOpen() const;
    
    virtual bool SetName(const char * pName);
        
    virtual bool Read(void * pBuff, u32 nBytes);
        
    virtual bool Write(void * pBuff, u32 nBytes);

    virtual u64 GetFileSize() const;

    virtual bool SeekToBeginning();

        
    virtual bool SeekForward(u32 nBytes);
        
    virtual bool SeekBackward(u32 nBytes);
        
    virtual bool SeekToEnd();
        
    virtual bool SeekToPosition(u64 nPosition);

    virtual void * GetHandle() const;

    virtual bool IsDirectory( void ) const { return false; }

private:
    void * m_pFileInternal;
};


#endif // #ifndef _ROKU_INCLUDE_CASCADE_UTIL_CASCADEFILE_H

// LOG
// 21-Jan-03    dwoodward       created
// 28-Jul-03    mjkobb      Fixed IsDirectory to be const
// 10-Aug-03    mjkobb      Added CopyInto

---