.TH "zipios::BasicEntry" 3 "Tue May 9 2017" "Zipios++" \" -*- nroff -*-
.ad l
.nh
.SH NAME
zipios::BasicEntry \- \fBBasicEntry\fP is a \fBFileEntry\fP that is suitable as a base class for basic entries, that e\&.g\&.  

.SH SYNOPSIS
.br
.PP
.PP
\fC#include <basicentry\&.h>\fP
.PP
Inherits \fBzipios::FileEntry\fP\&.
.SS "Public Member Functions"

.in +1c
.ti -1c
.RI "\fBBasicEntry\fP (const string &filename, const string &comment, const \fBFilePath\fP &basepath=\fBFilePath\fP())"
.br
.RI "Constructor\&. "
.ti -1c
.RI "virtual string \fBgetComment\fP () const"
.br
.RI "Returns the comment of the entry, if it has one\&. "
.ti -1c
.RI "virtual uint32 \fBgetCompressedSize\fP () const"
.br
.RI "Returns the compressed size of the entry\&. "
.ti -1c
.RI "virtual uint32 \fBgetCrc\fP () const"
.br
.RI "Returns the Crc for the entry, if it has one\&. "
.ti -1c
.RI "virtual vector< unsigned char > \fBgetExtra\fP () const"
.br
.RI "Returns a vector of bytes of extra data that may be stored with the entry\&. "
.ti -1c
.RI "virtual \fBStorageMethod\fP \fBgetMethod\fP () const"
.br
.RI "Returns the method used to store the entry in the \fBFileCollection\fP\&. "
.ti -1c
.RI "virtual string \fBgetName\fP () const"
.br
.RI "Returns the full filename of the entry, including a path if the entry is stored in a subfolder\&. "
.ti -1c
.RI "virtual string \fBgetFileName\fP () const"
.br
.RI "Returns the filename of the entry\&. "
.ti -1c
.RI "virtual uint32 \fBgetSize\fP () const"
.br
.RI "Returns the (uncompressed) size of the entry data\&. "
.ti -1c
.RI "virtual int \fBgetTime\fP () const"
.br
.RI "Returns the date and time of FIXME: what? "
.ti -1c
.RI "virtual bool \fBisValid\fP () const"
.br
.RI "Any method or operator that initializes a \fBFileEntry\fP may set a flag, that specifies whether the read entry is valid or not\&. "
.ti -1c
.RI "virtual bool \fBisDirectory\fP () const"
.br
.RI "Returns true if the entry is a directory\&. "
.ti -1c
.RI "virtual void \fBsetComment\fP (const string &comment)"
.br
.RI "Sets the comment field for the \fBFileEntry\fP\&. "
.ti -1c
.RI "virtual void \fBsetCompressedSize\fP (uint32 size)"
.br
.RI "Set the compressed size field of the entry\&. "
.ti -1c
.RI "virtual void \fBsetCrc\fP (uint32 crc)"
.br
.RI "Sets the crc field\&. "
.ti -1c
.RI "virtual void \fBsetExtra\fP (const vector< unsigned char > &extra)"
.br
.RI "Sets the extra field\&. "
.ti -1c
.RI "virtual void \fBsetMethod\fP (\fBStorageMethod\fP method)"
.br
.RI "Sets the storage method field for the entry\&. "
.ti -1c
.RI "virtual void \fBsetName\fP (const string &name)"
.br
.RI "Sets the name field for the entry\&. "
.ti -1c
.RI "virtual void \fBsetSize\fP (uint32 size)"
.br
.RI "Sets the size field for the entry\&. "
.ti -1c
.RI "virtual void \fBsetTime\fP (int time)"
.br
.RI "Sets the time field for the entry\&. "
.ti -1c
.RI "virtual string \fBtoString\fP () const"
.br
.RI "Returns a human-readable string representation of the entry\&. "
.ti -1c
.RI "virtual \fBFileEntry\fP * \fBclone\fP () const"
.br
.RI "Create a heap allocated clone of the object this method is called for\&. "
.in -1c
.SS "Protected Attributes"

.in +1c
.ti -1c
.RI "string \fB_filename\fP"
.br
.ti -1c
.RI "string \fB_comment\fP"
.br
.ti -1c
.RI "int \fB_size\fP"
.br
.ti -1c
.RI "bool \fB_valid\fP"
.br
.ti -1c
.RI "\fBFilePath\fP \fB_basepath\fP"
.br
.in -1c
.SS "Additional Inherited Members"
.SH "Detailed Description"
.PP 
\fBBasicEntry\fP is a \fBFileEntry\fP that is suitable as a base class for basic entries, that e\&.g\&. 

do not support any form of compression 
.PP
Definition at line 18 of file basicentry\&.h\&.
.SH "Constructor & Destructor Documentation"
.PP 
.SS "zipios::BasicEntry::BasicEntry (const string & filename, const string & comment, const \fBFilePath\fP & basepath = \fC\fBFilePath\fP()\fP)\fC [explicit]\fP"

