Zipios++
|
DirectoryCollection is a FileCollection that obtains its entries from a directory. More...
#include <dircoll.h>
Public Member Functions | |
DirectoryCollection () | |
Default Constructor. More... | |
DirectoryCollection (const string &path, bool recursive=true, bool load_now=false) | |
Constructor. More... | |
virtual void | close () |
Closes the FileCollection. More... | |
virtual ConstEntries | entries () const |
Returns a vector of const pointers to the entries in the FileCollection. More... | |
virtual ConstEntryPointer | getEntry (const string &name, MatchPath matchpath=MATCH) const |
Returns a ConstEntryPointer to a FileEntry object for the entry with the specified name. More... | |
virtual istream * | getInputStream (const ConstEntryPointer &entry) |
Returns a pointer to an opened istream for the specified FileEntry. More... | |
virtual istream * | getInputStream (const string &entry_name, MatchPath matchpath=MATCH) |
Returns a pointer to an opened istream for the specified entry name. More... | |
virtual int | size () const |
Returns the number of entries in the FileCollection. More... | |
virtual FileCollection * | clone () const |
Create a heap allocated clone of the object this method is called for. More... | |
virtual | ~DirectoryCollection () |
Destructor. More... | |
![]() | |
FileCollection () | |
FileCollection constructor. More... | |
FileCollection (const FileCollection &src) | |
Copy constructor. More... | |
const FileCollection & | operator= (const FileCollection &src) |
Copy assignment operator. More... | |
virtual void | close ()=0 |
Closes the FileCollection. More... | |
virtual ConstEntries | entries () const |
Returns a vector of const pointers to the entries in the FileCollection. More... | |
virtual ConstEntryPointer | getEntry (const string &name, MatchPath matchpath=MATCH) const |
Returns a ConstEntryPointer to a FileEntry object for the entry with the specified name. More... | |
virtual istream * | getInputStream (const ConstEntryPointer &entry)=0 |
Returns a pointer to an opened istream for the specified FileEntry. More... | |
virtual istream * | getInputStream (const string &entry_name, MatchPath matchpath=MATCH)=0 |
Returns a pointer to an opened istream for the specified entry name. More... | |
virtual string | getName () const |
Returns the name of the FileCollection. More... | |
virtual int | size () const |
Returns the number of entries in the FileCollection. More... | |
bool | isValid () const |
The member function returns true if the collection is valid. More... | |
virtual FileCollection * | clone () const =0 |
Create a heap allocated clone of the object this method is called for. More... | |
virtual | ~FileCollection () |
FileCollection destructor. More... | |
Protected Member Functions | |
void | loadEntries () const |
void | load (bool recursive, const FilePath &subdir=FilePath()) |
Protected Attributes | |
bool | _entries_loaded |
bool | _recursive |
FilePath | _filepath |
![]() | |
string | _filename |
Entries | _entries |
bool | _valid |
Additional Inherited Members | |
![]() | |
enum | MatchPath { IGNORE , MATCH } |
DirectoryCollection is a FileCollection that obtains its entries from a directory.
|
inlineexplicit |
|
explicit |
Constructor.
path | A directory path name. If the name is not a valid directory the created DirectoryCollection will be invalid. |
load_now | Load directory into memory now. Otherwise it will be done when it is first needed. |
Definition at line 20 of file dircoll.cpp.
|
virtual |
Destructor.
Definition at line 118 of file dircoll.cpp.
|
virtual |
Create a heap allocated clone of the object this method is called for.
The caller is responsible for deallocating the clone when he is done with it.
Implements zipios::FileCollection.
Definition at line 114 of file dircoll.cpp.
|
virtual |
Closes the FileCollection.
Implements zipios::FileCollection.
Definition at line 33 of file dircoll.cpp.
|
virtual |
Returns a vector of const pointers to the entries in the FileCollection.
InvalidStateException | Thrown if the collection is invalid. |
Reimplemented from zipios::FileCollection.
Definition at line 38 of file dircoll.cpp.
|
virtual |
Returns a ConstEntryPointer to a FileEntry object for the entry with the specified name.
To ignore the path part of the filename in search of a match, specify FileCollection::IGNORE as the second argument.
name | A string containing the name of the entry to get. |
matchpath | Speficy MATCH, if the path should match as well, specify IGNORE, if the path should be ignored. |
InvalidStateException | Thrown if the collection is invalid. |
Reimplemented from zipios::FileCollection.
Definition at line 49 of file dircoll.cpp.
|
virtual |
Returns a pointer to an opened istream for the specified FileEntry.
It is the callers responsibility to delete the stream when he is done with it. Returns 0, if there is no such FileEntry in the FileCollection.
entry | A ConstEntryPointer to the FileEntry to get an istream to. |
InvalidStateException | Thrown if the collection is invalid. |
Implements zipios::FileCollection.
Definition at line 68 of file dircoll.cpp.
|
virtual |
Returns a pointer to an opened istream for the specified entry name.
It is the callers responsibility to delete the stream when he is done with it. Returns 0, if there is no entry with the specified name in the FileCollection.
matchpath | Speficy MATCH, if the path should match as well, specify IGNORE, if the path should be ignored. |
InvalidStateException | Thrown if the collection is invalid. |
Implements zipios::FileCollection.
Definition at line 76 of file dircoll.cpp.
|
protected |
Definition at line 131 of file dircoll.cpp.
|
protected |
Definition at line 121 of file dircoll.cpp.
|
virtual |
Returns the number of entries in the FileCollection.
InvalidStateException | Thrown if the collection is invalid. |
Reimplemented from zipios::FileCollection.
Definition at line 106 of file dircoll.cpp.
|
mutableprotected |