zipios::BasicEntry - BasicEntry is a FileEntry that is suitable as a base class for basic entries, that

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

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

zipios::BasicEntry::BasicEntry(conststring&filename,conststring&comment,constFilePath&basepath=FilePath())[explicit]
       Constructor.

       Parametersfilename the filename of the entry.
           comment a comment for the entry.

       Definition at line 24 of file basicentry.cpp.

BasicEntry is a FileEntry that is suitable as a base class for basic entries, that e.g.

       do not support any form of compression

       Definition at line 18 of file basicentry.h.

FileEntry*zipios::BasicEntry::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::FileEntry.

       Definition at line 132 of file basicentry.cpp.

   stringzipios::BasicEntry::getComment()const[virtual]
       Returns the comment of the entry, if it has one. Otherwise it returns an empty string.

       Returns
           the comment associated with the entry, if there is one.

       Implements zipios::FileEntry.

       Definition at line 42 of file basicentry.cpp.

   uint32zipios::BasicEntry::getCompressedSize()const[virtual]
       Returns the compressed size of the entry. If the entry is not stored in a compressed format, the
       uncompressed size is returned.

       Returns
           the compressed size of the entry. If the entry is stored without compression the uncompressed size is
           returned.

       Implements zipios::FileEntry.

       Definition at line 46 of file basicentry.cpp.

   uint32zipios::BasicEntry::getCrc()const[virtual]
       Returns the Crc for the entry, if it has one. FIXME: what is returned if it doesn't have one?

       Returns
           the Crc for the entry, if it has one.

       Implements zipios::FileEntry.

       Definition at line 50 of file basicentry.cpp.

   vector<unsignedchar>zipios::BasicEntry::getExtra()const[virtual]
       Returns a vector of bytes of extra data that may be stored with the entry.

       Returns
           A vector< unsigned char > of extra bytes that may potentially be associated with an entry.

       Implements zipios::FileEntry.

       Definition at line 54 of file basicentry.cpp.

   stringzipios::BasicEntry::getFileName()const[virtual]
       Returns the filename of the entry.

       Returns
           Returns the filename of the entry.

       Implements zipios::FileEntry.

       Definition at line 66 of file basicentry.cpp.

   StorageMethodzipios::BasicEntry::getMethod()const[virtual]
       Returns the method used to store the entry in the FileCollection.

       Returns
           the storage method used to store the entry in the collection.

       Seealso
           StorageMethod.

       Implements zipios::FileEntry.

       Definition at line 58 of file basicentry.cpp.

   stringzipios::BasicEntry::getName()const[virtual]
       Returns the full filename of the entry, including a path if the entry is stored in a subfolder.

       Returns
           the filename of the entry, including path if the entry is stored in a sub-folder.

       Implements zipios::FileEntry.

       Definition at line 62 of file basicentry.cpp.

   uint32zipios::BasicEntry::getSize()const[virtual]
       Returns the (uncompressed) size of the entry data.

       Returns
           Returns the (uncompressed) size of the entry.

       Implements zipios::FileEntry.

       Definition at line 79 of file basicentry.cpp.

   intzipios::BasicEntry::getTime()const[virtual]
       Returns the date and time of FIXME: what?

       Returns
           the date and time of the entry.

       Implements zipios::FileEntry.

       Definition at line 83 of file basicentry.cpp.

   boolzipios::BasicEntry::isDirectory()const[virtual]
       Returns true if the entry is a directory. A directory entry is an entry which name ends with a separator
       ('/' for Unix systems, '\' for Windows and DOS systems.

       Returns
           true if the entry is a directory.

       Implements zipios::FileEntry.

       Definition at line 92 of file basicentry.cpp.

   boolzipios::BasicEntry::isValid()const[virtual]
       Any method or operator that initializes a FileEntry may set a flag, that specifies whether the read entry
       is valid or not. If it isn't this method returns false.

       Returns
           true if the FileEntry has been parsed succesfully.

       Implements zipios::FileEntry.

       Definition at line 87 of file basicentry.cpp.

   voidzipios::BasicEntry::setComment(conststring&comment)[virtual]
       Sets the comment field for the FileEntry.

       Parameterscomment string with the new comment.

       Implements zipios::FileEntry.

       Definition at line 98 of file basicentry.cpp.

   voidzipios::BasicEntry::setCompressedSize(uint32size)[virtual]
       Set the compressed size field of the entry.

       Parameterssize value to set the compressed size field of the entry to.

       Implements zipios::FileEntry.

       Definition at line 102 of file basicentry.cpp.

   voidzipios::BasicEntry::setCrc(uint32crc)[virtual]
       Sets the crc field.

       Parameterscrc value to set the crc field to.

       Implements zipios::FileEntry.

       Definition at line 105 of file basicentry.cpp.

   voidzipios::BasicEntry::setExtra(constvector<unsignedchar>&extra)[virtual]
       Sets the extra field.

       Parametersextra the extra field is set to this value.

       Implements zipios::FileEntry.

       Definition at line 108 of file basicentry.cpp.

   voidzipios::BasicEntry::setMethod(StorageMethodmethod)[virtual]
       Sets the storage method field for the entry.

       Parametersmethod the method field is set to the specified value.

       Implements zipios::FileEntry.

       Definition at line 111 of file basicentry.cpp.

   voidzipios::BasicEntry::setName(conststring&name)[virtual]
       Sets the name field for the entry.

       Parametersname the name field is set to the specified value.

       Implements zipios::FileEntry.

       Definition at line 114 of file basicentry.cpp.

   voidzipios::BasicEntry::setSize(uint32size)[virtual]
       Sets the size field for the entry.

       Parameterssize the size field is set to this value.

       Implements zipios::FileEntry.

       Definition at line 118 of file basicentry.cpp.

   voidzipios::BasicEntry::setTime(inttime)[virtual]
       Sets the time field for the entry.

       Parameterstime the time field is set to the specified value.

       Implements zipios::FileEntry.

       Definition at line 122 of file basicentry.cpp.

   stringzipios::BasicEntry::toString()const[virtual]
       Returns a human-readable string representation of the entry.

       Returns
           a human-readable string representation of the entry.

       Implements zipios::FileEntry.

       Definition at line 126 of file basicentry.cpp.

       zipios::BasicEntry - BasicEntry is a FileEntry that is suitable as a base class for basic entries, that
       e.g.

       #include <basicentry.h>

       Inherits zipios::FileEntry.

   PublicMemberFunctionsBasicEntry (const string &filename, const string &comment, const FilePath &basepath=FilePath())
           Constructor.
       virtual string getComment () const
           Returns the comment of the entry, if it has one.
       virtual uint32 getCompressedSize () const
           Returns the compressed size of the entry.
       virtual uint32 getCrc () const
           Returns the Crc for the entry, if it has one.
       virtual vector< unsigned char > getExtra () const
           Returns a vector of bytes of extra data that may be stored with the entry.
       virtual StorageMethodgetMethod () const
           Returns the method used to store the entry in the FileCollection.
       virtual string getName () const
           Returns the full filename of the entry, including a path if the entry is stored in a subfolder.
       virtual string getFileName () const
           Returns the filename of the entry.
       virtual uint32 getSize () const
           Returns the (uncompressed) size of the entry data.
       virtual int getTime () const
           Returns the date and time of FIXME: what?
            "
       virtual bool isValid () const
           Any method or operator that initializes a FileEntry may set a flag, that specifies whether the read
           entry is valid or not.
       virtual bool isDirectory () const
           Returns true if the entry is a directory.
       virtual void setComment (const string &comment)
           Sets the comment field for the FileEntry.
       virtual void setCompressedSize (uint32 size)
           Set the compressed size field of the entry.
       virtual void setCrc (uint32 crc)
           Sets the crc field.
       virtual void setExtra (const vector< unsigned char > &extra)
           Sets the extra field.
       virtual void setMethod (StorageMethod method)
           Sets the storage method field for the entry.
       virtual void setName (const string &name)
           Sets the name field for the entry.
       virtual void setSize (uint32 size)
           Sets the size field for the entry.
       virtual void setTime (int time)
           Sets the time field for the entry.
       virtual string toString () const
           Returns a human-readable string representation of the entry.
       virtual FileEntry * clone () const
           Create a heap allocated clone of the object this method is called for.

   ProtectedAttributes
       string _filename
       string _comment
       int _size
       bool _validFilePath_basepathAdditionalInheritedMembers