.PP
Constructor\&. 
.PP
\fBParameters:\fP
.RS 4
\fIfilename\fP the filename of the entry\&. 
.br
\fIcomment\fP a comment for the entry\&. 
.RE
.PP

.PP
Definition at line 24 of file basicentry\&.cpp\&.
.SH "Member Function Documentation"
.PP 
.SS "\fBFileEntry\fP * zipios::BasicEntry::clone () const\fC [virtual]\fP"

.PP
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\&. 
.PP
\fBReturns:\fP
.RS 4
A heap allocated copy of the object this method is called for\&. 
.RE
.PP

.PP
Implements \fBzipios::FileEntry\fP\&.
.PP
Definition at line 132 of file basicentry\&.cpp\&.
.SS "string zipios::BasicEntry::getComment () const\fC [virtual]\fP"

.PP
Returns the comment of the entry, if it has one\&. Otherwise it returns an empty string\&. 
.PP
\fBReturns:\fP
.RS 4
the comment associated with the entry, if there is one\&. 
.RE
.PP

.PP
Implements \fBzipios::FileEntry\fP\&.
.PP
Definition at line 42 of file basicentry\&.cpp\&.
.SS "uint32 zipios::BasicEntry::getCompressedSize () const\fC [virtual]\fP"

.PP
Returns the compressed size of the entry\&. If the entry is not stored in a compressed format, the uncompressed size is returned\&. 
.PP
\fBReturns:\fP
.RS 4
the compressed size of the entry\&. If the entry is stored without compression the uncompressed size is returned\&. 
.RE
.PP

.PP
Implements \fBzipios::FileEntry\fP\&.
.PP
Definition at line 46 of file basicentry\&.cpp\&.
.SS "uint32 zipios::BasicEntry::getCrc () const\fC [virtual]\fP"

.PP
Returns the Crc for the entry, if it has one\&. FIXME: what is returned if it doesn't have one? 
.PP
\fBReturns:\fP
.RS 4
the Crc for the entry, if it has one\&. 
.RE
.PP

.PP
Implements \fBzipios::FileEntry\fP\&.
.PP
Definition at line 50 of file basicentry\&.cpp\&.
.SS "vector< unsigned char > zipios::BasicEntry::getExtra () const\fC [virtual]\fP"

.PP
Returns a vector of bytes of extra data that may be stored with the entry\&. 
.PP
\fBReturns:\fP
.RS 4
A vector< unsigned char > of extra bytes that may potentially be associated with an entry\&. 
.RE
.PP

.PP
Implements \fBzipios::FileEntry\fP\&.
.PP
Definition at line 54 of file basicentry\&.cpp\&.
.SS "string zipios::BasicEntry::getFileName () const\fC [virtual]\fP"

.PP
Returns the filename of the entry\&. 
.PP
\fBReturns:\fP
.RS 4
Returns the filename of the entry\&. 
.RE
.PP

.PP
Implements \fBzipios::FileEntry\fP\&.
.PP
Definition at line 66 of file basicentry\&.cpp\&.
.SS "\fBStorageMethod\fP zipios::BasicEntry::getMethod () const\fC [virtual]\fP"

.PP
Returns the method used to store the entry in the \fBFileCollection\fP\&. 
.PP
\fBReturns:\fP
.RS 4
the storage method used to store the entry in the collection\&. 
.RE
.PP
\fBSee also:\fP
.RS 4
StorageMethod\&. 
.RE
.PP

.PP
Implements \fBzipios::FileEntry\fP\&.
.PP
Definition at line 58 of file basicentry\&.cpp\&.
.SS "string zipios::BasicEntry::getName () const\fC [virtual]\fP"

.PP
Returns the full filename of the entry, including a path if the entry is stored in a subfolder\&. 
.PP
\fBReturns:\fP
.RS 4
the filename of the entry, including path if the entry is stored in a sub-folder\&. 
.RE
.PP

.PP
Implements \fBzipios::FileEntry\fP\&.
.PP
Definition at line 62 of file basicentry\&.cpp\&.
.SS "uint32 zipios::BasicEntry::getSize () const\fC [virtual]\fP"

.PP
Returns the (uncompressed) size of the entry data\&. 
.PP
\fBReturns:\fP
.RS 4
Returns the (uncompressed) size of the entry\&. 
.RE
.PP

.PP
Implements \fBzipios::FileEntry\fP\&.
.PP
Definition at line 79 of file basicentry\&.cpp\&.
.SS "int zipios::BasicEntry::getTime () const\fC [virtual]\fP"

.PP
Returns the date and time of FIXME: what? 
.PP
\fBReturns:\fP
.RS 4
the date and time of the entry\&. 
.RE
.PP

