zipios::DirectoryCollection(3) | Library Functions Manual | zipios::DirectoryCollection(3) |
NAME¶
zipios::DirectoryCollection -SYNOPSIS¶
#include <dircoll.h> Inherits zipios::FileCollection.Public Member Functions¶
DirectoryCollection ()
Protected Member Functions¶
void loadEntries () const
Protected Attributes¶
bool _entries_loaded
Additional Inherited Members¶
Detailed Description¶
DirectoryCollection is a FileCollection that obtains its entries from a directory. Definition at line 19 of file dircoll.h.Constructor & Destructor Documentation¶
zipios::DirectoryCollection::DirectoryCollection () [inline], [explicit]¶
Default Constructor. Definition at line 23 of file dircoll.h.zipios::DirectoryCollection::DirectoryCollection (const string &path, boolrecursive = true, boolload_now = false) [explicit]¶
Constructor. Parameters: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.
zipios::DirectoryCollection::~DirectoryCollection () [virtual]¶
Destructor. Definition at line 118 of file dircoll.cpp.Member Function Documentation¶
FileCollection * zipios::DirectoryCollection::clone () const [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. Returns:A heap allocated copy of the object this method is called
for.
Implements zipios::FileCollection.
Definition at line 114 of file dircoll.cpp.
void zipios::DirectoryCollection::close () [virtual]¶
Closes the FileCollection. Implements zipios::FileCollection. Definition at line 33 of file dircoll.cpp.ConstEntries zipios::DirectoryCollection::entries () const [virtual]¶
Returns a vector of const pointers to the entries in the FileCollection. Returns:a ConstEntries containing the entries of the
FileCollection.
Exceptions:
InvalidStateException Thrown if
the collection is invalid.
Reimplemented from zipios::FileCollection.
Definition at line 38 of file dircoll.cpp.
ConstEntryPointer zipios::DirectoryCollection::getEntry (const string &name, MatchPathmatchpath = MATCH) const [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. Parameters: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.
Returns:
A ConstEntryPointer to the found entry. The returned
pointer equals zero if no entry is found.
Exceptions:
InvalidStateException Thrown if
the collection is invalid.
Reimplemented from zipios::FileCollection.
Definition at line 49 of file dircoll.cpp.
istream * zipios::DirectoryCollection::getInputStream (const ConstEntryPointer &entry) [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. Parameters:entry A ConstEntryPointer to the FileEntry
to get an istream to.
Returns:
an open istream for the specified entry. The istream is
allocated on heap and it is the users responsibility to delete it when he is
done with it.
Exceptions:
InvalidStateException Thrown if
the collection is invalid.
Implements zipios::FileCollection.
Definition at line 68 of file dircoll.cpp.
istream * zipios::DirectoryCollection::getInputStream (const string &entry_name, MatchPathmatchpath = MATCH) [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. Parameters:matchpath Speficy MATCH, if the path should match
as well, specify IGNORE, if the path should be ignored.
Returns:
an open istream for the specified entry. The istream is
allocated on heap and it is the users responsibility to delete it when he is
done with it.
Exceptions:
InvalidStateException Thrown if
the collection is invalid.
Implements zipios::FileCollection.
Definition at line 76 of file dircoll.cpp.
int zipios::DirectoryCollection::size () const [virtual]¶
Returns the number of entries in the FileCollection. Returns:the number of entries in the FileCollection.
Exceptions:
InvalidStateException Thrown if
the collection is invalid.
Reimplemented from zipios::FileCollection.
Definition at line 106 of file dircoll.cpp.
Author¶
Generated automatically by Doxygen for Zipios++ from the source code.Mon Sep 22 2014 | Zipios++ |