★ wanayoo — archive 1999 http://zipios.sourceforge.net/class_zipios__basicentry.htmlNouvelle recherche | Portail wanayoo
Main Page   Class Hierarchy   Compound List   File List   Compound Members  

zipios::BasicEntry Class Reference

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

#include <basicentry.h>

Inheritance diagram for zipios::BasicEntry

List of all members.

Public Methods

 BasicEntry ( const string &filename, const string &comment, const FilePath &basepath = string() )
 Constructor. More...

virtual string getComment () const
 Returns the comment of the entry, if it has one. More...

virtual int getCompressedSize () const
 Returns the compressed size of the entry. More...

virtual int getCrc () const
 Returns the Crc for the entry, if it has one. More...

virtual vector< unsigned char > getExtra () const
 Returns a vector of bytes of extra data that may be stored with the entry. More...

virtual StorageMethod getMethod () const
 Returns the method used to store the entry in the FileCollection. More...

virtual string getName () const
 Returns the full filename of the entry, including a path if the entry is stored in a subfolder. More...

virtual string getFileName () const
 Returns the filename of the entry. More...

virtual int getSize () const
 Returns the (uncompressed) size of the entry data. More...

virtual int getTime () const
 Returns the date and time of FIXME: what? More...

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

virtual bool isDirectory () const
 Returns true if the entry is a directory. More...

virtual void setComment ( const string &comment )
 Sets the comment field for the FileEntry. More...

virtual void setCompressedSize ( int size )
 Set the compressed size field of the entry. More...

virtual void setCrc ( int crc )
 Sets the crc field. More...

virtual void setExtra ( const vector< unsigned char > &extra )
 Sets the extra field. More...

virtual void setMethod ( StorageMethod method )
 Sets the storage method field for the entry. More...

virtual void setName ( const string &name )
 Sets the name field for the entry. More...

virtual void setSize ( int size )
 Sets the size field for the entry. More...

virtual void setTime ( int time )
 Sets the time field for the entry. More...

virtual string toString () const
 Returns a human-readable string representation of the entry. More...

virtual BasicEntry* clone () const
 Create a heap allocated clone of the object this method is called for. More...

virtual ~BasicEntry ()

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 17 of file basicentry.h.

Constructor & Destructor Documentation

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

Constructor.

Parameters:
filename   the filename of the entry.
comment   a comment for the entry.

Definition at line 23 of file basicentry.cpp.

Member Function Documentation

BasicEntry * 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.

Reimplemented from zipios::FileEntry.

Definition at line 131 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.

Reimplemented from zipios::FileEntry.

Definition at line 41 of file basicentry.cpp.

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

Reimplemented from zipios::FileEntry.

Definition at line 45 of file basicentry.cpp.

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

Reimplemented from zipios::FileEntry.

Definition at line 49 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.

Reimplemented from zipios::FileEntry.

Definition at line 53 of file basicentry.cpp.

string zipios::BasicEntry::getFileName ( ) const [virtual]

Returns the filename of the entry.

Returns:
Returns the filename of the entry.

Reimplemented from zipios::FileEntry.

Definition at line 65 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.

Reimplemented from zipios::FileEntry.

Definition at line 57 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.

Reimplemented from zipios::FileEntry.

Definition at line 61 of file basicentry.cpp.

int zipios::BasicEntry::getSize ( ) const [virtual]

Returns the (uncompressed) size of the entry data.

Returns:
Returns the (uncompressed) size of the entry.

Reimplemented from zipios::FileEntry.

Definition at line 78 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.

Reimplemented from zipios::FileEntry.

Definition at line 82 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.

Reimplemented from zipios::FileEntry.

Definition at line 91 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.

Reimplemented from zipios::FileEntry.

Definition at line 86 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.

Reimplemented from zipios::FileEntry.

Definition at line 97 of file basicentry.cpp.

void zipios::BasicEntry::setCompressedSize ( int size ) [virtual]

Set the compressed size field of the entry.

Parameters:
size   value to set the compressed size field of the entry to.

Reimplemented from zipios::FileEntry.

Definition at line 101 of file basicentry.cpp.

void zipios::BasicEntry::setCrc ( int crc ) [virtual]

Sets the crc field.

Parameters:
crc   value to set the crc field to.

Reimplemented from zipios::FileEntry.

Definition at line 104 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.

Reimplemented from zipios::FileEntry.

Definition at line 107 of file basicentry.cpp.

void zipios::BasicEntry::setMethod ( StorageMethod method ) [virtual]

Sets the storage method field for the entry.

Parameters:
method   the method field is set to the specified value.

Reimplemented from zipios::FileEntry.

Definition at line 110 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.

Reimplemented from zipios::FileEntry.

Definition at line 113 of file basicentry.cpp.

void zipios::BasicEntry::setSize ( int size ) [virtual]

Sets the size field for the entry.

Parameters:
size   the size field is set to this value.

Reimplemented from zipios::FileEntry.

Definition at line 117 of file basicentry.cpp.

void zipios::BasicEntry::setTime ( int time ) [virtual]

Sets the time field for the entry.

Parameters:
time   the time field is set to the specified value.

Reimplemented from zipios::FileEntry.

Definition at line 121 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.

Reimplemented from zipios::FileEntry.

Definition at line 125 of file basicentry.cpp.

The documentation for this class was generated from the following files:
Generated at Sun Jul 9 00:55:54 2000 for Zipios++ by doxygen1.1.4 written by Dimitri van Heesch, © 1997-2000