.PP
Implements \fBzipios::FileEntry\fP\&.
.PP
Definition at line 83 of file basicentry\&.cpp\&.
.SS "bool zipios::BasicEntry::isDirectory () const\fC [virtual]\fP"

.PP
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\&. 
.PP
\fBReturns:\fP
.RS 4
true if the entry is a directory\&. 
.RE
.PP

.PP
Implements \fBzipios::FileEntry\fP\&.
.PP
Definition at line 92 of file basicentry\&.cpp\&.
.SS "bool zipios::BasicEntry::isValid () const\fC [virtual]\fP"

.PP
Any method or operator that initializes a \fBFileEntry\fP may set a flag, that specifies whether the read entry is valid or not\&. If it isn't this method returns false\&. 
.PP
\fBReturns:\fP
.RS 4
true if the \fBFileEntry\fP has been parsed succesfully\&. 
.RE
.PP

.PP
Implements \fBzipios::FileEntry\fP\&.
.PP
Definition at line 87 of file basicentry\&.cpp\&.
.SS "void zipios::BasicEntry::setComment (const string & comment)\fC [virtual]\fP"

.PP
Sets the comment field for the \fBFileEntry\fP\&. 
.PP
\fBParameters:\fP
.RS 4
\fIcomment\fP string with the new comment\&. 
.RE
.PP

.PP
Implements \fBzipios::FileEntry\fP\&.
.PP
Definition at line 98 of file basicentry\&.cpp\&.
.SS "void zipios::BasicEntry::setCompressedSize (uint32 size)\fC [virtual]\fP"

.PP
Set the compressed size field of the entry\&. 
.PP
\fBParameters:\fP
.RS 4
\fIsize\fP value to set the compressed size field of the entry to\&. 
.RE
.PP

.PP
Implements \fBzipios::FileEntry\fP\&.
.PP
Definition at line 102 of file basicentry\&.cpp\&.
.SS "void zipios::BasicEntry::setCrc (uint32 crc)\fC [virtual]\fP"

.PP
Sets the crc field\&. 
.PP
\fBParameters:\fP
.RS 4
\fIcrc\fP value to set the crc field to\&. 
.RE
.PP

.PP
Implements \fBzipios::FileEntry\fP\&.
.PP
Definition at line 105 of file basicentry\&.cpp\&.
.SS "void zipios::BasicEntry::setExtra (const vector< unsigned char > & extra)\fC [virtual]\fP"

.PP
Sets the extra field\&. 
.PP
\fBParameters:\fP
.RS 4
\fIextra\fP the extra field is set to this value\&. 
.RE
.PP

.PP
Implements \fBzipios::FileEntry\fP\&.
.PP
Definition at line 108 of file basicentry\&.cpp\&.
.SS "void zipios::BasicEntry::setMethod (\fBStorageMethod\fP method)\fC [virtual]\fP"

.PP
Sets the storage method field for the entry\&. 
.PP
\fBParameters:\fP
.RS 4
\fImethod\fP the method field is set to the specified value\&. 
.RE
.PP

.PP
Implements \fBzipios::FileEntry\fP\&.
.PP
Definition at line 111 of file basicentry\&.cpp\&.
.SS "void zipios::BasicEntry::setName (const string & name)\fC [virtual]\fP"

.PP
Sets the name field for the entry\&. 
.PP
\fBParameters:\fP
.RS 4
\fIname\fP the name field is set to the specified value\&. 
.RE
.PP

.PP
Implements \fBzipios::FileEntry\fP\&.
.PP
Definition at line 114 of file basicentry\&.cpp\&.
.SS "void zipios::BasicEntry::setSize (uint32 size)\fC [virtual]\fP"

.PP
Sets the size field for the entry\&. 
.PP
\fBParameters:\fP
.RS 4
\fIsize\fP the size field is set to this value\&. 
.RE
.PP

.PP
Implements \fBzipios::FileEntry\fP\&.
.PP
Definition at line 118 of file basicentry\&.cpp\&.
.SS "void zipios::BasicEntry::setTime (int time)\fC [virtual]\fP"

.PP
Sets the time field for the entry\&. 
.PP
\fBParameters:\fP
.RS 4
\fItime\fP the time field is set to the specified value\&. 
.RE
.PP

.PP
Implements \fBzipios::FileEntry\fP\&.
.PP
Definition at line 122 of file basicentry\&.cpp\&.
.SS "string zipios::BasicEntry::toString () const\fC [virtual]\fP"

.PP
Returns a human-readable string representation of the entry\&. 
.PP
\fBReturns:\fP
.RS 4
a human-readable string representation of the entry\&. 
.RE
.PP

.PP
Implements \fBzipios::FileEntry\fP\&.
.PP
Definition at line 126 of file basicentry\&.cpp\&.

.SH "Author"
.PP 
Generated automatically by Doxygen for Zipios++ from the source code\&.