zipios::DirectoryCollection

       Generated automatically by Doxygen for Zipios++ from the source code.

Zipios++                                         Tue Mar 24 2020                  zipios::DirectoryCollection(3)

zipios::DirectoryCollection::DirectoryCollection()[inline],[explicit]
       Default Constructor.

       Definition at line 23 of file dircoll.h.

   zipios::DirectoryCollection::DirectoryCollection(conststring&path,boolrecursive=true,boolload_now=false)[explicit]
       Constructor.

       Parameterspath 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.

DirectoryCollection is a FileCollection that obtains its entries from a directory.

       Definition at line 19 of file dircoll.h.

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.

   voidzipios::DirectoryCollection::close()[virtual]
       Closes the FileCollection.

       Implements zipios::FileCollection.

       Definition at line 33 of file dircoll.cpp.

   ConstEntrieszipios::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.

       ExceptionsInvalidStateExceptionThrownifthecollectionisinvalid.

       Reimplemented from zipios::FileCollection.

       Definition at line 38 of file dircoll.cpp.

   ConstEntryPointerzipios::DirectoryCollection::getEntry(conststring&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.

       Parametersname 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.

       ExceptionsInvalidStateExceptionThrownifthecollectionisinvalid.

       Reimplemented from zipios::FileCollection.

       Definition at line 49 of file dircoll.cpp.

   istream*zipios::DirectoryCollection::getInputStream(constConstEntryPointer&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.

       Parametersentry 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.

       ExceptionsInvalidStateExceptionThrownifthecollectionisinvalid.

       Implements zipios::FileCollection.

       Definition at line 68 of file dircoll.cpp.

   istream*zipios::DirectoryCollection::getInputStream(conststring&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.

       Parametersmatchpath 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.

       ExceptionsInvalidStateExceptionThrownifthecollectionisinvalid.

       Implements zipios::FileCollection.

       Definition at line 76 of file dircoll.cpp.

   intzipios::DirectoryCollection::size()const[virtual]
       Returns the number of entries in the FileCollection.

       Returns
           the number of entries in the FileCollection.

       ExceptionsInvalidStateExceptionThrownifthecollectionisinvalid.

       Reimplemented from zipios::FileCollection.

       Definition at line 106 of file dircoll.cpp.

       zipios::DirectoryCollection

       #include <dircoll.h>

       Inherits zipios::FileCollection.

   PublicMemberFunctionsDirectoryCollection ()
           Default Constructor.
       DirectoryCollection (const string &path, bool recursive=true, bool load_now=false)
           Constructor.
       virtual void close ()
           Closes the FileCollection.
       virtual ConstEntriesentries () const
       virtual ConstEntryPointergetEntry (const string &name, MatchPath matchpath=MATCH) const
       virtual istream * getInputStream (const ConstEntryPointer &entry)
       virtual istream * getInputStream (const string &entry_name, MatchPath matchpath=MATCH)
           Returns a pointer to an opened istream for the specified entry name.
       virtual int size () const
           Returns the number of entries in the FileCollection.
       virtual FileCollection * clone () const
           Create a heap allocated clone of the object this method is called for.
       virtual ~DirectoryCollection ()
           Destructor.

   ProtectedMemberFunctions
       void loadEntries () const
       void load (bool recursive, const FilePath &subdir=FilePath())

   ProtectedAttributes
       bool _entries_loaded
       bool _recursiveFilePath_filepathAdditionalInheritedMembers