The resource collection interface. More...

#include "murl_resource_i_collection.h"

Inheritance diagram for Murl::Resource::ICollection:

Public Member Functions
virtual ICollection *	GetCollectionInterface ()=0
	Get the mutable ICollection interface. More...

virtual const ICollection *	GetCollectionInterface () const =0
	Get the constant ICollection interface. More...

virtual const ICollectionFactory *	GetCreator () const =0
	Get the factory object used to create this collection. More...

virtual Bool	Init ()=0
	Initialize this collection. More...

virtual Bool	DeInit ()=0
	De-initialize this collection. More...

virtual Bool	RegisterPackageData (const String &name, const ConstData &data)=0
	Register a specific package from a block of memory. More...

virtual Bool	UnregisterPackageData (const String &name)=0
	Unregister a package previously registered through RegisterPackageData(). More...

virtual const IPackage *	CreatePackageFromFile (const String &id, const ICondition *condition, const String &fileName, IEnums::FileCategory fileCategory, Result &result)=0
	Create a resource package from a file. More...

virtual const IPackage *	CreatePackageFromMemory (const String &id, const ICondition *condition, const String &fileName, IEnums::FileCategory fileCategory, const ConstData &data, Bool &dataCanBeDisposed, Result &result)=0
	Create a resource package from a block of memory. More...

virtual const IPackage *	CreatePackageReference (const IPackage referencedPackage, const String &id, const ICondition condition)=0
	Create a reference to an existing resource package. More...

virtual Bool	DestroyPackage (const IPackage *&package)=0
	Destroy a previously created package. More...

virtual Bool	QueryPackageFromFile (const String &fileName, IEnums::FileCategory fileCategory, String id, UInt32 revision, Bool isDataValid, Bool isVersionValid, Bool *isChecksumValid) const =0
	Query information about a package file. More...

virtual Bool	QueryPackageFromMemory (const ConstData &data, String id, UInt32 revision, Bool isDataValid, Bool isVersionValid, Bool *isChecksumValid) const =0
	Query information about a package in memory. More...

virtual UInt32	GetNumberOfPackages () const =0
	Get the total number of packages in this collection. More...

virtual const IPackage *	GetPackage (UInt32 index) const =0
	Get the package at a given index. More...

virtual const ICondition *	GetPackageCondition (UInt32 index) const =0
	Get the condition of a package at a given index. More...

virtual const IPackage *	GetPackage (const String &id) const =0
	Get a package by its ID. More...

virtual const IObject *	GetObject (const String &id) const =0
	Get a single generic resource object by its package/object ID. More...

virtual const IBinary *	GetBinary (const String &id) const =0
	Get a single object as a specialized Resource::IBinary. More...

virtual const IGraph *	GetGraph (const String &id) const =0
	Get a single object as a specialized Resource::IGraph. More...

virtual const IImage *	GetImage (const String &id) const =0
	Get a single object as a specialized Resource::IImage. More...

virtual const IMesh *	GetMesh (const String &id) const =0
	Get a single object as a specialized Resource::IMesh. More...

virtual const IFont *	GetFont (const String &id) const =0
	Get a single object as a specialized Resource::IFont. More...

virtual const IShader *	GetShader (const String &id) const =0
	Get a single object as a specialized Resource::IShader. More...

virtual const IAudio *	GetAudio (const String &id) const =0
	Get a single object as a specialized Resource::IAudio. More...

virtual const IAnimation *	GetAnimation (const String &id) const =0
	Get a single object as a specialized Resource::IAnimation. More...

virtual const IAtlas *	GetAtlas (const String &id) const =0
	Get a single object as a specialized Resource::IAtlas. More...

virtual const IArchive *	GetArchive (const String &id) const =0
	Get a single object as a specialized Resource::IArchive. More...

virtual const IVideo *	GetVideo (const String &id) const =0
	Get a single object as a specialized Resource::IVideo. More...

virtual const IScript *	GetScript (const String &id) const =0
	Get a single object as a specialized Resource::IScript. More...

virtual const IDictionary *	GetDictionary (const String &id) const =0
	Get a single object as a specialized Resource::IDictionary. More...

virtual const IGrid *	GetGrid (const String &id) const =0
	Get a single object as a specialized Resource::IGrid. More...

virtual const IText *	GetText (const String &id) const =0
	Get a single text resource. More...

virtual Bool	SetParentPackage (const IPackage *parentPackage)=0
	Set the optional parent package this collection belongs to. More...

virtual const IPackage *	GetParentPackage () const =0
	Get the optional parent package this collection belongs to. More...

virtual Bool	SetParentCollection (const ICollection *parentCollection)=0
	Set the optional parent collection. More...

virtual const ICollection *	GetParentCollection () const =0
	Get the optional parent collection. More...

virtual UInt32	GetNumberOfAllocatedResourceBytes () const =0
	Query the total number of allocated resource bytes in this collection. More...

