![]() |
Murl Engine API
Version 2024.1
|
The base interface for all resource objects. More...
#include <murl_resource_i_object.h>
The base interface for all resource objects.
Classes | |
class | ClassInfo |
The class information object. More... | |
Public Member Functions | |
virtual IObject * | GetObjectInterface ()=0 |
Get the mutable IObject interface. More... | |
virtual const IObject * | GetObjectInterface () const =0 |
Get the constant IObject interface. More... | |
virtual const IObjectFactory * | GetCreator () const =0 |
Get the object factory used to create this object. More... | |
virtual Bool | SetParentPackage (const IPackage *parentPackage)=0 |
Set the optional package this object belongs to. More... | |
virtual const IPackage * | GetParentPackage () const =0 |
Get the optional package this object belongs to. More... | |
virtual Bool | SetMetaData (const IMetaData *metaData)=0 |
Set optional meta data for this object. More... | |
virtual const IMetaData * | GetMetaData () const =0 |
Get the optional meta data held by this object. More... | |
virtual Bool | SetTags (const StringArray &tags)=0 |
Set optional resource tags for this object. More... | |
virtual const StringArray & | GetTags () const =0 |
Get the optional resource tags held by this object. More... | |
virtual Bool | Init ()=0 |
Initialize this object. More... | |
virtual Bool | DeInit ()=0 |
De-initialize this object. More... | |
virtual Bool | CreateBinary (Data &data) const =0 |
Create a binary representation from the object. More... | |
virtual const String & | GetId () const =0 |
Get the object's ID. More... | |
virtual IEnums::ResourceType | GetResourceType () const =0 |
Get the object's actual resource type. More... | |
virtual IEnums::FileType | GetFileType () const =0 |
Get the type of file this resource object was constructed from. More... | |
virtual IEnums::FileCategory | GetFileCategory () const =0 |
Get the optional file category containing the file this resource was constructed from. More... | |
virtual const String & | GetFileName () const =0 |
Get the optional file name this resource was constructed from, relative to the file category returned via GetFileCategory(). More... | |
virtual Bool | GetParameters (IAttributes *params) const =0 |
Fill a given IAttributes object with the actual parameters used during creation. More... | |
virtual Bool | GetValidationResults (ObjectArray< Result > &results) const =0 |
Fill a given array with possible error or warning results from validating given parameters. More... | |
virtual Bool | GetFileDependencies (Array< String > &fileNames) const =0 |
Fill a given string array with names of files the resource depends on. More... | |
virtual Bool | TakeDataOwnership ()=0 |
Take ownership of the data buffer used to create the resource. More... | |
![]() | |
~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 | |
![]() | |
using | ClassInfoArray = Array< const ClassInfo * > |
Definition of an array of ClassInfo objects. | |
![]() | |
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< IObject > *object) |
Reset an object instance's properties to their default values. More... | |
|
pure virtual |
|
pure virtual |
|
pure virtual |
Get the object factory used to create this object.
|
pure virtual |
Set the optional package this object belongs to.
parentPackage | The containing package, or null for removing. |
|
pure virtual |
Get the optional package this object belongs to.
Set optional meta data for this object.
If set, the object takes ownership of the meta data. The meta data object is automatically deleted when the object is destroyed, or a different meta data object is set.
metaData | The meta data, or null for removing. |
|
pure virtual |
Get the optional meta data held by this object.
|
pure virtual |
Set optional resource tags for this object.
tags | The resource tags. |
|
pure virtual |
Get the optional resource tags held by this object.
|
pure virtual |
Initialize this object.
|
pure virtual |
De-initialize this object.
Create a binary representation from the object.
data | A reference to a Data object receiving the binary. |
|
pure virtual |
Get the object's ID.
|
pure virtual |
Get the object's actual resource type.
|
pure virtual |
Get the type of file this resource object was constructed from.
|
pure virtual |
Get the optional file category containing the file this resource was constructed from.
|
pure virtual |
Get the optional file name this resource was constructed from, relative to the file category returned via GetFileCategory().
|
pure virtual |
Fill a given IAttributes object with the actual parameters used during creation.
params | An attributes object receiving the parameters. |
|
pure virtual |
Fill a given array with possible error or warning results from validating given parameters.
results | An array of result objects. |
|
pure virtual |
Fill a given string array with names of files the resource depends on.
fileNames | A string array receiving the dependency file names. |
|
pure virtual |
Take ownership of the data buffer used to create the resource.
After taking ownership, the resource object will delete the underlying data when the resource itself is deleted. The caller must ensure that the given data is not deallocated in a different place.