CollectionCollection is a FileCollection that consists of an arbitrary number of FileCollections. More...

#include <collcoll.h>

Public Member Functions
bool	addCollection (const FileCollection &collection)
	Adds a collection. More...

bool	addCollection (FileCollection *collection)
	Adds the collection pointed to by collection. More...

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

virtual void	close ()
	Closes the FileCollection. More...

	CollectionCollection ()
	Constructor. More...

	CollectionCollection (const CollectionCollection &src)
	Copy constructor. More...

virtual ConstEntries	entries () const
	Returns a vector of const pointers to the entries in the FileCollection. More...

virtual ConstEntryPointer	getEntry (const string &name, MatchPath matchpath=MATCH) const
	Returns a ConstEntryPointer to a FileEntry object for the entry with the specified name. More...

virtual istream *	getInputStream (const ConstEntryPointer &entry)
	Returns a pointer to an opened istream for the specified FileEntry. More...

virtual istream *	getInputStream (const string &entry_name, MatchPath matchpath=MATCH)
	Returns a pointer to an opened istream for the specified entry name. More...

const CollectionCollection &	operator= (const CollectionCollection &src)
	Copy assignment operator. More...

virtual int	size () const
	Returns the number in entries in all collections kept by the CollectionCollection object. More...

virtual	~CollectionCollection ()

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

virtual void	close ()=0
	Closes the FileCollection. More...

virtual ConstEntries	entries () const
	Returns a vector of const pointers to the entries in the FileCollection. More...

	FileCollection ()
	FileCollection constructor. More...

	FileCollection (const FileCollection &src)
	Copy constructor. More...

virtual ConstEntryPointer	getEntry (const string &name, MatchPath matchpath=MATCH) const
	Returns a ConstEntryPointer to a FileEntry object for the entry with the specified name. More...

virtual istream *	getInputStream (const ConstEntryPointer &entry)=0
	Returns a pointer to an opened istream for the specified FileEntry. More...

virtual istream *	getInputStream (const string &entry_name, MatchPath matchpath=MATCH)=0
	Returns a pointer to an opened istream for the specified entry name. More...

virtual string	getName () const
	Returns the name of the FileCollection. More...

bool	isValid () const
	The member function returns true if the collection is valid. More...

const FileCollection &	operator= (const FileCollection &src)
	Copy assignment operator. More...

virtual int	size () const
	Returns the number of entries in the FileCollection. More...

virtual	~FileCollection ()
	FileCollection destructor. More...

Static Public Member Functions
static CollectionCollection &	inst ()
	This static method provides a singleton instance of a CollectionCollection. More...

Protected Member Functions
void	getEntry (const string &name, ConstEntryPointer &cep, std::vector< FileCollection * >::const_iterator &it, MatchPath matchpath=MATCH) const
	A protected getEntry member function, that not only finds an entry that match the name, if such an entry exists in the collection, it also returns, which collection it was found in. More...

Additional Inherited Members
Public Types inherited from zipios::FileCollection
enum	MatchPath { IGN , MATCH }

Detailed Description

CollectionCollection is a FileCollection that consists of an arbitrary number of FileCollections.

With a CollectionCollection the user can use multiple FileCollections transparently, making it easy for a program to keep some of its files in a zip archive and others stored in ordinary files. CollectionCollection can be used to create a simple virtual filesystem, where all collections are mounted in /. If more than one collection contain a file with the same path only the one in the first added collection will be accessible.

Constructor & Destructor Documentation

◆ CollectionCollection() [1/2]

zipios::CollectionCollection::CollectionCollection ( )

explicit

Constructor.

Referenced by clone(), and inst().

◆ CollectionCollection() [2/2]

zipios::CollectionCollection::CollectionCollection ( const CollectionCollection & src )

Copy constructor.

◆ ~CollectionCollection()

zipios::CollectionCollection::~CollectionCollection ( )

virtual

Member Function Documentation

◆ addCollection() [1/2]

bool zipios::CollectionCollection::addCollection ( const FileCollection & collection )

Adds a collection.

Parameters

collection The collection to add.

Returns: true if the collection was added successfully and the added collection is valid.

References zipios::FileCollection::clone(), and zipios::FileCollection::isValid().

◆ addCollection() [2/2]

bool zipios::CollectionCollection::addCollection ( FileCollection * collection )

Adds the collection pointed to by collection.

The CollectionCollection will call delete on the pointer when it is destructed, so the caller should make absolutely sure to only pass in a collection created with new and be sure to leave it alone after adding it. If the collection is not added false is returned and the caller remains responsible for the collection pointed to by collection.

Parameters