virtual Bool	CollectStatisticsObjects (Index< const IStatisticsObject * > &objects) const =0
	Populate a given index with all objects currently present in the collection. More...

Public Member Functions inherited from Murl::IFactoryObject< ICollection >
	~IFactoryObject () override
	The destructor.

virtual const ClassInfo *	GetObjectClassInfo () const=0
	Get the object instance's class info, if present. More...

virtual void	ResetObjectProperties ()=0
	Reset the object instance's properties to their default values.

Additional Inherited Members
Public Types inherited from Murl::IFactoryObject< ICollection >
using	ClassInfoArray = Array< const ClassInfo * >
	Definition of an array of ClassInfo objects.

Static Public Member Functions inherited from Murl::IFactoryObject< ICollection >
static const PropertyInfo *	GetPropertyInfo ()
	Get the class' property info struct. More...

static const AttributeInfo *	GetAttributeInfo ()
	Get the class' attribute info struct. More...

static void	ResetProperties (IFactoryObject< ICollection > *object)
	Reset an object instance's properties to their default values. More...

Detailed Description

The resource collection interface.

A resource collection provides methods to manage individual Resource::IPackage objects, which contain a number of individual Resource::IObject instances. The resource collection also provides methods to retrieve individual objects via a package/object identifier pair in the form "packageId:objectId", as in GetObject() and related methods.

Member Function Documentation

◆ GetCollectionInterface() [1/2]

virtual ICollection* Murl::Resource::ICollection::GetCollectionInterface ( )

pure virtual

Get the mutable ICollection interface.

Returns: The ICollection interface.

◆ GetCollectionInterface() [2/2]

virtual const ICollection* Murl::Resource::ICollection::GetCollectionInterface ( ) const

pure virtual

Get the constant ICollection interface.

Returns: The ICollection interface.

◆ GetCreator()

virtual const ICollectionFactory* Murl::Resource::ICollection::GetCreator ( ) const

pure virtual

Get the factory object used to create this collection.

Returns: The creator factory.

◆ Init()

virtual Bool Murl::Resource::ICollection::Init ( )

pure virtual

Initialize this collection.

Returns: true if successful.

◆ DeInit()

virtual Bool Murl::Resource::ICollection::DeInit ( )

pure virtual

De-initialize this collection.

Returns: true if successful.

◆ RegisterPackageData()

virtual Bool Murl::Resource::ICollection::RegisterPackageData	(	const String &	name,
		const ConstData &	data
	)

pure virtual

Register a specific package from a block of memory.

This method can be used to register a package from memory as if it was a file on disk. Internally, the CreatePackageFromFile() first checks if any package with the given file name was registered through this method before actually searching the file system.

Parameters

name	The file name to register.
data	A Data object containing the binary package.

Returns: true if successful.

◆ UnregisterPackageData()

virtual Bool Murl::Resource::ICollection::UnregisterPackageData ( const String & name )

pure virtual

Unregister a package previously registered through RegisterPackageData().

Parameters

name	The file name to unregister.

Returns: true if successful.

◆ CreatePackageFromFile()

virtual const IPackage* Murl::Resource::ICollection::CreatePackageFromFile	(	const String &	id,
		const ICondition *	condition,
		const String &	fileName,
		IEnums::FileCategory	fileCategory,
		Result &	result
	)

pure virtual

Create a resource package from a file.

Parameters

id	The internal package ID.
condition	An optional condition interface to check.
fileName	The name of the package file, relative to the given file category below.
fileCategory	The file system category where to look for the given file.
result	The object to receive the result of the operation.

Returns: The newly created package, or null if failed.

◆ CreatePackageFromMemory()

virtual const IPackage* Murl::Resource::ICollection::CreatePackageFromMemory	(	const String &	id,
		const ICondition *	condition,
		const String &	fileName,
		IEnums::FileCategory	fileCategory,
		const ConstData &	data,
		Bool &	dataCanBeDisposed,
		Result &	result
	)

pure virtual

Create a resource package from a block of memory.

Parameters

id	The internal package ID.
condition	An optional condition interface to check.
fileName	The file name of the package, relative to which any individual file sub-resources/-packages are accessed from the file system.
fileCategory	The file system category to prepend to the file name.
data	The binary package data.
dataCanBeDisposed	A reference to a Bool variable receiving true whenever it is safe to delete the input data right after package creation. If this value receives false, the input data must be kept until the package is destroyed using DestroyPackage().
result	The object to receive the result of the operation.

Returns: The newly created package, or null if failed.

◆ CreatePackageReference()

virtual const IPackage* Murl::Resource::ICollection::CreatePackageReference	(	const IPackage *	referencedPackage,
		const String &	id,
		const ICondition *	condition
	)

pure virtual

Create a reference to an existing resource package.

Parameters

referencedPackage	The package to refer to.
id	The internal package ID.
condition	An optional condition interface to check.

