class CCL::FileResource

Overview

#include <fileresource.h>

class FileResource:
    public CCL::Object,
    public CCL::IFileResource
{
public:
    // fields

     IFileResource;

    // construction

    FileResource (UrlRef path);
    FileResource (const FileResource& other);

    // methods

    DECLARE_CLASS_ABSTRACT (FileResource, Object);
    virtual tbool CCL_API setPath (UrlRef path);
    virtual UrlRef CCL_API getPath () const;
    virtual tbool CCL_API open (int mode = 0);
    virtual tbool CCL_API create (int mode = 0);
    virtual tbool CCL_API close ();
    virtual tbool CCL_API isExisting () const;
    virtual tbool CCL_API isOpen () const;
    virtual tbool CCL_API deletePhysical (int mode = 0);
};

Inherited Members

public:
    // typedefs

    typedef CStringRef MemberID;

    // structs

    struct Closer;
    struct Opener;

    // methods

    virtual tresult CCL_API queryInterface (UIDRef iid, void** ptr) = 0;
    virtual unsigned int CCL_API retain () = 0;
    virtual unsigned int CCL_API release () = 0;
    Unknown& operator = (const Unknown&);
    unsigned int getRetainCount () const;
    virtual Object*CCL_API revealObject (const void* moduleAddress) = 0;
    virtual void CCL_API addObserver (IObserver* observer) = 0;
    virtual void CCL_API removeObserver (IObserver* observer) = 0;
    virtual void CCL_API signal (MessageRef msg) = 0;
    virtual void CCL_API deferSignal (IMessage* msg) = 0;
    static ISubject void addObserver (IUnknown* unknown, IObserver* observer);
    static void removeObserver (IUnknown* unknown, IObserver* observer);
    virtual void CCL_API notify (ISubject* subject, MessageRef msg) = 0;

    static IObserver void notify (
        IUnknown* unknown,
        ISubject* subject,
        MessageRef msg
    );

    virtual const ITypeInfo&CCL_API getTypeInfo () const = 0;
    virtual tbool CCL_API getProperty (Variant& var, MemberID propertyId) const = 0;
    virtual tbool CCL_API setProperty (MemberID propertyId, const Variant& var) = 0;
    virtual tbool CCL_API getPropertyNames (IPropertyCollector& collector) const = 0;
    virtual tbool CCL_API invokeMethod (Variant& returnValue, MessageRef msg) = 0;
    DECLARE_BASE_CLASS (Object);
    virtual void CCL_API removeObserver (IObserver* observer);
    virtual void CCL_API signal (MessageRef msg);
    virtual void CCL_API deferSignal (IMessage* msg);
    virtual void deferChanged ();
    virtual void CCL_API notify (ISubject* subject, MessageRef msg);
    virtual bool equals (const Object& obj) const;
    virtual int compare (const Object& obj) const;
    virtual bool load (const Storage& storage);
    virtual bool save (const Storage& storage) const;
    virtual bool save (const OutputStorage& storage) const;
    virtual bool toString (String& string, int flags = 0) const;
    virtual int getHashCode (int size) const;
    IUnknown* asUnknown ();
    static void addGarbageCollected (Object* obj, bool globalScope = true);
    static void deferDestruction (Object* obj);
    static const void* getModuleAddress ();
    virtual tbool CCL_API setPath (UrlRef path) = 0;
    virtual UrlRef CCL_API getPath () const = 0;
    virtual tbool CCL_API open (int mode = 0) = 0;
    virtual tbool CCL_API create (int mode = 0) = 0;
    virtual tbool CCL_API close () = 0;
    virtual tbool CCL_API isExisting () const = 0;
    virtual tbool CCL_API isOpen () const = 0;
    virtual tbool CCL_API deletePhysical (int mode = 0) = 0;

Detailed Documentation

Methods

virtual tbool CCL_API setPath (UrlRef path)

Call once to init file location.

virtual UrlRef CCL_API getPath () const

Get file location.

virtual tbool CCL_API open (int mode = 0)

Open existing file.

virtual tbool CCL_API create (int mode = 0)

Create new file.

virtual tbool CCL_API close ()

Close file.

virtual tbool CCL_API isExisting () const

Check if file exists.

virtual tbool CCL_API isOpen () const

Check if file is currently open.

virtual tbool CCL_API deletePhysical (int mode = 0)

Try to delete file physically.