collection A pointer to the collection to add.

Returns: true if the collection was added successfully and the added collection is valid.

References zipios::FileCollection::isValid().

◆ clone()

FileCollection * zipios::CollectionCollection::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::FileCollection.

References CollectionCollection().

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().

◆ close()

void zipios::CollectionCollection::close ( )

virtual

Closes the FileCollection.

Implements zipios::FileCollection.

Referenced by femexamples.examplesgui.FemExamples::reject().

◆ entries()

ConstEntries zipios::CollectionCollection::entries ( ) const

virtual

Returns a vector of const pointers to the entries in the FileCollection.

Returns: a ConstEntries containing the entries of the FileCollection.

Exceptions

InvalidStateException Thrown if the collection is invalid.

Reimplemented from zipios::FileCollection.

◆ getEntry() [1/2]

void zipios::CollectionCollection::getEntry	(	const string &	name,
		ConstEntryPointer &	cep,
		std::vector< FileCollection * >::const_iterator &	it,
		MatchPath	matchpath = `MATCH`
	)		const

protected

A protected getEntry member function, that not only finds an entry that match the name, if such an entry exists in the collection, it also returns, which collection it was found in.

◆ getEntry() [2/2]

ConstEntryPointer zipios::CollectionCollection::getEntry	(	const string &	name,
		MatchPath	matchpath = `MATCH`
	)		const

virtual

Returns a ConstEntryPointer to a FileEntry object for the entry with the specified name.

To ignore the path part of the filename in search of a match, specify FileCollection::IGNORE as the second argument.

Parameters

name	A string containing the name of the entry to get.
matchpath	specify MATCH, if the path should match as well, specify IGNORE, if the path should be ignored.

Returns: A ConstEntryPointer to the found entry. The returned pointer equals zero if no entry is found.

Exceptions

InvalidStateException Thrown if the collection is invalid.

Reimplemented from zipios::FileCollection.

References getEntry().

Referenced by getEntry(), and getInputStream().

◆ getInputStream() [1/2]

istream * zipios::CollectionCollection::getInputStream ( const ConstEntryPointer & entry )

virtual

Returns a pointer to an opened istream for the specified FileEntry.

It is the callers responsibility to delete the stream when he is done with it. Returns 0, if there is no such FileEntry in the FileCollection.

Parameters

entry A ConstEntryPointer to the FileEntry to get an istream to.

Returns: an open istream for the specified entry. The istream is allocated on heap and it is the users responsibility to delete it when he is done with it.

Exceptions

InvalidStateException Thrown if the collection is invalid.

Implements zipios::FileCollection.

References getInputStream().

Referenced by getInputStream().

◆ getInputStream() [2/2]

istream * zipios::CollectionCollection::getInputStream	(	const string &	entry_name,
		MatchPath	matchpath = `MATCH`
	)

virtual

Returns a pointer to an opened istream for the specified entry name.

It is the callers responsibility to delete the stream when he is done with it. Returns 0, if there is no entry with the specified name in the FileCollection.

Parameters

entry_name
matchpath	specify MATCH, if the path should match as well, specify IGNORE, if the path should be ignored.

Returns: an open istream for the specified entry. The istream is allocated on heap and it is the users responsibility to delete it when he is done with it.

Exceptions

InvalidStateException Thrown if the collection is invalid.

Implements zipios::FileCollection.

References getEntry().

◆ inst()

CollectionCollection & zipios::CollectionCollection::inst ( )

static

This static method provides a singleton instance of a CollectionCollection.

The instance is instantiated the first time the method is called.

Returns: A pointer to a singleton CollectionCollection instance.

References CollectionCollection().

◆ operator=()

const CollectionCollection & zipios::CollectionCollection::operator= ( const CollectionCollection & src )

Copy assignment operator.

References zipios::FileCollection::operator=().

◆ size()

int zipios::CollectionCollection::size ( ) const

virtual

Returns the number in entries in all collections kept by the CollectionCollection object.

Reimplemented from zipios::FileCollection.

Referenced by gzip_utf8.GzipFile::close(), PathScripts.PostUtils.GCodeEditorDialog::done(), and gzip_utf8.GzipFile::write().

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

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

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ CollectionCollection() [1/2]

◆ CollectionCollection() [2/2]

◆ ~CollectionCollection()

Member Function Documentation

◆ addCollection() [1/2]

◆ addCollection() [2/2]

◆ clone()

◆ close()

◆ entries()

◆ getEntry() [1/2]

◆ getEntry() [2/2]

◆ getInputStream() [1/2]

◆ getInputStream() [2/2]

◆ inst()

◆ operator=()

◆ size()