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

#include <basicentry.h>

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

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

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

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

virtual uint32	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 string	getFileName () const
	Returns the filename of 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 uint32	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	isDirectory () const
	Returns true if the entry is a directory. 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 void	setComment (const string &comment)
	Sets the comment field for the FileEntry. More...

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

virtual void	setCrc (uint32 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 (uint32 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 ()

Public Member Functions inherited from zipios::FileEntry
virtual FileEntry *	clone () const =0
	Create a heap allocated clone of the object this method is called for. More...

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

virtual uint32	getCompressedSize () const =0
	Returns the compressed size of the entry. More...

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

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

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

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

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

virtual uint32	getSize () const =0
	Returns the (uncompressed) size of the entry data. More...

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

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

virtual bool	isValid () const =0
	Any method or operator that initializes a FileEntry may set a flag, that specifies whether the read entry is valid or not. More...

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

virtual void	setCompressedSize (uint32 size)=0
	Set the compressed size field of the entry. More...

virtual void	setCrc (uint32 crc)=0
	Sets the crc field. More...

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

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

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

virtual void	setSize (uint32 size)=0
	Sets the size field for the entry. More...

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

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

virtual	~FileEntry ()
	FileEntry destructor. More...

Additional Inherited Members
Protected Member Functions inherited from zipios::FileEntry
void	ref () const

unsigned int	unref () const

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

Constructor & Destructor Documentation

◆ BasicEntry()

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

Referenced by clone().

◆ ~BasicEntry()

zipios::BasicEntry::~BasicEntry ( )

virtual

Member Function Documentation

◆ clone()

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.

References BasicEntry().

Referenced by ArchPanel.CommandPanelSheet::Activated(), ArchStructure.CommandStructuralSystem::Activated(), ArchComponent.Component::execute(), ArchCurtainWall.CurtainWall::execute(), ArchTruss.Truss::execute(), Mod.PartDesign.WizardShaft.SegmentFunction.SegmentFunction::integrated(), and PathTests.TestPathHelix.TestPathHelix::test04().

◆ getComment()

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.

◆ getCompressedSize()

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.

References getSize().

◆ getCrc()

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.

◆ getExtra()

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.

◆ getFileName()

string zipios::BasicEntry::getFileName ( ) const

virtual

Returns the filename of the entry.

Returns: Returns the filename of the entry.

Implements zipios::FileEntry.

References isDirectory(), and zipios::separator.

◆ getMethod()

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.

References zipios::STORED.

◆ getName()

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.

◆ getSize()

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.

Referenced by getCompressedSize().

◆ getTime()

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.

◆ isDirectory()

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.

References zipios::separator.

Referenced by getFileName().

◆ isValid()

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

Implements zipios::FileEntry.

◆ setComment()

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.

◆ setCompressedSize()

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.

◆ setCrc()

void zipios::BasicEntry::setCrc ( uint32 crc )

virtual

Sets the crc field.

Parameters

crc	value to set the crc field to.

Implements zipios::FileEntry.

◆ setExtra()

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.

◆ setMethod()

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.

◆ setName()

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.

◆ setSize()

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.

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

◆ setTime()

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.

◆ toString()

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.

References zipios::OutputStringStream::str().

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

FreeCAD/src/zipios++/basicentry.h
FreeCAD/src/zipios++/basicentry.cpp

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ BasicEntry()

◆ ~BasicEntry()

Member Function Documentation

◆ clone()

◆ getComment()

◆ getCompressedSize()

◆ getCrc()

◆ getExtra()

◆ getFileName()

◆ getMethod()

◆ getName()

◆ getSize()

◆ getTime()

◆ isDirectory()

◆ isValid()

◆ setComment()

◆ setCompressedSize()

◆ setCrc()

◆ setExtra()

◆ setMethod()

◆ setName()

◆ setSize()

◆ setTime()

◆ toString()