Returns: The referenced package, or null if failed.

◆ DestroyPackage()

virtual Bool Murl::Resource::ICollection::DestroyPackage ( const IPackage *& package )

pure virtual

Destroy a previously created package.

Parameters

package A reference to a pointer holding the package to destroy.

Returns: true if successful.

◆ QueryPackageFromFile()

virtual Bool Murl::Resource::ICollection::QueryPackageFromFile	(	const String &	fileName,
		IEnums::FileCategory	fileCategory,
		String *	id,
		UInt32 *	revision,
		Bool *	isDataValid,
		Bool *	isVersionValid,
		Bool *	isChecksumValid
	)		const

pure virtual

Query information about a package file.

Parameters

fileName	The name of the package file, relative to the given file category below.
fileCategory	The file system category where to look for the given file.
id	An optional pointer to receive the package ID, if present.
revision	An optional pointer to receive the user-defined package revision, if present.
isDataValid	An optional pointer to receive the result of the overall data validity check.
isVersionValid	An optional pointer to receive the result of the version check.
isChecksumValid	An optional pointer to receive the result of the checksum comparison, if the package does include one.

Returns: true if the package could be loaded in the first place.

◆ QueryPackageFromMemory()

virtual Bool Murl::Resource::ICollection::QueryPackageFromMemory	(	const ConstData &	data,
		String *	id,
		UInt32 *	revision,
		Bool *	isDataValid,
		Bool *	isVersionValid,
		Bool *	isChecksumValid
	)		const

pure virtual

Query information about a package in memory.

Parameters

data	The binary package data.
id	An optional pointer to receive the package ID, if present.
revision	An optional pointer to receive the user-defined package revision, if present.
isDataValid	An optional pointer to receive the result of the overall data validity check.
isVersionValid	An optional pointer to receive the result of the version check.
isChecksumValid	An optional pointer to receive the result of the checksum comparison, if the package does include one.

Returns: true if the package could be loaded in the first place.

◆ GetNumberOfPackages()

virtual UInt32 Murl::Resource::ICollection::GetNumberOfPackages ( ) const

pure virtual

Get the total number of packages in this collection.

Returns: The number of packages.

◆ GetPackage() [1/2]

virtual const IPackage* Murl::Resource::ICollection::GetPackage ( UInt32 index ) const

pure virtual

Get the package at a given index.

Parameters

index The index of the package, from 0 to GetNumberOfPackages()-1.

Returns: A pointer to the package, or null if the index is out of range.

◆ GetPackageCondition()

virtual const ICondition* Murl::Resource::ICollection::GetPackageCondition ( UInt32 index ) const

pure virtual

Get the condition of a package at a given index.

Parameters

index The index of the package, from 0 to GetNumberOfPackages()-1.

Returns: The condition, or null if unconditional or the index is out of range.

◆ GetPackage() [2/2]

virtual const IPackage* Murl::Resource::ICollection::GetPackage ( const String & id ) const

pure virtual

Get a package by its ID.

Parameters

id	The package ID to query.

Returns: A pointer to the package, or null if a package with given ID was not found.

◆ GetObject()

virtual const IObject* Murl::Resource::ICollection::GetObject ( const String & id ) const

pure virtual

Get a single generic resource object by its package/object ID.

The given ID must be in the form "/packageId/objectId", to reference an object in a specific loaded package. If the package contains sub-packages, the resource may be referenced via e.g. "/packageId/subPackageId/objectId".

Parameters

id	The ID of the object to retrieve.

Returns: A pointer to the generic object, or null if not found.

◆ GetBinary()

virtual const IBinary* Murl::Resource::ICollection::GetBinary ( const String & id ) const

pure virtual

Get a single object as a specialized Resource::IBinary.

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ GetCollectionInterface() [1/2]

◆ GetCollectionInterface() [2/2]

◆ GetCreator()

◆ Init()

◆ DeInit()

◆ RegisterPackageData()

◆ UnregisterPackageData()

◆ CreatePackageFromFile()

◆ CreatePackageFromMemory()

◆ CreatePackageReference()

◆ DestroyPackage()

◆ QueryPackageFromFile()

◆ QueryPackageFromMemory()

◆ GetNumberOfPackages()

◆ GetPackage() [1/2]

◆ GetPackageCondition()

◆ GetPackage() [2/2]

◆ GetObject()

◆ GetBinary()

◆ GetGraph()

◆ GetImage()

◆ GetMesh()

◆ GetFont()

◆ GetShader()

◆ GetAudio()

◆ GetAnimation()

◆ GetAtlas()

◆ GetArchive()

◆ GetVideo()

◆ GetScript()

◆ GetDictionary()

◆ GetGrid()

◆ GetText()

◆ SetParentPackage()

◆ GetParentPackage()

◆ SetParentCollection()

◆ GetParentCollection()

◆ GetNumberOfAllocatedResourceBytes()

◆ CollectStatisticsObjects()