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:

Public Member Functions
	BasicEntry (const string &filename, const string &comment, const FilePath &basepath=FilePath())
	Constructor.
virtual FileEntry *	clone () const
	Create a heap allocated clone of the object this method is called for.
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 string	getFileName () const
	Returns the filename of 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 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	isDirectory () const
	Returns true if the entry is a directory.
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 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	~BasicEntry ()
Protected Attributes
FilePath	_basepath
string	_comment
string	_filename
int	_size
bool	_valid

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

Definition at line 24 of file basicentry.cpp.

References _basepath, _filename, _size, _valid, and Sketcher::end.

Referenced by clone().

zipios::BasicEntry::~BasicEntry ( ) [virtual]

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

References BasicEntry().

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.

References _comment.

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.

References getSize().

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.

References _filename, isDirectory(), RobotExample::pos, and zipios::separator.

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.

References zipios::STORED.

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.

References _filename.

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.

References _size.

Referenced by getCompressedSize().

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.

References _filename, and zipios::separator.

Referenced by getFileName().

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.

References _valid.

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.

References _comment.

void zipios::BasicEntry::setCompressedSize ( uint32 size ) [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 ( uint32 crc ) [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 ( StorageMethod method ) [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.

References _filename.

void zipios::BasicEntry::setSize ( uint32 size ) [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.

References _size.

Referenced by zipios::DirectoryCollection::load().

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.

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.

References _filename, _size, and zipios::OutputStringStream::str().

Member Data Documentation

FilePath zipios::BasicEntry::_basepath [protected]

Definition at line 60 of file basicentry.h.

Referenced by BasicEntry().

string zipios::BasicEntry::_comment [protected]

Definition at line 57 of file basicentry.h.

Referenced by getComment(), and setComment().

string zipios::BasicEntry::_filename [protected]

Definition at line 56 of file basicentry.h.

Referenced by BasicEntry(), getFileName(), getName(), isDirectory(), setName(), and toString().

int zipios::BasicEntry::_size [protected]

Definition at line 58 of file basicentry.h.

Referenced by BasicEntry(), getSize(), setSize(), and toString().

bool zipios::BasicEntry::_valid [protected]

Definition at line 59 of file basicentry.h.

Referenced by BasicEntry(), and isValid().

The documentation for this class was generated from the following files:

zipios::BasicEntry Class Reference

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation