Scroll to navigation

zipios::BasicEntry(3) Library Functions Manual zipios::BasicEntry(3)

NAME

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

SYNOPSIS

#include <basicentry.h>
Inherits zipios::FileEntry.

Public Member Functions


BasicEntry (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 StorageMethod getMethod () 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.

Protected Attributes


string _filename
 
string _comment
 
int _size
 
bool _valid
 
FilePath _basepath
 

Detailed Description

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.

Constructor & Destructor Documentation

zipios::BasicEntry::BasicEntry (const string &filename, const string &comment, const FilePath &basepath = FilePath()) [explicit]

Constructor. Parameters:
filename the filename of the entry.
 
comment a comment for the entry.
 
Definition at line 24 of file basicentry.cpp.

Member Function Documentation

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.

string zipios::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.

uint32 zipios::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.

uint32 zipios::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< unsigned char > 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.

string zipios::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.

StorageMethod zipios::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.
See also:
StorageMethod.
 
Implements zipios::FileEntry.
Definition at line 58 of file basicentry.cpp.

string zipios::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.

uint32 zipios::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.

int zipios::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.

bool zipios::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.

bool zipios::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.

void zipios::BasicEntry::setComment (const string &comment) [virtual]

Sets the comment field for the FileEntry. Parameters:
comment string with the new comment.
 
Implements zipios::FileEntry.
Definition at line 98 of file basicentry.cpp.

void zipios::BasicEntry::setCompressedSize (uint32size) [virtual]

Set the compressed size field of the entry. Parameters:
size value to set the compressed size field of the entry to.
 
Implements zipios::FileEntry.
Definition at line 102 of file basicentry.cpp.

void zipios::BasicEntry::setCrc (uint32crc) [virtual]

Sets the crc field. Parameters:
crc value to set the crc field to.
 
Implements zipios::FileEntry.
Definition at line 105 of file basicentry.cpp.

void zipios::BasicEntry::setExtra (const vector< unsigned char > &extra) [virtual]

Sets the extra field. Parameters:
extra the extra field is set to this value.
 
Implements zipios::FileEntry.
Definition at line 108 of file basicentry.cpp.

void zipios::BasicEntry::setMethod (StorageMethodmethod) [virtual]

Sets the storage method field for the entry. Parameters:
method the method field is set to the specified value.
 
Implements zipios::FileEntry.
Definition at line 111 of file basicentry.cpp.

void zipios::BasicEntry::setName (const string &name) [virtual]

Sets the name field for the entry. Parameters:
name the name field is set to the specified value.
 
Implements zipios::FileEntry.
Definition at line 114 of file basicentry.cpp.

void zipios::BasicEntry::setSize (uint32size) [virtual]

Sets the size field for the entry. Parameters:
size the size field is set to this value.
 
Implements zipios::FileEntry.
Definition at line 118 of file basicentry.cpp.

void zipios::BasicEntry::setTime (inttime) [virtual]

Sets the time field for the entry. Parameters:
time the time field is set to the specified value.
 
Implements zipios::FileEntry.
Definition at line 122 of file basicentry.cpp.

string zipios::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.
 

Author

Generated automatically by Doxygen for Zipios++ from the source code.
Mon Oct 10 2011 Zipios++